@tillhub/schemas 6.162.0 → 6.164.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [6.164.0](https://github.com/tillhub/schemas/compare/v6.163.0...v6.164.0) (2022-10-20)
+
+
+### Features
+
+* **configurations:** base ([06aaf8a](https://github.com/tillhub/schemas/commit/06aaf8a))
+* **configurations:** tips ([0947fcb](https://github.com/tillhub/schemas/commit/0947fcb))
+
+# [6.163.0](https://github.com/tillhub/schemas/compare/v6.162.0...v6.163.0) (2022-09-29)
+
+
+### Features
+
+* **client_account:** better documentation ([ab4ae8f](https://github.com/tillhub/schemas/commit/ab4ae8f))
+
 # [6.162.0](https://github.com/tillhub/schemas/compare/v6.161.0...v6.162.0) (2022-09-29)
 
 

package/lib/v0/client_accounts/base.js

@@ -25,13 +25,14 @@ module.exports = {
     type: 'boolean'
   },
   preferred_initialization: {
-    description: 'remote means Staging, local means Production enviroment',
+    description: 'When local data ís missing - counting numbers can be initialized from the corresponding API table or - if available - from a secondary local storage (e.g. keychain on iOS)',
     type: 'string',
-    'enum': [
-      'remote',
-      'local'
+    enum: [
+      // ONLY on a fresh POS installation
+      'remote', // API data will be considered as primary source of truth and keychain data is ignored even when available
+      'local' // local data will be considered as primary source of truth, API will be considered in absence of local data
     ],
-    'default': 'remote'
+    default: 'remote'
   },
   template: {
     type: 'string',

package/lib/v1/configurations/base.js

@@ -267,16 +267,7 @@ module.exports = {
       }
     ]
   },
-  tips: {
-    anyOf: [
-      {
-        type: 'null'
-      },
-      {
-        type: 'object'
-      }
-    ]
-  },
+  tips: require('./items/tips'),
   emails: {
     anyOf: [
       {

package/lib/v1/configurations/items/financials.js

@@ -53,6 +53,7 @@ module.exports = {
       }
     }),
     tips_expense_note_required: oneOf({
+      description: 'Defines if a note required when an expense is made for tips',
       type: 'boolean',
       default: false
     }),

package/lib/v1/configurations/items/settings.js

@@ -702,8 +702,8 @@ module.exports = {
               type: 'string',
               enum: [
                 // ONLY on a fresh POS installation
-                'remote', // API data will be considered as primaray source of truth and keychain data is ignored even when available
-                'local' // local data will be considered as primaray source of truth, API will be considered in absence of local data
+                'remote', // API data will be considered as primary source of truth and keychain data is ignored even when available
+                'local' // local data will be considered as primary source of truth, API will be considered in absence of local data
               ],
               default: 'remote'
             })

package/lib/v1/configurations/items/tips.js

@@ -62,28 +62,30 @@ const tipsCartItemTemplate = {
   }
 }
 
-module.exports = {
+module.exports = oneOf({
   type: 'object',
+  required: [
+    'owner_item',
+    'employee_item'
+  ],
   properties: {
-    enabled: {
+    enabled: oneOf({
       description: 'global on-off-switch for the tips-feature',
       type: 'boolean',
       default: false
-    },
-    max_factor: {
-      ...oneOf({
-        description: 'The maximum multiplier to determine tips suggestions from a given cart price.',
-        type: 'number',
-        minimum: 1.0,
-        maximum: 2.0
-      }),
+    }),
+    max_factor: oneOf({
+      description: 'The maximum multiplier to determine tips suggestions from a given cart price.',
+      type: 'number',
+      minimum: 1.0,
+      maximum: 2.0,
       default: null // -> 1.3 in POS
-    },
-    auto_propose: {
+    }),
+    auto_propose: oneOf({
       description: 'if true, automatically selects the highest tip possible according to the given amount or the max_factor, no tips otherwise',
       type: 'boolean',
       default: false
-    },
+    }),
     owner_item: {
       description: 'Tip item template if the shop owner IS the recipient of the tip (e.g. non-zero tax account).',
       ...tipsCartItemTemplate
@@ -92,28 +94,25 @@ module.exports = {
       description: 'Tip item template if the shop owner is NOT the recipient of the tip (e.g. zero tax account).',
       ...tipsCartItemTemplate
     },
-    payment_types: {
-      ...oneOf({
-        description: 'Defines which payment types can be used with the tips-feature',
-        type: 'array',
-        items: {
-          type: 'string',
-          'enum': [
-            'cash',
-            'card',
-            'invoice',
-            'card_opi', // deprecated, use 'card' instead
-            'card_concardis', // deprecated, use 'card' instead
-            'card_tim', // deprecated, use 'card' instead
-            'card_adyen', // deprecated, use 'card' instead
-            'gift_card',
-            'default',
-            'undefined',
-            'voucher'
-          ]
-        }
-      }),
-      default: null // -> tips feature disabled in POS
-    }
+    payment_types: oneOf({
+      description: 'Defines which payment types can be used with the tips-feature',
+      type: 'array',
+      items: {
+        type: 'string',
+        'enum': [
+          'cash',
+          'card',
+          'invoice',
+          'card_opi', // deprecated, use 'card' instead
+          'card_concardis', // deprecated, use 'card' instead
+          'card_tim', // deprecated, use 'card' instead
+          'card_adyen', // deprecated, use 'card' instead
+          'gift_card',
+          'default',
+          'undefined',
+          'voucher'
+        ]
+      }
+    })
   }
-}
+})

package/package.json

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