@tillhub/schemas 6.230.0 → 6.232.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.232.0](https://github.com/tillhub/schemas/compare/v6.231.0...v6.232.0) (2023-07-20)
+
+
+### Features
+
+* **products:** configurations ([fdba281](https://github.com/tillhub/schemas/commit/fdba281))
+
+# [6.231.0](https://github.com/tillhub/schemas/compare/v6.230.0...v6.231.0) (2023-07-20)
+
+
+### Features
+
+* **service_categories:** add service_categories.create ([#829](https://github.com/tillhub/schemas/issues/829)) ([fc3e117](https://github.com/tillhub/schemas/commit/fc3e117))
+
 # [6.230.0](https://github.com/tillhub/schemas/compare/v6.229.0...v6.230.0) (2023-07-14)
 
 

package/lib/v0/index.js

@@ -74,5 +74,6 @@ module.exports.table_layouts = require('./table_layouts')
 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')
 
 // 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/service_categories/base.js

@@ -0,0 +1,41 @@
+const base = require('../product_groups/base')
+
+const request = {
+  ...base.request,
+  properties: {
+    ...base.request.properties,
+    description: {
+      description: 'A description of the service category',
+      type: 'string',
+      example: 'Haircuts for men'
+    },
+    active: {
+      description: 'Soft disable or enable this service category.',
+      type: 'boolean',
+      default: true
+    },
+    deleted: {
+      description: 'Soft delete this service category.',
+      type: 'boolean',
+      default: false
+    }
+  },
+  required: ['name']
+}
+
+module.exports = {
+  request,
+  response: {
+    ...request,
+    required: [],
+    properties: {
+      id: {
+        description: 'The service category ID',
+        type: 'string',
+        format: 'uuid',
+        example: '05297f58-3408-44d0-8bf4-125d4e86c08a'
+      },
+      ...request.properties
+    }
+  }
+}

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

@@ -0,0 +1,7 @@
+const { request } = require('./base')
+
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v0/service_categories.create.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...request
+}

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

@@ -0,0 +1,8 @@
+const { response } = require('./base')
+const commonResponse = require('../../common/response')
+
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v0/service_categories.create.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...commonResponse({ resultItems: response })
+}

package/lib/v0/service_categories/index.js

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

package/lib/v1/products/properties/configuration.js

@@ -1,4 +1,6 @@
+const { oneOf } = require('../../../helpers/payload-or-null')
 const { stripIndents } = require('common-tags')
+
 module.exports = {
   description: 'Defines various product behaviours.',
   default: {
@@ -12,6 +14,59 @@ module.exports = {
       type: 'object',
       additionalProperties: true,
       properties: {
+        external_rewards: oneOf({
+          type: 'object',
+          description: stripIndents`
+                Can grant external rewards when added to a cart.
+
+                NOTE: Should be used sparsely for special campign products that require barcode scanning as sort of campaign activator.
+                Should be used for products that are bound to specific branch groups.
+                These products will be currently visible to anyone as there is no dedicated type planned (Summer 2023).
+              `,
+          additionalProperties: true,
+          properties: {
+            coop: oneOf({
+              type: 'object',
+              description: 'Can grant Coop rewards when added to a cart.',
+              properties: {
+                campaign: oneOf({
+                  type: 'object',
+                  description: 'Can grant Coop campaign rewards when part of an active cart.',
+                  properties: {
+                    name: {
+                      description: 'Name of the campaign',
+                      type: 'string',
+                      example: 'Super Summer',
+                      minLength: 2,
+                      maxLength: 24
+                    },
+                    multiplier: {
+                      type: 'integer',
+                      description: 'Superpoint multiplier on cart total',
+                      minimum: 1,
+                      maximum: 100,
+                      default: 1
+                    },
+                    date_start: oneOf({
+                      type: 'string',
+                      format: 'date-time',
+                      example: '2023-08-04 12:00:21.165+00',
+                      description: 'Start date of the campaign',
+                      default: null // fallback: distant past
+                    }),
+                    date_end: oneOf({
+                      type: 'string',
+                      format: 'date-time',
+                      example: '2023-10-23 16:51:29.143+00',
+                      description: 'End date of the campaign',
+                      default: null // fallback: distant future
+                    })
+                  }
+                })
+              }
+            })
+          }
+        }),
         allow_zero_prices: {
           deprecated: true,
           description: 'Allow adding this product to a cart if it has no price.',

package/package.json

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

package/test/service_categories/v0/service_categories.v0.spec.js

@@ -0,0 +1,20 @@
+const test = require('tape')
+const validate = require('../../helpers/validate-schema')
+
+test('Service Categories V0: create request schema validation', t => {
+  t.plan(2)
+  const createRequest = require('../../../lib/v0/service_categories').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('Service Categories V0: create response schema validation', t => {
+  t.plan(2)
+  const createResponse = require('../../../lib/v0/service_categories').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()
+})