@tillhub/schemas 6.214.0 → 6.216.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+# [6.216.0](https://github.com/tillhub/schemas/compare/v6.215.0...v6.216.0) (2023-05-23)
+
+
+### Features
+
+* **configurations:** products ([7454cc0](https://github.com/tillhub/schemas/commit/7454cc0))
+* **configurations:** products ([cf8184c](https://github.com/tillhub/schemas/commit/cf8184c))
+* **configurations:** products ([b5b62d1](https://github.com/tillhub/schemas/commit/b5b62d1))
+* **configurations:** products ([83dc63f](https://github.com/tillhub/schemas/commit/83dc63f))
+
+# [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)
 
 

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/configurations/items/products.js

@@ -45,6 +45,47 @@ module.exports = {
             })
           }
         },
+        pricelist: oneOf({
+          type: 'object',
+          additionalProperties: false,
+          properties: {
+            type_precedence: oneOf({
+              type: 'object',
+              additionalProperties: false,
+              properties: {
+                enabled: {
+                  description: 'If true - price type precedence should be respected.',
+                  type: 'boolean',
+                  default: true
+                },
+                priorities: oneOf({
+                  description: 'Price types sorted by priority.',
+                  type: 'array',
+                  uniqueItems: true,
+                  default: ['scaled', 'time-based', 'branch'],
+                  items: {
+                    type: 'string',
+                    enum: [
+                      'time-based',
+                      'branch',
+                      'scaled'
+                    ]
+                  }
+                })
+              }
+            }),
+            conflict_resolution: oneOf({
+              type: 'string',
+              description: 'Defines which price is chosen by default when conflicts remain with or without type precedence.',
+              default: 'lowest_price',
+              enum: [
+                'user', // present the options to the cashier
+                'lowest_price',
+                'highest_price'
+              ]
+            })
+          }
+        }),
         product_id_template: {
           description: 'A Tillhub string pattern that allows for parameterized product id generation',
           oneOf: [

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.214.0",
+  "version": "6.216.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",