@tillhub/schemas 6.337.0 → 6.339.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.339.0](https://github.com/tillhub/schemas/compare/v6.338.0...v6.339.0) (2024-09-09)
+
+
+### Features
+
+* **configuration:** split payment feature flag ([adeb0b1](https://github.com/tillhub/schemas/commit/adeb0b1))
+
+# [6.338.0](https://github.com/tillhub/schemas/compare/v6.337.0...v6.338.0) (2024-08-21)
+
+
+### Features
+
+* **transactions:** cart_item ([ff21d8f](https://github.com/tillhub/schemas/commit/ff21d8f))
+
 # [6.337.0](https://github.com/tillhub/schemas/compare/v6.336.0...v6.337.0) (2024-08-19)
 
 

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

@@ -39,6 +39,11 @@ module.exports = {
         format: 'uuid'
       }
     }),
+    allow_split_by_person: oneOf({
+      description: 'If true, allows split by person',
+      default: false,
+      type: 'boolean'
+    }),
     allow_refund_split: oneOf({
       description: 'If true, allows multiple payments on negative cart totals, e.g. undefined + cash (e.g. health insurance case).',
       default: false,

package/lib/v1/products/base.js

@@ -1,6 +1,9 @@
 const { anyOf, oneOf } = require('../../helpers/payload-or-null')
 const locationType = require('../../common/location_type')
 const customProperties = require('../../common/custom_properties')
+const productImages = require('./properties/images')
+const productChildren = require('./properties/children')
+const productOptions = require('./properties/options')
 
 const stockConfigurationLocation = {
   type: 'array',
@@ -89,6 +92,8 @@ const request = {
       }
     ]
   },
+  options: productOptions,
+  children: productChildren,
   tags: {
     anyOf: [
       {
@@ -547,63 +552,7 @@ const request = {
       }
     ]
   },
-  images: {
-    oneOf: [
-      {
-        type: 'object',
-        additionalProperties: false,
-        properties: {
-          'original': oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          '1x': oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          '2x': oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          '3x': oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          lia_1x: oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          lia_2x: oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          lia_3x: oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          square_1x: oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          square_2x: oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          square_3x: oneOf({
-            type: 'string',
-            format: 'uri'
-          }, { default: null }),
-          avatar: {
-            type: 'string',
-            format: 'uri'
-          }
-        }
-      },
-      {
-        type: 'null'
-      }
-    ]
-  },
+  images: productImages,
   insert_id: {
     type: 'integer'
   },
@@ -738,9 +687,6 @@ const request = {
       type: 'string',
       format: 'uuid'
     }
-  },
-  {
-    type: 'null'
   }),
   components: {
     description: 'An array of components for composed product (the type is "composed_product")',

package/lib/v1/products/properties/children.js

@@ -0,0 +1,50 @@
+const { oneOf } = require('../../../helpers/payload-or-null')
+const productImages = require('./images')
+
+module.exports = oneOf({
+  description: 'Available children for variant parent products',
+  type: 'array',
+  items: {
+    type: 'object',
+    properties: {
+      id: {
+        description: 'Product ressource for full child product',
+        type: 'string',
+        format: 'uuid'
+      },
+      name: oneOf({
+        description: 'Name of the child product',
+        type: 'string',
+        example: 'Shirt S rot'
+      }),
+      custom_id: oneOf({
+        description: 'Product number of the child product',
+        type: 'string',
+        example: 'P0000001046TEST280824-1'
+      }),
+      attributes: oneOf({
+        type: 'object',
+        description: 'A dictionary <string, string> describing all values for the specific child',
+        additionalProperties: false,
+        maxProperties: 32,
+        patternProperties: {
+          '^.{1,256}$': { type: 'string' }
+        },
+        example: {
+          'Color': 'blue',
+          'Size': 'S'
+        }
+      }),
+      images: productImages,
+      barcodes: oneOf({
+        description: 'Product barcodes',
+        type: 'array',
+        items: {
+          type: 'string',
+          maxLength: 1024,
+          example: 'ABC-abc-1234'
+        }
+      })
+    }
+  }
+})

package/lib/v1/products/properties/images.js

@@ -0,0 +1,52 @@
+const { oneOf } = require('../../../helpers/payload-or-null')
+
+module.exports = oneOf({
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    'original': oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    '1x': oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    '2x': oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    '3x': oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    lia_1x: oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    lia_2x: oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    lia_3x: oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    square_1x: oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    square_2x: oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    square_3x: oneOf({
+      type: 'string',
+      format: 'uri'
+    }, { default: null }),
+    avatar: {
+      type: 'string',
+      format: 'uri'
+    }
+  }
+})

package/lib/v1/products/properties/options.js

@@ -0,0 +1,67 @@
+const { oneOf } = require('../../../helpers/payload-or-null')
+
+module.exports = oneOf({
+  description: 'Available options for variant parent products',
+  type: 'array',
+  items: {
+    type: 'object',
+    description: 'Describes a single option with all potential values',
+    patternProperties: {
+      '^.{1,256}$': { // e.g. 'Size'
+        type: 'array',
+        items: {
+          type: 'string',
+          example: 'L'
+        }
+      }
+    },
+    example: {
+      Size: [
+        'L',
+        'M',
+        'S'
+      ]
+    }
+  },
+  examples: [
+    [
+      {
+        Color: [
+          'blue',
+          'green',
+          'red'
+        ]
+      },
+      {
+        Size: [
+          'L',
+          'M',
+          'S'
+        ]
+      }
+    ],
+    [
+      {
+        Keyboard: [
+          'English',
+          'French',
+          'German'
+        ]
+      },
+      {
+        Memory: [
+          '8GB',
+          '16GB',
+          '32GB'
+        ]
+      },
+      {
+        Hardrive: [
+          '512GB',
+          '1TB',
+          '2TB'
+        ]
+      }
+    ]
+  ]
+})

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

@@ -721,22 +721,22 @@ module.exports = {
     type: 'object',
     description: 'Item property changes triggered by a user decision.',
     properties: {
-      tax_switched: {
+      tax_switched: oneOf({
         type: 'boolean'
-      },
+      }),
       action: oneOf({
         type: 'object',
         properties: {
-          tax: {
+          tax: oneOf({
             type: 'string',
             format: 'uuid'
-          },
-          default: {
+          }),
+          default: oneOf({
             type: 'boolean'
-          },
-          name: {
+          }),
+          name: oneOf({
             type: 'string'
-          }
+          })
         }
       })
     }

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

@@ -270,12 +270,7 @@ module.exports = {
   }),
   _amount_total: oneOf({
     description: stripIndents`
-    Manifesting Legacy: The given amount via this payment, 20.00 EUR or 20.00 HUF respectively (represented as Decimal) - tips are included, change money is not subtracted'
-
-    NOTE: The intention to use this without tip and change can not be realized as of 2023.
-
-    2023: Equal to \'_amount_given\' and \'_amount_requested\'.
-
+    Equals to \'_amount_requested\' + \'_tip_total\'.
     `,
     type: 'number',
     minimum: -1000000,
@@ -295,9 +290,8 @@ module.exports = {
     be payed e.g. 49.98, but the customer has given 50,00. This
     is usually of interest in cash payments, or when when customers
     gave fewer amount than they ought to pay.
-
-    2023: Equal to \'_amount_total\' and \'_amount_requested\'.
-
+    
+    Equals to given amount (requested + tips + change)
     `,
     example: '50.00',
     type: 'number',
@@ -308,11 +302,8 @@ module.exports = {
   _amount_requested: oneOf({
     description: stripIndents`
     The amount that was requested to e.g. a card payment terminal - thus it includes the proposed tip amount.
-    See NOTE!
-
-    NOTE: The intention to use this without tip and change can not be realized as of 2023.
-
-    2023: Equal to \'_amount_total\' and \'_amount_given\'.
+    
+    Equals to requested amount (tips are not included)
     `,
     example: '49.98',
     type: 'number',
@@ -321,11 +312,8 @@ module.exports = {
     multipleOf: 0.01
   }),
   _amount_change: oneOf({
-    description: stripIndents` .
-
-     NOTE: usually NULL - as change is tx top level an should currently not be attributed to a single payment (of potentially many).
-
-     2023: Change can be set on a payment ONLY if top level change is agreed to be 0 .
+    description: stripIndents`
+    Equals to change of this payment (change on transaction still has total change for all payments)
      `,
     example: '49.98',
     type: 'number',

package/package.json

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