@tillhub/schemas 6.121.0 → 6.124.0

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

@@ -1,4 +1,4 @@
-const { oneOf } = require('../../../helpers/payload-or-null')
+const { anyOf, oneOf } = require('../../../helpers/payload-or-null')
 const productServiceAnswerObject = require('../../transactions/components/embedded/product_service_answer/base')
 const returnReason = require('../../transactions/components/embedded/return/return_reason')
 const voucherObject = require('../../transactions/components/embedded/voucher/base')
@@ -6,34 +6,34 @@ const customProperties = require('../../../common/custom_properties')
 
 const masterData = {
   salesman_staff: {
-    oneOf: [
-      {
-        type: 'string',
-        format: 'uuid'
-      },
-      {
-        type: 'null'
-      }
-    ]
+    description: 'Staff person ID',
+    ...oneOf({
+      type: 'string',
+      format: 'uuid'
+    })
   },
   tax: {
+    description: 'Tax rate ID',
     type: 'string',
     format: 'uuid'
   },
   account: {
+    description: 'Account ID',
     type: 'string',
     format: 'uuid'
   },
+  account_number: {
+    description: 'Account number',
+    ...oneOf({
+      type: 'string'
+    })
+  },
   product_group: {
-    oneOf: [
-      {
-        type: 'string',
-        format: 'uuid'
-      },
-      {
-        type: 'null'
-      }
-    ]
+    description: 'Product group ID',
+    ...oneOf({
+      type: 'string',
+      format: 'uuid'
+    })
   }
 }
 
