@tillhub/schemas 6.118.0 → 6.121.0

package/lib/v0/branches/base.js

@@ -1,9 +1,11 @@
-const customProperties = require('../../common/custom_properties')
 const { stripIndents } = require('common-tags')
+const customProperties = require('../../common/custom_properties')
+const { getImages } = require('../../common/images')
 
 module.exports = {
   name: {
-    description: 'any arbitrary name for a branch that can be displayed in applications.',
+    description: 'Any arbitrary name for a branch that can be displayed in applications.',
+    example: 'Head office',
     anyOf: [
       {
         type: 'string',
@@ -16,17 +18,19 @@ module.exports = {
     ]
   },
   phonenumbers: {
-    description: 'A number of valid types of phonenumbers for a branch.',
+    description: 'A number of valid types of phone numbers for a branch.',
     anyOf: [
       {
         type: 'object',
         additionalProperties: false,
         properties: {
           line_main: {
-            type: 'string'
+            type: 'string',
+            example: '+49-555-1976'
           },
           line_1: {
-            type: 'string'
+            type: 'string',
+            example: '+49-555-1977'
           },
           line_2: {
             type: 'string'
@@ -57,6 +61,7 @@ module.exports = {
   },
   email: {
     description: 'The main contact email for a branch.',
+    example: 'office@my-incredible-company.to',
     anyOf: [
       {
         type: 'string',
@@ -70,6 +75,7 @@ module.exports = {
   },
   receipt_header: {
     description: 'An arbitrary string that will be printed on every receipt as the header.',
+    example: 'Perfect socks LTD',
     anyOf: [
       {
         type: 'string',
@@ -82,6 +88,7 @@ module.exports = {
   },
   receipt_footer: {
     description: 'An arbitrary string that will be printed on every receipt as the footer',
+    example: 'Thank you!',
     anyOf: [
       {
         type: 'string',
@@ -117,40 +124,7 @@ module.exports = {
       }
     ]
   },
-  images: {
-    description: 'A Tillhub image object with URLs to display images this for this branch.',
-    anyOf: [
-      {
-        type: 'object',
-        additionalProperties: true,
-        properties: {
-          '1x': {
-            type: 'string',
-            format: 'uri'
-          },
-          '2x': {
-            type: 'string',
-            format: 'uri'
-          },
-          '3x': {
-            type: 'string',
-            format: 'uri'
-          },
-          avatar: {
-            type: 'string',
-            format: 'uri'
-          },
-          original: {
-            type: 'string',
-            format: 'uri'
-          }
-        }
-      },
-      {
-        type: 'null'
-      }
-    ]
-  },
+  images: getImages(),
   image: {
     description: 'DEPRECATED. Omit or set null.',
     anyOf: [
@@ -170,11 +144,13 @@ module.exports = {
   },
   active: {
     description: 'Soft disable or enabled this branch.',
+    example: 'true',
     type: 'boolean',
     default: true
   },
   deleted: {
     description: 'Soft delete this branch.',
+    example: 'false',
     type: 'boolean',
     default: false
   },
@@ -186,10 +162,22 @@ module.exports = {
   branch_number: {
     type: 'number',
     description: 'The maximum stems from the fact that is it stored as an postgres int4 type, with 4 bytes of space',
+    example: 107,
     minimum: 0,
     maximum: 2147483647
   },
+  custom_id: {
+    description: 'Branch custom unique ID.',
+    example: 'dd3234of',
+    anyOf: [{
+      type: 'string'
+    }, {
+      type: 'null'
+    }]
+  },
   external_custom_id: {
+    description: 'Unique ID of this branch in external system. Uses for synchronization.',
+    example: '7882448928329',
     anyOf: [
       {
         type: 'string',
@@ -202,6 +190,8 @@ module.exports = {
     ]
   },
   cost_center: {
+    description: 'Cost center unique ID',
+    example: '7882448928329',
     anyOf: [
       {
         type: 'string',
@@ -242,6 +232,7 @@ module.exports = {
             },
             street: {
               description: 'A street name',
+              example: 'Downing Street',
               oneOf: [
                 {
                   type: 'string',
@@ -254,6 +245,7 @@ module.exports = {
             },
             street_number: {
               description: 'A street number',
+              example: '10',
               oneOf: [
                 {
                   type: 'string',
@@ -266,6 +258,7 @@ module.exports = {
             },
             locality: {
               description: 'The international format for a city, village and any other localizable city like place.',
+              example: 'London',
               oneOf: [
                 {
                   type: 'string'
@@ -277,6 +270,7 @@ module.exports = {
             },
             region: {
               description: 'The international format for regional sub category of a country e.g. a state or province.',
+              example: 'Greater London',
               oneOf: [
                 {
                   type: 'string'
@@ -288,6 +282,7 @@ module.exports = {
             },
             postal_code: {
               description: 'A non-validated postal code.',
+              example: 'SW1A',
               oneOf: [
                 {
                   type: 'string',
@@ -300,6 +295,7 @@ module.exports = {
             },
             country: {
               description: 'A country as ISO Alpha-2 code.',
+              example: 'UK',
               oneOf: [
                 {
                   type: 'string',
@@ -366,42 +362,37 @@ module.exports = {
   },
   configuration: {
     description: 'Deprecated: Overwriting a fa_account_number on cash payments for DATEV export.',
-    anyOf: [
-      {
-        type: 'string'
-      },
-      {
-        type: 'null'
-      }
-    ]
+    anyOf: [{
+      type: 'string'
+    }, {
+      type: 'null'
+    }]
   },
   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.',
-    anyOf: [
-      {
-        type: 'string'
-      },
-      {
-        type: 'null'
-      }
-    ]
+    example: 'Europe/London',
+    anyOf: [{
+      type: 'string'
+    }, {
+      type: 'null'
+    }]
   },
   currency_default: {
     description: 'The three letter [ISO currency](https://en.wikipedia.org/wiki/ISO_4217) of this branch.',
-    anyOf: [
-      {
-        type: 'string'
-      },
-      {
-        type: 'null'
-      }
-    ]
+    example: 'GBP',
+    anyOf: [{
+      type: 'string'
+    }, {
+      type: 'null'
+    }]
   },
   custom_properties: {
+    description: 'User-defined branch properties',
     ...customProperties.implementation
   },
   default_favourite: {
     description: 'Define which favourite set to show as default in the POS if none is defined on the register.',
+    example: '20e89159-28d9-46f2-bda3-d74bb70834e7',
     anyOf: [
       {
         type: 'string',
@@ -414,6 +405,7 @@ module.exports = {
   },
   default_category_tree: {
     description: 'Define which category tree to use as default in the POS if none is defined on the register.',
+    example: 'c45764ed-fc6d-4b32-b406-59a5e84d2999',
     anyOf: [
       {
         type: 'string',

package/lib/v0/branches/create.js

@@ -1,3 +1,5 @@
+const baseObject = require('../../common/base')
+const commonResponse = require('../../common/response')
 const base = require('./base')
 
 module.exports.request = {
@@ -10,3 +12,19 @@ module.exports.request = {
   properties: base,
   type: 'object'
 }
+
+module.exports.response = {
+  $id: 'https://schemas.tillhub.com/v0/branches.create.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  ...commonResponse({
+    resultItems: {
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        ...baseObject(),
+        ...base
+      }
+    }
+  })
+}

package/lib/v0/branches/index.js

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

package/lib/v0/branches/read.js

@@ -0,0 +1,119 @@
+const baseObject = require('../../common/base')
+const commonResponse = require('../../common/response')
+const commonQuery = require('../../common/query')
+const { oneOf } = require('../../helpers/payload-or-null')
+
+const base = require('./base')
+
+const extended = {
+  insert_id: {
+    description: 'Sequential branch index',
+    type: 'integer'
+  },
+  fa_account_number: {
+    description: 'Account number',
+    ...oneOf({
+      type: 'string'
+    })
+  },
+  configurations: {
+    description: 'Configurations set',
+    ...oneOf({
+      type: 'object'
+    })
+  },
+  merged_configurations: {
+    description: 'Merged configuration of branch and account',
+    ...oneOf({
+      type: 'object'
+    })
+  }
+}
+
+module.exports.all = {
+  query: {
+    $id: 'https://schemas.tillhub.com/v0/branches.read.all.query.schema.json',
+    ...commonQuery({
+      standard: ['start', 'end', 'active', 'deleted'],
+      additional: {
+        name: {
+          description: 'Filter branches by name substring',
+          example: 'Head office',
+          type: 'string'
+        },
+        branch_group: {
+          description: 'Filter branches by branch group ID',
+          example: 'Head office',
+          type: 'string',
+          format: 'uuid'
+        },
+        branch_number: {
+          description: 'Filter branches by number',
+          example: 239,
+          type: 'integer'
+        },
+        postal_code: {
+          description: 'Filter branches by postal code',
+          example: '10785',
+          type: 'string'
+        },
+        street: {
+          description: 'Filter branches by street name',
+          example: 'Genthiner Str. 34',
+          type: 'string'
+        },
+        city: {
+          description: 'Filter branches by city name',
+          example: 'Berlin',
+          type: 'string'
+        },
+        q: {
+          description: 'Search branches by several fields which match given string',
+          example: 'head',
+          type: 'string'
+        },
+        total: {
+          description: 'Return the total count of branches (in meta data call)',
+          example: 'true',
+          type: 'string',
+          enum: ['true', 'false']
+        }
+      }
+    })
+  },
+  response: {
+    $id: 'https://schemas.tillhub.com/v0/branches.read.all.response.schema.json',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    additionalProperties: false,
+    ...commonResponse({
+      resultItems: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          ...baseObject(),
+          ...base,
+          ...extended
+        }
+      }
+    })
+  }
+}
+
+module.exports.one = {
+  response: {
+    $id: 'https://schemas.tillhub.com/v0/branches.read.one.response.schema.json',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    additionalProperties: false,
+    ...commonResponse({
+      resultItems: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          ...baseObject(),
+          ...base,
+          ...extended
+        }
+      }
+    })
+  }
+}

package/lib/v0/branches/update.js

@@ -1,3 +1,5 @@
+const baseObject = require('../../common/base')
+const commonResponse = require('../../common/response')
 const base = require('./base')
 
 module.exports.request = {
@@ -8,3 +10,19 @@ module.exports.request = {
   required: [],
   properties: base
 }
+
+module.exports.response = {
+  $id: 'https://schemas.tillhub.com/v0/branches.update.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  ...commonResponse({
+    resultItems: {
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        ...baseObject(),
+        ...base
+      }
+    }
+  })
+}

package/lib/v0/category_trees/definitions.js

@@ -10,7 +10,7 @@ module.exports.children = {
             format: 'uuid'
           },
           children: {
-            type: 'object'
+            type: 'array'
           }
         }
       }