@tillhub/schemas 6.120.0 → 6.121.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,35 @@
1
+ const { oneOf } = require('../../helpers/payload-or-null')
2
+
3
+ module.exports = {
4
+ insert_id: {
5
+ description: 'Sequential customer index',
6
+ type: 'integer'
7
+ },
8
+ customer_group: {
9
+ description: 'Deprecated: The group of customer',
10
+ ...oneOf({
11
+ type: 'string'
12
+ })
13
+ },
14
+ price_list: {
15
+ description: 'Price list',
16
+ ...oneOf({
17
+ type: 'object'
18
+ })
19
+ },
20
+ delegated_to: {
21
+ description: 'Entries customer delegated to',
22
+ ...oneOf({
23
+ type: 'array',
24
+ items: {
25
+ type: 'string'
26
+ }
27
+ })
28
+ },
29
+ owner: {
30
+ description: 'Deprecated: Owner',
31
+ ...oneOf({
32
+ type: 'string'
33
+ })
34
+ }
35
+ }
@@ -0,0 +1,41 @@
1
+ const { anyOf } = require('../../helpers/payload-or-null')
2
+ const baseObject = require('../../common/base')
3
+ const commonResponse = require('../../common/response')
4
+
5
+ const base = require('./base')
6
+
7
+ module.exports = {
8
+ request: {
9
+ $id: 'https://schemas.tillhub.com/v0/customers.create.request.schema.json',
10
+ $schema: 'http://json-schema.org/draft-07/schema#',
11
+ additionalProperties: false,
12
+ type: 'object',
13
+ properties: base,
14
+ ...anyOf([{
15
+ required: [
16
+ 'firstname'
17
+ ]
18
+ }, {
19
+ required: [
20
+ 'lastname'
21
+ ]
22
+ }
23
+ ]),
24
+ required: []
25
+ },
26
+ response: {
27
+ $id: 'https://schemas.tillhub.com/v0/customers.create.response.schema.json',
28
+ $schema: 'http://json-schema.org/draft-07/schema#',
29
+ additionalProperties: false,
30
+ ...commonResponse({
31
+ resultItems: {
32
+ type: 'object',
33
+ additionalProperties: false,
34
+ properties: {
35
+ ...baseObject(),
36
+ ...base
37
+ }
38
+ }
39
+ })
40
+ }
41
+ }
@@ -1,14 +1,120 @@
1
1
  const { oneOf } = require('../../helpers/payload-or-null')
2
+ const baseObject = require('../../common/base')
3
+ const commonResponse = require('../../common/response')
4
+
5
+ const base = require('./base')
6
+ const baseExtended = require('./baseExt')
7
+ const create = require('./create')
8
+ const update = require('./update')
2
9
  const notes = require('./notes').base
3
10
 
