@tillhub/schemas 6.90.0 → 6.91.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [6.91.0](https://github.com/tillhub/schemas/compare/v6.90.3...v6.91.0) (2021-09-24)
+
+
+### Features
+
+* **client-accounts:** add 'abocard_system' flag ([67e9e42](https://github.com/tillhub/schemas/commit/67e9e42))
+
+## [6.90.3](https://github.com/tillhub/schemas/compare/v6.90.2...v6.90.3) (2021-09-23)
+
+
+### Bug Fixes
+
+* **loyalty_systems:** add abocard create schema #API-1020 ([#623](https://github.com/tillhub/schemas/issues/623)) ([a1fbc45](https://github.com/tillhub/schemas/commit/a1fbc45)), closes [#API-1020](https://github.com/tillhub/schemas/issues/API-1020) [#API-1020](https://github.com/tillhub/schemas/issues/API-1020)
+
+## [6.90.2](https://github.com/tillhub/schemas/compare/v6.90.1...v6.90.2) (2021-09-23)
+
+
+### Bug Fixes
+
+* **loyalty_systems:** adjust min value for abocard system validity pe… ([#624](https://github.com/tillhub/schemas/issues/624)) ([be1b62e](https://github.com/tillhub/schemas/commit/be1b62e)), closes [#API-1017](https://github.com/tillhub/schemas/issues/API-1017)
+
+## [6.90.1](https://github.com/tillhub/schemas/compare/v6.90.0...v6.90.1) (2021-09-23)
+
+
+### Bug Fixes
+
+* **loyalty_systems:** add validity_period to abocard system #API-1017 ([e172dd2](https://github.com/tillhub/schemas/commit/e172dd2)), closes [#API-1017](https://github.com/tillhub/schemas/issues/API-1017)
+
 # [6.90.0](https://github.com/tillhub/schemas/compare/v6.89.2...v6.90.0) (2021-09-22)
 
 

package/lib/v0/client_accounts/features/base.js

@@ -66,5 +66,9 @@ module.exports = {
   takeaway: {
     type: 'boolean',
     default: false
+  },
+  abocard: {
+    type: 'boolean',
+    default: false
   }
 }

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_cards = require('./loyalty_abocard_cards')
 module.exports.loyalty_abocard_systems = require('./loyalty_abocard_systems')
 module.exports.loyalty_systems = require('./loyalty_systems')
 module.exports.loyalty_accounts = require('./loyalty_accounts')

package/lib/v0/loyalty_abocard_cards/base.js

@@ -0,0 +1,58 @@
+const { oneOf } = require('../../helpers/payload-or-null')
+const baseObject = require('../../common/base')
+const voucher = require('../vouchers/base')
+
+const request = {
+  abocard_system: {
+    description: 'The abocard system UUID abocard belongs to',
+    example: '3610eb8a-2d21-4034-9aa6-0a097a2ce5f2',
+    type: 'string',
+    format: 'uuid'
+  },
+  customer: oneOf({
+    description: 'The customer UUID it was handed out for',
+    example: 'ad572a0d-301a-4270-8a49-5f720f2b277d',
+    type: 'string',
+    format: 'uuid'
+  })
+}
+
+const response = {
+  ...baseObject(),
+  ...request,
+  active: {
+    description: 'The abocard is active',
+    example: true,
+    type: 'boolean'
+  },
+  deleted: {
+    description: 'The abocard is deleted',
+    example: true,
+    type: 'boolean'
+  },
+  valid_until: oneOf({
+    description: 'When the abocard expires',
+    example: '2021-09-23T08:19:02.059Z',
+    type: 'string',
+    format: 'date-time'
+  }),
+  configuration: oneOf({
+    description: 'A snapshot of the configuration the abocard has been created with',
+    type: 'object',
+    additionalProperties: true,
+    required: []
+  }),
+  vouchers: oneOf({
+    description: 'Vouchers for the abocard in case when abocard system has system_type == "voucher"',
+    type: 'array',
+    items: voucher
+  })
+}
+
+module.exports = {
+  request,
+  response,
+  required: [
+    'abocard_system'
+  ]
+}

package/lib/v0/loyalty_abocard_cards/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_cards.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_cards.create.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...commonResponse({ resultItems: {
+    type: 'object',
+    properties: response
+  } })
+}

package/lib/v0/loyalty_abocard_cards/index.js

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

package/lib/v0/loyalty_abocard_systems/base.js

@@ -68,6 +68,30 @@ const request = {
     type: 'string',
     maxLength: 255
   }),
+  validity_period: {
+    description: 'Validity period of issued abocrads',
+    type: 'object',
+    additionalProperties: false,
+    required: ['unit', 'value'],
+    properties: {
+      unit: {
+        description: 'The type of period',
+        example: 'years',
+        type: 'string',
+        enum: [
+          'years'
+        ],
+        default: 'years'
+      },
+      value: {
+        description: 'The period value in given units',
+        example: 3,
+        type: 'number',
+        minimum: 1,
+        default: 3
+      }
+    }
+  },
   voucher_system: oneOf({
     description: 'Referenced voucher system when system_type == "voucher". 1 to 1 relationship with voucher system instance.',
     type: 'object',

package/package.json

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