@tillhub/schemas 6.126.0 → 6.129.0

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+# [6.129.0](https://github.com/tillhub/schemas/compare/v6.128.0...v6.129.0) (2022-03-21)
+
+
+### Features
+
+* **reasons:** add type "POS price change" #API-1409 ([#683](https://github.com/tillhub/schemas/issues/683)) ([1de76ff](https://github.com/tillhub/schemas/commit/1de76ff)), closes [#API-1409](https://github.com/tillhub/schemas/issues/API-1409) [#API-1409](https://github.com/tillhub/schemas/issues/API-1409)
+
+# [6.128.0](https://github.com/tillhub/schemas/compare/v6.127.0...v6.128.0) (2022-03-18)
+
+
+### Features
+
+* **branches:** add receipt_footer_image to branches model ([#682](https://github.com/tillhub/schemas/issues/682)) ([132523f](https://github.com/tillhub/schemas/commit/132523f))
+
+# [6.127.0](https://github.com/tillhub/schemas/compare/v6.126.0...v6.127.0) (2022-03-15)
+
+
+### Bug Fixes
+
+* **functions:** vouchers ([caa53d9](https://github.com/tillhub/schemas/commit/caa53d9))
+
+
+### Features
+
+* **functions:** discounted_voucher ([f8ed802](https://github.com/tillhub/schemas/commit/f8ed802))
+* **transactions:** references ([4a70818](https://github.com/tillhub/schemas/commit/4a70818))
+
 # [6.126.0](https://github.com/tillhub/schemas/compare/v6.125.0...v6.126.0) (2022-03-15)
 
 

package/lib/common/base.js

@@ -1,8 +1,18 @@
+const dateObject = require('./date_object')
+
 /**
  * Create common base object
  * @param {Object} [options]
  */
-function baseObject (options = {}) {
+function baseObject ({
+  splitDate = false
+} = {}) {
+  const dateType = splitDate ? dateObject : {
+    type: 'string',
+    format: 'date-time',
+    example: '2019-03-17T21:12:04.849Z'
+  }
+
   return {
     id: {
       description: 'Unique entity ID',
@@ -11,16 +21,12 @@ function baseObject (options = {}) {
       example: '936835f7-2d75-41d2-9001-38ed6e458328'
     },
     created_at: {
-      description: 'The date and time entity was created',
-      type: 'string',
-      format: 'date-time',
-      example: '2019-03-17T21:12:04.849Z'
+      ...dateType,
+      description: 'The date and time entity was created'
     },
     updated_at: {
-      description: 'The date and time entity was updated',
-      type: 'string',
-      format: 'date-time',
-      example: '2019-03-17T21:12:04.849Z'
+      ...dateType,
+      description: 'The date and time entity was updated'
     }
   }
 }

package/lib/common/images.js

@@ -1,3 +1,5 @@
+const { anyOf } = require('../helpers/payload-or-null')
+
 const definedSizes = {
   '1x': {
     description: 'Image transformed to predefined small size',
@@ -31,7 +33,11 @@ const definedSizes = {
   }
 }
 
-function getImages (sizes = ['1x', '2x', '3x', 'avatar'], strict = false) {
+const getImages = ({
+  sizes = ['1x', '2x', '3x', 'avatar'],
+  strict = false,
+  description = 'Images object with URLs of various types of images'
+}) => {
   const sizesMap = sizes.reduce((memo, size) => {
     if (!definedSizes[size]) {
       throw new ReferenceError(`Size '${size}' is not defined`)
@@ -42,8 +48,8 @@ function getImages (sizes = ['1x', '2x', '3x', 'avatar'], strict = false) {
   }, {})
 
   return {
-    description: 'Images object with URLs of various types of images',
-    anyOf: [{
+    description,
+    ...anyOf({
       type: 'object',
       additionalProperties: !strict,
       properties: {
@@ -54,9 +60,8 @@ function getImages (sizes = ['1x', '2x', '3x', 'avatar'], strict = false) {
           type: 'string',
           format: 'uri'
         }
-      } }, {
-      type: 'null'
-    }]
+      }
+    })
   }
 }
 

package/lib/v0/branches/base.js

@@ -124,7 +124,12 @@ module.exports = {
       }
     ]
   },
-  images: getImages(),
+  images: getImages({
+    description: 'A Tillhub image object with URLs to display images this for this branch.'
+  }),
+  receipt_footer_images: getImages({
+    description: 'A Tillhub image object with URLs to display receipt footer image this for this branch.'
+  }),
   image: {
     description: 'DEPRECATED. Omit or set null.',
     anyOf: [

package/lib/v0/customers/base.js

@@ -154,7 +154,7 @@ module.exports = {
       format: 'date-time'
     })
   },
-  images: getImages(['1x', '2x', '3x', 'avatar', 'gallery']),
+  images: getImages({ sizes: ['1x', '2x', '3x', 'avatar', 'gallery'] }),
   image: {
     description: 'DEPRECATED. Omit or set null.',
     ...anyOf({

package/lib/v0/functions/base.js

@@ -59,7 +59,7 @@ const linkedVoucherPayload = {
   additionalProperties: false,
   type: 'object',
   required: [
-    'products'
+    'linked_voucher'
   ],
   properties: {
     linked_voucher: {
@@ -120,6 +120,59 @@ const linkedVoucherPayload = {
   }
 }
 
+const discountedVoucherPayload = {
+  description: 'Specific description of the discounted voucher function (1 specific voucher added together with a negative amount product).',
+  additionalProperties: false,
+  type: 'object',
+  required: [
+    'discounted_voucher'
+  ],
+  properties: {
+    discounted_voucher: {
+      type: 'object',
+      description: 'Describes the necessary fields to sell voucher that is discounted by an additional product.',
+      additionalProperties: false,
+      properties: {
+        action: {
+          type: 'string',
+          format: 'uuid',
+          description: 'The primaray voucher action ressource ID.',
+          example: 'efe039d8-e38d-4333-86d8-48334da189a8'
+        },
+        amount: {
+          example: 50.0,
+          description: 'The primaray voucher amount (.2Decimal e.g. 50.00€).',
+          type: 'number',
+          minimum: 0,
+          maximum: 1000000,
+          multipleOf: 0.01
+        },
+        linked_product: {
+          type: 'string',
+          format: 'uuid',
+          description: 'The additional product ressource ID.',
+          example: 'fc7cc46a-ebe2-4b62-9b1b-0f849680b49'
+        },
+        linked_amount: {
+          example: 10.0,
+          description: 'The unit price of the linked product.',
+          type: 'number',
+          minimum: 0,
+          maximum: 1000000,
+          multipleOf: 0.01
+        },
+        linked_quantity: {
+          example: -1,
+          description: 'The quantity of the linked product (typically -1) to act as a discount.',
+          type: 'integer',
+          minimum: -16,
+          maximum: 0
+        }
+      }
+    }
+  }
+}
+
 const configurationProperties = {
   description: {
     oneOf: [
@@ -327,50 +380,74 @@ module.exports = {
         enum: [
           'instant_checkout',
           'add_to_cart',
-          'linked_voucher'
+          'linked_voucher',
+          'discounted_voucher'
         ]
       }
     },
-    if: {
-      properties: {
-        class: {
-          type: 'string',
-          enum: [
-            'instant_checkout',
-            'add_to_cart'
-          ]
-        }
-      }
-    },
-    then: {
-      properties: {
-        ...configurationProperties,
-        payload: {
-          ...oneOf(instantCheckoutPayload)
-        }
-      }
-    },
-    else: {
-      if: {
-        properties: {
-          class: {
-            type: 'string',
-            enum: [
-              'linked_voucher'
-            ]
+    allOf: [
+      {
+        if: {
+          properties: {
+            class: {
+              type: 'string',
+              enum: [
+                'instant_checkout',
+                'add_to_cart'
+              ]
+            }
+          }
+        },
+        then: {
+          properties: {
+            ...configurationProperties,
+            payload: {
+              ...oneOf(instantCheckoutPayload)
+            }
           }
         }
       },
-      then: {
-        properties: {
-          ...configurationProperties,
-          payload: {
-            ...oneOf(linkedVoucherPayload)
+      {
+        if: {
+          properties: {
+            class: {
+              type: 'string',
+              enum: [
+                'linked_voucher'
+              ]
+            }
+          }
+        },
+        then: {
+          properties: {
+            ...configurationProperties,
+            payload: {
+              ...oneOf(linkedVoucherPayload)
+            }
           }
         }
       },
-      else: false // further if-else statements add in here, as a nested prop
-    }
+      {
+        if: {
+          properties: {
+            class: {
+              type: 'string',
+              enum: [
+                'discounted_voucher'
+              ]
+            }
+          }
+        },
+        then: {
+          properties: {
+            ...configurationProperties,
+            payload: {
+              ...oneOf(discountedVoucherPayload)
+            }
+          }
+        }
+      }
+    ]
   },
   locations: {
     anyOf: [

package/lib/v0/reasons/base.js

@@ -3,6 +3,8 @@ const { oneOf } = require('../../helpers/payload-or-null')
 module.exports = {
   name: {
     ...oneOf([{
+      description: 'The reason name',
+      example: 'Returned goods',
       type: 'string',
       minLength: 1,
       maxLength: 128
@@ -10,6 +12,8 @@ module.exports = {
   },
   description: {
     ...oneOf([{
+      description: 'The reason description',
+      example: 'Goods were returned by the customer',
       type: 'string',
       minLength: 1,
       maxLength: 4096
@@ -56,26 +60,33 @@ module.exports = {
     type: 'boolean'
   },
   active: {
+    description: 'The reason is active',
     type: 'boolean'
   },
   type: {
+    description: 'The reason type',
+    example: 'expense',
     type: 'string',
     enum: [
       'refund',
+      'pos_price_change',
       'stock_change',
       'expense',
       'deposit'
     ]
   },
   noted_required: {
+    description: 'The action must be noted',
     type: 'boolean',
     default: false
   },
   image_required: {
+    description: 'The image must be enclosed',
     type: 'boolean',
     default: false
   },
   approval_required: {
+    description: 'The action must be approved by supervisor',
     type: 'boolean',
     default: false
   }

package/lib/v0/reasons/create.js

@@ -1,5 +1,5 @@
+const baseObject = require('../../common/base')
 const base = require('./base')
-const defaultResponse = require('./default-response')
 
 module.exports.request = {
   $id: 'https://schemas.tillhub.com/v0/reasons.create.request.schema.json',
@@ -22,5 +22,8 @@ module.exports.response = {
     'id',
     'name'
   ],
-  properties: defaultResponse
+  properties: {
+    ...baseObject(),
+    ...base
+  }
 }

package/lib/v0/reasons/index.js

@@ -1,2 +1,3 @@
 module.exports.create = require('./create')
+module.exports.read = require('./read')
 module.exports.update = require('./update')

package/lib/v0/reasons/read.js

@@ -0,0 +1,38 @@
+const baseObject = require('../../common/base')
+const commonResponse = require('../../common/response')
+
+const base = require('./base')
+
+module.exports.all = {
+  response: {
+    $id: 'https://schemas.tillhub.com/v0/reasons.read.all.response.schema.json',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    ...commonResponse({
+      resultItems: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          ...baseObject({ splitDate: true }),
+          ...base
+        }
+      }
+    })
+  }
+}
+
+module.exports.one = {
+  response: {
+    $id: 'https://schemas.tillhub.com/v0/reasons.read.one.response.schema.json',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    ...commonResponse({
+      resultItems: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          ...baseObject({ splitDate: true }),
+          ...base
+        }
+      }
+    })
+  }
+}

package/lib/v0/reasons/update.js

@@ -1,5 +1,5 @@
+const baseObject = require('../../common/base')
 const base = require('./base')
-const defaultResponse = require('./default-response')
 
 module.exports.request = {
   $id: 'https://schemas.tillhub.com/v0/reasons.update.request.schema.json',
@@ -18,5 +18,8 @@ module.exports.response = {
   required: [
     'id'
   ],
-  properties: defaultResponse
+  properties: {
+    ...baseObject(),
+    ...base
+  }
 }

package/lib/v1/transactions/components/embedded/reference/depends.js

@@ -19,7 +19,8 @@ module.exports = {
         'canceled_expense',
         'canceled_deposit',
         'canceled_bank_expense',
-        'canceled_bank_deposit'
+        'canceled_bank_deposit',
+        'linked_item'
       ]
     },
     id: {

package/package.json

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

package/lib/v0/reasons/default-response.js

@@ -1,17 +0,0 @@
-const base = require('./base')
-
-module.exports = {
-  ...base,
-  id: {
-    type: 'string',
-    format: 'uuid'
-  },
-  created_at: {
-    type: 'string',
-    format: 'date-time'
-  },
-  updated_at: {
-    type: 'string',
-    format: 'date-time'
-  }
-}