@tillhub/schemas 6.104.0 → 6.108.0

package/CHANGELOG.md

@@ -1,3 +1,43 @@
+# [6.108.0](https://github.com/tillhub/schemas/compare/v6.107.0...v6.108.0) (2021-12-22)
+
+
+### Features
+
+* **pricebooks:** Add Price Books to untrash ([#654](https://github.com/tillhub/schemas/issues/654)) ([d7850b5](https://github.com/tillhub/schemas/commit/d7850b5))
+
+# [6.107.0](https://github.com/tillhub/schemas/compare/v6.106.0...v6.107.0) (2021-12-21)
+
+
+### Features
+
+* **staffs:** Staff permissions from template instead of scopes ([#653](https://github.com/tillhub/schemas/issues/653)) ([821e7c5](https://github.com/tillhub/schemas/commit/821e7c5))
+
+# [6.106.0](https://github.com/tillhub/schemas/compare/v6.105.0...v6.106.0) (2021-12-13)
+
+
+### Bug Fixes
+
+* **transactions:** items ([876dc02](https://github.com/tillhub/schemas/commit/876dc02))
+
+
+### Features
+
+* **transactions:** legacy ([eb5ae77](https://github.com/tillhub/schemas/commit/eb5ae77))
+* **transactions:** legacy ([910471b](https://github.com/tillhub/schemas/commit/910471b))
+
+# [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)
 
 

package/lib/v0/loyalty_abocard_systems/base.js

@@ -1,5 +1,6 @@
 const { oneOf } = require('../../helpers/payload-or-null')
 const baseObject = require('../../common/base')
+const currencyAmount = require('../../common/currency_amount')
 const voucherSystemPropertiesFull = require('../voucher_systems/base')
 
 const {
@@ -231,7 +232,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 = {
@@ -239,7 +261,14 @@ const response = {
   deleted: {
     type: 'boolean'
   },
-  ...request
+  ...request,
+  actual_amount: {
+    description: 'The calculated amount of abocard based on abocard system settings (discount_type, selling_price_method, etc.) and location',
+    ...oneOf({
+      ...currencyAmount
+    }),
+    default: null
+  }
 }
 
 module.exports = {

package/lib/v0/staff/base.js

@@ -1,3 +1,5 @@
+const { oneOf } = require('../../helpers/payload-or-null')
+
 module.exports = {
   firstname: {
     anyOf: [
@@ -210,6 +212,9 @@ module.exports = {
       }
     ]
   },
+  user_permission_template_id: oneOf({
+    type: 'string'
+  }),
   active: {
     type: 'boolean'
   },

package/lib/v0/trash/get.js

@@ -35,6 +35,7 @@ module.exports.query = {
         'product_service_questions',
         'product_templates',
         'products_v1',
+        'pricebooks',
         'promotions',
         'reasons',
         'regions',

package/lib/v0/trash/update.js

@@ -31,6 +31,7 @@ module.exports.request = {
         'product_service_questions',
         'product_templates',
         'products_v1',
+        'pricebooks',
         'promotions',
         'reasons',
         'regions',

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

@@ -384,7 +384,8 @@ const internalDiscounts = {
               'sconto',
               'item',
               'promotion',
-              'voucher'
+              'voucher',
+              'product_voucher'
             ]
           },
           {

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/discount/base.js

@@ -88,7 +88,8 @@ module.exports = {
         'sconto',
         'item',
         'promotion',
-        'voucher'
+        'voucher',
+        'product_voucher'
       ]
     }),
     name: {
@@ -132,7 +133,9 @@ module.exports = {
             'item',
             'customer',
             'promotion',
-            'sconto'
+            'sconto',
+            'voucher',
+            'product_voucher'
           ]
         },
         {

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

@@ -123,6 +123,10 @@ module.exports = {
       maxLength: 2048,
       description: 'Messages from voucher processing.'
     },
+    creation: oneOf({
+      type: 'object',
+      description: 'Client specified container to store created abocards and/or vouchers.'
+    }),
     type: {
       type: 'string',
       description: 'Mainly legacy support for Fleurop flows.',
@@ -136,7 +140,9 @@ module.exports = {
         'tillhub_create', // formerly 6
         'tillhub_recharge', // formerly 7
         'tillhub_reedeem', // formerly 8
-        'tillhub_percentage' // formerly 9
+        'tillhub_percentage', // formerly 9
+        'tillhub_product', // ...
+        'tillhub_abocard_sell' // ...
       ]
     },
     status: {

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

@@ -285,7 +285,6 @@ module.exports = {
     })
   },
   discounts: {
-    deprecated: true,
     ...oneOf({
       type: 'array',
       items: {
@@ -306,7 +305,8 @@ module.exports = {
               'sconto', // originated from rounding currencies that do not use a 0.01 physical unit, e.g. CHF
               'item', // discounts that can only be used per item
               'promotion', // originated from applying the outcome of a promotion
-              'voucher' // originated from applying a percentage voucher
+              'voucher', // originated from applying a percentage voucher
+              'product_voucher' // originated from applying a voucher bound to a product
             ],
             description: 'The group type of discount (type was taken)'
           },
@@ -410,6 +410,8 @@ module.exports = {
               'voucher_is_locked', // If is_voucher, indicates the locked state within the API
               'voucher_message', // If is_voucher, collected messages from voucher processing API calls
               'voucher_title', // If is_voucher, a currently not used custom title
+              'voucher_linked_product', // If is_voucher and of type product, the id of the affected product
+              'voucher_creation', // If is_voucher and it involves creation of vocuhers or abocards - a stringified JSON of the relevant contents
               /*
               the voucher_type enum:
               [

package/package.json

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