@compassdigital/sdk.typescript 4.67.0 → 4.69.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 (87) hide show
  1. package/lib/index.d.ts +58 -57
  2. package/lib/index.d.ts.map +1 -1
  3. package/lib/index.js +503 -501
  4. package/lib/index.js.map +1 -1
  5. package/lib/interface/ai.d.ts +1 -1
  6. package/lib/interface/ai.d.ts.map +1 -1
  7. package/lib/interface/announcement.d.ts +1 -1
  8. package/lib/interface/announcement.d.ts.map +1 -1
  9. package/lib/interface/auth.d.ts +3 -3
  10. package/lib/interface/auth.d.ts.map +1 -1
  11. package/lib/interface/calendar.d.ts +2 -2
  12. package/lib/interface/calendar.d.ts.map +1 -1
  13. package/lib/interface/centricos.d.ts +11 -11
  14. package/lib/interface/centricos.d.ts.map +1 -1
  15. package/lib/interface/compassconnect.d.ts +1 -1
  16. package/lib/interface/compassconnect.d.ts.map +1 -1
  17. package/lib/interface/config.d.ts +1 -1
  18. package/lib/interface/config.d.ts.map +1 -1
  19. package/lib/interface/datalake.d.ts +1 -1
  20. package/lib/interface/datalake.d.ts.map +1 -1
  21. package/lib/interface/email.d.ts +1 -1
  22. package/lib/interface/email.d.ts.map +1 -1
  23. package/lib/interface/file.d.ts +2 -2
  24. package/lib/interface/file.d.ts.map +1 -1
  25. package/lib/interface/frictionless.d.ts +9 -9
  26. package/lib/interface/frictionless.d.ts.map +1 -1
  27. package/lib/interface/kds.d.ts +1 -1
  28. package/lib/interface/kds.d.ts.map +1 -1
  29. package/lib/interface/location.d.ts +6 -4
  30. package/lib/interface/location.d.ts.map +1 -1
  31. package/lib/interface/mealplan.d.ts +2 -1
  32. package/lib/interface/mealplan.d.ts.map +1 -1
  33. package/lib/interface/menu.d.ts +149 -109
  34. package/lib/interface/menu.d.ts.map +1 -1
  35. package/lib/interface/notification.d.ts +3 -3
  36. package/lib/interface/notification.d.ts.map +1 -1
  37. package/lib/interface/order.d.ts +7 -7
  38. package/lib/interface/order.d.ts.map +1 -1
  39. package/lib/interface/partner.d.ts +10 -10
  40. package/lib/interface/partner.d.ts.map +1 -1
  41. package/lib/interface/payment.d.ts +3 -3
  42. package/lib/interface/payment.d.ts.map +1 -1
  43. package/lib/interface/promo.d.ts +8 -8
  44. package/lib/interface/promo.d.ts.map +1 -1
  45. package/lib/interface/report.d.ts +10 -10
  46. package/lib/interface/report.d.ts.map +1 -1
  47. package/lib/interface/search.d.ts +8 -8
  48. package/lib/interface/search.d.ts.map +1 -1
  49. package/lib/interface/shoppingcart.d.ts +7 -7
  50. package/lib/interface/shoppingcart.d.ts.map +1 -1
  51. package/lib/interface/task.d.ts +8 -8
  52. package/lib/interface/task.d.ts.map +1 -1
  53. package/lib/interface/tax.d.ts +2 -2
  54. package/lib/interface/tax.d.ts.map +1 -1
  55. package/lib/interface/user.d.ts +16 -16
  56. package/lib/interface/user.d.ts.map +1 -1
  57. package/lib/interface/vendor.d.ts +6 -6
  58. package/lib/interface/vendor.d.ts.map +1 -1
  59. package/package.json +1 -1
  60. package/src/index.ts +10395 -10394
  61. package/src/interface/ai.ts +22 -22
  62. package/src/interface/announcement.ts +60 -60
  63. package/src/interface/auth.ts +68 -68
  64. package/src/interface/calendar.ts +94 -94
  65. package/src/interface/centricos.ts +145 -145
  66. package/src/interface/compassconnect.ts +59 -59
  67. package/src/interface/config.ts +166 -166
  68. package/src/interface/datalake.ts +13 -13
  69. package/src/interface/email.ts +13 -13
  70. package/src/interface/file.ts +18 -18
  71. package/src/interface/frictionless.ts +177 -177
  72. package/src/interface/kds.ts +49 -49
  73. package/src/interface/location.ts +771 -769
  74. package/src/interface/mealplan.ts +155 -154
  75. package/src/interface/menu.ts +4079 -4018
  76. package/src/interface/notification.ts +51 -51
  77. package/src/interface/order.ts +464 -464
  78. package/src/interface/partner.ts +823 -823
  79. package/src/interface/payment.ts +278 -278
  80. package/src/interface/promo.ts +373 -373
  81. package/src/interface/report.ts +348 -348
  82. package/src/interface/search.ts +135 -135
  83. package/src/interface/shoppingcart.ts +429 -429
  84. package/src/interface/task.ts +212 -212
  85. package/src/interface/tax.ts +69 -69
  86. package/src/interface/user.ts +410 -410
  87. package/src/interface/vendor.ts +215 -215
