@tillhub/schemas 6.100.2 → 6.103.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [6.103.0](https://github.com/tillhub/schemas/compare/v6.102.0...v6.103.0) (2021-11-08)
+
+
+### Features
+
+* **product_addons:** Extend add-ons with editable quantity functionality ([#645](https://github.com/tillhub/schemas/issues/645)) ([ba8a564](https://github.com/tillhub/schemas/commit/ba8a564))
+
+# [6.102.0](https://github.com/tillhub/schemas/compare/v6.101.0...v6.102.0) (2021-11-03)
+
+
+### Features
+
+* **pricebook:** add lowest_price, highest_price ([2c55b20](https://github.com/tillhub/schemas/commit/2c55b20))
+
+# [6.101.0](https://github.com/tillhub/schemas/compare/v6.100.3...v6.101.0) (2021-10-29)
+
+
+### Features
+
+* **pricebooks:** add branch groups #API-1115 ([fac9fd0](https://github.com/tillhub/schemas/commit/fac9fd0)), closes [#API-1115](https://github.com/tillhub/schemas/issues/API-1115)
+
+## [6.100.3](https://github.com/tillhub/schemas/compare/v6.100.2...v6.100.3) (2021-10-22)
+
+
+### Bug Fixes
+
+* **products:** q is required property in products search request chema ([#641](https://github.com/tillhub/schemas/issues/641)) ([ceb3019](https://github.com/tillhub/schemas/commit/ceb3019))
+
 ## [6.100.2](https://github.com/tillhub/schemas/compare/v6.100.1...v6.100.2) (2021-10-22)
 
 

package/lib/v0/product_addons/base.js

@@ -38,7 +38,7 @@ module.exports = {
       }
     }
   ),
-  quantity: {
+  stock_quantity: {
     type: 'number',
     description: 'How much of the product stock will be moved  (defaults to 1 - only important if it affects stock). This value can be negative number!',
     default: 1
@@ -53,6 +53,11 @@ module.exports = {
     description: 'Can the cashier edit the quantity of the addon selected (only important if it affects stock)',
     default: false
   },
+  max_quantity: {
+    type: 'number',
+    description: 'Maximum count the product stock will be moved. Related to the allow_quantity_edit - only if it set to true',
+    default: 1
+  },
   order_index: {
     type: 'number',
     description: 'Display the Addon in a specific order',

package/lib/v0/tse_exports/base.js

@@ -2,43 +2,30 @@ const { oneOf } = require('../../helpers/payload-or-null')
 
 module.exports = {
   client_id: {
-    description: 'An identifier used locally on POS for their own reference.',
-    oneOf: [
-      {
-        type: 'string',
-        maxLength: 128
-      },
-      {
-        type: 'null'
-      }
-    ]
+    description: 'An identifier used locally on POS for their own reference. Guaranteed to be there',
+    type: 'string',
+    maxLength: 128
   },
-  balance_client_id: {
+  balance_client_id: oneOf({
     type: 'string',
     maxLength: 128,
-    description: 'A reference to the balance this exports belongs to.'
-  },
-  balance_number: {
-    ...oneOf({
-      type: 'integer',
-      example: 5,
-      description: 'The associated balance\'s counting number (receipt number) of this export'
-    })
-  },
-  branch_custom_id: {
-    ...oneOf({
-      type: 'integer',
-      example: 7,
-      description: 'The branch number'
-    })
-  },
-  register_custom_id: {
-    ...oneOf({
-      type: 'integer',
-      example: 11,
-      description: 'The register number'
-    })
-  },
+    description: 'A reference to the balance this exports belongs to. Can be omitted for archives.'
+  }),
+  balance_number: oneOf({
+    type: 'integer',
+    example: 5,
+    description: 'The associated balance\'s counting number (receipt number) of this export. Can be omitted for archives.'
+  }),
+  branch_custom_id: oneOf({
+    type: 'integer',
+    example: 7,
+    description: 'The branch number'
+  }),
+  register_custom_id: oneOf({
+    type: 'integer',
+    example: 11,
+    description: 'The register number'
+  }),
   register: {
     type: 'string',
     format: 'uuid',
@@ -65,47 +52,30 @@ module.exports = {
   export: {
     type: 'object',
     properties: {
-      transaction_number_first: {
-        type: 'integer',
-        example: 15,
-        description: 'The first TSE transaction number in this export'
-      },
-      transaction_number_last: {
-        type: 'integer',
-        example: 19,
-        description: 'The last TSE transaction number in this export'
-      },
-      date_start: {
-        description: 'Daterange start of the export.',
+      date_start: oneOf({
+        description: 'Daterange start of the export, omitted for archives.',
         type: 'string',
         format: 'date-time',
         example: '2020-10-17T08:12:04.849Z'
-      },
+      }),
       date_end: {
         description: 'Daterange end of the export.',
         type: 'string',
         format: 'date-time',
         example: '2020-10-17T21:12:04.849Z'
       },
-      url: {
+      url: oneOf({
         description: 'URL of the uploaded export tar file.',
         type: 'string',
         format: 'uri'
-      },
+      }),
       type: {
         type: 'string',
         'enum': [
           'archive',
-          'number',
-          'number_interval',
           'time_period'
         ],
         default: 'time_period'
-      },
-      client_id: {
-        description: 'An identifier used locally on the POS for their own reference.',
-        type: 'string',
-        maxLength: 128
       }
     }
   }

package/lib/v0/tse_exports/create.js

@@ -9,7 +9,7 @@ module.exports = {
     additionalProperties: false,
     required: [
       'tse_serial_number',
-      'balance_client_id'
+      'export'
     ],
     properties: base,
     type: 'object'

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

@@ -29,9 +29,9 @@ module.exports = {
               type: 'string',
               description: 'Defines which price is chosen by default when conflict',
               enum: [
-                'default',
-                'pricebook',
-                'user'
+                'user',
+                'lowest_price',
+                'highest_price'
               ]
             }),
             inheritance: oneOf({

package/lib/v1/products/prices/book/base.js

@@ -23,6 +23,14 @@ module.exports = {
       format: 'uuid'
     }
   }),
+  branch_groups: oneOf({
+    description: 'If defined then only these branch groups (plus specified locations if any) will be using this price book',
+    type: 'array',
+    items: {
+      type: 'string',
+      format: 'uuid'
+    }
+  }),
   active: {
     type: 'boolean'
   },

package/lib/v1/products/search.js

@@ -4,6 +4,9 @@ module.exports = {
   type: 'object',
   // additional properties are a little bit of a danger zone of not being validated by the upstream service
   additionalProperties: true,
+  required: [
+    'q'
+  ],
   properties: {
     q: {
       type: 'string',

package/lib/v1/transactions/components/embedded/addon/base.js

@@ -33,6 +33,14 @@ module.exports = {
       maxLength: 3
     },
     quantity: {
+      type: 'number',
+      description: 'Number of times the addon is applied to the cart item. Respects the max_quantity setting on the Addon',
+      example: 3.6,
+      minimum: -32767.000,
+      maximum: 32767.000,
+      multipleOf: 0.001
+    },
+    stock_quantity: {
       type: 'number',
       description: 'The quantity of this addon, e.g. 1 pc or 0.125kg - this does never affect the price (only used for stock).',
       example: 3.6,

package/package.json

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