@tillhub/schemas 6.87.0 → 6.89.2

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [6.89.2](https://github.com/tillhub/schemas/compare/v6.89.1...v6.89.2) (2021-09-22)
+
+
+### Bug Fixes
+
+* **loyalty_systems:** promote base object for base response for abocrds system #API-1017 ([5a8e7e4](https://github.com/tillhub/schemas/commit/5a8e7e4)), closes [#API-1017](https://github.com/tillhub/schemas/issues/API-1017)
+
+## [6.89.1](https://github.com/tillhub/schemas/compare/v6.89.0...v6.89.1) (2021-09-21)
+
+
+### Bug Fixes
+
+* hijacked configuration param properly described ([c21090c](https://github.com/tillhub/schemas/commit/c21090c))
+
+# [6.89.0](https://github.com/tillhub/schemas/compare/v6.88.0...v6.89.0) (2021-09-21)
+
+
+### Features
+
+* **fiscal signing:** add base_url ([90d2f67](https://github.com/tillhub/schemas/commit/90d2f67))
+* **fiscal_signing:** add api version ([b1dc80f](https://github.com/tillhub/schemas/commit/b1dc80f))
+
+# [6.88.0](https://github.com/tillhub/schemas/compare/v6.87.1...v6.88.0) (2021-09-21)
+
+
+### Features
+
+* **configurations:** interfaces ([5c55f6f](https://github.com/tillhub/schemas/commit/5c55f6f))
+* **configurations:** interfaces ([b94687c](https://github.com/tillhub/schemas/commit/b94687c))
+
 # [6.87.0](https://github.com/tillhub/schemas/compare/v6.86.0...v6.87.0) (2021-09-17)
 
 

package/lib/v0/branches/base.js

@@ -365,11 +365,10 @@ module.exports = {
     ]
   },
   configuration: {
-    description: 'The reference to a configuration for branch level configurations. This should be omitted by implementers.',
+    description: 'Deprecated: Overwriting a fa_account_number on cash payments for DATEV export.',
     anyOf: [
       {
-        type: 'string',
-        format: 'uuid'
+        type: 'string'
       },
       {
         type: 'null'

package/lib/v0/loyalty_abocard_systems/base.js

@@ -34,7 +34,7 @@ const abocardAction = {
       ]
     },
     product: {
-      description: 'The product associated with this action. Product creates automatically along with abocard system and based on "linked_product" and "system_revenue_account" field values.',
+      description: 'The product associated with this action. Product gets created automatically when creating a abocard system and based on "linked_product" vat and "system_revenue_account" field values.',
       ...oneOf({
         type: 'string',
         format: 'uuid',
@@ -64,7 +64,7 @@ const request = {
   },
   name: oneOf({
     description: 'The abocard system name',
-    example: 'Buy 3 haircuts and get next 1 for free',
+    example: 'Buy 4 haircuts and pay 10 Bucks less.',
     type: 'string',
     maxLength: 255
   }),
@@ -94,7 +94,7 @@ const request = {
     })
   },
   linked_product: oneOf({
-    description: 'Product linked to abocard system. New products (abocards) being created for "actions[...].product" and "voucher_system.product" based on this value (VAT ID reference is most important part).',
+    description: 'The Product that is linked to the abocard, if the abocard system requires a bound product. On creation of the system, a new products (abocard XYZ) is being created for "actions[...].product" and "voucher_system.product" based on this product. The VAT ID reference is propogating system_tax_account, as systems with product binding are creating single purpose vouchers that are tax relevant.',
     example: '3610eb8a-2d21-4034-9aa6-0a097a2ce5f2',
     type: 'string',
     format: 'uuid'
@@ -118,14 +118,14 @@ const request = {
     format: 'uuid'
   }),
   used_product_price: oneOf({
-    description: 'The price of the product being used',
+    description: 'For type=voucher abocard systems: The price of the product used to calculate the value of discounts and vouchers.',
     example: 12.99,
     type: 'number',
     minimum: 0,
     multipleOf: 0.01
   }),
   price_source: oneOf({
-    description: 'The source of which product price was taken.',
+    description: 'The source of where the product price was taken from.',
     type: 'string',
     enum: [
       'product',
@@ -133,46 +133,46 @@ const request = {
     ]
   }),
   price_id: oneOf({
-    description: 'The price reference inside the price source. For JSONB fields use path.',
+    description: 'The price reference of the price source. In case of price book entries, a uuid, in case of default price, the path of the JSONB fields.',
     example: 'default_prices[0]',
     type: 'string',
     maxLength: 255
   }),
   selling_price: oneOf({
-    description: 'The selling price of the abocard',
+    description: 'The selling price of the abocard for the POS.',
     example: 11.99,
     type: 'number',
     minimum: 0,
     multipleOf: 0.01
   }),
   discount_value: oneOf({
-    description: 'The discount value',
+    description: 'For type=voucher abocard systems: The total discount value assigned to the abocard',
     example: 2.00,
     type: 'number',
     minimum: 0,
     multipleOf: 0.01
   }),
   total_value: oneOf({
-    description: 'The total amount value',
+    description: 'For type=voucher abocard systems: The total value of the abocard (selling price plus discount)',
     example: 9.99,
     type: 'number',
     minimum: 0,
     multipleOf: 0.01
   }),
   units: oneOf({
-    description: 'The amount of vouchers that we issue on creation of the abocard.',
+    description: 'For type=voucher abocard systems: The amount of vouchers that we issue on creation of the abocard',
     type: 'number',
     minimum: 0
   }),
   voucher_value_per_unit: oneOf({
-    description: 'The voucher value per unit (when system_type == "voucher")',
+    description: 'For type=voucher abocard systems: The voucher value per unit (when system_type == "voucher")',
     example: 3,
     type: 'number',
     minimum: 0,
     multipleOf: 0.01
   }),
   discount_value_per_unit: oneOf({
-    description: 'The discount value per unit',
+    description: 'For type=voucher abocard systems: The discount value per unit',
     example: 1.33,
     type: 'number',
     minimum: 0,
@@ -199,7 +199,7 @@ const request = {
 }
 
 const response = {
-  ...baseObject,
+  ...baseObject(),
   deleted: {
     type: 'boolean'
   },

package/lib/v0/voucher_systems/base.js

@@ -235,7 +235,14 @@ module.exports = {
   locations: oneOf({
     type: 'array',
     description: 'If defined then only these locations will be using this system. If not defined, there will be no restrictions on which locations can use this system.',
-    minItems: 1,
+    items: {
+      type: 'string',
+      format: 'uuid'
+    }
+  }),
+  branch_groups: oneOf({
+    type: 'array',
+    description: 'If defined then only these branch groups (plus specified locations if any) will be using this system.',
     items: {
       type: 'string',
       format: 'uuid'

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

@@ -110,7 +110,12 @@ module.exports = {
                 enabled: {
                   type: 'boolean',
                   default: true
-                }
+                },
+                swiss: oneOf({
+                  description: 'Defines if swiss-specific handling of the OPI protocol will be used',
+                  type: 'boolean',
+                  default: false
+                })
               }
             },
             sumup: {

package/lib/v1/registers/base.js

@@ -220,6 +220,25 @@ module.exports = {
                     description: 'Per fiskaly account: secret for their API',
                     example: 'QmSgQtMNfm0uZjVedM1BvqGRIQ3D9wjclLYDZcXPZve'
                   },
+                  api_version: {
+                    ...oneOf({
+                      description: 'Fiskaly account API version',
+                      type: 'string',
+                      enum: [
+                        'v1',
+                        'v2'
+                      ],
+                      default: 'v1'
+                    })
+                  },
+                  base_url: {
+                    ...oneOf({
+                      type: 'string',
+                      description: 'A custom Fiskaly API endpoint. If not set, the POS will use the version specific default endpoint.',
+                      example: 'https://kassensichv-middleware.fiskaly.com/api/v2/',
+                      default: null
+                    })
+                  },
                   client_timeout_ms: oneOf({
                     type: 'integer',
                     description: 'The timeout in milliseconds for the Fiskaly client component.',

package/package.json

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