@tillhub/schemas 6.236.1 → 6.238.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.238.0](https://github.com/tillhub/schemas/compare/v6.237.0...v6.238.0) (2023-07-27)
+
+
+### Features
+
+* **service_categories:** add schema for PUT service_categories ([#833](https://github.com/tillhub/schemas/issues/833)) ([3e6db9a](https://github.com/tillhub/schemas/commit/3e6db9a))
+
+# [6.237.0](https://github.com/tillhub/schemas/compare/v6.236.1...v6.237.0) (2023-07-27)
+
+
+### Features
+
+* **reports:** get top products endpoint's filters schema ([f99ca34](https://github.com/tillhub/schemas/commit/f99ca34))
+
 ## [6.236.1](https://github.com/tillhub/schemas/compare/v6.236.0...v6.236.1) (2023-07-25)
 
 

package/lib/v0/analytics/index.js

@@ -1,5 +1,6 @@
 module.exports = {
   discounts: require('./discounts'),
   staff: require('./staff'),
-  snapshots: require('./snapshots')
+  snapshots: require('./snapshots'),
+  reports: require('./reports')
 }

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

@@ -0,0 +1,3 @@
+module.exports = {
+  products: require('./products')
+}

package/lib/v0/analytics/reports/products/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  top: require('./top')
+}

package/lib/v0/analytics/reports/products/top.js

@@ -0,0 +1,27 @@
+module.exports.request = {
+  $id: 'https://schemas.tillhub.com/v0/analytics.reports.products.top.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  additionalProperties: false,
+  required: [],
+  properties: {
+    start: {
+      type: 'string',
+      format: 'date-time',
+      example: '2018-01-29T14:55:05.000Z',
+      description: 'Start date for top products report'
+    },
+    end: {
+      type: 'string',
+      format: 'date-time',
+      example: '2018-01-29T14:55:05.000Z',
+      description: 'End date for top products report'
+    },
+    branch_number: {
+      type: 'string',
+      pattern: '^[0-9]+$',
+      example: '239',
+      description: 'Branch number'
+    }
+  }
+}

package/lib/v0/service_categories/index.js

@@ -2,3 +2,8 @@ module.exports.create = {
   request: require('./create.request'),
   response: require('./create.response')
 }
+
+module.exports.update = {
+  request: require('./update.request'),
+  response: require('./update.response')
+}

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

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

package/lib/v0/service_categories/update.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.update.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...commonResponse({ resultItems: response })
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tillhub/schemas",
-  "version": "6.236.1",
+  "version": "6.238.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

@@ -18,3 +18,21 @@ test('Service Categories V0: create response schema validation', t => {
   t.error(error, 'should not get any error')
   t.end()
 })
+
+test('Service Categories V0: update request schema validation', t => {
+  t.plan(2)
+  const updateRequest = require('../../../lib/v0/service_categories').update.request
+  const { valid, error } = validate(updateRequest)
+  t.ok(valid, 'update request schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})
+
+test('Service Categories V0: update response schema validation', t => {
+  t.plan(2)
+  const updateResponse = require('../../../lib/v0/service_categories').update.response
+  const { valid, error } = validate(updateResponse)
+  t.ok(valid, 'update response schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})