@tillhub/schemas 6.238.0 → 6.240.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.240.0](https://github.com/tillhub/schemas/compare/v6.239.0...v6.240.0) (2023-07-31)
+
+
+### Features
+
+* **services:** add schema for POST services ([#836](https://github.com/tillhub/schemas/issues/836)) ([ac40de8](https://github.com/tillhub/schemas/commit/ac40de8))
+
+# [6.239.0](https://github.com/tillhub/schemas/compare/v6.238.0...v6.239.0) (2023-07-28)
+
+
+### Features
+
+* **branches:** external_rewards ([c18a2b8](https://github.com/tillhub/schemas/commit/c18a2b8))
+
 # [6.238.0](https://github.com/tillhub/schemas/compare/v6.237.0...v6.238.0) (2023-07-27)
 
 

package/lib/v0/branches/base.js

@@ -412,38 +412,32 @@ module.exports = {
       type: 'null'
     }]
   },
-  configurations: oneOf({
-    description: 'Replacement of configuration (unknown usage).',
+  external_rewards: oneOf({
+    description: 'Branch specific settinmgs for external reward systems',
     type: 'object',
     additionalProperties: false,
     properties: {
-      external_rewards: oneOf({
+      coop: oneOf({
         type: 'object',
-        additionalProperties: false,
+        description: 'Branch configuration object for Swiss Coop - data is used on transactions',
         properties: {
-          coop: oneOf({
-            type: 'object',
-            description: 'Branch configuration object for Swiss Coop - data is used on transactions',
-            properties: {
-              store_eain: {
-                type: 'string',
-                description: 'Coop identity of this Tillhub branch.',
-                example: '7640147960015'
-              },
-              store_name: oneOf({
-                type: 'string',
-                maxLength: 128,
-                description: 'Name of this branch within the Coop context.',
-                example: 'Coop Supermarkt Riehen Schmiedgasse',
-                default: '{name}'
-              }),
-              store_sap_number: oneOf({
-                type: 'string',
-                pattern: '^[0-9]{4}$',
-                description: 'Tillhub branch SAP number if available.',
-                example: '000001'
-              })
-            }
+          store_eain: {
+            type: 'string',
+            description: 'Coop identity of this Tillhub branch.',
+            example: '7640147960015'
+          },
+          store_name: oneOf({
+            type: 'string',
+            maxLength: 128,
+            description: 'Name of this branch within the Coop context.',
+            example: 'Coop Supermarkt Riehen Schmiedgasse',
+            default: '{name}'
+          }),
+          store_sap_number: oneOf({
+            type: 'string',
+            pattern: '^[0-9]{4}$',
+            description: 'Tillhub branch SAP number if available.',
+            example: '000001'
           })
         }
       })

package/lib/v0/index.js

@@ -75,5 +75,6 @@ module.exports.product_addons = require('./product_addons')
 module.exports.product_addon_groups = require('./product_addon_groups')
 module.exports.configurations = require('./configurations')
 module.exports.service_categories = require('./service_categories')
+module.exports.services = require('./services')
 
 // hygen:injection -  Please, don't delete this line: when running the cli for schema resources the new routes will be automatically added here.

package/lib/v0/services/create.request.js

@@ -0,0 +1,34 @@
+const base = require('../products/create')
+const { oneOf } = require('../../helpers/payload-or-null')
+
+module.exports = {
+  ...base,
+  properties: {
+    ...base.properties,
+    name: {
+      description: 'The name of the service',
+      type: 'string',
+      example: 'Haircut'
+    },
+    category: oneOf({
+      description: 'The UUID of the category that the service belogs to',
+      type: 'string',
+      format: 'uuid',
+      example: '05297f58-3408-44d0-8bf4-125d4e86c08a'
+    }),
+    duration: {
+      description: 'the duration of the service in mintues',
+      type: 'integer',
+      minimum: 5,
+      maximum: 1440,
+      example: 30
+    },
+    'linked_product': {
+      description: 'The UUID of the product associated with the service',
+      type: 'string',
+      format: 'uuid',
+      example: '05297f58-3408-44d0-8bf4-125d4e86c08a'
+    }
+  },
+  required: ['name', 'duration', 'linked_product']
+}

package/lib/v0/services/create.response.js

@@ -0,0 +1,22 @@
+const request = require('./create.request')
+const commonResponse = require('../../common/response')
+
+const response = {
+  ...request,
+  required: [],
+  properties: {
+    id: {
+      description: 'The service ID',
+      type: 'string',
+      format: 'uuid',
+      example: '05297f58-3408-44d0-8bf4-125d4e86c08a'
+    },
+    ...request.properties
+  }
+}
+
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v0/services.create.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...commonResponse({ resultItems: response })
+}

package/lib/v0/services/index.js

@@ -0,0 +1,4 @@
+module.exports.create = {
+  request: require('./create.request'),
+  response: require('./create.response')
+}

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

@@ -739,7 +739,7 @@ module.exports = {
               point_base_amount: {
                 type: 'integer',
                 description: stripIndents`
-                'Total value of the sale that qualifies for superpoints (campaign items and vouchers excluded)
+                'Total value of the sale that qualifies for superpoints (campaign items, tips and vouchers excluded)
 
                 as long as net items are not supported this is identical to \'total_amount\'.
                 `,

package/package.json

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

package/test/services/v0/services.v0.spec.js

@@ -0,0 +1,20 @@
+const test = require('tape')
+const validate = require('../../helpers/validate-schema')
+
+test('Services V0: create request schema validation', t => {
+  t.plan(2)
+  const createRequest = require('../../../lib/v0/services').create.request
+  const { valid, error } = validate(createRequest)
+  t.ok(valid, 'create request schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})
+
+test('Services V0: create response schema validation', t => {
+  t.plan(2)
+  const createResponse = require('../../../lib/v0/services').create.response
+  const { valid, error } = validate(createResponse)
+  t.ok(valid, 'create response schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})