@tillhub/schemas 6.264.0 → 6.266.0

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+# [6.266.0](https://github.com/tillhub/schemas/compare/v6.265.0...v6.266.0) (2023-10-17)
+
+
+### Features
+
+* **pricelist:** rebuild customer handling ([e915bcd](https://github.com/tillhub/schemas/commit/e915bcd))
+* **prices:** add customer bound type to list entries ([7b3409f](https://github.com/tillhub/schemas/commit/7b3409f))
+* **prices:** list ([07778e9](https://github.com/tillhub/schemas/commit/07778e9))
+* **products:** prices ([36165fd](https://github.com/tillhub/schemas/commit/36165fd))
+* **transactions:** customer ([cf6e687](https://github.com/tillhub/schemas/commit/cf6e687))
+
+# [6.265.0](https://github.com/tillhub/schemas/compare/v6.264.0...v6.265.0) (2023-10-16)
+
+
+### Bug Fixes
+
+* **staff:** put array length validation in place, now only array of length 7 is valid ([b4ac285](https://github.com/tillhub/schemas/commit/b4ac285))
+* **transactions_v1:** import of external module was not pointing to correct path ([1418414](https://github.com/tillhub/schemas/commit/1418414))
+
+
+### Features
+
+* **configurations:** carts ([78f6819](https://github.com/tillhub/schemas/commit/78f6819))
+* **configurations:** payments ([2dd438d](https://github.com/tillhub/schemas/commit/2dd438d))
+* **customers:** rename price_book_id to price_book ([#881](https://github.com/tillhub/schemas/issues/881)) ([17c4f3b](https://github.com/tillhub/schemas/commit/17c4f3b))
+* **encryption:** adjust ([3c8c5e4](https://github.com/tillhub/schemas/commit/3c8c5e4))
+* **shift_plan:** change schema a bit, move it out of branch and treat it as stand alone entity ([3bc439f](https://github.com/tillhub/schemas/commit/3bc439f))
+* **transactions:** legacy ([23a8964](https://github.com/tillhub/schemas/commit/23a8964)), closes [Security#2](https://github.com/Security/issues/2)
+
 # [6.264.0](https://github.com/tillhub/schemas/compare/v6.263.0...v6.264.0) (2023-09-28)
 
 

package/lib/v0/branches/index.js

@@ -1,7 +1,3 @@
 module.exports.create = require('./create')
 module.exports.read = require('./read')
 module.exports.update = require('./update')
-module.exports.shift_plan = {
-  read: require('./shift_plan/read'),
-  update: require('./shift_plan/update')
-}

package/lib/v0/customers/base.js

@@ -426,8 +426,8 @@ module.exports = {
       format: 'uuid'
     })
   },
-  price_book_id: {
-    description: 'in cases where the customer is going to have personal pricebook (like for discounts in pharmacy by personal insurance number), price_book_id is required',
+  price_book: {
+    description: 'in cases where the customer is going to have personal pricebook (like for discounts in pharmacy by personal insurance number), price_book is required',
     ...oneOf({
       type: 'string',
       format: 'uuid'

package/lib/v0/index.js

@@ -76,5 +76,6 @@ module.exports.product_addon_groups = require('./product_addon_groups')
 module.exports.configurations = require('./configurations')
 module.exports.service_categories = require('./service_categories')
 module.exports.services = require('./services')
+module.exports.shift_plan = require('./shift_plan')
 
 // hygen:injection -  Please, don't delete this line: when running the cli for schema resources the new routes will be automatically added here.

package/lib/v0/shift_plan/base.js

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

package/lib/v0/shift_plan/index.js

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

package/lib/v0/{branches/shift_plan → shift_plan}/read.js

@@ -1,4 +1,4 @@
-const commonResponse = require('../../../common/response')
+const commonResponse = require('../../common/response')
 const base = require('./base')
 
 module.exports.response = {

package/lib/v0/{branches/shift_plan → shift_plan}/update.js

@@ -1,4 +1,4 @@
-const commonResponse = require('../../../common/response')
+const commonResponse = require('../../common/response')
 const base = require('./base')
 
 module.exports.request = {

package/lib/v0/staff/base.js

@@ -525,6 +525,8 @@ module.exports = {
   individual_work_plan: {
     description: 'Custom schedule for this staff member.',
     type: 'array',
+    minItems: 7,
+    maxItems: 7,
     items: {
       type: 'object',
       properties: {

package/lib/v1/carts/base.js

@@ -142,6 +142,12 @@ module.exports = {
       maxLength: 128
     })
   },
+  customer_price_book: oneOf({
+    type: 'string',
+    format: 'uuid',
+    description: 'The Tillhub pricebook resource asscociated with the customer at that moment',
+    example: '512448db-5e6c-4fcf-bd70-f8a5e56fa269'
+  }),
   name: {
     description: 'Cart name',
     example: 'For the chosen one',
@@ -167,10 +173,24 @@ module.exports = {
     })
   },
   items,
-  metadata: {
+  metadata: oneOf({
+    type: 'object',
     description: 'Additional meta data',
-    type: 'object'
-  },
+    properties: {
+      customer: oneOf({
+        type: 'object',
+        description: 'Additional data for a customer',
+        properties: {
+          price_book: oneOf({
+            type: 'string',
+            format: 'uuid',
+            description: 'The Tillhub pricebook resource asscociated with the customer at that moment',
+            example: '512448db-5e6c-4fcf-bd70-f8a5e56fa269'
+          })
+        }
+      })
+    }
+  }),
   opened_at: {
     description: 'Date when this cart was opened. If date is not null, this cart must not be used.',
     example: '2022-02-19T00:00:00.001Z',

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

@@ -45,18 +45,21 @@ module.exports = oneOf({
           description: 'In case of refund - specifies if modicications are forbidden',
           type: 'boolean',
           default: false
-        }),
-        items: oneOf({
-          type: 'object',
-          additionalProperties: false,
-          properties: {
-            allow_editing: oneOf({
-              description: 'In case of refund items - specifies if quantity and price can be edited',
-              type: 'boolean',
-              default: false
-            })
-          }
-        })
+        }) // ,
+        // *
+        // * ### the follwing is already defined and used from 'configurations.settings.revision_safety.allow_editing_refund_items' ###
+        // *
+        // items: oneOf({
+        //  type: 'object',
+        //  additionalProperties: false,
+        //  properties: {
+        //    allow_editing: oneOf({
+        //      description: 'In case of refund items - specifies if quantity and price can be edited',
+        //      type: 'boolean',
+        //      default: false
+        //    })
+        //  }
+        // })
       }
     })
   }

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

@@ -40,6 +40,16 @@ module.exports = {
       description: 'If true, allows entering values for split payments that are higher than the remaining price - thus potentially handing back cash (legacy behavior).',
       default: false,
       type: 'boolean'
+    }),
+    allow_change_on_undefined: oneOf({
+      description: 'If true, allows entering values for split payments that are higher than the remaining price - thus potentially handing back cash (legacy behavior).',
+      default: false,
+      type: 'boolean'
+    }),
+    trigger_amount_on_undefined: oneOf({
+      description: 'If true, will ask for the amount on undefined payment types (rather than setting the total price of the cart).',
+      default: false,
+      type: 'boolean'
     })
   }
 }

package/lib/v1/delivery_notes/base.js

@@ -1,3 +1,4 @@
+const { oneOf } = require('../../helpers/payload-or-null')
 const items = require('./items').create
 
 module.exports = {
@@ -258,7 +259,22 @@ module.exports = {
     ]
   },
   items,
-  metadata: {
-    type: 'object'
-  }
+  metadata: oneOf({
+    type: 'object',
+    description: 'Additional meta data',
+    properties: {
+      customer: oneOf({
+        type: 'object',
+        description: 'Additional data for a customer',
+        properties: {
+          price_book: oneOf({
+            type: 'string',
+            format: 'uuid',
+            description: 'The Tillhub pricebook resource asscociated with the customer at that moment',
+            example: '512448db-5e6c-4fcf-bd70-f8a5e56fa269'
+          })
+        }
+      })
+    }
+  })
 }

package/lib/v1/products/pricelist/response.js

@@ -14,6 +14,7 @@ module.exports = {
       description: 'Type of the product prices',
       type: 'string',
       enum: [
+        'customer', // defined by pricebook when of type 'customer'
         'scaled', // defined by product
         'branch', // defined by product
         'time-based', // defined by pricebook-entry

package/lib/v1/products/prices/book/base.js

@@ -38,5 +38,15 @@ module.exports = {
   deleted: {
     type: 'boolean',
     default: false
-  }
+  },
+  type: oneOf({
+    description: 'Defines type of price books, e.g. bound-to-customer',
+    type: 'string',
+    enum: [
+      'general',
+      'customer'
+    ],
+    example: 'customer',
+    default: 'general'
+  })
 }

package/lib/v1/transactions/legacy/base.js

@@ -552,6 +552,12 @@ module.exports = {
               display: oneOf({
                 type: 'string',
                 example: 'Alexander von Müller'
+              }),
+              price_book: oneOf({
+                type: 'string',
+                format: 'uuid',
+                description: 'The Tillhub pricebook resource asscociated with the customer at that moment',
+                example: '512448db-5e6c-4fcf-bd70-f8a5e56fa269'
               })
             }
           }),
@@ -622,140 +628,5 @@ module.exports = {
         type: 'number'
       }
     }
-  }),
-  external_rewards: oneOf({
-    type: 'object',
-    description: 'Necessary data to handle an external reward triggered by a transaction.',
-    additionalProperties: false,
-    properties: {
-      coop: oneOf({
-        type: 'object',
-        description: 'Delta object for Swiss Coop',
-        properties: {
-          used_campaign_multiplier: {
-            type: 'integer',
-            description: 'Tillhub internal storage to calculate refunds properly.',
-            minimum: 1,
-            maximum: 100,
-            default: 1
-          },
-          current_balance: oneOf({
-            type: 'integer',
-            description: 'Current balance if known via the online validation process.',
-            minimum: 0,
-            maximum: 120000,
-            default: null
-          }),
-          supercard: {
-            type: 'string',
-            description: 'Supercard number, always required.',
-            example: '762250103984932838'
-          },
-          app_id: oneOf({
-            type: 'string',
-            description: 'GS1 AppID, Null for EAN13 cards.',
-            example: '000001'
-          }),
-          guid: oneOf({
-            type: 'string',
-            description: 'GS1 Card GUID, Null for EAN13 cards.',
-            example: '50269DCFF3AD18A0E10080000A050151'
-          }),
-          client_info: {
-            type: 'object',
-            description: 'Info about the store / Tillhub branch.',
-            properties: {
-              store_eain: {
-                type: 'string',
-                description: 'Coop identity of this Tillhub branch.',
-                example: '7640147960015'
-              },
-              store_name: {
-                type: 'string',
-                maxLength: 128,
-                description: 'Name of this Tillhub branch.',
-                example: 'Coop Supermarkt Riehen Schmiedgasse'
-              },
-              store_sap_number: oneOf({
-                type: 'string',
-                pattern: '^[0-9]{4}$',
-                description: 'Tillhub branch SAP number if available.',
-                example: '000001'
-              }),
-              terminal_id: oneOf({
-                type: 'string',
-                description: 'Tillhub custom register name.',
-                example: 'Kasse 1'
-              })
-            }
-          },
-          purchase_info: {
-            type: 'object',
-            description: 'Info about the store / Tillhub branch.',
-            properties: {
-              bonus_points: oneOf({
-                type: 'integer',
-                description: 'Bonus Points to be booked - Free Points preferred, use NULL here untill specified otherwise (2023-07).',
-                minimum: -12000,
-                maximum: 12000,
-                default: null
-              }),
-              free_points: {
-                type: 'integer',
-                description: 'Free Points - preferrably used over Bonus Points. (Current points x campaign multiplier) - refund points',
-                minimum: -12000,
-                maximum: 12000,
-                default: 0
-              },
-              timestamp: {
-                type: 'string',
-                format: 'date-time',
-                example: '2018-01-29T14:55:05.000Z',
-                description: 'Date of the purchase = transaction date'
-              },
-              timestamp_end: {
-                type: 'string',
-                format: 'date-time',
-                example: '2018-01-29T14:55:05.000Z',
-                description: 'Date of the purchase = transaction date'
-              },
-              total_items: {
-                type: 'integer',
-                description: 'Number of cart items in the transaction that are not campaign products or vouchers.',
-                minimum: 0,
-                maximum: 99
-              },
-              employee_flag: {
-                type: 'boolean',
-                description: 'Marks a Coop employee, not yet relevantm, send \'false\'.',
-                default: false
-              },
-              total_amount: {
-                type: 'integer',
-                description: 'Total value of the sale in Swiss Rappen including ALL cart items, including refunds, excluding tips.',
-                minimum: -2400000,
-                maximum: 2400000
-              },
-              point_base_amount: {
-                type: 'integer',
-                description: stripIndents`
-                'Total value of the sale that qualifies for superpoints (campaign items, tips and vouchers excluded)
-
-                as long as net items are not supported this is identical to \'total_amount\'.
-                `,
-                minimum: -2400000,
-                maximum: 2400000
-              },
-              bon_nr: {
-                type: 'integer',
-                description: 'Tillhub transaction number.',
-                minimum: 0,
-                maximum: 32000
-              }
-            }
-          }
-        }
-      })
-    }
   })
 }

package/lib/v1/transactions/legacy/create.js

@@ -1,4 +1,5 @@
 const { getEvent } = require('../../../common/webhooks')
+const { oneOf } = require('../../../helpers/payload-or-null')
 const statusCreate = require('../../statuses/create.request')
 const base = require('./base')
 const response = require('./response')
@@ -33,7 +34,23 @@ module.exports.request = {
     },
     status: {
       ...statusCreate
-    }
+    },
+    external_rewards: oneOf({
+      type: 'object',
+      description: 'Payback data that should be decrypted.',
+      additionalProperties: false,
+      properties: {
+        payback_data: {
+          type: 'string', // Base64
+          maxLength: 16384,
+          examples: [
+            'MEQCIAy4P9k+7x9saDO0uRZ4El8QwN+qTgYiv1DIaJIMWRiuAiAt+saFDGjK2Yi5Cxgy7PprXQ5O0seRgx4ltdpW9REvwA==',
+            'AUUwulkISDlfOMNro8Lx4aepbWinXgiHwGt9/xfb+WmyfAXnzAeBQmCfsRPheW/LKDlWVQWFUdvl7mXsh/vGx1vSLRiq6jn9qmL1fSGFRCrIos1U7X6dWxCr3VVZFXMILey6iuNw9i7HwNFSpyrpVOXFSDCdmKtYDfMMWD0JDAsKSFUTEbCay2yCtDEIOt/sELi6uiRwUoifztlTIt7wDNPdFrGxgJF17d2AJ4ah5V8kGTAzFygjGT8gCfTUbumKtGAJsvou+NqHAp4bb9K8+fTVG5rxw/OWux5GXmbtcxZQ3RX5IGurcsUv/kXFK+uGj7uUsCyEfq71uCxVs04Kig=='
+          ],
+          description: 'Payback data that should be decrypted..'
+        }
+      }
+    })
   }
 }
 

package/lib/v1/transactions/legacy/response.js

@@ -1,3 +1,4 @@
+const { stripIndents } = require('common-tags')
 const { oneOf } = require('../../../helpers/payload-or-null')
 const dateObject = require('../../../common/date_object')
 const statusResponse = require('../../statuses/response')
@@ -59,6 +60,164 @@ module.exports = {
     },
     status: {
       ...statusResponse
+    },
+    external_rewards: {
+      anyOf: [
+        {
+          type: 'object',
+          description: 'If data can not be decrypted - they are stored here - Base64.',
+          additionalProperties: false,
+          properties: {
+            payback_data: {
+              type: 'string', // Base64
+              maxLength: 16384,
+              examples: [
+                'MEQCIAy4P9k+7x9saDO0uRZ4El8QwN+qTgYiv1DIaJIMWRiuAiAt+saFDGjK2Yi5Cxgy7PprXQ5O0seRgx4ltdpW9REvwA==',
+                'AUUwulkISDlfOMNro8Lx4aepbWinXgiHwGt9/xfb+WmyfAXnzAeBQmCfsRPheW/LKDlWVQWFUdvl7mXsh/vGx1vSLRiq6jn9qmL1fSGFRCrIos1U7X6dWxCr3VVZFXMILey6iuNw9i7HwNFSpyrpVOXFSDCdmKtYDfMMWD0JDAsKSFUTEbCay2yCtDEIOt/sELi6uiRwUoifztlTIt7wDNPdFrGxgJF17d2AJ4ah5V8kGTAzFygjGT8gCfTUbumKtGAJsvou+NqHAp4bb9K8+fTVG5rxw/OWux5GXmbtcxZQ3RX5IGurcsUv/kXFK+uGj7uUsCyEfq71uCxVs04Kig=='
+              ],
+              description: 'If payback data can not be decrypted - they are stored here - Base64.'
+            }
+          }
+        },
+        {
+          type: 'object',
+          description: 'Necessary data to handle an external reward triggered by a transaction.',
+          additionalProperties: false,
+          properties: {
+            coop: oneOf({
+              type: 'object',
+              description: 'Delta object for Swiss Coop',
+              properties: {
+                used_campaign_multiplier: {
+                  type: 'integer',
+                  description: 'Tillhub internal storage to calculate refunds properly.',
+                  minimum: 1,
+                  maximum: 100,
+                  default: 1
+                },
+                current_balance: oneOf({
+                  type: 'integer',
+                  description: 'Current balance if known via the online validation process.',
+                  minimum: 0,
+                  maximum: 120000,
+                  default: null
+                }),
+                supercard: {
+                  type: 'string',
+                  description: 'Supercard number, always required.',
+                  example: '762250103984932838'
+                },
+                app_id: oneOf({
+                  type: 'string',
+                  description: 'GS1 AppID, Null for EAN13 cards.',
+                  example: '000001'
+                }),
+                guid: oneOf({
+                  type: 'string',
+                  description: 'GS1 Card GUID, Null for EAN13 cards.',
+                  example: '50269DCFF3AD18A0E10080000A050151'
+                }),
+                client_info: {
+                  type: 'object',
+                  description: 'Info about the store / Tillhub branch.',
+                  properties: {
+                    store_eain: {
+                      type: 'string',
+                      description: 'Coop identity of this Tillhub branch.',
+                      example: '7640147960015'
+                    },
+                    store_name: {
+                      type: 'string',
+                      maxLength: 128,
+                      description: 'Name of this Tillhub branch.',
+                      example: 'Coop Supermarkt Riehen Schmiedgasse'
+                    },
+                    store_sap_number: oneOf({
+                      type: 'string',
+                      pattern: '^[0-9]{4}$',
+                      description: 'Tillhub branch SAP number if available.',
+                      example: '000001'
+                    }),
+                    terminal_id: oneOf({
+                      type: 'string',
+                      description: 'Tillhub custom register name.',
+                      example: 'Kasse 1'
+                    })
+                  }
+                },
+                purchase_info: {
+                  type: 'object',
+                  description: 'Info about the store / Tillhub branch.',
+                  properties: {
+                    bonus_points: oneOf({
+                      type: 'integer',
+                      description: 'Bonus Points to be booked - Free Points preferred, use NULL here untill specified otherwise (2023-07).',
+                      minimum: -12000,
+                      maximum: 12000,
+                      default: null
+                    }),
+                    free_points: {
+                      type: 'integer',
+                      description: 'Free Points - preferrably used over Bonus Points. (Current points x campaign multiplier) - refund points',
+                      minimum: -12000,
+                      maximum: 12000,
+                      default: 0
+                    },
+                    timestamp: {
+                      type: 'string',
+                      format: 'date-time',
+                      example: '2018-01-29T14:55:05.000Z',
+                      description: 'Date of the purchase = transaction date'
+                    },
+                    timestamp_end: {
+                      type: 'string',
+                      format: 'date-time',
+                      example: '2018-01-29T14:55:05.000Z',
+                      description: 'Date of the purchase = transaction date'
+                    },
+                    total_items: {
+                      type: 'integer',
+                      description: 'Number of cart items in the transaction that are not campaign products or vouchers.',
+                      minimum: 0,
+                      maximum: 99
+                    },
+                    employee_flag: {
+                      type: 'boolean',
+                      description: 'Marks a Coop employee, not yet relevantm, send \'false\'.',
+                      default: false
+                    },
+                    total_amount: {
+                      type: 'integer',
+                      description: 'Total value of the sale in Swiss Rappen including ALL cart items, including refunds, excluding tips.',
+                      minimum: -2400000,
+                      maximum: 2400000
+                    },
+                    point_base_amount: {
+                      type: 'integer',
+                      description: stripIndents`
+                'Total value of the sale that qualifies for superpoints (campaign items, tips and vouchers excluded)
+
+                as long as net items are not supported this is identical to \'total_amount\'.
+                `,
+                      minimum: -2400000,
+                      maximum: 2400000
+                    },
+                    bon_nr: {
+                      type: 'integer',
+                      description: 'Tillhub transaction number.',
+                      minimum: 0,
+                      maximum: 32000
+                    }
+                  }
+                }
+              }
+            })
+          }
+        },
+        {
+          type: 'null'
+        }
+      ]
     }
   }
 }

package/package.json

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

package/test/shift_plan/shift_plan.v0.spec.js

@@ -0,0 +1,11 @@
+const test = require('tape')
+const validate = require('../helpers/validate-schema')
+
+test('Shift Plan V0: update schema validation', function (t) {
+  t.plan(2)
+  const updateRequest = require('../../lib/v0/shift_plan').update.request
+  const { valid, error } = validate(updateRequest)
+  t.ok(valid, 'update schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})

package/lib/v0/branches/shift_plan/base.js

@@ -1,46 +0,0 @@
-module.exports = {
-  shift_plan_enabled: {
-    type: 'boolean'
-  },
-  plan: {
-    type: 'array',
-    items: {
-      type: 'object',
-      additionalProperties: false,
-      properties: {
-        user: {
-          type: 'string',
-          format: 'uuid'
-        },
-        time_ranges: {
-          type: 'array',
-          items: {
-            type: 'object',
-            additionalProperties: false,
-            properties: {
-              date: {
-                type: 'string',
-                format: 'date'
-              },
-              times: {
-                type: 'array',
-                items: {
-                  type: 'object',
-                  additionalProperties: false,
-                  properties: {
-                    start: {
-                      type: 'string'
-                    },
-                    end: {
-                      type: 'string'
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-}