@tillhub/schemas 6.120.0 → 6.121.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [6.121.0](https://github.com/tillhub/schemas/compare/v6.120.0...v6.121.0) (2022-02-21)
+
+
+### Bug Fixes
+
+* **tests:** remove require() errors ([f2b6a16](https://github.com/tillhub/schemas/commit/f2b6a16))
+
+
+### Features
+
+* **customers:** add rmissing schemas #API-1393 ([#672](https://github.com/tillhub/schemas/issues/672)) ([a4b8f30](https://github.com/tillhub/schemas/commit/a4b8f30)), closes [#API-1393](https://github.com/tillhub/schemas/issues/API-1393) [#API-1393](https://github.com/tillhub/schemas/issues/API-1393)
+
 # [6.120.0](https://github.com/tillhub/schemas/compare/v6.119.0...v6.120.0) (2022-02-17)
 
 

package/lib/common/address.js

@@ -1,7 +1,7 @@
-module.exports = {
-  type: 'object',
-  additionalProperties: false,
-  required: [
+const { oneOf } = require('../helpers/payload-or-null')
+
+function getAddress ({
+  required = [
     'lines',
     'street',
     'locality',
@@ -10,10 +10,21 @@ module.exports = {
     'country',
     'type'
   ],
-  properties: {
-    lines: {
-      oneOf: [
-        {
+  availableTypes = [
+    'local',
+    'delivery',
+    'billing'
+  ]
+} = {}) {
+  return {
+    type: 'object',
+    additionalProperties: false,
+    required,
+    properties: {
+      lines: {
+        description: 'Address details',
+        example: 'Penthouse',
+        ...oneOf({
           type: 'array',
           minItems: 1,
           maxItems: 4,
@@ -21,91 +32,65 @@ module.exports = {
             type: 'string',
             minLength: 1
           }
-        },
-        {
-          type: 'null'
-        }
-      ]
-    },
-    street: {
-      oneOf: [
-        {
+        })
+      },
+      street: {
+        description: 'Street name',
+        example: 'Genthiner Str.',
+        ...oneOf({
           type: 'string'
-        },
-        {
-          type: 'null'
-        }
-      ]
-    },
-    street_number: {
-      oneOf: [
-        {
+        })
+      },
+      street_number: {
+        description: 'Building number',
+        example: '34',
+        ...oneOf({
           type: 'string'
-        },
-        {
-          type: 'null'
-        }
-      ]
-    },
-    locality: {
-      oneOf: [
-        {
+        })
+      },
+      locality: {
+        description: 'Locality name (city, village, etc.)',
+        example: 'Berlin',
+        ...oneOf({
           type: 'string'
-        },
-        {
-          type: 'null'
-        }
-      ]
-    },
-    region: {
-      oneOf: [
-        {
+        })
+      },
+      region: {
+        description: 'Region name',
+        example: 'Branderburg',
+        ...oneOf({
           type: 'string'
-        },
-        {
-          type: 'null'
-        }
-      ]
-    },
-    postal_code: {
-      oneOf: [
-        {
+        })
+      },
+      postal_code: {
+        description: 'Postal code',
+        example: '10785',
+        ...oneOf({
           type: 'string',
           maxLength: 10
-        },
-        {
-          type: 'null'
-        }
-      ]
-    },
-    country: {
-      oneOf: [
-        {
+        })
+      },
+      country: {
+        description: 'Country',
+        example: 'Germany',
+        ...oneOf({
           type: 'string',
           minLength: 2,
           maxLength: 2,
           pattern: '^[A-Z]{2}$'
-        },
-        {
-          type: 'null'
-        }
-      ],
-      'default': null
-    },
-    type: {
-      oneOf: [
-        {
+        }),
+        'default': null
+      },
+      type: {
+        description: 'Address type',
+        example: 'delivery',
+        ...oneOf({
           type: 'string',
-          'enum': [
-            'local',
-            'delivery',
-            'billing'
-          ]
-        },
-        {
-          type: 'null'
-        }
-      ]
+          'enum': availableTypes
+        })
+      }
     }
   }
 }
+
+module.exports = { getAddress }

package/lib/common/images.js

@@ -17,6 +17,12 @@ const definedSizes = {
     type: 'string',
     format: 'uri'
   },
+  gallery: {
+    description: 'Image transformed to predefined size to use in gallery',
+    example: 'https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_gallery.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',

package/lib/common/response.js

@@ -8,19 +8,19 @@ const cursor = {
       type: 'string',
       format: 'uri',
       description: 'The URI pointing to the next page.',
-      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?first=2018-07-02T21%3A47%3A44.382Z&page=0&size=10&cursor_field=updated_at'
+      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
     },
     first: {
       type: 'string',
       format: 'uri',
       description: 'The URI pointing to the the first page.',
-      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?first=2018-07-02T21%3A47%3A44.382Z&page=1&size=10&cursor_field=updated_at'
+      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
     },
     self: {
       type: 'string',
       format: 'uri',
       description: 'The URI pointing to this page.',
-      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?first=2018-07-02T21%3A47%3A44.382Z&page=0&size=10&cursor_field=updated_at'
+      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
     }
   }
 }

package/lib/v0/branches/read.js

@@ -1,6 +1,8 @@
 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 = {
@@ -10,27 +12,21 @@ const extended = {
   },
   fa_account_number: {
     description: 'Account number',
-    anyOf: [{
+    ...oneOf({
       type: 'string'
-    }, {
-      type: 'null'
-    }]
+    })
   },
   configurations: {
     description: 'Configurations set',
-    anyOf: [{
+    ...oneOf({
       type: 'object'
-    }, {
-      type: 'null'
-    }]
+    })
   },
   merged_configurations: {
     description: 'Merged configuration of branch and account',
-    anyOf: [{
+    ...oneOf({
       type: 'object'
-    }, {
-      type: 'null'
-    }]
+    })
   }
 }