@tillhub/schemas 6.208.0 → 6.210.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [6.210.0](https://github.com/tillhub/schemas/compare/v6.209.0...v6.210.0) (2023-04-25)
+
+
+### Features
+
+* **branchMms:** update branch & add branchMms ([e9d5821](https://github.com/tillhub/schemas/commit/e9d5821))
+* **mmsbranch:** fix typo ([d35d641](https://github.com/tillhub/schemas/commit/d35d641))
+
+# [6.209.0](https://github.com/tillhub/schemas/compare/v6.208.0...v6.209.0) (2023-04-18)
+
+
+### Features
+
+* **pricelists:** schema for new pricelists endpoint ([7254752](https://github.com/tillhub/schemas/commit/7254752))
+
 # [6.208.0](https://github.com/tillhub/schemas/compare/v6.207.0...v6.208.0) (2023-04-18)
 
 

package/lib/common/date_time_constraints.js

@@ -0,0 +1,113 @@
+const { oneOf } = require('../helpers/payload-or-null')
+const { timezone } = require('../common/timezones')
+
+const dateRange = {
+  type: 'object',
+  additionalProperties: false,
+  required: [
+    'enabled'
+  ],
+  properties: {
+    enabled: {
+      type: 'boolean',
+      description: 'disables or activates the date range',
+      default: true
+    },
+    tz: oneOf({
+      deprecated: true,
+      type: 'string',
+      description: 'specifies the timezone for a data range',
+      enum: timezone.iana,
+      default: null
+    }),
+    start: oneOf({
+      type: 'object',
+      additionalProperties: false,
+      required: [
+        'enabled'
+      ],
+      properties: {
+        enabled: {
+          type: 'boolean',
+          description: 'disables or activates the start of a date range',
+          default: true
+        },
+        value: oneOf({
+          type: 'string',
+          format: 'date-time',
+          description: 'starting time of a date range',
+          example: '2021-09-23T08:19:02.059Z',
+          default: null // == distant past
+        })
+      }
+    }),
+    end: oneOf({
+      type: 'object',
+      additionalProperties: false,
+      required: [
+        'enabled'
+      ],
+      properties: {
+        enabled: {
+          type: 'boolean',
+          description: 'disables or activates the end of a date range',
+          default: true
+        },
+        value: oneOf({
+          type: 'string',
+          format: 'date-time',
+          description: 'starting time of a date range',
+          example: '2021-10-03T14:20:31.011Z',
+          default: null // == distant future
+        })
+      }
+    })
+  }
+}
+
+const dayTimeSlot = {
+  type: 'object',
+  additionalProperties: false,
+  required: [
+    'enabled'
+  ],
+  properties: {
+    enabled: {
+      type: 'boolean',
+      description: 'disables or activates a set slot',
+      default: true
+    },
+    start: oneOf({
+      type: 'string',
+      pattern: '([0-1][0-9]|2[0-3]):[0-5][0-9]',
+      example: '08:30',
+      description: 'daytime for the start of an active time slot',
+      default: '00:00'
+    }),
+    end: oneOf({
+      type: 'string',
+      pattern: '([0-1][0-9]|2[0-3]):[0-5][0-9]',
+      example: '09:15',
+      description: 'daytime for the end of an active time slot',
+      default: '23:59'
+    })
+  }
+}
+
+const dayTimeSlots = oneOf({
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    slots: oneOf({
+      description: 'A number of timeslots for a specific day. Not enforced - but overlaps are not encouraged',
+      type: 'array',
+      items: dayTimeSlot
+    })
+  }
+})
+
+module.exports = {
+  dateRange,
+  dayTimeSlot,
+  dayTimeSlots
+}

package/lib/common/time_constraints.js

@@ -1,110 +1,5 @@
 const { oneOf } = require('../helpers/payload-or-null')
-const { timezone } = require('../common/timezones')
-
-const dateRange = {
-  type: 'object',
-  additionalProperties: false,
-  required: [
-    'enabled'
-  ],
-  properties: {
-    enabled: {
-      type: 'boolean',
-      description: 'disables or activates the date range',
-      default: true
-    },
-    tz: oneOf({
-      deprecated: true,
-      type: 'string',
-      description: 'specifies the timezone for a data range',
-      enum: timezone.iana,
-      default: null
-    }),
-    start: oneOf({
-      type: 'object',
-      additionalProperties: false,
-      required: [
-        'enabled'
-      ],
-      properties: {
-        enabled: {
-          type: 'boolean',
-          description: 'disables or activates the start of a date range',
-          default: true
-        },
-        value: oneOf({
-          type: 'string',
-          format: 'date-time',
-          description: 'starting time of a date range',
-          example: '2021-09-23T08:19:02.059Z',
-          default: null // == distant past
-        })
-      }
-    }),
-    end: oneOf({
-      type: 'object',
-      additionalProperties: false,
-      required: [
-        'enabled'
-      ],
-      properties: {
-        enabled: {
-          type: 'boolean',
-          description: 'disables or activates the end of a date range',
-          default: true
-        },
-        value: oneOf({
-          type: 'string',
-          format: 'date-time',
-          description: 'starting time of a date range',
-          example: '2021-10-03T14:20:31.011Z',
-          default: null // == distant future
-        })
-      }
-    })
-  }
-}
-
-const dayTimeSlot = {
-  type: 'object',
-  additionalProperties: false,
-  required: [
-    'enabled'
-  ],
-  properties: {
-    enabled: {
-      type: 'boolean',
-      description: 'disables or activates a set slot',
-      default: true
-    },
-    start: oneOf({
-      type: 'string',
-      pattern: '([0-1][0-9]|2[0-3]):[0-5][0-9]',
-      example: '08:30',
-      description: 'daytime for the start of an active time slot',
-      default: '00:00'
-    }),
-    end: oneOf({
-      type: 'string',
-      pattern: '([0-1][0-9]|2[0-3]):[0-5][0-9]',
-      example: '09:15',
-      description: 'daytime for the end of an active time slot',
-      default: '23:59'
-    })
-  }
-}
-
-const dayTimeSlots = oneOf({
-  type: 'object',
-  additionalProperties: false,
-  properties: {
-    slots: oneOf({
-      description: 'A number of timeslots for a specific day. Not enforced - but overlaps are not encouraged',
-      type: 'array',
-      items: dayTimeSlot
-    })
-  }
-})
+const { dateRange, dayTimeSlots } = require('./date_time_constraints')
 
 module.exports = {
   type: 'object',

package/lib/v0/branches/base-mms.js

@@ -0,0 +1,160 @@
+const { oneOf } = require('../../helpers/payload-or-null')
+
+module.exports = {
+  branch_id: {
+    description: 'The id of the parent branch.',
+    type: 'string',
+    format: 'uuid'
+  },
+  mms_id: oneOf({
+    description: 'The id of the branch that identifies it in Mms.',
+    type: 'string',
+    format: 'uuid'
+  }),
+  created_by: oneOf({
+    description: 'When was created the branch in Mms.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  updated_by: oneOf({
+    description: 'Last time it was updated in Mms.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  scope: oneOf({
+    description: 'The scope from Mms.',
+    type: 'string',
+    format: 'uuid'
+  }),
+  attributes: oneOf({
+    description: 'The attributes of the branch.',
+    type: 'object'
+  }),
+  vat_id: oneOf({
+    description: 'The vat id.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  commercial_register_number: oneOf({
+    description: 'The commercial register number.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  creditor_id: oneOf({
+    description: 'The creditor id.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  court_of_jurisdiction: oneOf({
+    description: 'The court of jurisdiction.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  company_name_short: oneOf({
+    description: 'The short company name.',
+    type: 'string',
+    maxLength: 1024,
+    minLength: 1
+  }),
+  company_description: oneOf({
+    description: 'The company description.',
+    type: 'string',
+    maxLength: 16384,
+    minLength: 1
+  }),
+  registration_authority: oneOf({
+    description: 'The registration authority.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  legal_entity_type: oneOf({
+    description: 'The legal entity type.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  country_of_registration: oneOf({
+    description: 'The country of registration.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  countries_of_operations: oneOf({
+    description: 'The countries of operations.',
+    type: 'array',
+    items: {
+      type: 'string'
+    }
+  }),
+  date_of_foundation: oneOf({
+    description: 'The date of foundation.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  website: oneOf({
+    description: 'The website.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  sector: oneOf({
+    description: 'The sector.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  contacts: oneOf({
+    description: 'The contacts.',
+    type: 'object'
+  }),
+  unzer_identifier_records: oneOf({
+    description: 'The unzer identifier records.',
+    type: 'object'
+  }),
+  state: oneOf({
+    description: 'The state.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  contracts: oneOf({
+    description: 'The contracts.',
+    type: 'object'
+  }),
+  units: oneOf({
+    description: 'The uuids of units.',
+    type: 'array',
+    items: {
+      type: 'string',
+      format: 'uuid'
+    }
+  }),
+  sales_streams: oneOf({
+    description: 'The uuids of sales streams.',
+    type: 'array',
+    items: {
+      type: 'string',
+      format: 'uuid'
+    }
+  }),
+  type: oneOf({
+    description: 'The type.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  }),
+  unit_unzer_id: oneOf({
+    description: 'The unit unzer id.',
+    type: 'string',
+    maxLength: 255,
+    minLength: 1
+  })
+}

package/lib/v0/branches/base.js

@@ -18,6 +18,32 @@ module.exports = {
       }
     ]
   },
+  created_at: {
+    description: 'When the branch was created. It was added for creating branches coming from MMS',
+    oneOf: [
+      {
+        type: 'string',
+        format: 'date-time',
+        example: '2019-03-17T21:12:04.849Z'
+      },
+      {
+        type: 'null'
+      }
+    ]
+  },
+  updated_at: {
+    description: 'When the branch was last updated. It was added for creating branches coming from MMS',
+    oneOf: [
+      {
+        type: 'string',
+        format: 'date-time',
+        example: '2019-03-17T21:12:04.849Z'
+      },
+      {
+        type: 'null'
+      }
+    ]
+  },
   phonenumbers: {
     description: 'A number of valid types of phone numbers for a branch.',
     anyOf: [

package/lib/v0/branches/create.js

@@ -1,6 +1,18 @@
 const baseObject = require('../../common/base')
 const commonResponse = require('../../common/response')
 const base = require('./base')
+const baseMms = require('./base-mms')
+
+module.exports.mms = {
+  $id: 'https://schemas.tillhub.com/v0/branches.create.mms.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  additionalProperties: false,
+  required: [
+    'branch_id'
+  ],
+  properties: baseMms,
+  type: 'object'
+}
 
 module.exports.request = {
   $id: 'https://schemas.tillhub.com/v0/branches.create.request.schema.json',

package/lib/v1/products/index.js

@@ -215,3 +215,5 @@ module.exports.bulk = {
     }
   }
 }
+
+module.exports.pricelist = require('./pricelist/index')

package/lib/v1/products/pricelist/index.js

@@ -0,0 +1,12 @@
+const commonResponse = require('../../../common/response')
+module.exports = {
+  get: {
+    all: {
+      response: {
+        $id: 'https://schemas.tillhub.com/v1/products.pricelist.get-all.response.schema.json',
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        ...commonResponse({ resultItems: require('./response') }, { hasCursor: true })
+      }
+    }
+  }
+}

package/lib/v1/products/pricelist/response.js

@@ -0,0 +1,103 @@
+const { oneOf } = require('../../../helpers/payload-or-null')
+const { dateRange, dayTimeSlots } = require('../../../common/date_time_constraints')
+
+module.exports = {
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    product: {
+      description: 'The reference to the product',
+      type: 'string',
+      format: 'uuid'
+    },
+    type: {
+      description: 'Type of the product prices',
+      type: 'string',
+      enum: [
+        'scaled',
+        'branch',
+        'time-based'
+      ],
+      example: 'scaled'
+    },
+    created_at: {
+      type: 'string',
+      format: 'date-time',
+      example: '2018-11-04T23:18:43.075Z'
+    },
+    updated_at: {
+      type: 'string',
+      format: 'date-time',
+      example: '2018-11-04T23:18:43.075Z'
+    },
+    deleted: {
+      type: 'boolean',
+      default: false
+    },
+    net: {
+      ...oneOf({
+        description: 'The net sales price is the price without sales tax.',
+        example: '27633.02',
+        type: 'number',
+        minimum: 0,
+        maximum: 1000000,
+        multipleOf: 0.01
+      })
+    },
+    gross: {
+      ...oneOf({
+        description: 'The gross sales price is the price that the customer pays, including sales tax.',
+        example: '27633.02',
+        type: 'number',
+        minimum: 0,
+        maximum: 1000000,
+        multipleOf: 0.01
+      })
+    },
+    currency: {
+      ...oneOf({
+        type: 'string',
+        description: 'The three letter [ISO currency](https://en.wikipedia.org/wiki/ISO_4217) of this item.',
+        example: 'EUR',
+        minLength: 3,
+        maxLength: 3
+      })
+    },
+    price_book: oneOf({
+      description: 'The reference to the price book',
+      type: 'string',
+      format: 'uuid'
+    }),
+    quantity: oneOf({
+      description: 'The price is applied if quantity of items in cart is bigger or equal to this number. If 0, then it represents default pricing.',
+      type: 'number',
+      minimum: 0,
+      example: 0
+    }),
+    date_range: oneOf({
+      description: 'a single range with optional start and end date',
+      dateRange
+    }),
+    day_of_week: oneOf({
+      type: 'object',
+      description: 'specifies daytime slots based on weekdays',
+      additionalProperties: false,
+      required: [
+        'enabled'
+      ],
+      properties: {
+        enabled: {
+          type: 'boolean',
+          default: true
+        },
+        monday: dayTimeSlots,
+        tuesday: dayTimeSlots,
+        wednesday: dayTimeSlots,
+        thursday: dayTimeSlots,
+        friday: dayTimeSlots,
+        saturday: dayTimeSlots,
+        sunday: dayTimeSlots
+      }
+    })
+  }
+}

package/package.json

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