@tillhub/schemas 6.122.0 → 6.125.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [6.125.0](https://github.com/tillhub/schemas/compare/v6.124.0...v6.125.0) (2022-03-10)
+
+
+### Features
+
+* **staff:** unify 'gender' field #API-1412 ([b927123](https://github.com/tillhub/schemas/commit/b927123)), closes [#API-1412](https://github.com/tillhub/schemas/issues/API-1412)
+
+# [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)
 
 

package/lib/common/gender.js

@@ -0,0 +1,18 @@
+const { oneOf } = require('../helpers/payload-or-null')
+
+function getGender () {
+  return {
+    description: 'Gender',
+    example: 'male',
+    ...oneOf({
+      type: 'string',
+      enum: [
+        'male',
+        'female',
+        'unspecified'
+      ]
+    })
+  }
+}
+
+module.exports = { getGender }

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/v0/client_accounts/features/base.js

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

package/lib/v0/customers/base.js

@@ -1,5 +1,6 @@
 const { anyOf, oneOf } = require('../../helpers/payload-or-null')
 const { getAddress } = require('../../common/address')
+const { getGender } = require('../../common/gender')
 const { getImages } = require('../../common/images')
 
 module.exports = {
@@ -401,18 +402,7 @@ module.exports = {
       }
     })
   },
-  gender: {
-    description: 'Gender',
-    example: 'male',
-    ...oneOf({
-      type: 'string',
-      enum: [
-        'male',
-        'female',
-        'unspecified'
-      ]
-    })
-  },
+  gender: getGender(),
   vat_id: {
     description: 'Customer VAT ID',
     ...oneOf({

package/lib/v0/staff/base.js

@@ -1,3 +1,4 @@
+const { getGender } = require('../../common/gender')
 const { oneOf } = require('../../helpers/payload-or-null')
 
 module.exports = {
@@ -136,20 +137,7 @@ module.exports = {
       }
     ]
   },
-  gender: {
-    oneOf: [
-      {
-        type: 'string',
-        enum: [
-          'male',
-          'female'
-        ]
-      },
-      {
-        type: 'null'
-      }
-    ]
-  },
+  gender: getGender(),
   images: {
     description: 'A Tillhub image object with URLs to display images this for staff.',
     anyOf: [

package/lib/v0/users/profile/base.js

@@ -1,3 +1,4 @@
+const { getGender } = require('../../../common/gender')
 const { oneOf } = require('../../../helpers/payload-or-null')
 
 module.exports = {
@@ -181,13 +182,7 @@ module.exports = {
     type: 'string',
     format: 'date-time'
   }),
-  gender: oneOf({
-    type: 'string',
-    enum: [
-      'male',
-      'female'
-    ]
-  }),
+  gender: getGender(),
   active: {
     description: 'Soft disable or enable this user_profiles.',
     type: 'boolean',

package/lib/v1/carts/items/create.js

@@ -6,20 +6,30 @@ const customProperties = require('../../../common/custom_properties')
 
 const masterData = {
   salesman_staff: {
+    description: 'Staff person ID',
     ...oneOf({
       type: 'string',
       format: 'uuid'
     })
   },
   tax: {
+    description: 'Tax rate ID',
     type: 'string',
     format: 'uuid'
   },
   account: {
+    description: 'Account ID',
     type: 'string',
     format: 'uuid'
   },
+  account_number: {
+    description: 'Account number',
+    ...oneOf({
+      type: 'string'
+    })
+  },
   product_group: {
+    description: 'Product group ID',
     ...oneOf({
       type: 'string',
       format: 'uuid'
@@ -407,15 +417,18 @@ const internalDiscounts = {
 
 const base = {
   name: {
+    description: 'Cart item display name',
     type: 'string',
     minLength: 1,
     maxLength: 128
   },
   position: {
+    description: 'Cart item position',
     type: 'number',
     minimum: 0
   },
   comments: {
+    description: 'Additional comments',
     ...anyOf({
       type: 'string',
       maxLength: 4096
@@ -435,15 +448,6 @@ const base = {
 const externalCart = {
   additionalProperties: false,
   type: 'object',
-  required: [
-    'custom_id',
-    'qty',
-    'name',
-    'currency',
-    'amount',
-    'tax',
-    'account'
-  ],
   properties: {
     product: {
       description: 'The Tillhub product unique identifier',
@@ -502,15 +506,29 @@ const externalCart = {
     },
     discounts: externalDiscounts,
     ...base
-  }
+  },
+  anyOf: [{
+    required: [
+      'custom_id',
+      'qty',
+      'name',
+      'currency',
+      'amount',
+      'tax'
+    ]
+  }, {
+    required: [
+      'custom_id',
+      'qty',
+      'name',
+      'currency',
+      'amount',
+      'vat_rate'
+    ]
+  }]
 }
 
 const cartOfIds = {
-  required: [
-    'product',
-    'currency',
-    'qty'
-  ],
   additionalProperties: false,
   type: 'object',
   properties: {
@@ -548,25 +566,17 @@ const cartOfIds = {
       maxLength: 128
     },
     discounts: externalDiscounts
-  }
+  },
+  required: [
+    'product',
+    'currency',
+    'qty'
+  ]
 }
 
 const internalCart = {
   additionalProperties: false,
   type: 'object',
-  required: [
-    'product',
-    'qty',
-    'custom_id',
-    'vat_rate',
-    'salesman_staff',
-    'tax',
-    'account',
-    'name',
-    'discounts',
-    'amount',
-    'currency'
-  ],
   properties: {
     product: {
       description: 'Identifier of the product',
@@ -704,7 +714,32 @@ const internalCart = {
         type: 'object'
       })
     }
-  }
+  },
+  anyOf: [{
+    required: [
+      'product',
+      'qty',
+      'custom_id',
+      'salesman_staff',
+      'name',
+      'discounts',
+      'amount',
+      'currency',
+      'tax'
+    ]
+  }, {
+    required: [
+      'product',
+      'qty',
+      'custom_id',
+      'salesman_staff',
+      'name',
+      'discounts',
+      'amount',
+      'currency',
+      'vat_rate'
+    ]
+  }]
 }
 
 module.exports = {

package/package.json

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