@tillhub/schemas 6.232.0 → 6.233.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [6.233.0](https://github.com/tillhub/schemas/compare/v6.232.0...v6.233.0) (2023-07-20)
+
+
+### Features
+
+* **branches:** configurations ([1139fc9](https://github.com/tillhub/schemas/commit/1139fc9))
+* **branches:** fix descriptions ([3c32cb7](https://github.com/tillhub/schemas/commit/3c32cb7))
+* **branches:** make branch name default for store name ([4ce8337](https://github.com/tillhub/schemas/commit/4ce8337))
+* **branches:** simplify schema ([8acf2bf](https://github.com/tillhub/schemas/commit/8acf2bf))
+* **configurations:** add validation type ([1101e41](https://github.com/tillhub/schemas/commit/1101e41))
+* **configurations:** features ([b5c3019](https://github.com/tillhub/schemas/commit/b5c3019))
+* **transactions:** add current point balance ([662a4fb](https://github.com/tillhub/schemas/commit/662a4fb))
+* **transactions:** add status to external rewards ([e777abe](https://github.com/tillhub/schemas/commit/e777abe))
+* **transactions:** delete script ([4423eed](https://github.com/tillhub/schemas/commit/4423eed))
+* **transactions:** external_rewards ([b924c19](https://github.com/tillhub/schemas/commit/b924c19))
+* **transactions:** external_rewards ([4093e53](https://github.com/tillhub/schemas/commit/4093e53))
+* **transactions:** external_rewards: oneOf({ ([2383efa](https://github.com/tillhub/schemas/commit/2383efa))
+* **transactions:** store original campaign multiplier ([6eaa40d](https://github.com/tillhub/schemas/commit/6eaa40d))
+
 # [6.232.0](https://github.com/tillhub/schemas/compare/v6.231.0...v6.232.0) (2023-07-20)
 
 

package/lib/v0/branches/base.js

@@ -412,6 +412,43 @@ module.exports = {
       type: 'null'
     }]
   },
+  configurations: oneOf({
+    description: 'Replacement of configuration (unknown usage).',
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+      external_rewards: oneOf({
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          coop: oneOf({
+            type: 'object',
+            description: 'Branch configuration object for Swiss Coop - data is used on transactions',
+            properties: {
+              store_eain: {
+                type: 'string',
+                description: 'Coop identity of this Tillhub branch.',
+                example: '7640147960015'
+              },
+              store_name: oneOf({
+                type: 'string',
+                maxLength: 128,
+                description: 'Name of this branch within the Coop context.',
+                example: 'Coop Supermarkt Riehen Schmiedgasse',
+                default: '{name}'
+              }),
+              store_sap_number: oneOf({
+                type: 'string',
+                pattern: '^[0-9]{4}$',
+                description: 'Tillhub branch SAP number if available.',
+                example: '000001'
+              })
+            }
+          })
+        }
+      })
+    }
+  }),
   timezone_default: {
     description: 'An IANA timezone that will be used to display local timezones in documents and UI. Validation for the timezone will happen in memory of the server, but not on that schema.',
     example: 'Europe/London',

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

@@ -98,7 +98,26 @@ module.exports = oneOf({
           minimum: 2,
           maximum: 99,
           default: 10
-        }
+        },
+        type: oneOf({
+          description: 'Type of the payback scheme, additional logic might apply.',
+          type: 'string',
+          enum: [
+            'generic',
+            'coop' // has predefined constants more or less for GS1
+          ],
+          default: 'generic'
+        }),
+        validation: oneOf({
+          description: 'Type of the validation.',
+          type: 'string',
+          enum: [
+            'none',
+            'offline',
+            'online'
+          ],
+          default: 'none'
+        })
       }
     }),
     split_receipt: oneOf({

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

@@ -622,5 +622,136 @@ 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 0 here.',
+                minimum: -12000,
+                maximum: 12000,
+                default: 0
+              }),
+              free_points: {
+                type: 'integer',
+                description: 'Free Points - preferrably used over Bonus 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'
+              },
+              timestamp_end: {
+                type: 'string',
+                format: 'date-time',
+                example: '2018-01-29T14:55:05.000Z',
+                description: 'Date of the purchase'
+              },
+              total_items: {
+                type: 'integer',
+                description: 'Number of cart items in the transaction.',
+                minimum: 0,
+                maximum: 99
+              },
+              employee_flag: {
+                type: 'boolean',
+                description: 'Marks a Coop employee, not yet relevant.',
+                default: false
+              },
+              total_amount: {
+                type: 'integer',
+                description: 'Total value of the sale in Swiss Rappen including all purchased items.',
+                minimum: -2400000,
+                maximum: 2400000
+              },
+              point_base_amount: {
+                type: 'integer',
+                description: 'Total value of the salethat qualifies for superpoints (certain items excluded).',
+                minimum: -2400000,
+                maximum: 2400000
+              },
+              bon_nr: {
+                type: 'integer',
+                description: 'Tillhub transaction number.',
+                minimum: 0,
+                maximum: 32000
+              }
+            }
+          }
+        }
+      })
+    }
   })
 }

package/package.json

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