@tillhub/schemas 6.100.0 → 6.101.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [6.101.0](https://github.com/tillhub/schemas/compare/v6.100.3...v6.101.0) (2021-10-29)
+
+
+### Features
+
+* **pricebooks:** add branch groups #API-1115 ([fac9fd0](https://github.com/tillhub/schemas/commit/fac9fd0)), closes [#API-1115](https://github.com/tillhub/schemas/issues/API-1115)
+
+## [6.100.3](https://github.com/tillhub/schemas/compare/v6.100.2...v6.100.3) (2021-10-22)
+
+
+### Bug Fixes
+
+* **products:** q is required property in products search request chema ([#641](https://github.com/tillhub/schemas/issues/641)) ([ceb3019](https://github.com/tillhub/schemas/commit/ceb3019))
+
+## [6.100.2](https://github.com/tillhub/schemas/compare/v6.100.1...v6.100.2) (2021-10-22)
+
+
+### Bug Fixes
+
+* **products:** Products search schema fixed ([#640](https://github.com/tillhub/schemas/issues/640)) ([24377f9](https://github.com/tillhub/schemas/commit/24377f9))
+
+## [6.100.1](https://github.com/tillhub/schemas/compare/v6.100.0...v6.100.1) (2021-10-22)
+
+
+### Bug Fixes
+
+* **products:** Products search request schema added ([#639](https://github.com/tillhub/schemas/issues/639)) ([2f0eef0](https://github.com/tillhub/schemas/commit/2f0eef0))
+
 # [6.100.0](https://github.com/tillhub/schemas/compare/v6.99.0...v6.100.0) (2021-10-20)
 
 

package/lib/v1/products/index.js

@@ -5,6 +5,10 @@ const priceBookBase = require('./prices/book').base
 const priceBookEntryBase = require('./prices/book/entry').base
 const commonResponse = require('../../common/response')
 
+module.exports.search = {
+  request: require('./search')
+}
+
 module.exports.create = {
   request: require('./create.request'),
   response: require('./create.response')

package/lib/v1/products/prices/book/base.js

@@ -23,6 +23,14 @@ module.exports = {
       format: 'uuid'
     }
   }),
+  branch_groups: oneOf({
+    description: 'If defined then only these branch groups (plus specified locations if any) will be using this price book',
+    type: 'array',
+    items: {
+      type: 'string',
+      format: 'uuid'
+    }
+  }),
   active: {
     type: 'boolean'
   },

package/lib/v1/products/search.js

@@ -0,0 +1,77 @@
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v1/products.search.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  // additional properties are a little bit of a danger zone of not being validated by the upstream service
+  additionalProperties: true,
+  required: [
+    'q'
+  ],
+  properties: {
+    q: {
+      type: 'string',
+      minLength: 3,
+      maxLength: 256
+    },
+    types: {
+      type: 'array',
+      items: {
+        type: 'string',
+        enum: ['composed_product', 'variant_product', 'linked_product', 'product', 'voucher', 'variant', 'linked']
+      }
+    },
+    branch: {
+      type: 'string',
+      format: 'uuid'
+    },
+    location: {
+      type: 'string',
+      format: 'uuid'
+    },
+    stockable: {
+      type: 'string',
+      enum: ['false', 'true']
+    },
+    sellable: {
+      type: 'string',
+      enum: ['false', 'true']
+    },
+    purchasable: {
+      type: 'string',
+      enum: ['false', 'true']
+    },
+    limit: {
+      type: 'number',
+      minimum: 1,
+      default: 100
+    },
+    offset: {
+      type: 'number',
+      minimum: 0,
+      default: 0
+    },
+    timeout: {
+      type: 'number',
+      maximum: 1500,
+      minimum: 300,
+      default: 1500
+    },
+    filter: {
+      oneOf: [
+        {
+          type: 'string',
+          enum: ['contains', 'starts_with', 'search']
+        },
+        {
+          type: 'array',
+          maxItems: 2,
+          minItems: 2,
+          items: {
+            type: 'string',
+            enum: ['contains', 'starts_with', 'search']
+          }
+        }
+      ]
+    }
+  }
+}

package/package.json

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