@@ -88,16 +88,11 @@ const externalDiscounts = {
         type: 'object',
         properties: {
           rate: {
-            oneOf: [
-              {
-                type: 'number',
-                minimum: 0,
-                maximum: 1
-              },
-              {
-                type: 'null'
-              }
-            ]
+            ...oneOf({
+              type: 'number',
+              minimum: 0,
+              maximum: 1
+            })
           },
           order_index: {
             type: 'integer'
@@ -139,14 +134,9 @@ const externalDiscounts = {
         type: 'object',
         properties: {
           value: {
-            oneOf: [
-              {
-                type: 'number'
-              },
-              {
-                type: 'null'
-              }
-            ]
+            ...oneOf({
+              type: 'number'
+            })
           },
           order_index: {
             type: 'integer'
@@ -310,26 +300,16 @@ const internalDiscounts = {
         description: 'The logical group type of the discount, reflecting it\'s origin.'
       },
       value: {
-        oneOf: [
-          {
-            type: 'number'
-          },
-          {
-            type: 'null'
-          }
-        ]
+        ...oneOf({
+          type: 'number'
+        })
       },
       rate: {
-        oneOf: [
-          {
-            type: 'number',
-            minimum: 0,
-            maximum: 1
-          },
-          {
-            type: 'null'
-          }
-        ]
+        ...oneOf({
+          type: 'number',
+          minimum: 0,
+          maximum: 1
+        })
       },
       client_id: {
         type: 'string',
@@ -337,61 +317,41 @@ const internalDiscounts = {
       },
       external_reference_id: {
         description: 'A caller defined custom ID for the purpose of syncing from external resources, or to use in analytics.',
-        oneOf: [
-          {
-            type: 'string',
-            maxLength: 128
-          },
-          {
-            type: 'null'
-          }
-        ]
+        ...oneOf({
+          type: 'string',
+          maxLength: 128
+        })
       },
       source_id: {
         description: 'The Tillhub discount resource (if available)',
-        oneOf: [
-          {
-            type: 'string',
-            format: 'uuid'
-          },
-          {
-            type: 'null'
-          }
-        ]
+        ...oneOf({
+          type: 'string',
+          format: 'uuid'
+        })
       },
       assignment_id: {
         description: 'Identification of the process that created this discount',
-        oneOf: [
-          {
-            type: 'string',
-            maxLength: 128
-          },
-          {
-            type: 'null'
-          }
-        ]
+        ...oneOf({
+          type: 'string',
+          maxLength: 128
+        })
       },
       assignment_source: {
         description: 'Identification of the source of the process that created this discount',
-        oneOf: [
-          {
-            type: 'string',
-            enum: [
-              'customer',
-              'staff',
-              'cart',
-              'product_set',
-              'sconto',
-              'item',
-              'promotion',
-              'voucher',
-              'product_voucher'
-            ]
-          },
-          {
-            type: 'null'
-          }
-        ]
+        ...oneOf({
+          type: 'string',
+          enum: [
+            'customer',
+            'staff',
+            'cart',
+            'product_set',
+            'sconto',
+            'item',
+            'promotion',
+            'voucher',
+            'product_voucher'
+          ]
+        })
       },
       name: {
         type: 'string',
@@ -457,24 +417,22 @@ const internalDiscounts = {
 
 const base = {
   name: {
+    description: 'Cart item display name',
     type: 'string',
     minLength: 1,
     maxLength: 128
   },
   position: {
+    description: 'Cart item position',
     type: 'number',
     minimum: 0
   },
   comments: {
-    anyOf: [
-      {
-        type: 'string',
-        maxLength: 4096
-      },
-      {
-        type: 'null'
-      }
-    ],
+    description: 'Additional comments',
+    ...anyOf({
+      type: 'string',
+      maxLength: 4096
+    }),
     default: null
   },
   client_id: {
@@ -490,117 +448,115 @@ const base = {
 const externalCart = {
   additionalProperties: false,
   type: 'object',
-  required: [
-    'custom_id',
-    'qty',
-    'name',
-    'currency',
-    'amount',
-    'tax',
-    'account'
-  ],
   properties: {
     product: {
       description: 'The Tillhub product unique identifier',
+      example: 'aa165950-26f1-4a59-a85a-1c6017b3cb79',
       type: 'string',
-      format: 'uuid',
-      example: 'aa165950-26f1-4a59-a85a-1c6017b3cb79'
+      format: 'uuid'
     },
     custom_id: {
       description: 'The product.custom_id as stated in https://tillhub.atlassian.net/browse/TM-5665',
+      example: '260620-727-DE',
       type: 'string',
-      maxLength: 128,
-      example: '260620-727-DE'
+      maxLength: 128
     },
     product_supplier_name: {
-      oneOf: [
-        {
-          type: 'string',
-          description: 'Custom identifier for the product\'s supplier',
-          maxLength: 128
-        },
-        {
-          type: 'null'
-        }
-      ]
+      description: 'Custom identifier for the product\'s supplier',
+      ...oneOf({
+        type: 'string',
+        maxLength: 128
+      })
     },
     is_service: {
-      oneOf: [
-        {
-          type: 'boolean',
-          default: false,
-          description: 'If true, this item represents a service and might come with answers to service questions'
-        },
-        {
-          type: 'null'
-        }
-      ]
+      description: 'If true, this item represents a service and might come with answers to service questions',
+      default: false,
+      ...oneOf({
+        type: 'boolean'
+      })
     },
     discountable: {
-      // supports correct discount behavior without product lookup
-      oneOf: [
-        {
-          type: 'boolean'
-        },
-        {
-          type: 'null'
-        }
-      ]
+      description: 'Supports correct discount behavior without product lookup',
+      ...oneOf({
+        type: 'boolean'
+      })
     },
     qty: {
+      description: 'Product quantity in the cart',
+      example: 2,
       type: 'number'
     },
     currency: {
+      description: 'Currency symbol',
+      example: 'EUR',
       type: 'string',
       minLength: 3,
       maxLength: 3
     },
     amount: {
-      ...amount,
-      description: 'the currency / amount object combination is the Tillhub Money object. In this context it is the price of 1 item. The total will price * qty.'
+      description: 'The currency / amount object combination is the Tillhub Money object. In this context it is the price of 1 item. The total will price * qty.',
+      ...amount
     },
     vat_rate: {
+      description: 'VAT rate',
+      example: 0.12,
       type: 'number',
       minimum: 0,
       maximum: 1
     },
     discounts: externalDiscounts,
     ...base
-  }
+  },
+  anyOf: [{
+    required: [
+      'custom_id',
+      'qty',
+      'name',
+      'currency',
+      'amount',
+      'tax'
+    ]
+  }, {
+    required: [
+      'custom_id',
+      'qty',
+      'name',
+      'currency',
+      'amount',
+      'vat_rate'
+    ]
+  }]
 }
 
 const cartOfIds = {
-  required: [
-    'product',
-    'currency',
-    'qty'
-  ],
   additionalProperties: false,
   type: 'object',
   properties: {
     position: {
+      description: 'Cart item position',
       type: 'number',
       minimum: 0
     },
     discountable: {
-      // supports correct discount behavior without product lookup
-      oneOf: [
-        {
-          type: 'boolean'
-        },
-        {
-          type: 'null'
-        }
-      ]
+      description: 'Supports correct discount behavior without product lookup',
+      ...oneOf({
+        type: 'boolean'
+      })
     },
     product: {
+      description: 'Identifier of the product',
+      example: 'cd0a2886-e245-4ed9-a758-443e7e5b3a3f',
       type: 'string'
       // format: 'uuid'
     },
     qty: {
+      description: 'Product quantity in the cart',
+      example: 2,
       type: 'number'
     },
     currency: {
+      description: 'Currency symbol',
+      example: 'EUR',
       type: 'string',
       minLength: 3,
       maxLength: 3
@@ -610,102 +566,84 @@ const cartOfIds = {
       maxLength: 128
     },
     discounts: externalDiscounts
-  }
+  },
+  required: [
+    'product',
+    'currency',
+    'qty'
+  ]
 }
 
 const internalCart = {
   additionalProperties: false,
   type: 'object',
-  required: [
-    'product',
-    'qty',
-    'custom_id',
-    'vat_rate',
-    'salesman_staff',
-    'tax',
-    'account',
-    'name',
-    'discounts',
-    'amount',
-    'currency'
-  ],
   properties: {
     product: {
+      description: 'Identifier of the product',
+      example: 'cd0a2886-e245-4ed9-a758-443e7e5b3a3f',
       type: 'string',
       format: 'uuid'
     },
     product_supplier_name: {
-      oneOf: [
-        {
-          type: 'string',
-          description: 'Custom identifier for the product\'s supplier',
-          maxLength: 128
-        },
-        {
-          type: 'null'
-        }
-      ]
+      description: 'Custom identifier for the product\'s supplier',
+      example: '00555kff34323',
+      ...oneOf({
+        type: 'string',
+        maxLength: 128
+      })
     },
     is_service: {
-      oneOf: [
-        {
-          type: 'boolean',
-          default: false,
-          description: 'If true, this item represents a service and might come with answers to service questions'
-        },
-        {
-          type: 'null'
-        }
-      ]
+      description: 'If true, this item represents a service and might come with answers to service questions',
+      ...oneOf({
+        type: 'boolean',
+        default: false
+      })
     },
     discountable: {
-      // supports correct discount behavior without product lookup
-      oneOf: [
-        {
-          type: 'boolean'
-        },
-        {
-          type: 'null'
-        }
-      ]
+      description: 'Supports correct discount behavior without product lookup',
+      ...oneOf({
+        type: 'boolean'
+      })
     },
     qty: {
+      description: 'Product quantity in the cart',
+      example: 2,
       type: 'number'
     },
     custom_id: {
-      oneOf: [
-        {
-          type: 'string',
-          maxLength: 128
-        },
-        {
-          type: 'null'
-        }
-      ]
+      description: 'Custom cart item ID',
+      ...oneOf({
+        type: 'string',
+        maxLength: 128
+      })
     },
     vat_rate: {
+      description: 'VAT rate',
+      example: 0.12,
       type: 'number',
       minimum: 0,
       maximum: 1
     },
-    vat_rate_class: oneOf({
-      default: 'normal',
+    vat_rate_class: {
       description: 'Rate class from \'taxes.rate_class\' according to international standards, used in Germany to map types for e.g. fiscalization',
-      type: 'string',
-      'enum': [
-        'normal',
-        'reduced',
-        'super_reduced'
-      ]
-    }),
+      default: 'normal',
+      ...oneOf({
+        type: 'string',
+        'enum': [
+          'normal',
+          'reduced',
+          'super_reduced'
+        ]
+      })
+    },
     currency: {
+      description: 'Currency symbol',
+      example: 'EUR',
       type: 'string',
       minLength: 3,
       maxLength: 3
     },
-    amount: {
-      ...amount
-    },
+    amount,
     promotion_amount: oneOf({
       description: 'The promotion amount on the per unit qty base of 1.',
       type: 'number',
@@ -728,10 +666,10 @@ const internalCart = {
       }
     }),
     is_voucher: {
+      description: 'If true, this item represents a voucher and must come with voucher information in \'voucher\'',
+      default: false,
       ...oneOf({
-        type: 'boolean',
-        default: false,
-        description: 'If true, this item represents a voucher and must come with voucher information in \'voucher\''
+        type: 'boolean'
       })
     },
     voucher: {
@@ -741,47 +679,67 @@ const internalCart = {
       default: null
     },
     is_refund: {
+      description: 'If true, the item was created by (partially) refunding a previous sale.',
       ...oneOf({
-        type: 'boolean',
-        description: 'If true, the item was created by (partially) refunding a previous sale.'
+        type: 'boolean'
       })
     },
     return_reason: returnReason,
     attributes_description: {
+      description: 'A short description of the child attributes in variant products',
+      example: 'red | big | 32',
       ...oneOf({
-        type: 'string',
-        example: 'red | big | 32',
-        description: 'A short description of the child attributes in variant products'
+        type: 'string'
       })
     },
     reference_cartitem_client_id: {
+      description: 'In cases of refund or cancellation, or invoicing a delivery note or selling a saved cart: the client_id of the origin item',
+      example: '01331B44-130B-45D4-97A7-401247FD5B68',
       ...oneOf({
-        type: 'string',
-        example: '01331B44-130B-45D4-97A7-401247FD5B68',
-        description: 'In cases of refund or cancellation, or invoicing a delivery note or selling a saved cart: the client_id of the origin item'
+        type: 'string'
       })
     },
     used_barcode: {
+      description: 'The barcode used to trigger putting this item into the cart (defaults to the first available barcode from the product)',
+      example: '0E9761310XF',
       ...oneOf({
-        type: 'string',
-        example: '0E9761310XF',
-        description: 'The barcode used to trigger putting this item into the cart (defaults to the first available barcode from the product)'
+        type: 'string'
       })
     },
     ...base,
     discounts: internalDiscounts,
     attributes: {
       default: null,
-      anyOf: [
-        {
-          type: 'object'
-        },
-        {
-          type: 'null'
-        }
-      ]
+      ...anyOf({
+        type: 'object'
+      })
     }
-  }
+  },
+  anyOf: [{
+    required: [
+      'product',
+      'qty',
+      'custom_id',
+      'salesman_staff',
+      'name',
+      'discounts',
+      'amount',
+      'currency',
+      'tax'
+    ]
+  }, {
+    required: [
+      'product',
+      'qty',
+      'custom_id',
+      'salesman_staff',
+      'name',
+      'discounts',
+      'amount',
+      'currency',
+      'vat_rate'
+    ]
+  }]
 }
 
 module.exports = {
@@ -790,7 +748,7 @@ module.exports = {
   maxItems: 300,
   items: {
     anyOf: [
-      // order is important: most specialised schema will win
+      // order is important: most specialized schema will win
       internalCart,
       externalCart,
       cartOfIds