@@ -1,128 +1,128 @@
1
1
  /* eslint-disable */
2
2
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
3
 
4
- import { RequestQuery, BaseRequest } from "./util";
4
+ import { RequestQuery, BaseRequest } from './util';
5
5
 
6
6
  export interface Error {
7
- message?: string;
8
- code?: number;
9
- data?: Record<string, any>;
7
+ message?: string;
8
+ code?: number;
9
+ data?: Record<string, any>;
10
10
  }
11
11
 
12
12
  export interface Event {
13
- data?: {
14
- title?: string;
15
- description?: string;
16
- color?: string;
17
- forecolor?: string;
18
- icon?: string;
19
- busy?: boolean;
20
- calendar?: string;
21
- location?: string;
22
- id?: string;
23
- menu?: string;
24
- version?: number;
25
- [index: string]: any;
26
- };
27
- schedule?: Schedule;
13
+ data?: {
14
+ title?: string;
15
+ description?: string;
16
+ color?: string;
17
+ forecolor?: string;
18
+ icon?: string;
19
+ busy?: boolean;
20
+ calendar?: string;
21
+ location?: string;
22
+ id?: string;
23
+ menu?: string;
24
+ version?: number;
25
+ [index: string]: any;
26
+ };
27
+ schedule?: Schedule;
28
28
  }
29
29
 
30
30
  export interface Calendar {
31
- id?: string;
32
- // brand timezone
33
- timezone?: string;
34
- events?: Event[];
35
- date?: {
36
- last_sync?: number;
37
- last_sync_error?: number;
38
- };
31
+ id?: string;
32
+ // brand timezone
33
+ timezone?: string;
34
+ events?: Event[];
35
+ date?: {
36
+ last_sync?: number;
37
+ last_sync_error?: number;
38
+ };
39
39
  }
40
40
 
41
41
  export interface CDLCalendar {
42
- id?: string;
43
- business?: OperationHours[];
44
- delivery?: OperationHours[];
45
- menus?: MenuHours[];
42
+ id?: string;
43
+ business?: OperationHours[];
44
+ delivery?: OperationHours[];
45
+ menus?: MenuHours[];
46
46
  }
47
47
 
48
48
  export interface UpdatedCalendar {
49
- events?: Event[];
49
+ events?: Event[];
50
50
  }
51
51
 
52
52
  export interface Success {
53
- success?: boolean;
53
+ success?: boolean;
54
54
  }
55
55
 
56
56
  export interface Schedule {
57
- duration?: number;
58
- times?: string[];
59
- dayOfWeek?: number[];
60
- [index: string]: any;
57
+ duration?: number;
58
+ times?: string[];
59
+ dayOfWeek?: number[];
60
+ [index: string]: any;
61
61
  }
62
62
 
63
63
  export interface OperationHours {
64
- hours?: string;
65
- day?: {
66
- start?: number;
67
- end?: number;
68
- };
64
+ hours?: string;
65
+ day?: {
66
+ start?: number;
67
+ end?: number;
68
+ };
69
69
  }
70
70
 
71
71
  export interface Hours {
72
- // hours
73
- id?: string;
74
- date?: {
75
- deleted?: string;
76
- start?: string;
77
- end?: string;
78
- };
79
- day?: {
80
- start?: number;
81
- end?: number;
82
- };
83
- hours?: string;
72
+ // hours
73
+ id?: string;
74
+ date?: {
75
+ deleted?: string;
76
+ start?: string;
77
+ end?: string;
78
+ };
79
+ day?: {
80
+ start?: number;
81
+ end?: number;
82
+ };
83
+ hours?: string;
84
84
  }
85
85
 
86
86
  export interface MenuHours {
87
- // menu
88
- id?: string;
89
- label?: {
90
- en?: string;
91
- };
92
- hours?: Hours[];
93
- is_pickup?: boolean;
94
- is_delivery?: boolean;
95
- is_frictionless?: boolean;
96
- state?: BrandOrMenuState;
87
+ // menu
88
+ id?: string;
89
+ label?: {
90
+ en?: string;
91
+ };
92
+ hours?: Hours[];
93
+ is_pickup?: boolean;
94
+ is_delivery?: boolean;
95
+ is_frictionless?: boolean;
96
+ state?: BrandOrMenuState;
97
97
  }
