@tillhub/schemas 6.212.0 → 6.214.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [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)
+
+
+### Features
+
+* **register:** update register & add mms ([7dd4555](https://github.com/tillhub/schemas/commit/7dd4555))
+
 # [6.212.0](https://github.com/tillhub/schemas/compare/v6.211.0...v6.212.0) (2023-04-25)
 
 

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/v1/registers/base-mms.js

@@ -0,0 +1,116 @@
+const { oneOf } = require('../../helpers/payload-or-null')
+
+module.exports = {
+  register_id: {
+    description: 'The id of the parent register.',
+    type: 'string',
+    format: 'uuid'
+  },
+  mms_id: oneOf({
+    description: 'The id of the register that identifies it in Mms.',
+    type: 'string',
+    format: 'uuid'
+  }),
+  created_by: oneOf({
+    description: 'Who created the register in Mms.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  updated_by: oneOf({
+    description: 'Who updated the register for the last time in Mms.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  deleted_by: oneOf({
+    description: 'Who deleted the register in Mms.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  scope: oneOf({
+    description: 'The scope from Mms.',
+    type: 'string',
+    format: 'uuid'
+  }),
+  attributes: oneOf({
+    description: 'The attributes of the register.',
+    type: 'object'
+  }),
+  state: oneOf({
+    description: 'The state.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  type: oneOf({
+    description: 'The type.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  enable_cross_channel_referencing: {
+    type: 'boolean',
+    default: false
+  },
+  key_pairs: oneOf({
+    type: 'array',
+    items: {
+      type: 'object'
+    }
+  }),
+  payment_products: oneOf({
+    type: 'array',
+    items: {
+      type: 'object'
+    }
+  }),
+  urls: oneOf({
+    type: 'array',
+    items: {
+      type: 'string'
+    }
+  }),
+  website: oneOf({
+    description: 'The website.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  max_amount_per_txn: oneOf({
+    type: 'number'
+  }),
+  max_amount_per_month: oneOf({
+    type: 'number'
+  }),
+  average_amount_per_month: oneOf({
+    type: 'number'
+  }),
+  average_count_per_month: oneOf({
+    type: 'number'
+  }),
+  min_amount_per_month: oneOf({
+    type: 'number'
+  }),
+  min_amount_per_txn: oneOf({
+    type: 'number'
+  }),
+  pci_level: oneOf({
+    description: 'The commercial register number.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  price_information: oneOf({
+    description: 'The price information of the register.',
+    type: 'object'
+  }),
+  mcc: oneOf({
+    description: 'The mcc of the register.',
+    type: 'object'
+  }),
+  average_basket_size: oneOf({
+    type: 'number'
+  })
+}

package/lib/v1/registers/base.js

@@ -79,6 +79,20 @@ module.exports = {
       }
     ]
   },
+  external_custom_id: {
+    description: 'Unique ID of this branch in external system. Uses for synchronization.',
+    example: '7882448928329',
+    anyOf: [
+      {
+        type: 'string',
+        maxLength: 64,
+        minLength: 1
+      },
+      {
+        type: 'null'
+      }
+    ]
+  },
   custom_ids: {
     anyOf: [
       {
@@ -129,6 +143,18 @@ module.exports = {
     type: 'boolean',
     default: false
   },
+  created_at: oneOf({
+    description: 'The date when register was created.',
+    example: '2023-04-05T16:06:04.849Z',
+    type: 'string',
+    format: 'date-time'
+  }),
+  updated_at: oneOf({
+    description: 'The date when register was last updated.',
+    example: '2023-04-05T16:06:04.849Z',
+    type: 'string',
+    format: 'date-time'
+  }),
   deleted_at: oneOf({
     description: 'The date when register was deleted.',
     example: '2023-04-05T16:06:04.849Z',

package/lib/v1/registers/create.mms.js

@@ -0,0 +1,10 @@
+const baseMms = require('./base-mms')
+
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v1/registers.create.mms.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  type: 'object',
+  required: ['register_id'],
+  properties: { ...baseMms }
+}

package/lib/v1/registers/index.js

@@ -1,4 +1,4 @@
 
-module.exports.create = { request: require('./create.request') }
+module.exports.create = { request: require('./create.request'), mms: require('./create.mms') }
 module.exports.update = { request: require('./update.request') }
 module.exports.notification = require('./notification')

package/package.json

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