@tillhub/schemas 6.306.5 → 6.307.0

package/CHANGELOG.md

@@ -1,43 +1,176 @@
-## [6.306.5](https://github.com/tillhub/schemas/compare/v6.306.4...v6.306.5) (2024-05-02)
+# [6.307.0](https://github.com/tillhub/schemas/compare/v6.306.7...v6.307.0) (2024-05-13)
+
+
+### Features
+
+* **promotion:** add barcode schema to the promotion ([#950](https://github.com/tillhub/schemas/issues/950)) ([b33023a](https://github.com/tillhub/schemas/commit/b33023a))
+
+## [6.306.7](https://github.com/tillhub/schemas/compare/v6.306.6...v6.306.7) (2024-05-02)
 
 
 ### Bug Fixes
 
-* **overview:** fixing example ([b1b02be](https://github.com/tillhub/schemas/commit/b1b02be))
+* **overview:** fixing example ([0bb6309](https://github.com/tillhub/schemas/commit/0bb6309))
 
-# [6.306.4](https://github.com/tillhub/schemas/compare/6.306.3...6.306.4) (2024-05-02)
+## [6.306.4](https://github.com/tillhub/schemas/compare/v6.306.3...v6.306.4) (2024-05-02)
 
 
 ### Bug Fixes
 
-* **full-receipts:** add the dynamic footer feature ([#943](https://github.com/tillhub/schemas/issues/943)) ([9497e3a](https://github.com/tillhub/schemas/commit/9497e3a))
-* **full-receipts:** add the dynamic footer feature ([#944](https://github.com/tillhub/schemas/issues/944)) ([db57b5c](https://github.com/tillhub/schemas/commit/db57b5c))
+* **overview:** fixing example ([f57381e](https://github.com/tillhub/schemas/commit/f57381e))
 
+## [6.306.3](https://github.com/tillhub/schemas/compare/v6.306.2...v6.306.3) (2024-04-29)
 
-### Features
 
-* **configurations:** settings ([6517c36](https://github.com/tillhub/schemas/commit/6517c36))
+### Bug Fixes
+
+* **full-receipts:** add the dynamic footer feature ([#944](https://github.com/tillhub/schemas/issues/944)) ([e028b92](https://github.com/tillhub/schemas/commit/e028b92))
 
-# [6.306.3](https://github.com/tillhub/schemas/compare/v6.288.0...v6.289.0) (2024-05-02)
+## [6.306.2](https://github.com/tillhub/schemas/compare/v6.306.1...v6.306.2) (2024-04-26)
 
 
 ### Bug Fixes
 
-* **full-receipts:** add the dynamic footer feature ([#943](https://github.com/tillhub/schemas/issues/943)) ([9497e3a](https://github.com/tillhub/schemas/commit/9497e3a))
-* **full-receipts:** add the dynamic footer feature ([#944](https://github.com/tillhub/schemas/issues/944)) ([db57b5c](https://github.com/tillhub/schemas/commit/db57b5c))
+* **full-receipts:** add the dynamic footer feature ([#943](https://github.com/tillhub/schemas/issues/943)) ([76bfa38](https://github.com/tillhub/schemas/commit/76bfa38))
+
+## [6.306.1](https://github.com/tillhub/schemas/compare/v6.306.0...v6.306.1) (2024-04-26)
+
+
+### Bug Fixes
+
+* **full-receipts:** add the dynamic footer feature ([#942](https://github.com/tillhub/schemas/issues/942)) ([5de7c09](https://github.com/tillhub/schemas/commit/5de7c09))
+* **report:** add export_history permission ([#941](https://github.com/tillhub/schemas/issues/941)) ([8ffe02f](https://github.com/tillhub/schemas/commit/8ffe02f))
+
+# [6.306.0](https://github.com/tillhub/schemas/compare/v6.305.0...v6.306.0) (2024-04-25)
 
 
 ### Features
 
-* **configurations:** settings ([6517c36](https://github.com/tillhub/schemas/commit/6517c36))
+* **products:** rename list to selection ([#940](https://github.com/tillhub/schemas/issues/940)) ([b40f7f4](https://github.com/tillhub/schemas/commit/b40f7f4))
+
+# [6.305.0](https://github.com/tillhub/schemas/compare/v6.304.1...v6.305.0) (2024-04-22)
+
+
+### Features
+
+* **configurations:** add terms of service url ([#939](https://github.com/tillhub/schemas/issues/939)) ([1482f5d](https://github.com/tillhub/schemas/commit/1482f5d))
 
-# [6.289.0](https://github.com/tillhub/schemas/compare/v6.288.0...v6.289.0) (2024-05-02)
+## [6.304.1](https://github.com/tillhub/schemas/compare/v6.304.0...v6.304.1) (2024-04-19)
 
 
 ### Bug Fixes
 
-* **full-receipts:** add the dynamic footer feature ([#943](https://github.com/tillhub/schemas/issues/943)) ([9497e3a](https://github.com/tillhub/schemas/commit/9497e3a))
-* **full-receipts:** add the dynamic footer feature ([#944](https://github.com/tillhub/schemas/issues/944)) ([db57b5c](https://github.com/tillhub/schemas/commit/db57b5c))
+* **products:** export list schema ([#938](https://github.com/tillhub/schemas/issues/938)) ([18b3087](https://github.com/tillhub/schemas/commit/18b3087))
+
+# [6.304.0](https://github.com/tillhub/schemas/compare/v6.303.0...v6.304.0) (2024-04-19)
+
+
+### Features
+
+* **products:** add list request schema ([#937](https://github.com/tillhub/schemas/issues/937)) ([b1cb23b](https://github.com/tillhub/schemas/commit/b1cb23b))
+
+# [6.303.0](https://github.com/tillhub/schemas/compare/v6.302.0...v6.303.0) (2024-04-18)
+
+
+### Features
+
+* **feature_flags:** add online payments feature flag ([#936](https://github.com/tillhub/schemas/issues/936)) ([a8f36d3](https://github.com/tillhub/schemas/commit/a8f36d3))
+
+# [6.302.0](https://github.com/tillhub/schemas/compare/v6.301.0...v6.302.0) (2024-04-17)
+
+
+### Features
+
+* **branches:** change double backlashes to single ([#935](https://github.com/tillhub/schemas/issues/935)) ([a232a9a](https://github.com/tillhub/schemas/commit/a232a9a))
+
+# [6.301.0](https://github.com/tillhub/schemas/compare/v6.300.0...v6.301.0) (2024-04-11)
+
+
+### Features
+
+* **configurations:** add map address field ([#930](https://github.com/tillhub/schemas/issues/930)) ([a4532a3](https://github.com/tillhub/schemas/commit/a4532a3))
+
+# [6.300.0](https://github.com/tillhub/schemas/compare/v6.299.0...v6.300.0) (2024-04-11)
+
+
+### Features
+
+* **shift_plan:** add shifts for multiple branches ([#934](https://github.com/tillhub/schemas/issues/934)) ([f29c220](https://github.com/tillhub/schemas/commit/f29c220))
+
+# [6.299.0](https://github.com/tillhub/schemas/compare/v6.298.0...v6.299.0) (2024-04-09)
+
+
+### Features
+
+* **staffs:** add branch id to time ranges ([#931](https://github.com/tillhub/schemas/issues/931)) ([78bb4db](https://github.com/tillhub/schemas/commit/78bb4db))
+
+# [6.298.0](https://github.com/tillhub/schemas/compare/v6.297.0...v6.298.0) (2024-04-06)
+
+
+### Features
+
+* **products:** removed min_order_qty as it should be per supplier ([0289ad5](https://github.com/tillhub/schemas/commit/0289ad5))
+
+# [6.297.0](https://github.com/tillhub/schemas/compare/v6.296.0...v6.297.0) (2024-03-28)
+
+
+### Features
+
+* **products:** added min stock and order ([4a90afb](https://github.com/tillhub/schemas/commit/4a90afb))
+* **products:** min_stock and min_order nullable ([22386a9](https://github.com/tillhub/schemas/commit/22386a9))
+
+# [6.296.0](https://github.com/tillhub/schemas/compare/v6.295.0...v6.296.0) (2024-03-25)
+
+
+### Features
+
+* **configurations:** add toggle for individual opening hours and closing days ([#926](https://github.com/tillhub/schemas/issues/926)) ([ed11944](https://github.com/tillhub/schemas/commit/ed11944))
+
+# [6.295.0](https://github.com/tillhub/schemas/compare/v6.294.0...v6.295.0) (2024-03-21)
+
+
+### Features
+
+* **configurations:** discounts ([a300ddf](https://github.com/tillhub/schemas/commit/a300ddf))
+
+# [6.294.0](https://github.com/tillhub/schemas/compare/v6.293.0...v6.294.0) (2024-03-19)
+
+
+### Features
+
+* **web_view:** icon configuration ([b0314a6](https://github.com/tillhub/schemas/commit/b0314a6))
+
+# [6.293.0](https://github.com/tillhub/schemas/compare/v6.292.0...v6.293.0) (2024-03-06)
+
+
+### Features
+
+* **customers:** make lastname nullable ([275a9e1](https://github.com/tillhub/schemas/commit/275a9e1))
+
+# [6.292.0](https://github.com/tillhub/schemas/compare/v6.291.0...v6.292.0) (2024-03-01)
+
+
+### Features
+
+* **configurations:** fix defaults ([b1538e2](https://github.com/tillhub/schemas/commit/b1538e2))
+
+# [6.291.0](https://github.com/tillhub/schemas/compare/v6.290.0...v6.291.0) (2024-02-26)
+
+
+### Features
+
+* **configurations:** balances ([9053e0c](https://github.com/tillhub/schemas/commit/9053e0c))
+* **configurations:** settings ([514bf1c](https://github.com/tillhub/schemas/commit/514bf1c))
+
+# [6.290.0](https://github.com/tillhub/schemas/compare/v6.289.0...v6.290.0) (2024-02-15)
+
+
+### Features
+
+* **customers:** fix linting issue ([27c4c5c](https://github.com/tillhub/schemas/commit/27c4c5c))
+* **customers:** make customer lastname optional ([dc99d1a](https://github.com/tillhub/schemas/commit/dc99d1a))
+
+# [6.289.0](https://github.com/tillhub/schemas/compare/v6.288.0...v6.289.0) (2024-02-13)
 
 
 ### Features

package/lib/v0/branches/base.js

@@ -368,6 +368,19 @@ module.exports = {
                   type: 'null'
                 }
               ]
+            },
+            reservations_google_maps_address: {
+              description: 'The location of the branch on Google Maps',
+              example: 'https://maps.app.goo.gl/tpF7EMsEC7Wy5hmd6',
+              pattern: '^https:\\/\\/maps\\.app\\.goo\\.gl\\/[A-Za-z0-9]*$',
+              oneOf: [
+                {
+                  type: 'string'
+                },
+                {
+                  type: 'null'
+                }
+              ]
             }
           },
           required: [
@@ -529,5 +542,11 @@ module.exports = {
         type: 'null'
       }
     ]
+  },
+  shift_plan_enabled: {
+    description: 'Define if this branch uses a shift plan.',
+    example: 'false',
+    type: 'boolean',
+    default: false
   }
 }

package/lib/v0/client_accounts/features/base.js

@@ -90,5 +90,9 @@ module.exports = {
   reservations: {
     type: 'boolean',
     default: false
+  },
+  reservations_online_payments: {
+    type: 'boolean',
+    default: false
   }
 }

package/lib/v0/customers/base.js

@@ -26,8 +26,10 @@ module.exports = {
   lastname: {
     example: 'Fett',
     description: 'Last name',
-    type: 'string',
-    maxLength: 128
+    ...anyOf({
+      type: 'string',
+      maxLength: 128
+    })
   },
   middlename: {
     description: 'Middle name',

package/lib/v0/customers/create.js

@@ -11,10 +11,7 @@ module.exports = {
     $schema: 'http://json-schema.org/draft-07/schema#',
     additionalProperties: false,
     type: 'object',
-    properties: base,
-    required: [
-      'lastname'
-    ]
+    properties: base
   },
   response: {
     $id: 'https://schemas.tillhub.com/v0/customers.create.response.schema.json',

package/lib/v0/promotions/base.js

@@ -86,5 +86,12 @@ module.exports = {
     description: 'The version number of the promotion. Version 1 is deprecated, current version is 2',
     example: 2,
     minimum: 1
-  })
+  }),
+  barcode: {
+    description: 'The barcode used to trigger the promotion',
+    example: '0E9761310XF',
+    ...oneOf({
+      type: 'string'
+    })
+  }
 }

package/lib/v0/shift_plan/base.js

@@ -1,32 +1,42 @@
 module.exports = {
-  shift_plan_enabled: {
-    type: 'boolean'
-  },
-  shift_plan: {
+  shifts: {
     type: 'array',
     items: {
       type: 'object',
       additionalProperties: false,
       properties: {
-        staff_member_id: {
+        branch_id: {
           type: 'string',
           format: 'uuid'
         },
-        date: {
-          type: 'string',
-          format: 'date'
-        },
-        plan: {
+        shift_plan: {
           type: 'array',
           items: {
             type: 'object',
             additionalProperties: false,
             properties: {
-              start: {
-                type: 'string'
+              staff_member_id: {
+                type: 'string',
+                format: 'uuid'
+              },
+              date: {
+                type: 'string',
+                format: 'date'
               },
-              end: {
-                type: 'string'
+              plan: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  additionalProperties: false,
+                  properties: {
+                    start: {
+                      type: 'string'
+                    },
+                    end: {
+                      type: 'string'
+                    }
+                  }
+                }
               }
             }
           }

package/lib/v0/staff/base.js

@@ -549,6 +549,11 @@ module.exports = {
               end: {
                 description: 'The end time of this range.',
                 type: 'string'
+              },
+              branch_id: {
+                description: 'The branch at which the staff member will be during this range.',
+                type: 'string',
+                format: 'uuid'
               }
             }
           }

package/lib/v1/configurations/items/balances.js

@@ -160,6 +160,18 @@ module.exports = {
       ],
       default: 'optional'
     },
+    signing_data_exports: oneOf({
+      type: 'object',
+      additionalProperties: false,
+      description: 'Defines if and how signing data should be exported alongside conducting a balance.',
+      properties: {
+        enabled: {
+          description: 'If true AND the signing type supports exports from the POS (tse_epson), the export dialog will be triggered.',
+          type: 'boolean',
+          default: true // clients using an Epson TSE will have this enabled when the POS application starts supporting the technology (iOS 4.30.0)
+        }
+      }
+    }),
     show_account_names: {
       description: 'Defines if account names are shown additionally to the numbers.',
       default: false,

package/lib/v1/configurations/items/discounts.js

@@ -94,6 +94,18 @@ module.exports = {
                 })
               }
             }),
+            automatic: oneOf({
+              type: 'object',
+              description: 'Rules for automatic discounts when adding a product to the cart',
+              additionalProperties: false,
+              properties: {
+                override_stacked_on_product: oneOf({
+                  description: 'If true, overrides generic limits.stacked_on_product.',
+                  type: 'boolean',
+                  default: false
+                })
+              }
+            }),
             price_and_quantity_edit_condition: oneOf({
               description: 'In case of discounted items - specifies if quantity and price can still be edited',
               type: 'string',
@@ -115,6 +127,7 @@ module.exports = {
           }
         }),
         stacked_on_product: oneOf({
+          description: 'Regulates if cart items can have more than 1 discount.',
           type: 'boolean',
           default: true
         })

package/lib/v1/configurations/items/features.js

@@ -214,6 +214,15 @@ module.exports = oneOf({
           minLength: 2,
           maxLength: 24
         },
+        type: oneOf({
+          description: 'Web view icon type',
+          type: 'string',
+          enum: [
+            'none',
+            'calendar'
+          ],
+          default: 'none'
+        }),
         log_level: {
           description: 'defines the granularity of the web api logging.',
           type: 'string',

package/lib/v1/configurations/items/receipts.js

@@ -298,22 +298,22 @@ const balanceReceipt = {
     print_total_sales: oneOf({
       description: 'Defines if the total number of sales will be printed.',
       type: 'boolean',
-      default: true
+      default: false
     }),
     print_tips_section: oneOf({
       description: 'Defines if the extended tips-section will be printed.',
       type: 'boolean',
-      default: true
+      default: false
     }),
     print_cash_units_section: oneOf({
       description: 'Defines if the counted cash units will be printed.',
       type: 'boolean',
-      default: true
+      default: false
     }),
     print_extended_stats: oneOf({
       description: 'Defines if the extended balance stats will be printed. Requires configurations.balances.extended_report and related data.',
       type: 'boolean',
-      default: true
+      default: false
     }),
     print_account_names: oneOf({
       description: 'Defines if account names are printed additionally to the numbers.',

package/lib/v1/configurations/items/reservations.js

@@ -1,6 +1,9 @@
 module.exports = {
   type: 'object',
   properties: {
+    use_individual_closing_days: {
+      type: 'boolean'
+    },
     closing_days: {
       type: 'array',
       items: {
@@ -84,9 +87,25 @@ module.exports = {
         },
         reservation_frequency_minutes: {
           type: 'number'
+        },
+        payment_options: {
+          type: 'array',
+          items: {
+            enum: ['in-store', 'online']
+          },
+          default: ['in-store']
+        },
+        terms_of_service_url: {
+          oneOf: [
+            { type: 'null' },
+            { type: 'string' }
+          ]
         }
       }
     },
+    use_individual_opening_hours: {
+      type: 'boolean'
+    },
     opening_hours: {
       type: 'array',
       items: {

package/lib/v1/configurations/items/settings.js

@@ -132,6 +132,11 @@ module.exports = {
                   maximum: 120
                 }
               }
+            }),
+            allow_time_adjustment_for_archiving: oneOf({
+              description: 'defines if exports (archives only) should be tried for expired certificates, HANDLE WITH CARE',
+              type: 'boolean',
+              default: false
             })
           }
         }),
@@ -341,7 +346,7 @@ module.exports = {
                 },
                 active: {
                   // supported on POS, FALSE for e.g. KHG, TRUE by default
-                  description: 'If true, products will be downloaded to the POS',
+                  description: 'If true, customers will be downloaded to the POS',
                   default: true,
                   type: 'boolean'
                 }
@@ -586,7 +591,8 @@ module.exports = {
                 },
                 only_self_sustained: {
                   description: `Instruct clients to filter for types 'variant_product', 'product' and 'voucher'`,
-                  type: 'boolean'
+                  type: 'boolean',
+                  default: true
                 }
               }
             },

package/lib/v1/configurations/items/taxes.js

@@ -12,7 +12,8 @@ module.exports = {
           enum: [
             'inclusive',
             'exclusive'
-          ]
+          ],
+          default: 'inclusive'
         }
       }
     }

package/lib/v1/products/base.js

@@ -198,6 +198,32 @@ const request = {
       }
     ]
   },
+  min_stock: {
+    description: 'The minimum stock',
+    oneOf: [
+      {
+        type: 'array',
+        items: {
+          type: 'object',
+          additionalProperties: false,
+          properties: {
+            location: {
+              description: 'Alphanumerical uuid of the location, e.g. branch or warehouse',
+              type: 'string',
+              format: 'uuid'
+            },
+            qty: {
+              description: 'The min stock qty',
+              type: 'number'
+            }
+          }
+        }
+      },
+      {
+        type: 'null'
+      }
+    ]
+  },
   sellable: {
     description: 'Define whether a product should be sellable (appears in use cases which assume sale)',
     type: 'boolean',

package/lib/v1/products/index.js

@@ -9,6 +9,10 @@ module.exports.search = {
   request: require('./search')
 }
 
+module.exports.selection = {
+  request: require('./selection')
+}
+
 module.exports.create = {
   request: require('./create.request'),
   response: require('./create.response'),

package/lib/v1/products/selection.js

@@ -0,0 +1,20 @@
+module.exports = {
+  $id: 'https://schemas.tillhub.com/v1/products.selection.request.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  type: 'object',
+  required: ['product_ids'],
+  properties: {
+    product_ids: {
+      type: 'array',
+      minItems: 1,
+      maxItems: 100,
+      items: {
+        description: 'Product UUID',
+        type: 'string',
+        format: 'uuid',
+        example: '05297f58-3408-44d0-8bf4-125d4e86c08a'
+      }
+    }
+  }
+}

package/lib/v1/templates/put.js

@@ -1,7 +1,7 @@
 const base = require('./base').base
 const map = require('./map')
-const options = require('./base').options
 const footerItems = require('./footer-items')
+const options = require('./base').options
 
 module.exports.request = {
   $id: 'https://schemas.tillhub.com/v1/templates.put.request.schema.json',

package/lib/v3/analytics/reports/transactions/overview.js

@@ -3,7 +3,7 @@ const analyticsResponse = require('../../../../common/analytics_response')
 const summary = {
   absolute_average_transaction_cancellation_items_total: {
     description: 'Absolute average total of transactions with type "sale_cancel"',
-    example: 12,
+    example: 2,
     type: ['integer', 'null']
   },
   absolute_average_transaction_items_total: {

package/package.json

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