u
This commit is contained in:
@@ -45,7 +45,7 @@ Finds a posterminal by its pairingpin.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, maxknowntombstoneid: number|null, rootCategoryId: number|null, syncRootArticles: boolean|number, lastseenAt: string|null, updatedAt: string}|null>` — The posterminal, or null if not found.
|
||||
`Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, maxknownobituaryid: number|null, rootCategoryId: number|null, syncRootArticles: boolean|number, lastseenAt: string|null, updatedAt: string}|null>` — The posterminal, or null if not found.
|
||||
|
||||
## `posterminal.findByToken`
|
||||
|
||||
@@ -62,7 +62,7 @@ Finds a posterminal by its auth token.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, maxknowntombstoneid: number|null, rootCategoryId: number|null, syncRootArticles: boolean|number, lastseenAt: string|null, updatedAt: string}|null>` — The posterminal, or null if not found.
|
||||
`Promise<{id: number, companyId: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, maxknownobituaryid: number|null, rootCategoryId: number|null, syncRootArticles: boolean|number, lastseenAt: string|null, updatedAt: string}|null>` — The posterminal, or null if not found.
|
||||
|
||||
## `posterminal.getCategoryCount`
|
||||
|
||||
@@ -212,7 +212,7 @@ Counts deleted entities for a POS terminal after the given cursor ID.
|
||||
| --- | --- | --- |
|
||||
| `input` | `object` | |
|
||||
| `input.posterminalId` | `number` | The POS terminal id. |
|
||||
| `[input.cursor=0]` | `number` | The highest synced tombstone ID. |
|
||||
| `[input.cursor=0]` | `number` | The highest synced obituary ID. |
|
||||
| `[tx]` | `object` | Optional transaction. |
|
||||
|
||||
**Returns**
|
||||
@@ -231,7 +231,7 @@ Lists deleted entities for a POS terminal after the given cursor ID.
|
||||
| --- | --- | --- |
|
||||
| `input` | `object` | |
|
||||
| `input.posterminalId` | `number` | The POS terminal id. |
|
||||
| `[input.cursor=0]` | `number` | The highest synced tombstone ID. |
|
||||
| `[input.cursor=0]` | `number` | The highest synced obituary ID. |
|
||||
| `[input.limit=200]` | `number` | Max items to return. |
|
||||
| `[tx]` | `object` | Optional transaction. |
|
||||
|
||||
@@ -311,13 +311,13 @@ Lists the posterminals of the user's selected company.
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<Array<{id: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, maxknowntombstoneid: number|null, rootCategoryId: number|null, syncRootArticles: boolean|number, lastseenAt: string|null, updatedAt: string}>>` — The posterminals.
|
||||
`Promise<Array<{id: number, name: string, token: string|null, pairingpin: string|null, pairedAt: string|null, clientserial: string|null, maxknownobituaryid: number|null, rootCategoryId: number|null, syncRootArticles: boolean|number, lastseenAt: string|null, updatedAt: string}>>` — The posterminals.
|
||||
|
||||
**Example**
|
||||
|
||||
```js
|
||||
const terminals = await store.posterminal.list(42);
|
||||
// => [{ id, name, token, pairingpin, pairedAt, clientserial, maxknowntombstoneid, rootCategoryId, syncRootArticles, lastseenAt, updatedAt }]
|
||||
// => [{ id, name, token, pairingpin, pairedAt, clientserial, maxknownobituaryid, rootCategoryId, syncRootArticles, lastseenAt, updatedAt }]
|
||||
```
|
||||
|
||||
## `posterminal.pair`
|
||||
@@ -341,11 +341,11 @@ Completes POS device pairing for a terminal.
|
||||
|
||||
`Promise<{id: number, token: string, clientserial: string|null, pairedAt: string|null}>`
|
||||
|
||||
## `posterminal.recordTombstone`
|
||||
## `posterminal.recordObituary`
|
||||
|
||||
*Source: `src/store/posterminal/recordTombstone.js`*
|
||||
*Source: `src/store/posterminal/recordObituary.js`*
|
||||
|
||||
Records a tombstone for all active paired POS terminals of a company.
|
||||
Records an obituary for all active paired POS terminals of a company.
|
||||
|
||||
**Parameters**
|
||||
|
||||
@@ -361,23 +361,23 @@ Records a tombstone for all active paired POS terminals of a company.
|
||||
|
||||
`Promise<void>`
|
||||
|
||||
## `posterminal.setMaxKnownTombstoneId`
|
||||
## `posterminal.setMaxKnownObituaryId`
|
||||
|
||||
*Source: `src/store/posterminal/setMaxKnownTombstoneId.js`*
|
||||
*Source: `src/store/posterminal/setMaxKnownObituaryId.js`*
|
||||
|
||||
Updates the max known tombstone ID for a POS terminal.
|
||||
Updates the max known obituary ID for a POS terminal.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `id` | `number` | The posterminal id. |
|
||||
| `maxknowntombstoneid` | `number|null` | The highest synced tombstone ID. |
|
||||
| `maxknownobituaryid` | `number|null` | The highest synced obituary ID. |
|
||||
| `[tx]` | `object` | Optional transaction to run within. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, maxknowntombstoneid: number|null}>`
|
||||
`Promise<{id: number, maxknownobituaryid: number|null}>`
|
||||
|
||||
## `posterminal.setOff`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user