@tillhub/schemas 6.112.0 → 6.115.0

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+# [6.115.0](https://github.com/tillhub/schemas/compare/v6.114.0...v6.115.0) (2022-01-20)
+
+
+### Features
+
+* **configurations:** gastro ([8d42bed](https://github.com/tillhub/schemas/commit/8d42bed))
+* **configurations:** gastro ([22a71cf](https://github.com/tillhub/schemas/commit/22a71cf))
+* **configurations:** gastro ([bf8546e](https://github.com/tillhub/schemas/commit/bf8546e))
+* **configurations:** interfaces ([25ffd1b](https://github.com/tillhub/schemas/commit/25ffd1b))
+* **configurations:** receipts ([2caf476](https://github.com/tillhub/schemas/commit/2caf476))
+
+# [6.114.0](https://github.com/tillhub/schemas/compare/v6.113.0...v6.114.0) (2022-01-20)
+
+
+### Features
+
+* **configuration:** add background_release_seconds ([5ffec4d](https://github.com/tillhub/schemas/commit/5ffec4d))
+* **configurations:** gastro ([bdc4f0a](https://github.com/tillhub/schemas/commit/bdc4f0a))
+
+# [6.113.0](https://github.com/tillhub/schemas/compare/v6.112.1...v6.113.0) (2022-01-20)
+
+
+### Features
+
+* **configurations:** features ([6cd1289](https://github.com/tillhub/schemas/commit/6cd1289))
+* **configurations:** features ([139876d](https://github.com/tillhub/schemas/commit/139876d))
+
+## [6.112.1](https://github.com/tillhub/schemas/compare/v6.112.0...v6.112.1) (2022-01-13)
+
+
+### Bug Fixes
+
+* **staffs:** renaming user_permission_template_id to staff_permission_template_id ([#661](https://github.com/tillhub/schemas/issues/661)) ([6fbedb4](https://github.com/tillhub/schemas/commit/6fbedb4))
+
 # [6.112.0](https://github.com/tillhub/schemas/compare/v6.111.0...v6.112.0) (2022-01-10)
 
 

package/lib/common/permissions.js

@@ -128,7 +128,8 @@ module.exports.staff = {
       'staff:staff:licenses:delete',
       'staff:staff:processes:all_staff',
       'staff:staff:processes:all_locations',
-      'staff:staff:orders:others:locked:modify' // allows modifying other staffs' orders (gastro)
+      'staff:staff:orders:others:locked:modify', // allows modifying other staffs' orders (gastro)
+      'staff:staff:orders:preview:print' // allows printing previews for unpaid orders (gastro)
     ]
   }
 }

package/lib/v0/staff/base.js

@@ -212,7 +212,7 @@ module.exports = {
       }
     ]
   },
-  user_permission_template_id: oneOf({
+  staff_permission_template_id: oneOf({
     type: 'string'
   }),
   active: {

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

@@ -92,11 +92,35 @@ module.exports = oneOf({
       additionalProperties: false,
       properties: {
         enabled: {
-          description: 'Specifies if gastro tables feature is available.',
+          description: 'Specifies if gastro tables feature is available - mutually exclusive with \'web_view\'.',
           type: 'boolean',
           default: false
         }
       }
+    }),
+    web_view: oneOf({
+      description: 'Web view with js-interaction to iOS. Introduced by Regiondo project. Can not be used with Gastro.',
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        enabled: {
+          description: 'Specifies if a web view is shown in the main sale view - mutually exclusive with \'gastro_tables\'.',
+          type: 'boolean',
+          default: false
+        },
+        url: {
+          description: 'The URL of the web view',
+          type: 'string',
+          format: 'uri'
+        },
+        name: {
+          description: 'Display name of the web view tab in the POS',
+          type: 'string',
+          example: 'Regiondo',
+          minLength: 2,
+          maxLength: 24
+        }
+      }
     })
   }
 })

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

@@ -2,9 +2,53 @@ const { oneOf } = require('../../../helpers/payload-or-null')
 module.exports = {
   type: 'object',
   properties: {
+    takeaway: oneOf({
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        enabled: {
+          type: 'boolean',
+          description: 'Specifies if takeaway is available.',
+          default: false
+        },
+        use_fallback: {
+          type: 'boolean',
+          description: 'Legacy tax options can be used as a fallback before all products are synched',
+          default: true
+        }
+      }
+    }),
     orders: oneOf({
       type: 'object',
       properties: {
+        preview_printing: oneOf({
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              description: 'defines whether preview printing is enabled.',
+              default: 'false'
+            }
+          }
+        }),
+        remote_access: oneOf({
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              description: 'defines whether remote access is available on the main POS.',
+              default: 'false'
+            },
+            background_release_seconds: {
+              description: 'The time in seconds that the Local Server will stay available when the app is send to the background.',
+              type: 'integer',
+              example: 15,
+              minimum: 0,
+              maximum: 3600,
+              default: 25
+            }
+          }
+        }),
         lock_to_waiters: oneOf({
           type: 'boolean',
           description: 'defines whether orders are locked to the waiters',

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

@@ -89,9 +89,17 @@ module.exports = {
                   enum: [
                     'none', // messages will not be visible on the POS but overall functionality is not affected
                     'criollo', // there have been issues (BSH)
-                    'telegraph' // unknown yet
+                    'telegraph' // more stable than criollo
                   ],
-                  default: 'criollo'
+                  default: 'telegraph'
+                }),
+                inter_call_delay_seconds: oneOf({
+                  type: 'number',
+                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+                  minimum: 0.0,
+                  maximum: 10.0,
+                  multipleOf: 0.001,
+                  default: 0.0
                 })
               }
             },
@@ -101,7 +109,15 @@ module.exports = {
                 enabled: {
                   type: 'boolean',
                   default: true
-                }
+                },
+                inter_call_delay_seconds: oneOf({
+                  type: 'number',
+                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+                  minimum: 0.0,
+                  maximum: 10.0,
+                  multipleOf: 0.001,
+                  default: 0.0
+                })
               }
             },
             opi: {
@@ -115,6 +131,14 @@ module.exports = {
                   description: 'Defines if swiss-specific handling of the OPI protocol will be used',
                   type: 'boolean',
                   default: false
+                }),
+                inter_call_delay_seconds: oneOf({
+                  type: 'number',
+                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+                  minimum: 0.0,
+                  maximum: 10.0,
+                  multipleOf: 0.001,
+                  default: 1.0 // defaults to 3.0 if Swiss
                 })
               }
             },
@@ -124,7 +148,15 @@ module.exports = {
                 enabled: {
                   type: 'boolean',
                   default: true
-                }
+                },
+                inter_call_delay_seconds: oneOf({
+                  type: 'number',
+                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+                  minimum: 0.0,
+                  maximum: 10.0,
+                  multipleOf: 0.001,
+                  default: 0.0
+                })
               }
             },
             tim: {
@@ -133,7 +165,15 @@ module.exports = {
                 enabled: {
                   type: 'boolean',
                   default: true
-                }
+                },
+                inter_call_delay_seconds: oneOf({
+                  type: 'number',
+                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+                  minimum: 0.0,
+                  maximum: 10.0,
+                  multipleOf: 0.001,
+                  default: 0.0
+                })
               }
             }
           }

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

@@ -496,6 +496,11 @@ module.exports = oneOf({
           type: 'object',
           ...cartReceipt
         },
+        preview: {
+          description: 'Defines preview receipt printing for sales',
+          type: 'object',
+          ...cartReceipt
+        },
         order: {
           description: 'Defines order receipt printing',
           type: 'object',

package/package.json

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