@tillhub/schemas 6.252.0 → 6.253.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [6.253.0](https://github.com/tillhub/schemas/compare/v6.252.1...v6.253.0) (2023-08-24)
+
+
+### Bug Fixes
+
+* **chore:** commit message fix for new version ([#856](https://github.com/tillhub/schemas/issues/856)) ([8047905](https://github.com/tillhub/schemas/commit/8047905))
+
+
+### Features
+
+* **stock-management:** add optional transaction_id to stock-book create event ([#857](https://github.com/tillhub/schemas/issues/857)) ([43091fa](https://github.com/tillhub/schemas/commit/43091fa))
+
+## [6.252.1](https://github.com/tillhub/schemas/compare/v6.252.0...v6.252.1) (2023-08-21)
+
+
+### Bug Fixes
+
+* **customers:** base ([6233e17](https://github.com/tillhub/schemas/commit/6233e17))
+
 # [6.252.0](https://github.com/tillhub/schemas/compare/v6.251.0...v6.252.0) (2023-08-21)
 
 

package/README.md

@@ -26,7 +26,8 @@ console.log(createCartSchema)
 ## Release flow
 
 Releases are automated with @semantic-release. 
-For triggering a new release just use commit messages started from "feat" or "fix" prefix which is part of [proper message format](https://github.com/semantic-release/semantic-release#commit-message-format).
+For triggering a new release just use commit messages started from "feat" or "fix" prefix which 
+is part of [proper message format](https://github.com/semantic-release/semantic-release#commit-message-format) (please do not forget about it!).
 
 CricleCI takes care of publishing the package. it will only trigger on the master branch.
 After the PR is merged into master, CircleCI will start the deployment process:

package/lib/v0/analytics/snapshots/create.js

@@ -1,3 +1,4 @@
+const dateObject = require('../../../common/date_object')
 const commonResponse = require('../../../common/response')
 
 module.exports.request = {
@@ -109,12 +110,18 @@ module.exports.response = {
           maxLength: 2048
         },
         created_at: {
-          type: 'string',
-          format: 'date-time'
+          ...dateObject
         },
         updated_at: {
-          type: 'string',
-          format: 'date-time'
+          ...dateObject
+        },
+        start: {
+          ...dateObject,
+          description: 'Start date for the filter'
+        },
+        end: {
+          ...dateObject,
+          description: 'End date for the filter'
         },
         items: {
           type: 'array',

package/lib/v0/customers/base.js

@@ -410,5 +410,20 @@ module.exports = {
       maxLength: 20,
       minLength: 5
     })
+  },
+  source: {
+    description: 'Customer source of creation',
+    example: 'N/A, DASHBOARD, APPOINTMENT_CALENDAR, WEB_RESERVATION, POS',
+    ...oneOf({
+      type: 'string',
+      maxLength: 128
+    })
+  },
+  branch_id: {
+    description: 'in cases where the customer is created via the POS, the branch_id is required',
+    ...oneOf({
+      type: 'string',
+      format: 'uuid'
+    })
   }
 }

package/lib/v0/services/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/services/update.request.js

@@ -0,0 +1,36 @@
+const base = require('../products/update')
+const { oneOf } = require('../../helpers/payload-or-null')
+
+module.exports = {
+  ...base,
+  properties: {
+    ...base.properties,
+    name: {
+      description: 'The name of the service',
+      type: 'string',
+      example: 'Haircut'
+    },
+    category: oneOf({
+      description: 'The UUID of the category that the service belongs to',
+      type: 'string',
+      format: 'uuid',
+      example: '05297f58-3408-44d0-8bf4-125d4e86c08a'
+    }),
+    duration: {
+      description: 'the duration of the service in mintues',
+      type: 'integer',
+      minimum: 5,
+      maximum: 1440,
+      example: 30
+    },
+    'linked_product': {
+      description: 'The UUID of the product associated with the service',
+      type: 'string',
+      format: 'uuid',
+      example: '05297f58-3408-44d0-8bf4-125d4e86c08a'
+    }
+  },
+  required: [],
+  $id: 'https://schemas.tillhub.com/v0/services.update.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#'
+}

package/lib/v0/services/update.response.js

@@ -0,0 +1,22 @@
+const request = require('./update.request')
+const commonResponse = require('../../common/response')
+
+const response = {
+  ...request,
+  required: [],
+  properties: {
+    id: {
+      description: 'The service ID',
+      type: 'string',
+      format: 'uuid',
+      example: '05297f58-3408-44d0-8bf4-125d4e86c08a'
+    },
+    ...request.properties
+  }
+}
+
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v0/services.update.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...commonResponse({ resultItems: response })
+}

package/lib/v0/stocks_book/create.js

@@ -63,6 +63,11 @@ const eventOverrideData = {
     description: 'The reason name: the user generated text which can be specifically set when booking things out manually',
     type: 'string',
     example: 'Not arbitrary reason'
+  }),
+  transaction_id: oneOf({
+    description: 'id of transaction, if stock book is related to transaction',
+    type: 'string',
+    example: 'f0a52a37-df58-465d-9121-b8180fc95133'
   })
 }
 

package/package.json

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

package/test/services/v0/services.v0.spec.js

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