@tillhub/schemas 6.101.0 → 6.105.0

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+# [6.105.0](https://github.com/tillhub/schemas/compare/v6.104.0...v6.105.0) (2021-12-13)
+
+
+### Bug Fixes
+
+* **abocard-systems:** fixes due to linter ([49ddbc3](https://github.com/tillhub/schemas/commit/49ddbc3))
+
+
+### Features
+
+* **abocard:** Add "discount_type" and "selling_price_method" ([#649](https://github.com/tillhub/schemas/issues/649)) ([b2024de](https://github.com/tillhub/schemas/commit/b2024de))
+* **prices:** add actual prices schema #API-1257 ([2260e72](https://github.com/tillhub/schemas/commit/2260e72)), closes [#API-1257](https://github.com/tillhub/schemas/issues/API-1257)
+
+# [6.104.0](https://github.com/tillhub/schemas/compare/v6.103.0...v6.104.0) (2021-12-07)
+
+
+### Features
+
+* **safes:** add pos_to_safe_cancel ([2f0dfda](https://github.com/tillhub/schemas/commit/2f0dfda))
+
+# [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)
 
 

package/lib/v0/loyalty_abocard_systems/base.js

@@ -231,7 +231,28 @@ const request = {
     description: 'Defines whether assigning a customer is required for creation actions within this system.',
     type: 'boolean',
     default: 'false'
-  })
+  }),
+  discount_type: oneOf(
+    {
+      description: `
+      the calculation type of the discount of the Purpose Product (Zweck/Artikel).
+      * \`relative\` - stores discount absolute in currency of system
+      * \`absolute\` - stores relative discount value in percent (e.g.: 12,58%) to allow two decimals on percent if necessary (which wouldn’t be possible with a rate)
+    `,
+      type: 'string',
+      enum: ['relative', 'absolute']
+    },
+    { default: null }
+  ),
+  selling_price_method: {
+    description: `
+      "static", "dynamic" configuration of selling price.
+      * \`static\` - For "static" we use the current behavior of our implementation.
+      * \`dynamic\` - For "dynamic" we calculate the selling price according to this document
+    `,
+    enum: ['static', 'dynamic'],
+    default: 'static'
+  }
 }
 
 const response = {

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/safes/book.js

@@ -36,7 +36,8 @@ module.exports.request = {
       transfer_type: {
         type: 'string',
         enum: [
-          'pos_to_safe'
+          'pos_to_safe',
+          'pos_to_safe_cancel'
         ]
       }
     }

package/lib/v0/safes_log_book/base.js

@@ -37,6 +37,7 @@ module.exports = {
       'safe_to_safe',
       'safe_to_bank',
       'pos_to_safe',
+      'pos_to_safe_cancel',
       'safe_to_expense'
     ]
   },

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/index.js

@@ -159,6 +159,10 @@ module.exports.prices = {
         }
       }
     }
+  },
+  actual: {
+    query: require('./prices/actual/query'),
+    response: require('./prices/actual/response')
   }
 }
 

package/lib/v1/products/prices/actual/query.js

@@ -0,0 +1,34 @@
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v1/products.prices.actual.query.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  type: 'object',
+  required: [
+    'location'
+  ],
+  properties: {
+    product_id: {
+      description: 'Product ID (required if no "product_custom_id" provided)',
+      type: 'string',
+      format: 'uuid',
+      example: 'fd4bac62-937b-445f-b7bf-fb9e653de50f'
+    },
+    product_custom_id: {
+      description: 'Product custom ID',
+      type: 'string',
+      example: '936835 1234'
+    },
+    location: {
+      description: 'Product location',
+      type: 'string',
+      format: 'uuid',
+      example: '69ac1b92-7956-43d8-8620-e556299b5023'
+    },
+    quantity: {
+      description: 'Product quantity (to search among product scaled price embedded in product only)',
+      type: 'integer',
+      minimum: 0,
+      example: 3
+    }
+  }
+}

package/lib/v1/products/prices/actual/response.js

@@ -0,0 +1,16 @@
+const priceBookEntryBase = require('../book/entry').base
+
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v1/products.prices.actual.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  type: 'object',
+  required: [
+  ],
+  properties: {
+    amount_net: priceBookEntryBase.amount_net,
+    amount_gross: priceBookEntryBase.amount_gross,
+    rate: priceBookEntryBase.rate,
+    currency: priceBookEntryBase.currency
+  }
+}

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