@tillhub/schemas 6.147.0 → 6.148.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+# [6.148.0](https://github.com/tillhub/schemas/compare/v6.147.0...v6.148.0) (2022-07-13)
+
+
+### Bug Fixes
+
+* **configurations:** financials ([8585621](https://github.com/tillhub/schemas/commit/8585621))
+
+
+### Features
+
+* **balances:** reduce signature types ([099404a](https://github.com/tillhub/schemas/commit/099404a))
+* **balances:** status ([44c727e](https://github.com/tillhub/schemas/commit/44c727e))
+* **configurations:** discounts ([118f48e](https://github.com/tillhub/schemas/commit/118f48e))
+* **financials:** adds price_change_reason_enabled property to financials ([2d0f387](https://github.com/tillhub/schemas/commit/2d0f387))
+* **financials:** adds price_change_reason_required property to financials ([39dcf9f](https://github.com/tillhub/schemas/commit/39dcf9f))
+* **priceChangeReason:** add price_change_reason object ([e7b3b8a](https://github.com/tillhub/schemas/commit/e7b3b8a))
+* **transactions_v1_legacy:** add account and balance links ([57c212a](https://github.com/tillhub/schemas/commit/57c212a))
+
 # [6.147.0](https://github.com/tillhub/schemas/compare/v6.146.0...v6.147.0) (2022-07-08)
 
 

package/lib/v1/balances/index.js

@@ -26,4 +26,13 @@ module.exports.get = {
   }
 }
 
-module.exports.legacy = require('./legacy')
+module.exports.legacy = {
+  create: {
+    request: require('./legacy/create.request'),
+    response: {
+      $id: 'https://schemas.tillhub.com/v1/balances.legacy.post.response.schema.json',
+      $schema: 'http://json-schema.org/draft-07/schema#',
+      ...commonResponse({ resultItems: require('./legacy/response') })
+    }
+  }
+}

package/lib/v1/balances/legacy/create.request.js

@@ -1,4 +1,6 @@
 const base = require('./base')
+const statusCreate = require('../../statuses/create.request')
+const { oneOf } = require('../../../helpers/payload-or-null')
 
 module.exports = {
   $id: 'https://schemas.tillhub.com/v1/balances.legacy.create.request.schema.json',
@@ -9,6 +11,9 @@ module.exports = {
     'date'
   ],
   properties: {
-    ...base
+    ...base,
+    status: oneOf({
+      ...statusCreate
+    })
   }
 }

package/lib/v1/balances/legacy/response.js

@@ -1,5 +1,6 @@
 const { oneOf } = require('../../../helpers/payload-or-null')
 const base = require('./base')
+const statusResponse = require('../../statuses/response')
 
 module.exports = {
   type: 'object',
@@ -35,6 +36,9 @@ module.exports = {
         description: 'Temporary hack for id-functionality (which is Int)'
       })
     },
+    status: {
+      ...statusResponse
+    },
     ...base
   }
 }

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

@@ -26,7 +26,7 @@ module.exports = {
   type: 'object',
   additionalProperties: false,
   properties: {
-    value_distribution: {
+    value_distribution: oneOf({
       description: 'Defines the distribution for absolute value discounts applied to more than one cart item.',
       type: 'string',
       enum: [
@@ -34,90 +34,79 @@ module.exports = {
         'proportional' // item will get an amount proportional to it's current total with respect to the cart total (~ target * item / total)
       ],
       default: 'proportional'
-    },
-    display: {
+    }),
+    display: oneOf({
       type: 'object',
       additionalProperties: false,
       properties: {
-        show_inactive: {
-          default: false,
+        show_inactive: oneOf({
+          type: 'boolean',
           description: 'If true, non-active discounts will be still displayed (greyed out)',
-          oneOf: [
-            {
-              type: 'null'
-            },
-            {
-              type: 'boolean'
-            }
-          ]
-        }
+          default: false
+        })
       }
-    },
-    limits: {
+    }),
+    limits: oneOf({
       type: 'object',
       description: 'Global limits for effective discount values',
       additionalProperties: false,
       properties: {
-        cart_item: {
+        cart_item: oneOf({
           type: 'object',
           description: 'Global limits for effective discount values on single cart items (affects current cart via multi-assignment)',
           additionalProperties: false,
           properties: {
-            variable: {
+            variable: oneOf({
               type: 'object',
               description: '0-discounts (Frank) that let the cashier enter a value, limits e.g. to 30% AND $2.00',
               additionalProperties: false,
               properties: {
                 ...discountOptions,
-                can_exceed_cart_item_total: {
+                can_exceed_cart_item_total: oneOf({
                   description: 'If true, negative outcomes are alowed (via stacking value discounts) or having rates > 1.0',
                   type: 'boolean',
                   default: false
-                }
+                })
               }
-            },
-            fixed: {
+            }),
+            fixed: oneOf({
               type: 'object',
               description: 'Standard-discounts (have 5% or $3.00 already) - limit creation values in the Dashboard',
               additionalProperties: false,
               properties: {
                 ...discountOptions,
-                can_exceed_cart_item_total: {
+                can_exceed_cart_item_total: oneOf({
                   description: 'If true, negative outcomes are alowed (via stacking value discounts) or having rates > 1.0',
                   type: 'boolean',
                   default: false
-                }
+                })
               }
-            }
+            }),
+            price_and_quantity_edit_condition: oneOf({
+              description: 'In case of discounted items - specifies if quantity and price can still be edited',
+              type: 'string',
+              enum: [
+                'none',
+                'no_value_discounts',
+                'no_discounts'
+              ],
+              default: 'no_value_discounts'
+            })
           }
-        },
-        cart: {
+        }),
+        cart: oneOf({
           type: 'object',
           description: 'Global limits for effective discount values on the whole cart (must additionally respect values for items)',
           additionalProperties: false,
           properties: {
             ...discountOptions
           }
-        },
-        stacked_on_product: {
+        }),
+        stacked_on_product: oneOf({
           type: 'boolean',
           default: true
-        }
+        })
       }
-    },
-    fixed: {
-      description: 'DEPRECATED: DO NOT USE',
-      oneOf: [
-        {
-          type: 'null'
-        },
-        {
-          type: 'object'
-        },
-        {
-          type: 'array'
-        }
-      ]
-    }
+    })
   }
 }

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

@@ -4,46 +4,63 @@ const currencyAmounts = require('../../../common/currency_amounts')
 module.exports = {
   type: 'object',
   properties: {
-    expense_note_required: {
+    expense_note_required: oneOf({
       type: 'boolean',
       default: false
-    },
-    deposit_note_required: {
+    }),
+    deposit_note_required: oneOf({
       type: 'boolean',
       default: false
-    },
-    bank_note_required: {
+    }),
+    bank_note_required: oneOf({
       type: 'boolean',
       default: false
-    },
-    safe_note_required: {
+    }),
+    safe_note_required: oneOf({
       type: 'boolean',
       default: false
-    },
-    expense_reason_required: {
+    }),
+    expense_reason_required: oneOf({
       type: 'boolean',
       description: 'Defines whether selecting a predefined reason is required when booking an expense',
       default: false
-    },
-    deposit_reason_required: {
+    }),
+    deposit_reason_required: oneOf({
       type: 'boolean',
       description: 'Defines whether selecting a predefined reason is required when booking a deposit',
       default: false
-    },
-    price_change_note_required: {
+    }),
+    price_change_note_required: oneOf({
       description: 'Defines if a note is mandatory on price changes on the register ',
       type: 'boolean',
       default: false
-    },
-    tips_expense_note_required: {
+    }),
+    price_change_reason: oneOf({
+      type: 'object',
+      description: 'Defines configurations for price change reason ',
+      additionalProperties: false,
+      properties: {
+        enabled: oneOf({
+          type: 'boolean',
+          description: 'Defines whether asking for a reason for a price change is enabled on the register',
+          default: false
+        }),
+        required: oneOf({
+          type: 'boolean',
+          description: 'Defines if a reason is mandatory on price changes on the register',
+          default: false
+        })
+      }
+    }),
+    tips_expense_note_required: oneOf({
       type: 'boolean',
       default: false
-    },
-    sale_cancellation_note_required: {
+    }),
+    sale_cancellation_note_required: oneOf({
       description: 'Defines if a note is mandatory for sale cancellation',
       type: 'boolean',
       default: false
-    },
+    }),
     safe_deposit_limit: {
       description: 'How much cash per currency can be taken from a safe, regardless of it\'s state',
       ...oneOf({
@@ -77,59 +94,57 @@ module.exports = {
       ],
       default: 'items'
     }),
-    roundings: {
-      ...oneOf({
-        description: 'Defines the fractional rounding behavior of currencies (e.g. to 0.05 CHF)',
-        type: 'array',
-        items: {
-          type: 'object',
-          additionalProperties: false,
-          properties: {
-            currency: {
-              type: 'string',
-              description: 'The three letter [ISO currency](https://en.wikipedia.org/wiki/ISO_4217) of this item.',
-              example: '',
-              minLength: 3,
-              maxLength: 3
-            },
-            enabled: {
-              description: 'States if rounding information should be used for this currency',
-              type: 'boolean',
-              default: true
-            },
-            fraction: {
-              ...oneOf({
-                description: 'The smallest fraction to round to when source equals \'fixed\'.',
-                type: 'number',
-                minimum: 0.01,
-                maximum: 10000,
-                multipleOf: 0.01
-              }),
-              default: null
-            },
-            mode: {
-              description: 'The desired rounding mode',
-              type: 'string',
-              'enum': [
-                'up',
-                'down',
-                'bankers'
-              ],
-              default: 'bankers'
-            },
-            source: {
-              description: 'The source for defining the fraction',
-              type: 'string',
-              'enum': [
-                'cash_units', // lowest cash unit will be used instead of fraction
-                'fraction' // fraction must be present and will be used
-              ],
-              default: 'cash_units'
-            }
+    roundings: oneOf({
+      description: 'Defines the fractional rounding behavior of currencies (e.g. to 0.05 CHF)',
+      type: 'array',
+      items: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          currency: {
+            type: 'string',
+            description: 'The three letter [ISO currency](https://en.wikipedia.org/wiki/ISO_4217) of this item.',
+            example: '',
+            minLength: 3,
+            maxLength: 3
+          },
+          enabled: {
+            description: 'States if rounding information should be used for this currency',
+            type: 'boolean',
+            default: true
+          },
+          fraction: {
+            ...oneOf({
+              description: 'The smallest fraction to round to when source equals \'fixed\'.',
+              type: 'number',
+              minimum: 0.01,
+              maximum: 10000,
+              multipleOf: 0.01
+            }),
+            default: null
+          },
+          mode: {
+            description: 'The desired rounding mode',
+            type: 'string',
+            'enum': [
+              'up',
+              'down',
+              'bankers'
+            ],
+            default: 'bankers'
+          },
+          source: {
+            description: 'The source for defining the fraction',
+            type: 'string',
+            'enum': [
+              'cash_units', // lowest cash unit will be used instead of fraction
+              'fraction' // fraction must be present and will be used
+            ],
+            default: 'cash_units'
           }
         }
-      })
-    },
+      }
+    }),
     fa_transit_account: oneOf({
       description: 'Used to be "settings_old.fa_transit_account"',
       type: 'string'

package/lib/v1/transactions/legacy/base.js

@@ -248,6 +248,12 @@ module.exports = {
     ...oneOf({
       type: 'object',
       properties: {
+        expense_account: {
+          type: 'string',
+          format: 'uuid',
+          example: '09a9a469-c16b-4b54-835d-692d05d218f9',
+          description: 'The Tillhub expense account resource'
+        },
         expense_account_name: {
           type: 'string',
           example: '2 Testausgabe',
@@ -270,6 +276,12 @@ module.exports = {
           example: '1338',
           description: 'Custom id of the used expense account'
         },
+        balance_client_id: {
+          type: 'string',
+          example: 'c1265a62-62e9-46de-9df7-4d3009c46068',
+          maxLength: 128,
+          description: 'The client_id of the balance this expense is part of.'
+        },
         safe_id: {
           type: 'string',
           format: 'uuid',
@@ -404,6 +416,12 @@ module.exports = {
     This is is commonly refered to as 'transaction number' plus possibly any extension as string.
     `
   }),
+  _balance_client_id: oneOf({
+    type: 'string',
+    example: 'c1265a62-62e9-46de-9df7-4d3009c46068',
+    maxLength: 128,
+    description: 'The client_id of the balance this transaction is part of.'
+  }),
   _staff: oneOf({
     type: 'string',
     format: 'uuid',

package/package.json

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

package/test/balances/balances.v1.spec.js

@@ -1,7 +1,7 @@
 const test = require('tape')
 const validate = require('../helpers/validate-schema')
 
-test('Balances: create schema validation', function (t) {
+test('Balances: v1: create schema validation', function (t) {
   t.plan(2)
   const createRequest = require('../../lib/v1/balances').create.request
   const { valid, error } = validate(createRequest)
@@ -9,3 +9,30 @@ test('Balances: create schema validation', function (t) {
   t.error(error, 'should not get any error')
   t.end()
 })
+
+test('Balances: v1: create response schema', function (t) {
+  t.plan(2)
+  const createResponse = require('../../lib/v1/balances').create.response
+  const { valid, error } = validate(createResponse)
+  t.ok(valid, 'response schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})
+
+test('Balances: v1: legacy: create request schema', function (t) {
+  t.plan(2)
+  const createRequest = require('../../lib/v1/balances').legacy.create.request
+  const { valid, error } = validate(createRequest)
+  t.ok(valid, 'create schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})
+
+test('Balances: v1: legacy: create response schema', function (t) {
+  t.plan(2)
+  const createResponse = require('../../lib/v1/balances').legacy.create.response
+  const { valid, error } = validate(createResponse)
+  t.ok(valid, 'response schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})