@tillhub/schemas 6.314.0 → 6.316.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.316.0](https://github.com/tillhub/schemas/compare/v6.315.0...v6.316.0) (2024-06-07)
+
+
+### Features
+
+* **promotion:** defining promotion v1 ([#962](https://github.com/tillhub/schemas/issues/962)) ([c8ed835](https://github.com/tillhub/schemas/commit/c8ed835))
+
+# [6.315.0](https://github.com/tillhub/schemas/compare/v6.314.0...v6.315.0) (2024-06-07)
+
+
+### Features
+
+* **promotion:** defining promotion v1 ([#961](https://github.com/tillhub/schemas/issues/961)) ([8b3e5cd](https://github.com/tillhub/schemas/commit/8b3e5cd))
+
 # [6.314.0](https://github.com/tillhub/schemas/compare/v6.313.1...v6.314.0) (2024-06-06)
 
 

package/lib/v1/index.js

@@ -11,5 +11,6 @@ module.exports.registers = require('./registers')
 module.exports.templates = require('./templates')
 module.exports.transactions = require('./transactions')
 module.exports.statuses = require('./statuses')
+module.exports.promotions = require('./promotions')
 
 // 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/v1/promotions/base.js

@@ -0,0 +1,91 @@
+const { oneOf } = require('../../helpers/payload-or-null')
+
+module.exports = {
+  name: {
+    ...oneOf([{
+      type: 'string',
+      minLength: 1,
+      maxLength: 255
+    }])
+  },
+  description: {
+    ...oneOf([{
+      type: 'string',
+      minLength: 1,
+      maxLength: 1024
+    }])
+  },
+  type: {
+    description: 'The type of the promotion function',
+    type: 'string',
+    enum: [
+      'cart_map_function'
+    ]
+  },
+  metadata: {
+    ...oneOf({
+      type: 'object'
+    })
+  },
+  arguments: {
+    ...oneOf({
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    })
+  },
+  locations: {
+    ...oneOf({
+      type: 'array',
+      items: {
+        type: 'string',
+        format: 'uuid'
+      }
+    })
+  },
+  client_id: {
+    description: 'A identifier used locally on POS for their own reference.',
+    ...oneOf([{
+      type: 'string',
+      minLength: 1,
+      maxLength: 128
+    }])
+  },
+  deleted: {
+    type: 'boolean',
+    default: false
+  },
+  active: {
+    type: 'boolean',
+    default: true
+  },
+  template: {
+    ...require('./template')
+  },
+  constraints: {
+    ...oneOf(require('./constraints'))
+  },
+  branch_groups: {
+    ...oneOf({
+      type: 'array',
+      items: {
+        type: 'string',
+        format: 'uuid'
+      }
+    })
+  },
+  version: oneOf({
+    type: 'integer',
+    description: 'The version number of the promotion. Version 1 is deprecated, current version is 2',
+    example: 2,
+    minimum: 1
+  }),
+  barcode: {
+    description: 'The barcode used to trigger the promotion',
+    example: '0E9761310XF',
+    ...oneOf({
+      type: 'string'
+    })
+  }
+}

package/lib/v1/promotions/constraints/index.js

@@ -0,0 +1,12 @@
+const { oneOf } = require('../../../helpers/payload-or-null')
+const { timeConstraints } = require('../../../common/time_constraints')
+
+module.exports = {
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    time: oneOf({
+      ...timeConstraints
+    })
+  }
+}

package/lib/v1/promotions/create.js

@@ -0,0 +1,26 @@
+const base = require('./base')
+const defaultResponse = require('./default-response')
+
+module.exports.request = {
+  $id: 'https://schemas.tillhub.com/v0/promotions.create.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  type: 'object',
+  required: [
+    'name',
+    'template',
+    'type'
+  ],
+  properties: base
+}
+
+module.exports.response = {
+  $id: 'https://schemas.tillhub.com/v0/promotions.create.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: true,
+  type: 'object',
+  required: [
+    'id'
+  ],
+  properties: defaultResponse
+}

package/lib/v1/promotions/default-response.js

@@ -0,0 +1,17 @@
+const base = require('./base')
+
+module.exports = {
+  ...base,
+  id: {
+    type: 'string',
+    format: 'uuid'
+  },
+  created_at: {
+    type: 'string',
+    format: 'date-time'
+  },
+  updated_at: {
+    type: 'string',
+    format: 'date-time'
+  }
+}

package/lib/v1/promotions/index.js

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

package/lib/v1/promotions/template/index.js

@@ -0,0 +1,58 @@
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v0/promotions.templates.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  oneOf: [
+    {
+      additionalProperties: false,
+      type: 'object',
+      required: [
+        'inputs',
+        'type'
+      ],
+      properties: {
+        type: {
+          type: 'string',
+          enum: [
+            'product_property:and_or_concat:output_properties'
+          ]
+        },
+        inputs: {
+          oneOf: [
+            {
+              type: 'object'
+            },
+            {
+              type: 'null'
+            }
+          ]
+        }
+      }
+    },
+    {
+      additionalProperties: false,
+      type: 'object',
+      required: [
+        'inputs',
+        'type'
+      ],
+      properties: {
+        type: {
+          type: 'string',
+          enum: [
+            'product_property:exclusive_bundle:output_properties'
+          ]
+        },
+        inputs: {
+          oneOf: [
+            {
+              type: 'object'
+            },
+            {
+              type: 'null'
+            }
+          ]
+        }
+      }
+    }
+  ]
+}

package/lib/v1/promotions/update.js

@@ -0,0 +1,22 @@
+const base = require('./base')
+const defaultResponse = require('./default-response')
+
+module.exports.request = {
+  $id: 'https://schemas.tillhub.com/v0/promotions.update.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  type: 'object',
+  required: [],
+  properties: base
+}
+
+module.exports.response = {
+  $id: 'https://schemas.tillhub.com/v0/promotions.update.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: true,
+  type: 'object',
+  required: [
+    'id'
+  ],
+  properties: defaultResponse
+}

package/package.json

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