@tillhub/schemas 6.121.0 → 6.124.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [6.124.0](https://github.com/tillhub/schemas/compare/v6.123.0...v6.124.0) (2022-03-09)
+
+
+### Features
+
+* **discounts:** Discounts export ([#677](https://github.com/tillhub/schemas/issues/677)) ([ced1b07](https://github.com/tillhub/schemas/commit/ced1b07))
+
+# [6.123.0](https://github.com/tillhub/schemas/compare/v6.122.0...v6.123.0) (2022-02-25)
+
+
+### Features
+
+* **carts:** make 'tax' and 'vat_rate' conditional required, add 'acc… ([#674](https://github.com/tillhub/schemas/issues/674)) ([d4e00b6](https://github.com/tillhub/schemas/commit/d4e00b6)), closes [#API-1373](https://github.com/tillhub/schemas/issues/API-1373)
+
+# [6.122.0](https://github.com/tillhub/schemas/compare/v6.121.0...v6.122.0) (2022-02-22)
+
+
+### Features
+
+* **carts:** add detailed schema #API-1394 ([#673](https://github.com/tillhub/schemas/issues/673)) ([774c03b](https://github.com/tillhub/schemas/commit/774c03b)), closes [#API-1394](https://github.com/tillhub/schemas/issues/API-1394) [#API-1394](https://github.com/tillhub/schemas/issues/API-1394)
+
 # [6.121.0](https://github.com/tillhub/schemas/compare/v6.120.0...v6.121.0) (2022-02-21)
 
 

package/lib/v0/analytics/discounts/index.js

@@ -0,0 +1,63 @@
+module.exports.request = {
+  $id: 'https://schemas.tillhub.com/v0/analytics.discounts.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  'additionalProperties': false,
+  'properties': {
+    'limit': {
+      'type': 'string',
+      'maxLength': 4
+    },
+    'format': {
+      'type': 'string',
+      'enum': [
+        'csv'
+      ]
+    },
+    'start': {
+      'oneOf': [
+        {
+          'type': 'string',
+          'format': 'date'
+        },
+        {
+          'type': 'string',
+          'format': 'date-time'
+        }
+      ]
+    },
+    'end': {
+      'oneOf': [
+        {
+          'type': 'string',
+          'format': 'date'
+        },
+        {
+          'type': 'string',
+          'format': 'date-time'
+        }
+      ]
+    },
+    'discount': {
+      'type': 'string'
+    },
+    'product': {
+      'type': 'string'
+    },
+    'branch': {
+      'type': 'string'
+    },
+    'discount_rate': {
+      'type': 'string'
+    },
+    'export_map': {
+      'type': 'object',
+      'properties': {
+        'fields': {
+          'type': 'object'
+        }
+      }
+    }
+  },
+  'required': []
+}

package/lib/v0/analytics/index.js

@@ -1,3 +1,4 @@
 module.exports = {
+  discounts: require('./discounts'),
   snapshots: require('./snapshots')
 }

package/lib/v1/carts/base.js

@@ -0,0 +1,182 @@
+const { oneOf } = require('../../helpers/payload-or-null')
+const items = require('./items').create
+
+module.exports = {
+  date: {
+    description: 'Date of this cart',
+    example: '2022-02-20T19:41:07.736Z',
+    ...oneOf({
+      type: 'string',
+      format: 'date-time'
+    })
+  },
+  done_at: {
+    description: 'Date when this cart was used in a transaction (currently). If date is not null, this cart must not be used.',
+    example: '2022-02-21T16:14:55.076Z',
+    ...oneOf({
+      type: 'string',
+      format: 'date-time'
+    })
+  },
+  branch: {
+    description: 'The branch cart belongs to',
+    example: '0eb9ad65-63e5-445e-a7c2-3e13591011de',
+    ...oneOf({
+      type: 'string',
+      format: 'uuid'
+    })
+  },
+  register: {
+    description: 'The register cart belongs to',
+    example: 'ede968cc-1ea1-4710-8d81-97d5a5fb166e',
+    ...oneOf({
+      type: 'string',
+      format: 'uuid'
+    })
+  },
+  cashier_staff: {
+    description: 'Cashier who handled the cart',
+    example: 'bcd84d35-f887-4c35-bdad-291a154802a7',
+    ...oneOf({
+      type: 'string',
+      format: 'uuid'
+    })
+  },
+  temporary_staff: {
+    description: 'Staff who was lending permissions temporarily (in case that \'cashier_staff\' did not have that permission)',
+    example: 'f925ce8c-fd80-40e5-bac4-b269a04bda6f',
+    ...oneOf({
+      type: 'string',
+      format: 'uuid'
+    })
+  },
+  currency: {
+    description: 'Currency being used',
+    example: 'EUR',
+    ...oneOf({
+      type: 'string',
+      minLength: 3,
+      maxLength: 3
+    })
+  },
+  custom_id: {
+    description: 'User defined (human readable) identifier for the cart, e.g. counting number 1, 2, 3 ...',
+    example: '17',
+    ...oneOf({
+      type: 'string',
+      maxLength: 128
+    })
+  },
+  client_id: {
+    description: 'Producer side unique identifier to resolve downstream mapping targets, e.g. GUID or UUID',
+    example: '00060968000420200624004214945',
+    ...oneOf({
+      type: 'string',
+      minLength: 12,
+      maxLength: 64
+    })
+  },
+  cart_id: {
+    description: 'Cart ID',
+    example: '4553332',
+    ...oneOf({
+      type: 'string',
+      maxLength: 128
+    })
+  },
+  external_reference_id: {
+    description: 'Cart ID in external system',
+    example: '4433fg44ghnh4dfdf322',
+    ...oneOf({
+      type: 'string',
+      maxLength: 128
+    })
+  },
+  lps: {
+    description: 'Lean Payment System: If TRUE the client application will process this cart with minimal validation and without forced property fetching. Use on at your own risk.',
+    ...oneOf({
+      type: 'boolean'
+    })
+  },
+  instant_checkout: {
+    description: 'If TRUE this cart will be checked out immediately and thus landing on the payment screen.',
+    ...oneOf({
+      type: 'boolean'
+    })
+  },
+  immutable: {
+    description: 'If TRUE this cart will not be editable, thus a user can not remove nor add new items.',
+    ...oneOf({
+      type: 'boolean'
+    })
+  },
+  customer: {
+    description: 'Customer ID cart belongs to',
+    example: '55ec2da5-f9a4-4868-8f00-65ae0804a9d3',
+    ...oneOf({
+      type: 'string',
+      format: 'uuid'
+    })
+  },
+  customer_name: {
+    description: 'Customer name',
+    example: 'Morpheus',
+    ...oneOf({
+      type: 'string',
+      maxLength: 64
+    })
+  },
+  customer_description: {
+    description: 'Customer description',
+    example: 'Color pills seller',
+    ...oneOf({
+      type: 'string',
+      maxLength: 128
+    })
+  },
+  customer_number: {
+    description: 'Customer number',
+    example: '322223',
+    ...oneOf({
+      type: 'string',
+      maxLength: 128
+    })
+  },
+  name: {
+    description: 'Cart name',
+    example: 'For the chosen one',
+    ...oneOf({
+      type: 'string',
+      maxLength: 128
+    })
+  },
+  description: {
+    description: 'Cart description',
+    example: 'Red or blue',
+    ...oneOf({
+      type: 'string',
+      maxLength: 512
+    })
+  },
+  comments: {
+    description: 'Additional comments',
+    example: 'Just funny choice',
+    ...oneOf({
+      type: 'string',
+      maxLength: 4096
+    })
+  },
+  items,
+  metadata: {
+    description: 'Additional meta data',
+    type: 'object'
+  },
+  opened_at: {
+    description: 'Date when this cart was opened. If date is not null, this cart must not be used.',
+    example: '2022-02-19T00:00:00.001Z',
+    ...oneOf({
+      type: 'string',
+      format: 'date-time'
+    })
+  }
+}

package/lib/v1/carts/create.js

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

package/lib/v1/carts/index.js

@@ -1,8 +1,3 @@
-
-module.exports.create = {
-  request: require('./create.request')
-}
-
-module.exports.patch = {
-  request: require('./patch.request')
-}
+module.exports.create = require('./create')
+module.exports.read = require('./read')
+module.exports.patch = require('./patch')