@tillhub/schemas 6.131.0 → 6.134.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [6.134.0](https://github.com/tillhub/schemas/compare/v6.133.0...v6.134.0) (2022-04-05)
+
+
+### Features
+
+* **products:** configuration ([3050bd5](https://github.com/tillhub/schemas/commit/3050bd5))
+
+# [6.133.0](https://github.com/tillhub/schemas/compare/v6.132.0...v6.133.0) (2022-04-01)
+
+
+### Features
+
+* **carts:** add more information about data integrity validation #API-1461 ([19e065b](https://github.com/tillhub/schemas/commit/19e065b)), closes [#API-1461](https://github.com/tillhub/schemas/issues/API-1461)
+
+# [6.132.0](https://github.com/tillhub/schemas/compare/v6.131.0...v6.132.0) (2022-03-30)
+
+
+### Features
+
+* **configurations:** payments ([a96eb88](https://github.com/tillhub/schemas/commit/a96eb88))
+
 # [6.131.0](https://github.com/tillhub/schemas/compare/v6.130.0...v6.131.0) (2022-03-29)
 
 

package/lib/v1/carts/items/create.js

@@ -13,7 +13,7 @@ const masterData = {
     })
   },
   tax: {
-    description: 'Tax rate ID',
+    description: 'Tax rate ID. If not present, the "vat_rate" must be present. The active tax with such ID must be defined in the system',
     type: 'string',
     format: 'uuid'
   },
@@ -23,7 +23,7 @@ const masterData = {
     format: 'uuid'
   },
   account_number: {
-    description: 'Account number',
+    description: 'Account number. The only one active account with the same number must be defined in the system (does not apply when "account" value is present)',
     ...oneOf({
       type: 'string'
     })
@@ -498,7 +498,7 @@ const externalCart = {
       ...amount
     },
     vat_rate: {
-      description: 'VAT rate',
+      description: 'VAT rate in the range 0-1. Required when "tax" value is not present. The only one active VAT with the same rate must be defined in the system (does not apply when "tax" value is present)',
       example: 0.12,
       type: 'number',
       minimum: 0,
@@ -618,7 +618,7 @@ const internalCart = {
       })
     },
     vat_rate: {
-      description: 'VAT rate',
+      description: 'VAT rate in the range 0-1. Required when "tax" value is not present. The only one active VAT with the same rate must be defined in the system (does not apply when "tax" value is present)',
       example: 0.12,
       type: 'number',
       minimum: 0,

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

@@ -21,6 +21,11 @@ module.exports = {
       description: 'If true, allows multiple payments on negative cart totals, e.g. undefined + cash (e.g. health insurance case).',
       default: false,
       type: 'boolean'
+    }),
+    allow_change_on_cards: oneOf({
+      description: 'If true, allows entering values for split payments that are higher than the remaining price - thus potentially handing back cash (legacy behavior).',
+      default: false,
+      type: 'boolean'
     })
   }
 }

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

@@ -188,7 +188,14 @@ module.exports = {
           ]
         },
         allow_zero_prices: {
-          description: 'If true, a product can be added to the cart with 0.0 as price or its price can be changed to 0.0.',
+          deprecated: true,
+          description: stripIndents`
+            If true, a product can be added to the cart with 0.0 as price or its price can be changed to 0.0.
+
+            NOTE: Hard validation will be removed entirely!
+                  Behavior will be driven by 'v1/products.configuration.pricing.request_input'
+                  and 'v1/products.configuration.pricing.zero_input_allowed'.
+          `,
           oneOf: [
             {
               type: 'null'

package/lib/v1/products/properties/configuration.js

@@ -1,3 +1,4 @@
+const { stripIndents } = require('common-tags')
 module.exports = {
   description: 'Defines various product behaviours.',
   default: {
@@ -12,6 +13,7 @@ module.exports = {
       additionalProperties: true,
       properties: {
         allow_zero_prices: {
+          deprecated: true,
           description: 'Allow adding this product to a cart if it has no price.',
           type: 'boolean'
         },
@@ -19,8 +21,27 @@ module.exports = {
           type: 'object',
           properties: {
             allow_is_free: {
+              deprecated: true,
               description: 'If an eligible price is 0 define whether the user is prompted to enter a price or whether the price can stay 0, to essentially be a freebie.',
               type: 'boolean'
+            },
+            request_input: {
+              type: 'boolean',
+              default: false,
+              description: stripIndents`
+                If true, request cashier input - regardless of the current price value, but pre-filled with it.
+
+                NOTE: If false and price is 0 - adds item with 0 price automatically.
+              `
+            },
+            zero_input_allowed: {
+              type: 'boolean',
+              default: false,
+              description: stripIndents`
+                Defines whether a requested price input can be confirmed with a zero value or not.
+
+                NOTE: Does not affect any zero price behavior directly, just the input validation when 'request_input'=true.
+              `
             }
           }
         }

package/package.json

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