4
- module.exports.base = {
11
+ const extended = {
5
12
  analytics: require('./properties/anaylytics'),
6
- notes: {
7
- ...oneOf({
8
- type: 'array',
9
- items: {
10
- ...notes
13
+ notes: oneOf({
14
+ type: 'array',
15
+ items: {
16
+ ...notes
17
+ }
18
+ })
19
+ }
20
+
21
+ module.exports = {
22
+ create: {
23
+ request: {
24
+ $id: 'https://schemas.tillhub.com/v0/customers.ext.create.request.schema.json',
25
+ $schema: 'http://json-schema.org/draft-07/schema#',
26
+ additionalProperties: false,
27
+ type: 'object',
28
+ required: create.request.required,
29
+ properties: {
30
+ ...base,
31
+ ...extended
32
+ }
33
+ },
34
+ response: {
35
+ $id: 'https://schemas.tillhub.com/v0/customers.ext.create.response.schema.json',
36
+ $schema: 'http://json-schema.org/draft-07/schema#',
37
+ additionalProperties: false,
38
+ ...commonResponse({
39
+ resultItems: {
40
+ type: 'object',
41
+ additionalProperties: false,
42
+ properties: {
43
+ ...baseObject(),
44
+ ...base,
45
+ ...extended
46
+ }
47
+ }
48
+ })
49
+ }
50
+ },
51
+ read: {
52
+ all: {
53
+ response: {
54
+ $id: 'https://schemas.tillhub.com/v0/customers.ext.read.all.response.schema.json',
55
+ $schema: 'http://json-schema.org/draft-07/schema#',
56
+ additionalProperties: false,
57
+ ...commonResponse({
58
+ resultItems: {
59
+ type: 'object',
60
+ additionalProperties: false,
61
+ properties: {
62
+ ...baseObject(),
63
+ ...base,
64
+ ...baseExtended,
65
+ ...extended
66
+ }
67
+ }
68
+ }, { hasCursor: true })
69
+ }
70
+ },
71
+ one: {
72
+ response: {
73
+ $id: 'https://schemas.tillhub.com/v0/customers.ext.read.one.response.schema.json',
74
+ $schema: 'http://json-schema.org/draft-07/schema#',
75
+ additionalProperties: false,
76
+ ...commonResponse({
77
+ resultItems: {
78
+ type: 'object',
79
+ additionalProperties: false,
80
+ properties: {
81
+ ...baseObject(),
82
+ ...base,
83
+ ...baseExtended,
84
+ ...extended
85
+ }
86
+ }
87
+ }, { hasCursor: true })
88
+ }
89
+ }
90
+ },
91
+ update: {
92
+ request: {
93
+ $id: 'https://schemas.tillhub.com/v0/customers.ext.update.request.schema.json',
94
+ $schema: 'http://json-schema.org/draft-07/schema#',
95
+ additionalProperties: false,
96
+ type: 'object',
97
+ required: update.request.required,
98
+ properties: {
99
+ ...base,
100
+ ...extended
11
101
  }
12
- })
102
+ },
103
+ response: {
104
+ $id: 'https://schemas.tillhub.com/v0/customers.ext.update.response.schema.json',
105
+ $schema: 'http://json-schema.org/draft-07/schema#',
106
+ additionalProperties: false,
107
+ ...commonResponse({
108
+ resultItems: {
109
+ type: 'object',
110
+ additionalProperties: false,
111
+ properties: {
112
+ ...baseObject(),
113
+ ...base,
114
+ ...extended
115
+ }
116
+ }
117
+ })
118
+ }
13
119
  }
14
120
  }
@@ -1,46 +1,17 @@
1
- const ext = require('./ext')
2
1
  const base = require('./base')
3
-
4
- const createRequest = require('./create.request')
5
- const updateRequest = require('./update.request')
2
+ const create = require('./create')
3
+ const read = require('./read')
4
+ const update = require('./update')
6
5
  const notesCreateRequest = require('./notes').create
6
+ const ext = require('./ext')
7
7
 
8
- module.exports.create = {
9
- request: createRequest
10
- }
11
-
12
- module.exports.update = {
13
- request: updateRequest
8
+ module.exports = {
9
+ create,
10
+ read,
11
+ update,
12
+ ext
14
13
  }
15
14
 
16
- module.exports.ext = {
17
- create: {
18
- request: {
19
- $id: 'https://schemas.tillhub.com/v0/customers.ext.create.request.schema.json',
20
- $schema: 'http://json-schema.org/draft-07/schema#',
21
- additionalProperties: false,
22
- type: 'object',
23
- required: createRequest.required,
24
- properties: {
25
- ...base,
26
- ...ext.base
27
- }
28
- }
29
- },
30
- update: {
31
- request: {
32
- $id: 'https://schemas.tillhub.com/v0/customers.ext.update.request.schema.json',
33
- $schema: 'http://json-schema.org/draft-07/schema#',
34
- additionalProperties: false,
35
- type: 'object',
36
- required: updateRequest.required,
37
- properties: {
38
- ...base,
39
- ...ext.base
40
- }
41
- }
42
- }
43
- }
44
15
  module.exports.notes = {
45
16
  create: {
46
17
  request: {
@@ -65,18 +36,15 @@ module.exports.bulk = {
65
36
  properties: {
66
37
  ...base
67
38
  },
68
- anyOf: [
69
- {
70
- required: [
71
- 'firstname'
72
- ]
73
- },
74
- {
75
- required: [
76
- 'lastname'
77
- ]
78
- }
79
- ],
39
+ anyOf: [{
40
+ required: [
41
+ 'firstname'
42
+ ]
43
+ }, {
44
+ required: [
45
+ 'lastname'
46
+ ]
47
+ }],
80
48
  required: []
81
49
  }
82
50
  }
@@ -12,7 +12,7 @@ module.exports = {
12
12
  additionalProperties: false,
13
13
  properties: {
14
14
  top_seller: {
15
- description: 'Reference to top selling Tillhub staff, based on "salesman_staff" on cartitem level. The top results per currency are shown.',
15
+ description: 'Reference to top selling staff person, based on "salesman_staff" on cart item level. The top results per currency are shown.',
16
16
  ...oneOf({
17
17
  type: 'array',
18
18
  items: {
@@ -49,7 +49,7 @@ module.exports = {
49
49
  })
50
50
  },
51
51
  top_branch: {
52
- description: 'Reference to top selling Tillhub branch. The top results per currency are shown.',
52
+ description: 'Reference to top selling branch. The top results per currency are shown.',
53
53
  ...oneOf({
54
54
  type: 'array',
55
55
  items: {
@@ -79,7 +79,7 @@ module.exports = {
79
79
  },
80
80
  branch_number: {
81
81
  type: 'number',
82
- min: 0,
82
+ minimum: 0,
83
83
  multipleOf: 1
84
84
  },
85
85
  branch: {
@@ -94,14 +94,14 @@ module.exports = {
94
94
  description: 'The anbsolute number of cart items (products), including the absolute returns. This is meant as "items handled" per customer.',
95
95
  ...oneOf({
96
96
  type: 'number',
97
- min: 0
97
+ minimum: 0
98
98
  })
99
99
  },
100
100
  total_quantity_returns: {
101
101
  description: 'Absolute number of all transactions that include at least a return.',
102
102
  ...oneOf({
103
103
  type: 'number',
104
- min: 0,
104
+ minimum: 0,
105
105
  multipleOf: 1
106
106
  })
107
107
  },
@@ -109,7 +109,7 @@ module.exports = {
109
109
  description: 'Absolute number of all cart items that are of type "sale".',
110
110
  ...oneOf({
111
111
  type: 'number',
112
- min: 0,
112
+ minimum: 0,
113
113
  multipleOf: 1
114
114
  })
115
115
  },
@@ -150,7 +150,7 @@ module.exports = {
150
150
  description: 'Absolute number of all transactions.',
151
151
  ...oneOf({
152
152
  type: 'number',
153
- min: 0,
153
+ minimum: 0,
154
154
  multipleOf: 1
155
155
  })
156
156
  },
@@ -0,0 +1,42 @@
1
+ const baseObject = require('../../common/base')
2
+ const commonResponse = require('../../common/response')
3
+ const base = require('./base')
4
+ const baseExtended = require('./baseExt')
5
+
6
+ module.exports.all = {
7
+ response: {
8
+ $id: 'https://schemas.tillhub.com/v0/customers.read.all.response.schema.json',
9
+ $schema: 'http://json-schema.org/draft-07/schema#',
10
+ additionalProperties: false,
11
+ ...commonResponse({
12
+ resultItems: {
13
+ type: 'object',
14
+ additionalProperties: false,
15
+ properties: {
16
+ ...baseObject(),
17
+ ...base,
18
+ ...baseExtended
19
+ }
20
+ }
21
+ }, { hasCursor: true })
22
+ }
23
+ }
24
+
25
+ module.exports.one = {
26
+ response: {
27
+ $id: 'https://schemas.tillhub.com/v0/customers.read.one.response.schema.json',
28
+ $schema: 'http://json-schema.org/draft-07/schema#',
29
+ additionalProperties: false,
30
+ ...commonResponse({
31
+ resultItems: {
32
+ type: 'object',
33
+ additionalProperties: false,
34
+ properties: {
35
+ ...baseObject(),
36
+ ...base,
37
+ ...baseExtended
38
+ }
39
+ }
40
+ })
41
+ }
42
+ }
@@ -0,0 +1,30 @@
1
+ const baseObject = require('../../common/base')
2
+ const commonResponse = require('../../common/response')
3
+
4
+ const base = require('./base')
5
+
6
+ module.exports = {
7
+ request: {
8
+ $id: 'https://schemas.tillhub.com/v0/customers.update.request.schema.json',
9
+ $schema: 'http://json-schema.org/draft-07/schema#',
10
+ additionalProperties: false,
11
+ type: 'object',
12
+ properties: base,
13
+ required: []
14
+ },
15
+ response: {
16
+ $id: 'https://schemas.tillhub.com/v0/customers.update.response.schema.json',
17
+ $schema: 'http://json-schema.org/draft-07/schema#',
18
+ additionalProperties: false,
19
+ ...commonResponse({
20
+ resultItems: {
21
+ type: 'object',
22
+ additionalProperties: false,
23
+ properties: {
24
+ ...baseObject(),
25
+ ...base
26
+ }
27
+ }
28
+ })
29
+ }
30
+ }
@@ -1,5 +1,5 @@
1
1
 
2
- const address = require('../../common/address')
2
+ const { getAddress } = require('../../common/address')
3
3
 
4
4
  module.exports = {
5
5
  order: {
@@ -138,7 +138,7 @@ module.exports = {
138
138
  },
139
139
  recipient: {
140
140
  oneOf: [
141
- address,
141
+ getAddress(),
142
142
  {
143
143
  type: 'null'
144
144
  }
@@ -146,7 +146,7 @@ module.exports = {
146
146
  },
147
147
  sender: {
148
148
  oneOf: [
149
- address,
149
+ getAddress(),
150
150
  {
151
151
  type: 'null'
152
152
  }
@@ -1,4 +1,4 @@
1
- const address = require('../../common/address')
1
+ const { getAddress } = require('../../common/address')
2
2
  const orderItem = require('./items').create
3
3
 
4
4
  module.exports = {
@@ -92,13 +92,13 @@ module.exports = {
92
92
  type: 'object',
93
93
  additionalProperties: false,
94
94
  properties: {
95
- address
95
+ address: getAddress()
96
96
  }
97
97
  },
98
98
  sender: {
99
99
  type: 'object',
100
100
  properties: {
101
- address
101
+ address: getAddress()
102
102
  }
103
103
  },
104
104
  direction: {
@@ -1,4 +1,4 @@
1
- const address = require('../../common/address')
1
+ const { getAddress } = require('../../common/address')
2
2
 
3
3
  module.exports = {
4
4
  $id: 'https://schemas.tillhub.com/v0/pdfs.templates.deliveries.create.schema.json',
@@ -78,9 +78,7 @@ module.exports = {
78
78
  },
79
79
  sender: {
80
80
  oneOf: [
81
- {
82
- ...address
83
- },
81
+ getAddress(),
84
82
  {
85
83
  type: 'null'
86
84
  }
@@ -116,9 +114,7 @@ module.exports = {
116
114
  },
117
115
  recipient: {
118
116
  oneOf: [
119
- {
120
- ...address
121
- },
117
+ getAddress(),
122
118
  {
123
119
  type: 'null'
124
120
  }
@@ -1,4 +1,4 @@
1
- const address = require('../../common/address')
1
+ const { getAddress } = require('../../common/address')
2
2
 
3
3
  module.exports = {
4
4
  $id: 'https://schemas.tillhub.com/v0/pdfs.templates.delivery_notes.create.schema.json',
@@ -73,9 +73,7 @@ module.exports = {
73
73
  },
74
74
  address: {
75
75
  oneOf: [
76
- {
77
- ...address
78
- },
76
+ getAddress(),
79
77
  {
80
78
  type: 'null'
81
79
  }
@@ -120,9 +118,7 @@ module.exports = {
120
118
  },
121
119
  address: {
122
120
  oneOf: [
123
- {
124
- ...address
125
- },
121
+ getAddress(),
126
122
  {
127
123
  type: 'null'
128
124
  }
@@ -1,4 +1,4 @@
1
- const address = require('../../common/address')
1
+ const { getAddress } = require('../../common/address')
2
2
 
3
3
  module.exports = {
4
4
  $id: 'https://schemas.tillhub.com/v0/pdfs.templates.full_receipts.create.schema.json',
@@ -86,9 +86,7 @@ module.exports = {
86
86
  },
87
87
  address: {
88
88
  oneOf: [
89
- {
90
- ...address
91
- },
89
+ getAddress(),
92
90
  {
93
91
  type: 'null'
94
92
  }
@@ -133,9 +131,7 @@ module.exports = {
133
131
  },
134
132
  address: {
135
133
  oneOf: [
136
- {
137
- ...address
138
- },
134
+ getAddress(),
139
135
  {
140
136
  type: 'null'
141
137
  }
@@ -1,4 +1,4 @@
1
- const address = require('../../common/address')
1
+ const { getAddress } = require('../../common/address')
2
2
 
3
3
  module.exports = {
4
4
  $id: 'https://schemas.tillhub.com/v0/pdfs.templates.invoices.create.schema.json',
@@ -86,9 +86,7 @@ module.exports = {
86
86
  },
87
87
  address: {
88
88
  oneOf: [
89
- {
90
- ...address
91
- },
89
+ getAddress(),
92
90
  {
93
91
  type: 'null'
94
92
  }
@@ -133,9 +131,7 @@ module.exports = {
133
131
  },
134
132
  address: {
135
133
  oneOf: [
136
- {
137
- ...address
138
- },
134
+ getAddress(),
139
135
  {
140
136
  type: 'null'
141
137
  }
@@ -1,4 +1,4 @@
1
- const address = require('../../common/address')
1
+ const { getAddress } = require('../../common/address')
2
2
 
3
3
  module.exports = {
4
4
  $id: 'https://schemas.tillhub.com/v0/pdfs.templates.transaction_receipts.create.schema.json',
@@ -142,9 +142,7 @@ module.exports = {
142
142
  },
143
143
  address: {
144
144
  oneOf: [
145
- {
146
- ...address
147
- },
145
+ getAddress(),
148
146
  {
149
147
  type: 'null'
150
148
  }
@@ -189,9 +187,7 @@ module.exports = {
189
187
  },
190
188
  address: {
191
189
  oneOf: [
192
- {
193
- ...address
194
- },
190
+ getAddress(),
195
191
  {
196
192
  type: 'null'
197
193
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tillhub/schemas",
3
- "version": "6.120.0",
3
+ "version": "6.121.0",
4
4
  "private": false,
5
5
  "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
6
6
  "main": "./lib/index.js",