@tillhub/schemas 6.213.0 → 6.215.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [6.215.0](https://github.com/tillhub/schemas/compare/v6.214.0...v6.215.0) (2023-05-17)
+
+
+### Features
+
+* **countings:** protocols ([4e235f0](https://github.com/tillhub/schemas/commit/4e235f0))
+* **wallets:** references ([79f22d5](https://github.com/tillhub/schemas/commit/79f22d5))
+
+# [6.214.0](https://github.com/tillhub/schemas/compare/v6.213.0...v6.214.0) (2023-05-02)
+
+
+### Features
+
+* **permissions:** wallets ([392ee87](https://github.com/tillhub/schemas/commit/392ee87))
+
 # [6.213.0](https://github.com/tillhub/schemas/compare/v6.212.0...v6.213.0) (2023-04-27)
 
 

package/lib/common/permissions.js

@@ -133,7 +133,15 @@ module.exports.staff = {
       'staff:staff:orders:others:locked:modify', // allows modifying other staffs' orders (gastro)
       'staff:staff:orders:preview:print', // allows printing previews for unpaid orders (gastro)
       'staff:staff:cart:clear', // Can clear the current cart
-      'staff:staff:cart:clear:row' // Can remove items from the cart
+      'staff:staff:cart:clear:row', // Can remove items from the cart
+      'staff:staff:wallets', // General access and all rights below
+      'staff:staff:wallets:create', // Can create wallets
+      'staff:staff:wallets:update', // Can update wallets
+      'staff:staff:wallets:read', // Can read wallets
+      'staff:staff:wallets:assign', // Assign Waiter Wallets to Waiters
+      'staff:staff:wallets:transfer', // Transfer cash between the main till and any Waiter Wallet to create the Starting Balance for a Wallet.
+      'staff:staff:wallets:discrepancy', // Accept discrepancies for not matching closing balances for individual Waiter Wallets
+      'staff:staff:wallets:activation' // Activate and deactivate Waiter Wallets
     ]
   }
 }

package/lib/v0/cashier_counting_protocols/base.js

@@ -45,6 +45,11 @@ module.exports = {
     }),
     default: null
   },
+  wallet: oneOf({
+    type: 'string',
+    format: 'uuid',
+    description: 'Id of the Tillhub wallet resource - applicable to counting type: wallet'
+  }),
   client_id: oneOf({
     type: 'string',
     description: 'A client definable ID for the purpose of syncing to a client or used in analytics for e.g. transactions that created a product offline and done transactions offline before they received a backend ID.',
@@ -195,7 +200,9 @@ module.exports = {
     type: 'string',
     enum: [
       'opening',
-      'cashing_up'
+      'cashing_up',
+      'wallet_open',
+      'wallet_close'
     ]
   },
   counting_date: {

package/lib/v1/balances/legacy/base.js

@@ -7,6 +7,7 @@ const balanceExpensesObject = require('./embedded/expenses/base')
 const balancePaymentsObject = require('./embedded/payments/base')
 const balanceCashUnitsObject = require('./embedded/cash_units/base')
 const balanceTipsObject = require('./embedded/tips/base')
+const balanceWalletDataObject = require('./embedded/wallet_data/base')
 const balanceExtendedObject = require('./embedded/extended')
 const balanceMetadataObject = require('./embedded/metadata')
 
@@ -284,5 +285,8 @@ module.exports = {
   }),
   _metadata: oneOf({
     ...balanceMetadataObject
+  }),
+  wallet_data: oneOf({
+    ...balanceWalletDataObject
   })
 }

package/lib/v1/balances/legacy/embedded/wallet_data/base.js

@@ -0,0 +1,22 @@
+const { oneOf } = require('../../../../../helpers/payload-or-null')
+const currencyAmount = require('../../../../../common/currency_amount')
+const balanceWalletObject = require('./wallet')
+
+module.exports = {
+  description: 'Balance stats for waiter wallets',
+  additionalProperties: false,
+  type: 'object',
+  properties: {
+    outstanding_total: oneOf({
+      description: 'The outstanding cash from all wallets at the time of the balance',
+      ...currencyAmount
+    }),
+    wallets: oneOf({
+      type: 'array',
+      description: 'Wallet balance objects',
+      items: {
+        ...balanceWalletObject
+      }
+    })
+  }
+}

package/lib/v1/balances/legacy/embedded/wallet_data/wallet.js

@@ -0,0 +1,25 @@
+const { oneOf } = require('../../../../../helpers/payload-or-null')
+const currencyAmount = require('../../../../../common/currency_amount')
+
+module.exports = {
+  description: 'Cash balance for a specific wallet',
+  additionalProperties: false,
+  type: 'object',
+  required: [
+    'id'
+  ],
+  properties: {
+    id: {
+      type: 'string',
+      example: '860defb8-5598-421d-9da4-f0826e767536',
+      format: 'uuid',
+      description: 'The Tillhub wallet resource ID'
+    },
+    outstanding: {
+      ...oneOf({
+        description: 'The outstanding cash for this wallet at the time of the balance',
+        ...currencyAmount
+      })
+    }
+  }
+}

package/lib/v1/transactions/legacy/base.js

@@ -376,6 +376,11 @@ module.exports = {
     format: 'uuid',
     description: 'Id of the Tillhub register resource'
   }),
+  wallet: oneOf({
+    type: 'string',
+    format: 'uuid',
+    description: 'Id of the Tillhub wallet resource'
+  }),
   _type: oneOf({
     type: 'string',
     description: stripIndents`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tillhub/schemas",
-  "version": "6.213.0",
+  "version": "6.215.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",