98
98
 
99
- export type BrandOrMenuState = "open" | "closed" | "preorder";
99
+ export type BrandOrMenuState = 'open' | 'closed' | 'preorder';
100
100
 
101
101
  // GET /calendar/{id}
102
102
 
103
103
  export interface GetCalendarPath {
104
- // brand
105
- id: string;
104
+ // brand
105
+ id: string;
106
106
  }
107
107
 
108
108
  export interface GetCalendarQuery {
109
- // Graphql query string
110
- _query?: string;
111
- nocache?: boolean;
109
+ // Graphql query string
110
+ _query?: string;
111
+ nocache?: boolean;
112
112
  }
113
113
 
114
114
  export type GetCalendarResponse = Calendar;
115
115
 
116
116
  export interface GetCalendarRequest
117
- extends BaseRequest,
118
- RequestQuery<GetCalendarQuery>,
119
- GetCalendarPath {}
117
+ extends BaseRequest,
118
+ RequestQuery<GetCalendarQuery>,
119
+ GetCalendarPath {}
120
120
 
121
121
  // PUT /calendar/{id} - Set the calendar for an id. Overrides previous record
122
122
 
123
123
  export interface PutCalendarPath {
124
- // brand
125
- id: string;
124
+ // brand
125
+ id: string;
126
126
  }
127
127
 
128
128
  export type PutCalendarBody = UpdatedCalendar;
@@ -130,14 +130,14 @@ export type PutCalendarBody = UpdatedCalendar;
130
130
  export type PutCalendarResponse = Calendar;
131
131
 
132
132
  export interface PutCalendarRequest extends BaseRequest, PutCalendarPath {
133
- body: PutCalendarBody;
133
+ body: PutCalendarBody;
134
134
  }
135
135
 
136
136
  // DELETE /calendar/{id} - Delete a calendar.
137
137
 
138
138
  export interface DeleteCalendarPath {
139
- // brand
140
- id: string;
139
+ // brand
140
+ id: string;
141
141
  }
142
142
 
143
143
  export type DeleteCalendarResponse = Success;
@@ -147,44 +147,44 @@ export interface DeleteCalendarRequest extends BaseRequest, DeleteCalendarPath {
147
147
  // GET /calendar/{id}/cdl - Get the calendar events in a CDL compatible format for next 7 days
148
148
 
149
149
  export interface GetCalendarCdlPath {
150
- // brand
151
- id: string;
150
+ // brand
151
+ id: string;
152
152
  }
153
153
 
154
154
  export interface GetCalendarCdlQuery {
155
- // Start date in ms to get 7 day calendar from. Defaults now.
156
- start_date?: number;
157
- // Graphql query string
158
- _query?: string;
155
+ // Start date in ms to get 7 day calendar from. Defaults now.
156
+ start_date?: number;
157
+ // Graphql query string
158
+ _query?: string;
159
159
  }
160
160
 
161
161
  export type GetCalendarCdlResponse = CDLCalendar;
162
162
 
163
163
  export interface GetCalendarCdlRequest
164
- extends BaseRequest,
165
- RequestQuery<GetCalendarCdlQuery>,
166
- GetCalendarCdlPath {}
164
+ extends BaseRequest,
165
+ RequestQuery<GetCalendarCdlQuery>,
166
+ GetCalendarCdlPath {}
167
167
 
168
168
  // GET /calendar/swagger.json
169
169
 
170
170
  export interface GetCalendarSwaggerQuery {
171
- // Graphql query string
172
- _query?: string;
171
+ // Graphql query string
172
+ _query?: string;
173
173
  }
174
174
 
175
175
  export interface GetCalendarSwaggerResponse {
176
- [index: string]: any;
176
+ [index: string]: any;
177
177
  }
178
178
 
179
179
  export interface GetCalendarSwaggerRequest
180
- extends BaseRequest,
181
- RequestQuery<GetCalendarSwaggerQuery> {}
180
+ extends BaseRequest,
181
+ RequestQuery<GetCalendarSwaggerQuery> {}
182
182
 
183
183
  // POST /calendar/{id}/sync - Trigger synchronization of calendar to location API
184
184
 
185
185
  export interface PostCalendarSyncPath {
186
- // brand
187
- id: string;
186
+ // brand
187
+ id: string;
188
188
  }
189
189
 
190
190
  export type PostCalendarSyncResponse = Success;