@tillhub/schemas 6.86.0 → 6.89.1

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+## [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)
+
+
+### Features
+
+* **loyalties-abocard-systems:** add abocard systems schema #API-1017 ([af58999](https://github.com/tillhub/schemas/commit/af58999)), closes [#API-1017](https://github.com/tillhub/schemas/issues/API-1017)
+* **loyalties-abocard-systems:** add description #API-1017 ([e74bc61](https://github.com/tillhub/schemas/commit/e74bc61)), closes [#API-1017](https://github.com/tillhub/schemas/issues/API-1017)
+* **loyalties-abocard-systems:** add more details and examples #API-1017 ([301578e](https://github.com/tillhub/schemas/commit/301578e)), closes [#API-1017](https://github.com/tillhub/schemas/issues/API-1017)
+* **loyalties-abocard-systems:** differ request and response properties set #API-1017 ([9ba50fe](https://github.com/tillhub/schemas/commit/9ba50fe)), closes [#API-1017](https://github.com/tillhub/schemas/issues/API-1017)
+* **loyalty_systems:** abocards ([7715d14](https://github.com/tillhub/schemas/commit/7715d14))
+
 # [6.86.0](https://github.com/tillhub/schemas/compare/v6.85.0...v6.86.0) (2021-09-16)
 
 

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

@@ -31,6 +31,7 @@ module.exports.warehouses = require('./warehouses')
 module.exports.product_service_questions = require('./product_service_questions')
 module.exports.product_service_question_groups = require('./product_service_question_groups')
 module.exports.time_entries = require('./time_entries')
+module.exports.loyalty_abocard_systems = require('./loyalty_abocard_systems')
 module.exports.loyalty_systems = require('./loyalty_systems')
 module.exports.loyalty_accounts = require('./loyalty_accounts')
 module.exports.loyalty_cards = require('./loyalty_cards')

package/lib/v0/loyalty_abocard_systems/base.js

@@ -0,0 +1,216 @@
+const { oneOf } = require('../../helpers/payload-or-null')
+const baseObject = require('../../common/base')
+const voucherSystemPropertiesFull = require('../voucher_systems/base')
+
+const {
+  name: omitName,
+  product: omitProduct,
+  actions: omitActions,
+  locations: omitLocations,
+  location_groups: omitLocationGroups,
+  ...voucherSystemProperties
+} = voucherSystemPropertiesFull
+
+const abocardAction = {
+  description: 'The abocard action',
+  type: 'object',
+  additionalProperties: false,
+  required: [
+    'id',
+    'type'
+  ],
+  properties: {
+    id: {
+      description: 'The abocard action reference ID',
+      type: 'string',
+      format: 'uuid',
+      example: '43847a66-97dc-4ac2-8e8a-c44920e1f22f'
+    },
+    type: {
+      description: 'The abocard action type',
+      type: 'string',
+      enum: [
+        'sell'
+      ]
+    },
+    product: {
+      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',
+        example: '43847a66-97dc-4ac2-8e8a-c44920e1f22f'
+      })
+    },
+    context: {
+      description: 'Specifies from where this action can be triggered',
+      ...oneOf({
+        type: 'string',
+        enum: [
+          'library'
+        ]
+      })
+    }
+  }
+}
+
+const request = {
+  system_type: {
+    description: 'The type of abocard system',
+    type: 'string',
+    enum: [
+      'voucher'
+    ],
+    example: 'voucher'
+  },
+  name: oneOf({
+    description: 'The abocard system name',
+    example: 'Buy 4 haircuts and pay 10 Bucks less.',
+    type: 'string',
+    maxLength: 255
+  }),
+  voucher_system: oneOf({
+    description: 'Referenced voucher system when system_type == "voucher". 1 to 1 relationship with voucher system instance.',
+    type: 'object',
+    additionalProperties: false,
+    required: [],
+    properties: {
+      id: {
+        description: 'Voucher system primary key (should be omitted for creation but required for update)',
+        example: 'ad572a0d-301a-4270-8a49-5f720f2b277d',
+        type: 'string',
+        format: 'uuid'
+      },
+      ...voucherSystemProperties
+    }
+  }),
+  actions: {
+    description: 'Defines actions for various abocard system life cycle events',
+    ...oneOf({
+      type: 'array',
+      items: {
+        description: 'Available actions for this system',
+        ...abocardAction
+      }
+    })
+  },
+  linked_product: oneOf({
+    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'
+  }),
+  system_revenue_account: oneOf({
+    description: 'Referenced revenue account. New products being created for "actions[...].product" and "voucher_system.product" will use this revenue account.',
+    example: '075a2f42-c29f-44d2-9ed3-2d636888e9b5',
+    type: 'string',
+    format: 'uuid'
+  }),
+  system_tax_account: oneOf({
+    description: 'Referenced tax account. New products being created for "actions[...].product" and "voucher_system.product" will use this tax account.',
+    example: '075a2f42-c29f-44d2-9ed3-2d636888e9b5',
+    type: 'string',
+    format: 'uuid'
+  }),
+  system_tax_rate: oneOf({
+    description: 'New products being created for "actions[...].product" and "voucher_system.product" will use this tax rate.',
+    example: '075a2f42-c29f-44d2-9ed3-2d636888e9b5',
+    type: 'string',
+    format: 'uuid'
+  }),
+  used_product_price: oneOf({
+    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 where the product price was taken from.',
+    type: 'string',
+    enum: [
+      'product',
+      'pricebook_entry'
+    ]
+  }),
+  price_id: oneOf({
+    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 for the POS.',
+    example: 11.99,
+    type: 'number',
+    minimum: 0,
+    multipleOf: 0.01
+  }),
+  discount_value: oneOf({
+    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: '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: '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: '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: 'For type=voucher abocard systems: The discount value per unit',
+    example: 1.33,
+    type: 'number',
+    minimum: 0,
+    multipleOf: 0.01
+  }),
+  locations: oneOf({
+    description: 'Locations where abocard system is applicable',
+    example: ['6d541143-2ada-4ece-9cc1-1260e7e5f718'],
+    type: 'array',
+    items: {
+      type: 'string',
+      format: 'uuid'
+    }
+  }),
+  location_groups: oneOf({
+    description: 'Location groups where abocard system is applicable',
+    example: ['25812497-4559-458c-ab0e-faa93e513d3e'],
+    type: 'array',
+    items: {
+      type: 'string',
+      format: 'uuid'
+    }
+  })
+}
+
+const response = {
+  ...baseObject,
+  deleted: {
+    type: 'boolean'
+  },
+  ...request
+}
+
+module.exports = {
+  request,
+  response,
+  required: [
+    'system_type',
+    'name'
+  ]
+}

