@tillhub/schemas 6.117.1 → 6.120.0

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+# [6.120.0](https://github.com/tillhub/schemas/compare/v6.119.0...v6.120.0) (2022-02-17)
+
+
+### Features
+
+* **branches:** add detailed branches schema #API-1392 ([#671](https://github.com/tillhub/schemas/issues/671)) ([3232d2b](https://github.com/tillhub/schemas/commit/3232d2b)), closes [#API-1392](https://github.com/tillhub/schemas/issues/API-1392) [#API-1392](https://github.com/tillhub/schemas/issues/API-1392)
+
+# [6.119.0](https://github.com/tillhub/schemas/compare/v6.118.1...v6.119.0) (2022-02-15)
+
+
+### Features
+
+* **audits:** add audit logs response schema #API-1331 ([#668](https://github.com/tillhub/schemas/issues/668)) ([057c73e](https://github.com/tillhub/schemas/commit/057c73e)), closes [#API-1331](https://github.com/tillhub/schemas/issues/API-1331) [#API-1331](https://github.com/tillhub/schemas/issues/API-1331)
+
+## [6.118.1](https://github.com/tillhub/schemas/compare/v6.118.0...v6.118.1) (2022-02-14)
+
+
+### Bug Fixes
+
+* **docs:** fixing the children type on category_trees ([141dc8e](https://github.com/tillhub/schemas/commit/141dc8e))
+
+# [6.118.0](https://github.com/tillhub/schemas/compare/v6.117.1...v6.118.0) (2022-02-10)
+
+
+### Features
+
+* **configurations:** features ([d9ad71d](https://github.com/tillhub/schemas/commit/d9ad71d))
+* **configurations:** gastro ([d977675](https://github.com/tillhub/schemas/commit/d977675))
+* **configurations:** gastro ([71126be](https://github.com/tillhub/schemas/commit/71126be))
+
 ## [6.117.1](https://github.com/tillhub/schemas/compare/v6.117.0...v6.117.1) (2022-02-09)
 
 

package/lib/common/base.js

@@ -5,16 +5,19 @@
 function baseObject (options = {}) {
   return {
     id: {
+      description: 'Unique entity ID',
       type: 'string',
       format: 'uuid',
       example: '936835f7-2d75-41d2-9001-38ed6e458328'
     },
     created_at: {
+      description: 'The date and time entity was created',
       type: 'string',
       format: 'date-time',
       example: '2019-03-17T21:12:04.849Z'
     },
     updated_at: {
+      description: 'The date and time entity was updated',
       type: 'string',
       format: 'date-time',
       example: '2019-03-17T21:12:04.849Z'

package/lib/common/images.js

@@ -0,0 +1,57 @@
+const definedSizes = {
+  '1x': {
+    description: 'Image transformed to predefined small size',
+    example: 'https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_1x.png',
+    type: 'string',
+    format: 'uri'
+  },
+  '2x': {
+    description: 'Image transformed to predefined medium size',
+    example: 'https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_2x.png',
+    type: 'string',
+    format: 'uri'
+  },
+  '3x': {
+    description: 'Image transformed to predefined big size',
+    example: 'https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_1x.png',
+    type: 'string',
+    format: 'uri'
+  },
+  avatar: {
+    description: 'Image transformed to predefined size to use as "avatar"',
+    example: 'https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_avatar.png',
+    type: 'string',
+    format: 'uri'
+  }
+}
+
+function getImages (sizes = ['1x', '2x', '3x', 'avatar'], strict = false) {
+  const sizesMap = sizes.reduce((memo, size) => {
+    if (!definedSizes[size]) {
+      throw new ReferenceError(`Size '${size}' is not defined`)
+    }
+
+    memo[size] = { ...definedSizes[size] }
+    return memo
+  }, {})
+
+  return {
+    description: 'Images object with URLs of various types of images',
+    anyOf: [{
+      type: 'object',
+      additionalProperties: !strict,
+      properties: {
+        ...sizesMap,
+        original: {
+          description: 'Original image',
+          example: 'https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879.png',
+          type: 'string',
+          format: 'uri'
+        }
+      } }, {
+      type: 'null'
+    }]
+  }
+}
+
+module.exports = { getImages }

package/lib/common/query.js

@@ -0,0 +1,64 @@
+const standardParams = {
+  start: {
+    description: 'The start date to filter entities by "updated_at" field value',
+    example: '2022-02-01T00:00:00.000Z',
+    type: 'string',
+    format: 'date-time'
+  },
+  end: {
+    description: 'The end date to filter entities by "updated_at" field value',
+    example: '2022-02-28T23:59:59.999Z',
+    type: 'string',
+    format: 'date-time'
+  },
+  limit: {
+    description: 'The maximum amount of entries on page (for paginated output)',
+    example: 50,
+    type: 'integer',
+    minimum: 1
+  },
+  active: {
+    description: 'Filter entities by "active" field value',
+    example: 'true',
+    type: 'string',
+    enum: ['true', 'false']
+  },
+  deleted: {
+    description: 'Filter entities which are deleted or not',
+    example: 'true',
+    type: 'string',
+    enum: ['true', 'false']
+  }
+}
+
+/**
+ * Generate a common query for entities set
+ * @param {Object} required Required fields to restrict the amount of entries
+ */
+function getQuery ({
+  standard = ['start', 'end'],
+  required = ['start', 'end'],
+  additional = {}
+} = {}) {
+  const properties = standard.reduce((memo, paramName) => {
+    if (!standardParams[paramName]) {
+      throw new ReferenceError(`Parameter '${paramName}' is not standard`)
+    }
+
+    memo[paramName] = { ...standardParams[paramName] }
+
+    return memo
+  }, {})
+
+  Object.assign(properties, additional)
+
+  return {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    additionalProperties: false,
+    type: 'object',
+    required,
+    properties
+  }
+}
+
+module.exports = getQuery

package/lib/common/response.js

@@ -1,7 +1,8 @@
 const cursor = {
   type: 'object',
+  description: 'Optional cursor in paginated API calls. The cursor next field must be called as fully quantifiable URI in order to hit the next if available.',
   additionalProperties: false,
-  description: 'Optional cursor in pagable API calls. The cursor next field must be called as fully qualifyable URI in order to hit the next page',
+  required: ['self'],
   properties: {
     next: {
       type: 'string',
@@ -47,14 +48,14 @@ function commonResponse ({ resultItems, results, additionals } = {}, { hasCursor
       msg: {
         type: 'string',
         minLength: 1,
-        example: 'Queried transactions sucessefully.',
-        description: 'Any English sentence, meant as information for developers and implementers. Avoid displaying this to the users and especially do not expect thos messages to stay stable.'
+        example: 'Queried transactions successfully.',
+        description: 'Any English sentence, meant as information for developers and implementers. Avoid displaying this to the users and especially do not expect those messages to stay stable.'
       },
       msg_localised: {
+        description: 'Optional localized message that can be displayed to the user if existing. The language can be set by in the request or will fallback to English.',
+        example: 'Abgefragte Transaktionen erfolgreich.',
         type: 'string',
-        minLength: 1,
-        example: 'Queried transactions sucessefully.',
-        description: 'Optional localised message that can be displayed to the user if existing. The language can be set by in the request or will fallback to English.'
+        minLength: 1
       },
       request: {
         type: 'object',
@@ -84,7 +85,7 @@ function commonResponse ({ resultItems, results, additionals } = {}, { hasCursor
     }
   }
 
-  if (hasCursor) response.cursor = cursor
+  if (hasCursor) response.properties.cursor = cursor
 
   return response
 }

package/lib/v0/audits/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  logs: require('./logs')
+}

package/lib/v0/audits/logs/base.js

@@ -0,0 +1,81 @@
+const { oneOf } = require('../../../helpers/payload-or-null')
+
+const changeEntry = {
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    op: {
+      description: 'Operation type',
+      type: 'string',
+      enum: [
+        'add',
+        'replace',
+        'remove'
+      ]
+    },
+    path: {
+      description: 'Changed property path (with dot as separator)',
+      type: 'string',
+      example: 'images.0.url'
+    },
+    value: {
+      description: 'Changed value',
+      type: 'string',
+      example: 'This is it'
+    }
+  }
+}
+
+module.exports = {
+  type: {
+    description: 'Log type (entity type and action type)',
+    type: 'string',
+    example: 'product.update'
+  },
+  old: oneOf({
+    description: 'Old data',
+    type: 'object',
+    example: {}
+  }),
+  new: oneOf({
+    description: 'New data',
+    type: 'object',
+    example: {
+      id: '0f91b67b-b1eb-4aba-827a-3a83ff967c5e',
+      name: 'Foo bar'
+    }
+  }),
+  change: oneOf({
+    description: 'Changes between old and new',
+    type: 'array',
+    items: changeEntry
+  }),
+  description: oneOf({
+    description: 'Description',
+    type: 'string',
+    example: 'Login attempt from service account'
+  }),
+  issuer: oneOf({
+    description: 'Issuer data',
+    type: 'object',
+    properties: {
+      sub_user: {
+        description: 'Sub-user (person authorized under organization account) UUID',
+        type: 'string',
+        format: 'uuid',
+        example: '8ddb94bf-98cf-4832-9833-c118ebf04675'
+      }
+    }
+  }),
+  metadata: oneOf({
+    description: 'Metadata',
+    type: 'object',
+    properties: {
+      user_agent: {
+        description: 'User-agent data',
+        type: 'string',
+        example: 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36'
+      }
+    }
+  })
+}

package/lib/v0/audits/logs/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  read: require('./read')
+}

package/lib/v0/audits/logs/read.js

@@ -0,0 +1,30 @@
+const commonBase = { ...require('../../../common/base') }
+const commonResponse = require('../../../common/response')
+const { oneOf } = require('../../../helpers/payload-or-null')
+
+const base = require('./base')
+
+// Logs are read-only
+delete commonBase.updated_at
+
+module.exports.response = {
+  $id: 'https://schemas.tillhub.com/v0/audits.logs.read.response.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  ...commonResponse({
+    resultItems: {
+      type: 'object',
+      required: ['id', 'created_at', 'insert_id', 'type'],
+      additionalProperties: false,
+      properties: {
+        ...commonBase,
+        insert_id: oneOf({
+          description: 'Sequential counter',
+          type: 'integer',
+          example: 16259
+        }),
+        ...base
+      }
+    }
+  }, { hasCursor: true })
+}

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,123 @@
+const baseObject = require('../../common/base')
+const commonResponse = require('../../common/response')
+const commonQuery = require('../../common/query')
+const base = require('./base')
+
+const extended = {
+  insert_id: {
+    description: 'Sequential branch index',
+    type: 'integer'
+  },
+  fa_account_number: {
+    description: 'Account number',
+    anyOf: [{
+      type: 'string'
+    }, {
+      type: 'null'
+    }]
+  },
+  configurations: {
+    description: 'Configurations set',
+    anyOf: [{
+      type: 'object'
+    }, {
+      type: 'null'
+    }]
+  },
+  merged_configurations: {
+    description: 'Merged configuration of branch and account',
+    anyOf: [{
+      type: 'object'
+    }, {
+      type: 'null'
+    }]
+  }
+}
+
+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'
           }
         }
       }

package/lib/v0/index.js

@@ -1,3 +1,4 @@
+module.exports.audits = require('./audits')
 module.exports.products = require('./products')
 module.exports.product_groups = require('./product_groups')
 module.exports.product_templates = require('./product_templates')

package/lib/v1/branches/index.js

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

package/lib/v1/branches/read.js

@@ -0,0 +1,16 @@
+const commonResponse = require('../../common/response')
+const { all } = require('../../v0/branches/read')
+
+module.exports.all = {
+  query: {
+    ...all.query,
+    $id: 'https://schemas.tillhub.com/v1/branches.read.all.query.schema.json'
+  },
+  response: {
+    ...all.response,
+    $id: 'https://schemas.tillhub.com/v1/branches.read.all.response.schema.json',
+    ...commonResponse({
+      resultItems: all.response.properties.results.items
+    }, { hasCursor: true })
+  }
+}

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

@@ -119,6 +119,18 @@ module.exports = oneOf({
           example: 'Regiondo',
           minLength: 2,
           maxLength: 24
+        },
+        log_level: {
+          description: 'defines the granularity of the web api logging.',
+          type: 'string',
+          enum: [
+            'error',
+            'warning',
+            'info',
+            'debug',
+            'verbose' // request/response bodies
+          ],
+          default: 'info'
         }
       }
     })

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

@@ -46,6 +46,18 @@ module.exports = {
               minimum: 0,
               maximum: 3600,
               default: 25
+            },
+            log_level: {
+              description: 'defines the granularity of the local server logging.',
+              type: 'string',
+              enum: [
+                'error',
+                'warning',
+                'info', // basic server info
+                'debug', // basic request/response info
+                'verbose' // request/response bodies
+              ],
+              default: 'info'
             }
           }
         }),

package/lib/v1/index.js

@@ -1,12 +1,13 @@
+module.exports.balances = require('./balances')
+module.exports.branches = require('./branches')
 module.exports.carts = require('./carts')
+module.exports.configurations = require('./configurations')
+module.exports.delivery_notes = require('./delivery_notes')
+module.exports.discounts = require('./discounts')
+module.exports.gastro_orders = require('./gastro_orders')
 module.exports.products = require('./products')
 module.exports.registers = require('./registers')
-module.exports.delivery_notes = require('./delivery_notes')
-module.exports.configurations = require('./configurations')
 module.exports.templates = require('./templates')
 module.exports.transactions = require('./transactions')
-module.exports.balances = require('./balances')
-module.exports.discounts = require('./discounts')
-module.exports.gastro_orders = require('./gastro_orders')
 
 // hygen:injection -  Please, don't delete this line: when running the cli for schema resources the new routes will be automatically added here.

package/package.json

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

package/test/audits/logs/logs.spec.js

@@ -0,0 +1,11 @@
+const test = require('tape')
+const validate = require('../../helpers/validate-schema')
+
+test('Audits:logs: read.response schema validation', function (t) {
+  t.plan(2)
+  const readResponse = require('../../../lib/v0/audits/logs').read.response
+  const { valid, error } = validate(readResponse)
+  t.ok(valid, 'create schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})

package/test/branches/branches.v0.spec.js

@@ -1,20 +1,59 @@
 const test = require('tape')
 const validate = require('../helpers/validate-schema')
+const branchesSchema = require('../../lib/v0/branches')
+
+test('Branches:v0: create schema validation', function (t) {
+  {
+    const { valid, error } = validate(branchesSchema.create.request)
+    t.ok(valid, 'create request schema is valid')
+    t.error(error, 'should not get any error')
+  }
+
+  {
+    const { valid, error } = validate(branchesSchema.create.response)
+    t.ok(valid, 'create response schema is valid')
+    t.error(error, 'should not get any error')
+  }
+
+  t.end()
+})
+
+test('Branches:v0: read.all schema validation', function (t) {
+  {
+    const { valid, error } = validate(branchesSchema.read.all.query)
+    t.ok(valid, 'read query schema is valid')
+    t.error(error, 'should not get any error')
+  }
+
+  {
+    const { valid, error } = validate(branchesSchema.read.all.response)
+    t.ok(valid, 'read response schema is valid')
+    t.error(error, 'should not get any error')
+  }
 
-test('Branches: create schema validation', function (t) {
-  t.plan(2)
-  const createRequest = require('../../lib/v0/branches').create.request
-  const { valid, error } = validate(createRequest)
-  t.ok(valid, 'create schema is valid')
-  t.error(error, 'should not get any error')
   t.end()
 })
 
-test('Branches: update schema validation', function (t) {
-  t.plan(2)
-  const updateRequest = require('../../lib/v0/branches').update.request
-  const { valid, error } = validate(updateRequest)
-  t.ok(valid, 'update schema is valid')
+test('Branches:v0: read.one schema validation', function (t) {
+  const { valid, error } = validate(branchesSchema.read.one.response)
+  t.ok(valid, 'read query schema is valid')
   t.error(error, 'should not get any error')
+
+  t.end()
+})
+
+test('Branches:v0: update schema validation', function (t) {
+  {
+    const { valid, error } = validate(branchesSchema.update.request)
+    t.ok(valid, 'update request schema is valid')
+    t.error(error, 'should not get any error')
+  }
+
+  {
+    const { valid, error } = validate(branchesSchema.update.response)
+    t.ok(valid, 'update response schema is valid')
+    t.error(error, 'should not get any error')
+  }
+
   t.end()
 })

package/test/branches/branches.v1.spec.js

@@ -0,0 +1,19 @@
+const test = require('tape')
+const validate = require('../helpers/validate-schema')
+const branchesSchema = require('../../lib/v1/branches')
+
+test('Branches:v1: read.all schema validation', function (t) {
+  {
+    const { valid, error } = validate(branchesSchema.read.all.query)
+    t.ok(valid, 'read query schema is valid')
+    t.error(error, 'should not get any error')
+  }
+
+  {
+    const { valid, error } = validate(branchesSchema.read.all.response)
+    t.ok(valid, 'read response schema is valid')
+    t.error(error, 'should not get any error')
+  }
+
+  t.end()
+})