245 lines
5.8 KiB
Markdown
245 lines
5.8 KiB
Markdown
# posterminal
|
|
|
|
This document is auto-generated from the JSDoc comments in `src/store` by running `npm run api-doc`.
|
|
|
|
## `posterminal.delete`
|
|
|
|
*Source: `src/store/posterminal/delete.js`*
|
|
|
|
Deletes a posterminal by its id within the user's selected company.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `id` | `number` | The id of the posterminal to delete. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<void>`
|
|
|
|
**Throws**
|
|
|
|
`Error` — If the posterminal is not found.
|
|
|
|
**Example**
|
|
|
|
```js
|
|
await store.posterminal.delete(42, 5);
|
|
```
|
|
|
|
## `posterminal.findByPairingpin`
|
|
|
|
*Source: `src/store/posterminal/findByPairingpin.js`*
|
|
|
|
Finds a posterminal by its pairingpin.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `pairingpin` | `string` | The pairing pin to search for. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<object|null>` — The posterminal row, or null if not found.
|
|
|
|
## `posterminal.list`
|
|
|
|
*Source: `src/store/posterminal/list.js`*
|
|
|
|
Lists the posterminals of the user's selected company.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<Array<{id: number, name: string, token: string, pairingpin: string}>>` — The posterminals.
|
|
|
|
**Example**
|
|
|
|
```js
|
|
const terminals = await store.posterminal.list(42);
|
|
// => [{ id, name, token, pairingpin }]
|
|
```
|
|
|
|
## `posterminal.pair`
|
|
|
|
*Source: `src/store/posterminal/pair.js`*
|
|
|
|
Completes POS device pairing for a terminal.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `id` | `number` | The posterminal id. |
|
|
| `input` | `object` | |
|
|
| `input.token` | `string` | The auth token for the paired device. |
|
|
| `[input.clientserial]` | `string` | The client name or serial identifier. |
|
|
| `[input.pairedAt]` | `string` | Timestamp when paired. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<{id: number, token: string, clientserial: string|null, pairedAt: string|null}>`
|
|
|
|
## `posterminal.setOff`
|
|
|
|
*Source: `src/store/posterminal/setOff.js`*
|
|
|
|
Removes a category assignment from a posterminal (turns it off).
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `posterminalId` | `number` | The id of the posterminal. |
|
|
| `categoryId` | `number` | The id of the category to remove. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<{id: number, categoryIds: Array<number>}>` — The posterminal with its remaining category ids.
|
|
|
|
**Throws**
|
|
|
|
`Error` — If the posterminal is not found.
|
|
|
|
**Example**
|
|
|
|
```js
|
|
const result = await store.posterminal.setOff(42, 5, 9);
|
|
// => { id, categoryIds: [...] }
|
|
```
|
|
|
|
## `posterminal.setOffAll`
|
|
|
|
*Source: `src/store/posterminal/setOffAll.js`*
|
|
|
|
Removes all category assignments from a posterminal.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `posterminalId` | `number` | The id of the posterminal. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<{id: number, categoryIds: Array<number>}>` — The posterminal with an empty category list.
|
|
|
|
**Throws**
|
|
|
|
`Error` — If the posterminal is not found.
|
|
|
|
**Example**
|
|
|
|
```js
|
|
const result = await store.posterminal.setOffAll(42, 5);
|
|
// => { id, categoryIds: [] }
|
|
```
|
|
|
|
## `posterminal.setOn`
|
|
|
|
*Source: `src/store/posterminal/setOn.js`*
|
|
|
|
Assigns a category to a posterminal (turns it on for that category).
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `posterminalId` | `number` | The id of the posterminal. |
|
|
| `categoryId` | `number` | The id of the category to assign. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<{id: number, categoryIds: Array<number>}>` — The posterminal with its category ids.
|
|
|
|
**Throws**
|
|
|
|
`Error` — If the posterminal is not found.
|
|
|
|
**Example**
|
|
|
|
```js
|
|
const result = await store.posterminal.setOn(42, 5, 9);
|
|
// => { id, categoryIds: [9, ...] }
|
|
```
|
|
|
|
## `posterminal.setOnAll`
|
|
|
|
*Source: `src/store/posterminal/setOnAll.js`*
|
|
|
|
Assigns all categories of the user's selected company to a posterminal.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `posterminalId` | `number` | The id of the posterminal. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<{id: number, categoryIds: Array<number>}>` — The posterminal with all category ids.
|
|
|
|
**Throws**
|
|
|
|
`Error` — If the posterminal is not found.
|
|
|
|
**Example**
|
|
|
|
```js
|
|
const result = await store.posterminal.setOnAll(42, 5);
|
|
// => { id, categoryIds: [...] }
|
|
```
|
|
|
|
## `posterminal.upsert`
|
|
|
|
*Source: `src/store/posterminal/upsert.js`*
|
|
|
|
Creates or updates a posterminal for the user's selected company.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `input` | `object` | The posterminal input. |
|
|
| `input.name` | `string` | The posterminal name. |
|
|
| `input.pairingpin` | `string` | The pairing pin. |
|
|
| `[input.token]` | `string` | Optional token. |
|
|
| `[input.id]` | `number` | Optional id to update an existing posterminal. |
|
|
| `[tx]` | `object` | Optional transaction to run within. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<{id: number, name: string, token: string, pairingpin: string}>` — The upserted posterminal.
|
|
|
|
**Throws**
|
|
|
|
`Error` — If the posterminal is invalid.
|
|
|
|
**Example**
|
|
|
|
```js
|
|
const terminal = await store.posterminal.upsert(42, { name: 'Kasse 1', pairingpin: '1234', token: 'abc' });
|
|
// => { id, name, token, pairingpin }
|
|
```
|