package/lib/v0/loyalty_abocard_systems/create.js

@@ -0,0 +1,20 @@
+const { request, response, required } = require('./base')
+const commonResponse = require('../../common/response')
+
+module.exports.request = {
+  $id: 'https://schemas.tillhub.com/v0/loyalty_abocard_systems.create.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  type: 'object',
+  required,
+  properties: request
+}
+
+module.exports.response = {
+  $id: 'https://schemas.tillhub.com/v0/loyalty_abocard_systems.create.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...commonResponse({ resultItems: {
+    type: 'object',
+    properties: response
+  } })
+}

package/lib/v0/loyalty_abocard_systems/get.js

@@ -0,0 +1,9 @@
+const query = {
+}
+
+module.exports.query = {
+  $id: 'https://schemas.tillhub.com/v0/loyalty_abocard_systems.get.query.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  properties: query
+}

package/lib/v0/loyalty_abocard_systems/index.js

@@ -0,0 +1,3 @@
+module.exports.create = require('./create')
+module.exports.update = require('./update')
+module.exports.get = require('./get')

package/lib/v0/loyalty_abocard_systems/update.js

@@ -0,0 +1,20 @@
+const { request, response, required } = require('./base')
+const commonResponse = require('../../common/response')
+
+module.exports.request = {
+  $id: 'https://schemas.tillhub.com/v0/loyalty_abocard_systems.update.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  type: 'object',
+  required,
+  properties: request
+}
+
+module.exports.response = {
+  $id: 'https://schemas.tillhub.com/v0/loyalty_abocard_systems.update.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...commonResponse({ resultItems: {
+    type: 'object',
+    properties: response
+  } })
+}

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