@tillhub/schemas 6.418.1 → 6.420.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.
Files changed (8) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/lib/v0/analytics/reports/index.js +3 -1
  3. package/lib/v0/analytics/reports/payment_options/export.js +51 -0
  4. package/lib/v0/analytics/reports/payment_options/index.js +3 -0
  5. package/lib/v0/analytics/reports/payments/export.js +79 -0
  6. package/lib/v0/analytics/reports/payments/index.js +3 -0
  7. package/lib/v1/configurations/items/gastro.js +1 -1
  8. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ # [6.420.0](https://github.com/tillhub/schemas/compare/v6.419.0...v6.420.0) (2026-02-10)
2
+
3
+
4
+ ### Features
5
+
6
+ * **UNTIL-18708:** add payments report module ([#1109](https://github.com/tillhub/schemas/issues/1109)) ([30ab360](https://github.com/tillhub/schemas/commit/30ab360))
7
+
8
+ # [6.419.0](https://github.com/tillhub/schemas/compare/v6.418.1...v6.419.0) (2026-02-09)
9
+
10
+
11
+ ### Features
12
+
13
+ * **UNTIL-18651:** Add payment options report module and schema ([#1108](https://github.com/tillhub/schemas/issues/1108)) ([6b2ac7e](https://github.com/tillhub/schemas/commit/6b2ac7e))
14
+
1
15
  ## [6.418.1](https://github.com/tillhub/schemas/compare/v6.418.0...v6.418.1) (2026-01-15)
2
16
 
3
17
 
package/lib/v0/analytics/reports/index.js CHANGED
@@ -1,3 +1,5 @@
1
1
  module.exports = {
2
- products: require('./products')
2
+ products: require('./products'),
3
+ payment_options: require('./payment_options'),
4
+ payments: require('./payments')
3
5
  }
package/lib/v0/analytics/reports/payment_options/export.js ADDED
@@ -0,0 +1,51 @@
1
+ module.exports.request = {
2
+ $id: 'https://schemas.tillhub.com/v0/analytics.reports.payment_options.export.request.schema.json',
3
+ $schema: 'http://json-schema.org/draft-07/schema#',
4
+ type: 'object',
5
+ // Keep this permissive: Tillhub API report queries include many filters.
6
+ // Validation here is focused on export-pipeline metadata.
7
+ additionalProperties: true,
8
+ required: ['format', 'documentType', 'email'],
9
+ properties: {
10
+ // timeframe (payment_options uses start/end)
11
+ start: { type: 'string', format: 'date-time' },
12
+ end: { type: 'string', format: 'date-time' },
13
+
14
+ // aliases used by other reports (optional)
15
+ date_start: { type: 'string', format: 'date-time' },
16
+ date_end: { type: 'string', format: 'date-time' },
17
+
18
+ // report/query filters (optional but validated when present)
19
+ cursor_field: { type: 'string' },
20
+ branch_number: {
21
+ anyOf: [
22
+ { type: 'string', minLength: 1, maxLength: 64 },
23
+ { type: 'array', items: { type: 'string', minLength: 1, maxLength: 64 } }
24
+ ]
25
+ },
26
+ branch_group: {
27
+ anyOf: [
28
+ { type: 'string', minLength: 1, maxLength: 64 },
29
+ { type: 'array', items: { type: 'string', minLength: 1, maxLength: 64 } }
30
+ ]
31
+ },
32
+ context_locations: { type: 'string', minLength: 1, maxLength: 64 },
33
+ payment_option_type_name: { type: 'string', minLength: 1, maxLength: 64 },
34
+ legacy: { enum: ['true', 'false', true, false] },
35
+ report_v2: { enum: ['true', 'false', true, false] },
36
+
37
+ // export pipeline metadata
38
+ format: { type: 'string', enum: ['csv', 'xls'] },
39
+ delimiter: { type: 'string', enum: ['comma', 'semicolon'] },
40
+ enclosure: { type: 'string', enum: ['single', 'double'] },
41
+ show_column_name: { type: 'string', enum: ['true', 'false'] },
42
+ column_selection: { type: 'array', items: { type: 'string' } },
43
+
44
+ documentType: { type: 'string', enum: ['PaymentOptionsExport'] },
45
+ email: { type: 'string', minLength: 5 },
46
+ lang: { type: 'string' },
47
+ scheduled_id: { type: 'string', minLength: 1, maxLength: 64 },
48
+ existingId: { type: 'string', format: 'uuid' },
49
+ correlationId: { type: 'string', format: 'uuid' }
50
+ }
51
+ }
package/lib/v0/analytics/reports/payment_options/index.js ADDED
@@ -0,0 +1,3 @@
1
+ module.exports = {
2
+ export: require('./export')
3
+ }
package/lib/v0/analytics/reports/payments/export.js ADDED
@@ -0,0 +1,79 @@
1
+ module.exports.request = {
2
+ $id: 'https://schemas.tillhub.com/v0/analytics.reports.payments.export.request.schema.json',
3
+ $schema: 'http://json-schema.org/draft-07/schema#',
4
+ type: 'object',
5
+ // Keep this permissive: Tillhub API report queries include many filters.
6
+ // Validation here is focused on export-pipeline metadata.
7
+ additionalProperties: true,
8
+ required: ['format', 'documentType', 'email'],
9
+ properties: {
10
+ // timeframe
11
+ start: {
12
+ oneOf: [
13
+ { type: 'string', format: 'date' },
14
+ { type: 'string', format: 'date-time' }
15
+ ]
16
+ },
17
+ end: {
18
+ oneOf: [
19
+ { type: 'string', format: 'date' },
20
+ { type: 'string', format: 'date-time' }
21
+ ]
22
+ },
23
+
24
+ // report/query filters (optional but validated when present)
25
+ limit: { type: 'string', maxLength: 10 },
26
+ offset: { type: 'string', maxLength: 10 },
27
+ page: { type: 'string', maxLength: 10 },
28
+ size: { type: 'string', maxLength: 10 },
29
+ pageSize: { type: 'string', maxLength: 10 },
30
+ cursor: { type: 'string' },
31
+ cursor_field: { type: 'string' },
32
+ legacy: { enum: ['true', 'false', true, false] },
33
+ context_locations: { type: 'string', minLength: 1, maxLength: 64 },
34
+
35
+ payment_option: { type: 'string' },
36
+ payment_type: { type: 'string' },
37
+ customer_number: { type: 'string' },
38
+ cashier_number: { type: 'string' },
39
+ transaction_number: { type: 'string' },
40
+ balance_number: { type: 'string' },
41
+ branch_number: { type: 'string' },
42
+ branch_group: {
43
+ oneOf: [
44
+ { type: 'string', minLength: 1, maxLength: 64 },
45
+ { type: 'array', items: { type: 'string', minLength: 1, maxLength: 64 } }
46
+ ]
47
+ },
48
+ register_number: { type: 'string' },
49
+ q: { type: 'string' },
50
+ change: {
51
+ type: 'object',
52
+ properties: {
53
+ from: { type: 'string' },
54
+ to: { type: 'string' }
55
+ }
56
+ },
57
+ amount: {
58
+ type: 'object',
59
+ properties: {
60
+ from: { type: 'string' },
61
+ to: { type: 'string' }
62
+ }
63
+ },
64
+
65
+ // export pipeline metadata
66
+ format: { type: 'string', enum: ['csv', 'xls'] },
67
+ delimiter: { type: 'string', enum: ['comma', 'semicolon'] },
68
+ enclosure: { type: 'string', enum: ['single', 'double'] },
69
+ show_column_name: { type: 'string', enum: ['true', 'false'] },
70
+ column_selection: { type: 'array', items: { type: 'string' } },
71
+
72
+ documentType: { type: 'string', enum: ['PaymentsExport'] },
73
+ email: { type: 'string', minLength: 5 },
74
+ lang: { type: 'string' },
75
+ scheduled_id: { type: 'string', minLength: 1, maxLength: 64 },
76
+ existingId: { type: 'string', format: 'uuid' },
77
+ correlationId: { type: 'string', format: 'uuid' }
78
+ }
79
+ }
package/lib/v0/analytics/reports/payments/index.js ADDED
@@ -0,0 +1,3 @@
1
+ module.exports = {
2
+ export: require('./export')
3
+ }
package/lib/v1/configurations/items/gastro.js CHANGED
@@ -96,7 +96,7 @@ module.exports = {
96
96
  transactions: oneOf({
97
97
  description: 'Specifies if Orderpro should fetch transactions to potentially process cancellations and refunds',
98
98
  type: 'boolean',
99
- default: false
99
+ default: true
100
100
  })
101
101
  }
102
102
  })
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tillhub/schemas",
3
- "version": "6.418.1",
3
+ "version": "6.420.0",
4
4
  "private": false,
5
5
  "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
6
6
  "main": "./lib/index.js",