@compassdigital/sdk.typescript 4.67.0 → 4.68.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 +5 -3
  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,335 +1,335 @@
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 User {
13
- // user
14
- id?: string;
15
- email?: string;
16
- name?: {
17
- first?: string;
18
- last?: string;
19
- };
20
- date?: {
21
- created?: string;
22
- modified?: string;
23
- };
24
- birthday?: string;
25
- password?: string;
26
- // User phone number
27
- phone?: number;
28
- // User phone country code in ISO 3166-1 alpha-2 format
29
- phone_country_code?: string;
30
- // realm
31
- realm?: string;
32
- gender?: "male" | "female" | "non-binary";
33
- meta?: UserMeta;
34
- is?: {
35
- disabled?: boolean;
36
- // User locked out status
37
- locked_out?: boolean;
38
- // If the users email is verified
39
- verified?: boolean;
40
- //@deprecated
41
- phone_verified?: boolean;
42
- // User deleted status
43
- deleted?: boolean;
44
- };
45
- permissions?: Scopes;
46
- // User location group
47
- location_group?: string;
48
- ssoId?: string;
13
+ // user
14
+ id?: string;
15
+ email?: string;
16
+ name?: {
17
+ first?: string;
18
+ last?: string;
19
+ };
20
+ date?: {
21
+ created?: string;
22
+ modified?: string;
23
+ };
24
+ birthday?: string;
25
+ password?: string;
26
+ // User phone number
27
+ phone?: number;
28
+ // User phone country code in ISO 3166-1 alpha-2 format
29
+ phone_country_code?: string;
30
+ // realm
31
+ realm?: string;
32
+ gender?: 'male' | 'female' | 'non-binary';
33
+ meta?: UserMeta;
34
+ is?: {
35
+ disabled?: boolean;
36
+ // User locked out status
37
+ locked_out?: boolean;
38
+ // If the users email is verified
39
+ verified?: boolean;
40
+ //@deprecated
41
+ phone_verified?: boolean;
42
+ // User deleted status
43
+ deleted?: boolean;
44
+ };
45
+ permissions?: Scopes;
46
+ // User location group
47
+ location_group?: string;
48
+ ssoId?: string;
49
49
  }
50
50
 
51
51
  export interface CashlessLog {
52
- added?: string;
53
- deleted?: string;
52
+ added?: string;
53
+ deleted?: string;
54
54
  }
55
55
 
56
56
  export interface GuestUserCreate {
57
- email?: string;
58
- name?: {
59
- first?: string;
60
- last?: string;
61
- };
62
- // realm
63
- realm?: string;
57
+ email?: string;
58
+ name?: {
59
+ first?: string;
60
+ last?: string;
61
+ };
62
+ // realm
63
+ realm?: string;
64
64
  }
65
65
 
66
66
  export interface GuestUserToken {
67
- // realm
68
- realm?: string;
67
+ // realm
68
+ realm?: string;
69
69
  }
70
70
 
71
71
  export interface Changepassword {
72
- password?: string;
73
- new_password?: string;
72
+ password?: string;
73
+ new_password?: string;
74
74
  }
75
75
 
76
76
  export interface Forgotpassword {
77
- email: string;
78
- type?: "forgot_password" | "new_user";
77
+ email: string;
78
+ type?: 'forgot_password' | 'new_user';
79
79
  }
80
80
 
81
81
  export interface Resetpassword {
82
- password?: string;
82
+ password?: string;
83
83
  }
84
84
 
85
85
  export interface ResetpasswordSuccess {
86
- code?: number;
87
- success?: boolean;
86
+ code?: number;
87
+ success?: boolean;
88
88
  }
89
89
 
90
90
  export interface VerifyEmail {
91
- // Token to verify user email
92
- verification_token: string;
91
+ // Token to verify user email
92
+ verification_token: string;
93
93
  }
94
94
 
95
95
  export interface success {
96
- success?: boolean;
96
+ success?: boolean;
97
97
  }
98
98
 
99
99
  export interface auth {
100
- //@deprecated
101
- token?: string;
102
- access?: {
103
- token?: string;
104
- expires?: string;
105
- };
106
- refresh?: {
107
- token?: string;
108
- expires?: string;
109
- };
110
- // user
111
- user?: string;
112
- profile?: User;
100
+ //@deprecated
101
+ token?: string;
102
+ access?: {
103
+ token?: string;
104
+ expires?: string;
105
+ };
106
+ refresh?: {
107
+ token?: string;
108
+ expires?: string;
109
+ };
110
+ // user
111
+ user?: string;
112
+ profile?: User;
113
113
  }
114
114
 
115
115
  export interface guestAuth {
116
- //@deprecated
117
- token?: string;
118
- access?: {
119
- token?: string;
120
- expires?: string;
121
- };
122
- // user
123
- user?: string;
124
- profile?: User;
116
+ //@deprecated
117
+ token?: string;
118
+ access?: {
119
+ token?: string;
120
+ expires?: string;
121
+ };
122
+ // user
123
+ user?: string;
124
+ profile?: User;
125
125
  }
126
126
 
127
127
  export interface omsauth {
128
- access?: {
129
- token?: string;
130
- expires?: string;
131
- };
132
- refresh?: {
133
- token?: string;
134
- expires?: string;
135
- };
136
- oauthaccess?: {
137
- token?: string;
138
- expires?: string;
139
- };
140
- // user
141
- user?: string;
142
- profile?: User;
128
+ access?: {
129
+ token?: string;
130
+ expires?: string;
131
+ };
132
+ refresh?: {
133
+ token?: string;
134
+ expires?: string;
135
+ };
136
+ oauthaccess?: {
137
+ token?: string;
138
+ expires?: string;
139
+ };
140
+ // user
141
+ user?: string;
142
+ profile?: User;
143
143
  }
144
144
 
145
145
  export interface guestAuthToken {
146
- //@deprecated
147
- token?: string;
148
- access?: {
149
- token?: string;
150
- expires?: string;
151
- };
146
+ //@deprecated
147
+ token?: string;
148
+ access?: {
149
+ token?: string;
150
+ expires?: string;
151
+ };
152
152
  }
153
153
 
154
154
  export type Permission = string;
155
155
 
156
156
  export interface KDSToken {
157
- device?: KDSDevice;
158
- access?: {
159
- token?: string;
160
- expires?: number;
161
- };
157
+ device?: KDSDevice;
158
+ access?: {
159
+ token?: string;
160
+ expires?: number;
161
+ };
162
162
  }
163
163
 
164
164
  export interface KDSDevices {
165
- devices?: KDSDevice[];
165
+ devices?: KDSDevice[];
166
166
  }
167
167
 
168
168
  export interface KDSDevice {
169
- id?: string;
170
- lat?: string;
171
- long?: string;
172
- location_group?: string;
173
- is?: {
174
- authorized?: boolean;
175
- deleted?: boolean;
176
- };
169
+ id?: string;
170
+ lat?: string;
171
+ long?: string;
172
+ location_group?: string;
173
+ is?: {
174
+ authorized?: boolean;
175
+ deleted?: boolean;
176
+ };
177
177
  }
178
178
 
179
179
  export interface Checkin {
180
- // checkin
181
- checkin_id?: string;
182
- // The colour that identifies the visit in hex code
183
- colour?: string;
184
- // The image that identifies the visit
185
- image?: {
186
- // Mime type of the image ex image/png, image/svg.
187
- type?: string;
188
- // Base64 encoded image with a transparent background this should be displayed across the entire screen of the User's phone over the background color.
189
- data?: string;
190
- };
191
- // The shopping cart associated to the user's visit
192
- shoppingcart?: string;
193
- is?: {
194
- // `True` when a `User` is attached. A `User` is attached when they are in the store and have visually connected with the in-store visual system.
195
- complete?: boolean;
196
- // If the `User` is near or far from a store (as determined by the backend). If this is `false` for a prolonged period the client should assume the `User` is not in a standard store and stop trying to attach.
197
- near_store?: boolean;
198
- };
199
- // user
200
- user_id?: string;
201
- date_queued?: string;
202
- // The state of the user association process (attaching). Present for NFC check-ins only
203
- state?: "new" | "unconfirmed" | "associated" | "failed";
204
- meta?: CheckinMeta;
180
+ // checkin
181
+ checkin_id?: string;
182
+ // The colour that identifies the visit in hex code
183
+ colour?: string;
184
+ // The image that identifies the visit
185
+ image?: {
186
+ // Mime type of the image ex image/png, image/svg.
187
+ type?: string;
188
+ // Base64 encoded image with a transparent background this should be displayed across the entire screen of the User's phone over the background color.
189
+ data?: string;
190
+ };
191
+ // The shopping cart associated to the user's visit
192
+ shoppingcart?: string;
193
+ is?: {
194
+ // `True` when a `User` is attached. A `User` is attached when they are in the store and have visually connected with the in-store visual system.
195
+ complete?: boolean;
196
+ // If the `User` is near or far from a store (as determined by the backend). If this is `false` for a prolonged period the client should assume the `User` is not in a standard store and stop trying to attach.
197
+ near_store?: boolean;
198
+ };
199
+ // user
200
+ user_id?: string;
201
+ date_queued?: string;
202
+ // The state of the user association process (attaching). Present for NFC check-ins only
203
+ state?: 'new' | 'unconfirmed' | 'associated' | 'failed';
204
+ meta?: CheckinMeta;
205
205
  }
206
206
 
207
207
  export interface PatchCheckin {
208
- // Date when the checkin was put into the queue to be processed.
209
- date_queued?: number;
210
- // The state of the user association process (attaching). Present for NFC check-ins only
211
- state?: "new" | "unconfirmed" | "associated" | "failed";
212
- meta?: CheckinMeta;
208
+ // Date when the checkin was put into the queue to be processed.
209
+ date_queued?: number;
210
+ // The state of the user association process (attaching). Present for NFC check-ins only
211
+ state?: 'new' | 'unconfirmed' | 'associated' | 'failed';
212
+ meta?: CheckinMeta;
213
213
  }
214
214
 
215
215
  export interface CheckinMeta {
216
- order_id?: string;
217
- status?: "processed" | "failed";
218
- logs?: {
219
- code?: number;
220
- date?: string;
221
- message?: string;
222
- type?: "error" | "log";
223
- [index: string]: any;
224
- }[];
225
- [index: string]: any;
216
+ order_id?: string;
217
+ status?: 'processed' | 'failed';
218
+ logs?: {
219
+ code?: number;
220
+ date?: string;
221
+ message?: string;
222
+ type?: 'error' | 'log';
223
+ [index: string]: any;
224
+ }[];
225
+ [index: string]: any;
226
226
  }
227
227
 
228
228
  export interface RefreshToken {
229
- refresh_token?: string;
229
+ refresh_token?: string;
230
230
  }
231
231
 
232
232
  export interface CheckInUserInfo {
233
- // Location brand
234
- brand?: string;
235
- // User location latitude
236
- latitude?: number;
237
- // User location longitude
238
- longitude?: number;
239
- // NFC URI required for NFC check-in
240
- nfc_uri?: string;
241
- // Balance of the user's mealplan tender
242
- tender_balance?: number;
233
+ // Location brand
234
+ brand?: string;
235
+ // User location latitude
236
+ latitude?: number;
237
+ // User location longitude
238
+ longitude?: number;
239
+ // NFC URI required for NFC check-in
240
+ nfc_uri?: string;
241
+ // Balance of the user's mealplan tender
242
+ tender_balance?: number;
243
243
  }
244
244
 
245
245
  export interface Scopes {
246
- scopes?: Permission[];
247
- acl?: Acl;
246
+ scopes?: Permission[];
247
+ acl?: Acl;
248
248
  }
249
249
 
250
250
  export interface Users {
251
- users?: User[];
251
+ users?: User[];
252
252
  }
253
253
 
254
254
  export interface Key {
255
- key?: string;
255
+ key?: string;
256
256
  }
257
257
 
258
258
  export interface UserDeviceAuthBody {
259
- // KDS IDFA id
260
- id?: string;
261
- // CDL encoded id of a serial_number
262
- serial_number?: string;
263
- // Location latitude
264
- lat?: string;
265
- // Location longitude
266
- long?: string;
259
+ // KDS IDFA id
260
+ id?: string;
261
+ // CDL encoded id of a serial_number
262
+ serial_number?: string;
263
+ // Location latitude
264
+ lat?: string;
265
+ // Location longitude
266
+ long?: string;
267
267
  }
268
268
 
269
269
  export type AclAction = string[];
270
270
 
271
271
  export interface Acl {
272
- // Any role name
273
- ROLE?: {
274
- // Any resource name
275
- RESOURCE?: {
276
- "create:own"?: AclAction;
277
- "read:own"?: AclAction;
278
- "update:own"?: AclAction;
279
- "delete:own"?: AclAction;
280
- "create:any"?: AclAction;
281
- "read:any"?: AclAction;
282
- "update:any"?: AclAction;
283
- "delete:any"?: AclAction;
284
- };
285
- [index: string]: any;
286
- };
287
- [index: string]: any;
272
+ // Any role name
273
+ ROLE?: {
274
+ // Any resource name
275
+ RESOURCE?: {
276
+ 'create:own'?: AclAction;
277
+ 'read:own'?: AclAction;
278
+ 'update:own'?: AclAction;
279
+ 'delete:own'?: AclAction;
280
+ 'create:any'?: AclAction;
281
+ 'read:any'?: AclAction;
282
+ 'update:any'?: AclAction;
283
+ 'delete:any'?: AclAction;
284
+ };
285
+ [index: string]: any;
286
+ };
287
+ [index: string]: any;
288
288
  }
289
289
 
290
290
  export interface UserMeta {
291
- marketing_opt_in?: boolean;
292
- marketing_opt_in_date?: string;
293
- marketing_opt_in_source?: "App" | "Web";
294
- // Stores notification preference for order status, opt-in/opt-out from receiving order status update notifications
295
- order_status_notification?: {
296
- send_emails?: boolean;
297
- send_emails_date_updated?: string;
298
- };
299
- mealplan_added_date?: string;
300
- // limit set to prevent too many login attempts with incorrect password
301
- login_limit?: {
302
- login_attempts?: number;
303
- last_attempt_date?: string;
304
- };
305
- // forgot password verification details
306
- password_verification?: {
307
- attempts?: number;
308
- first_attempted?: string;
309
- };
310
- //@deprecated
311
- phone_verification?: {
312
- verification_code?: string;
313
- date_generated?: number;
314
- failed_attempts?: number;
315
- consecutive_failed_attempts?: number;
316
- };
317
- cashless?: {
318
- stipend?: CashlessLog;
319
- voucher?: CashlessLog;
320
- badge_pay?: CashlessLog;
321
- coupon_voucher?: CashlessLog;
322
- };
323
- [index: string]: any;
291
+ marketing_opt_in?: boolean;
292
+ marketing_opt_in_date?: string;
293
+ marketing_opt_in_source?: 'App' | 'Web';
294
+ // Stores notification preference for order status, opt-in/opt-out from receiving order status update notifications
295
+ order_status_notification?: {
296
+ send_emails?: boolean;
297
+ send_emails_date_updated?: string;
298
+ };
299
+ mealplan_added_date?: string;
300
+ // limit set to prevent too many login attempts with incorrect password
301
+ login_limit?: {
302
+ login_attempts?: number;
303
+ last_attempt_date?: string;
304
+ };
305
+ // forgot password verification details
306
+ password_verification?: {
307
+ attempts?: number;
308
+ first_attempted?: string;
309
+ };
310
+ //@deprecated
311
+ phone_verification?: {
312
+ verification_code?: string;
313
+ date_generated?: number;
314
+ failed_attempts?: number;
315
+ consecutive_failed_attempts?: number;
316
+ };
317
+ cashless?: {
318
+ stipend?: CashlessLog;
319
+ voucher?: CashlessLog;
320
+ badge_pay?: CashlessLog;
321
+ coupon_voucher?: CashlessLog;
322
+ };
323
+ [index: string]: any;
324
324
  }
325
325
 
326
326
  // GET /user/auth - Gets the JWT token for a user
327
327
 
328
328
  export interface GetUserAuthQuery {
329
- // realm
330
- realm?: string;
331
- // Graphql query string
332
- _query?: string;
329
+ // realm
330
+ realm?: string;
331
+ // Graphql query string
332
+ _query?: string;
333
333
  }
334
334
 
335
335
  export type GetUserAuthResponse = auth;
@@ -343,50 +343,50 @@ export type PostUserAuthBody = RefreshToken;
343
343
  export type PostUserAuthResponse = auth;
344
344
 
345
345
  export interface PostUserAuthRequest extends BaseRequest {
346
- body: PostUserAuthBody;
346
+ body: PostUserAuthBody;
347
347
  }
348
348
 
349
349
  // POST /user/oauth - Fetches a jwt token containing a compass token
350
350
 
351
351
  export interface PostUserOauthBody {
352
- // OMS code from commpass sso
353
- code: string;
354
- // the oms url for compass
355
- oms_url: string;
356
- // the return uri for compassconnect
357
- callback_uri: string;
358
- // the id of the application for compassconnect
359
- client_id: string;
352
+ // OMS code from commpass sso
353
+ code: string;
354
+ // the oms url for compass
355
+ oms_url: string;
356
+ // the return uri for compassconnect
357
+ callback_uri: string;
358
+ // the id of the application for compassconnect
359
+ client_id: string;
360
360
  }
361
361
 
362
362
  export type PostUserOauthResponse = omsauth;
363
363
 
364
364
  export interface PostUserOauthRequest extends BaseRequest {
365
- body: PostUserOauthBody;
365
+ body: PostUserOauthBody;
366
366
  }
367
367
 
368
368
  // POST /user/zendesk - Get Zendesk JWT token to allow web widget to search restricted articles
369
369
 
370
370
  export interface PostUserZendeskBody {
371
- // Zendesk JWT
372
- token?: string;
371
+ // Zendesk JWT
372
+ token?: string;
373
373
  }
374
374
 
375
375
  export interface PostUserZendeskResponse {
376
- token: string;
376
+ token: string;
377
377
  }
378
378
 
379
379
  export interface PostUserZendeskRequest extends BaseRequest {
380
- body: PostUserZendeskBody;
380
+ body: PostUserZendeskBody;
381
381
  }
382
382
 
383
383
  // POST /user - Create an User
384
384
 
385
385
  export interface PostUserQuery {
386
- // Use ACL permission system
387
- acl?: boolean;
388
- // hCaptcha response key
389
- captchaResponseKey: string;
386
+ // Use ACL permission system
387
+ acl?: boolean;
388
+ // hCaptcha response key
389
+ captchaResponseKey: string;
390
390
  }
391
391
 
392
392
  export type PostUserBody = User;
@@ -394,21 +394,21 @@ export type PostUserBody = User;
394
394
  export type PostUserResponse = User;
395
395
 
396
396
  export interface PostUserRequest extends BaseRequest, RequestQuery<PostUserQuery> {
397
- body: PostUserBody;
397
+ body: PostUserBody;
398
398
  }
399
399
 
400
400
  // GET /user/{id} - Get an individual user
401
401
 
402
402
  export interface GetUserPath {
403
- // User ID
404
- id: string;
403
+ // User ID
404
+ id: string;
405
405
  }
406
406
 
407
407
  export interface GetUserQuery {
408
- // Use ACL permission system
409
- acl?: boolean;
410
- // Graphql query string
411
- _query?: string;
408
+ // Use ACL permission system
409
+ acl?: boolean;
410
+ // Graphql query string
411
+ _query?: string;
412
412
  }
413
413
 
414
414
  export type GetUserResponse = User;
@@ -418,15 +418,15 @@ export interface GetUserRequest extends BaseRequest, RequestQuery<GetUserQuery>,
418
418
  // PUT /user/{id} - Update an individual user
419
419
 
420
420
  export interface PutUserPath {
421
- // User ID
422
- id: string;
421
+ // User ID
422
+ id: string;
423
423
  }
424
424
 
425
425
  export interface PutUserQuery {
426
- // The language of the user ex en, fr
427
- lang?: string;
428
- // Use ACL permission system
429
- acl?: boolean;
426
+ // The language of the user ex en, fr
427
+ lang?: string;
428
+ // Use ACL permission system
429
+ acl?: boolean;
430
430
  }
431
431
 
432
432
  export type PutUserBody = User;
@@ -434,21 +434,21 @@ export type PutUserBody = User;
434
434
  export type PutUserResponse = User;
435
435
 
436
436
  export interface PutUserRequest extends BaseRequest, RequestQuery<PutUserQuery>, PutUserPath {
437
- body: PutUserBody;
437
+ body: PutUserBody;
438
438
  }
439
439
 
440
440
  // PATCH /user/{id} - Update an individual user
441
441
 
442
442
  export interface PatchUserPath {
443
- // User ID
444
- id: string;
443
+ // User ID
444
+ id: string;
445
445
  }
446
446
 
447
447
  export interface PatchUserQuery {
448
- // The language of the user ex en, fr
449
- lang?: string;
450
- // Use ACL permission system
451
- acl?: boolean;
448
+ // The language of the user ex en, fr
449
+ lang?: string;
450
+ // Use ACL permission system
451
+ acl?: boolean;
452
452
  }
453
453
 
454
454
  export type PatchUserBody = User;
@@ -456,27 +456,27 @@ export type PatchUserBody = User;
456
456
  export type PatchUserResponse = User;
457
457
 
458
458
  export interface PatchUserRequest extends BaseRequest, RequestQuery<PatchUserQuery>, PatchUserPath {
459
- body: PatchUserBody;
459
+ body: PatchUserBody;
460
460
  }
461
461
 
462
462
  // DELETE /user/{id} - delete an individual user
463
463
 
464
464
  export interface DeleteUserPath {
465
- // User ID
466
- id: string;
465
+ // User ID
466
+ id: string;
467
467
  }
468
468
 
469
469
  export interface DeleteUserQuery {
470
- // Use ACL permission system
471
- acl?: boolean;
470
+ // Use ACL permission system
471
+ acl?: boolean;
472
472
  }
473
473
 
474
474
  export type DeleteUserResponse = success;
475
475
 
476
476
  export interface DeleteUserRequest
477
- extends BaseRequest,
478
- RequestQuery<DeleteUserQuery>,
479
- DeleteUserPath {}
477
+ extends BaseRequest,
478
+ RequestQuery<DeleteUserQuery>,
479
+ DeleteUserPath {}
480
480
 
481
481
  // POST /user/device/auth - Endpoint for generating/retrieving KDS device token
482
482
 
@@ -485,15 +485,15 @@ export type PostUserKdsTokenBody = UserDeviceAuthBody;
485
485
  export type PostUserKdsTokenResponse = KDSToken;
486
486
 
487
487
  export interface PostUserKdsTokenRequest extends BaseRequest {
488
- body: PostUserKdsTokenBody;
488
+ body: PostUserKdsTokenBody;
489
489
  }
490
490
 
491
491
  // GET /user/device/auth - Endpoint retrieving KDS device token
492
492
 
493
493
  export interface GetUserKdsTokenQuery {
494
- authorized?: boolean;
495
- // Graphql query string
496
- _query?: string;
494
+ authorized?: boolean;
495
+ // Graphql query string
496
+ _query?: string;
497
497
  }
498
498
 
499
499
  export type GetUserKdsTokenResponse = KDSDevices;
@@ -503,8 +503,8 @@ export interface GetUserKdsTokenRequest extends BaseRequest, RequestQuery<GetUse
503
503
  // DELETE /user/device/auth/{device_id} - Endpoint for deleting a device by specified device_id
504
504
 
505
505
  export interface DeleteUserDeviceAuthPath {
506
- // KDS device ID
507
- device_id: string;
506
+ // KDS device ID
507
+ device_id: string;
508
508
  }
509
509
 
510
510
  export type DeleteUserDeviceAuthResponse = Error;
@@ -514,28 +514,28 @@ export interface DeleteUserDeviceAuthRequest extends BaseRequest, DeleteUserDevi
514
514
  // PATCH /user/device/auth/{device_id} - Endpoint for authorizing device to retrieve valid kds token
515
515
 
516
516
  export interface PatchUserAuthKdsPath {
517
- // KDS device ID
518
- device_id: string;
517
+ // KDS device ID
518
+ device_id: string;
519
519
  }
520
520
 
521
521
  export interface PatchUserAuthKdsBody {
522
- // Location group of the device
523
- location_group?: string;
522
+ // Location group of the device
523
+ location_group?: string;
524
524
  }
525
525
 
526
526
  export interface PatchUserAuthKdsResponse {
527
- device?: KDSDevice;
527
+ device?: KDSDevice;
528
528
  }
529
529
 
530
530
  export interface PatchUserAuthKdsRequest extends BaseRequest, PatchUserAuthKdsPath {
531
- body: PatchUserAuthKdsBody;
531
+ body: PatchUserAuthKdsBody;
532
532
  }
533
533
 
534
534
  // POST /user/{id}/changepassword - Change the users password
535
535
 
536
536
  export interface PostUserChangePasswordPath {
537
- // User ID
538
- id: string;
537
+ // User ID
538
+ id: string;
539
539
  }
540
540
 
541
541
  export type PostUserChangePasswordBody = Changepassword;
@@ -543,7 +543,7 @@ export type PostUserChangePasswordBody = Changepassword;
543
543
  export type PostUserChangePasswordResponse = User;
544
544
 
545
545
  export interface PostUserChangePasswordRequest extends BaseRequest, PostUserChangePasswordPath {
546
- body: PostUserChangePasswordBody;
546
+ body: PostUserChangePasswordBody;
547
547
  }
548
548
 
549
549
  // DELETE /user/logout - Logs out current user
@@ -555,9 +555,9 @@ export interface DeleteUserLogoutRequest extends BaseRequest {}
555
555
  // POST /user/{id}/secret/{key} - Add a secret key
556
556
 
557
557
  export interface PostUserAddSecretPath {
558
- // User ID
559
- id: string;
560
- key: string;
558
+ // User ID
559
+ id: string;
560
+ key: string;
561
561
  }
562
562
 
563
563
  export type PostUserAddSecretBody = Record<string, any>;
@@ -565,40 +565,40 @@ export type PostUserAddSecretBody = Record<string, any>;
565
565
  export type PostUserAddSecretResponse = Key;
566
566
 
567
567
  export interface PostUserAddSecretRequest extends BaseRequest, PostUserAddSecretPath {
568
- body: PostUserAddSecretBody;
568
+ body: PostUserAddSecretBody;
569
569
  }
570
570
 
571
571
  // GET /user/{id}/secret/{key} - Get back a secret key
572
572
 
573
573
  export interface GetUserSecretPath {
574
- // User ID
575
- id: string;
576
- key: string;
574
+ // User ID
575
+ id: string;
576
+ key: string;
577
577
  }
578
578
 
579
579
  export interface GetUserSecretQuery {
580
- // Graphql query string
581
- _query?: string;
580
+ // Graphql query string
581
+ _query?: string;
582
582
  }
583
583
 
584
584
  export interface GetUserSecretResponse {
585
- [index: string]: any;
585
+ [index: string]: any;
586
586
  }
587
587
 
588
588
  export interface GetUserSecretRequest
589
- extends BaseRequest,
590
- RequestQuery<GetUserSecretQuery>,
591
- GetUserSecretPath {}
589
+ extends BaseRequest,
590
+ RequestQuery<GetUserSecretQuery>,
591
+ GetUserSecretPath {}
592
592
 
593
593
  // POST /user/forgotpassword - Reset the users password
594
594
 
595
595
  export interface PostUserResetPasswordQuery {
596
- // The language of the user ex en, fr
597
- lang?: string;
598
- // realm
599
- realm?: string;
600
- // hCaptcha response key
601
- captchaResponseKey: string;
596
+ // The language of the user ex en, fr
597
+ lang?: string;
598
+ // realm
599
+ realm?: string;
600
+ // hCaptcha response key
601
+ captchaResponseKey: string;
602
602
  }
603
603
 
604
604
  export type PostUserResetPasswordBody = Forgotpassword;
@@ -606,23 +606,23 @@ export type PostUserResetPasswordBody = Forgotpassword;
606
606
  export type PostUserResetPasswordResponse = ResetpasswordSuccess;
607
607
 
608
608
  export interface PostUserResetPasswordRequest
609
- extends BaseRequest,
610
- RequestQuery<PostUserResetPasswordQuery> {
611
- body: PostUserResetPasswordBody;
609
+ extends BaseRequest,
610
+ RequestQuery<PostUserResetPasswordQuery> {
611
+ body: PostUserResetPasswordBody;
612
612
  }
613
613
 
614
614
  // POST /user/{id}/resetpassword - Reset the users password using a reset token
615
615
 
616
616
  export interface PostUserResetPasswordTokenPath {
617
- // realm
618
- id: string;
617
+ // realm
618
+ id: string;
619
619
  }
620
620
 
621
621
  export interface PostUserResetPasswordTokenQuery {
622
- // password reset token
623
- reset_token: string;
624
- // The language of the user ex en, fr
625
- lang?: string;
622
+ // password reset token
623
+ reset_token: string;
624
+ // The language of the user ex en, fr
625
+ lang?: string;
626
626
  }
627
627
 
628
628
  export type PostUserResetPasswordTokenBody = Resetpassword;
@@ -630,90 +630,90 @@ export type PostUserResetPasswordTokenBody = Resetpassword;
630
630
  export type PostUserResetPasswordTokenResponse = success;
631
631
 
632
632
  export interface PostUserResetPasswordTokenRequest
633
- extends BaseRequest,
634
- RequestQuery<PostUserResetPasswordTokenQuery>,
635
- PostUserResetPasswordTokenPath {
636
- body: PostUserResetPasswordTokenBody;
633
+ extends BaseRequest,
634
+ RequestQuery<PostUserResetPasswordTokenQuery>,
635
+ PostUserResetPasswordTokenPath {
636
+ body: PostUserResetPasswordTokenBody;
637
637
  }
638
638
 
639
639
  // GET /user/realm/{realm} - Get all the users in a realm
640
640
 
641
641
  export interface GetUserRealmUsersPath {
642
- // realm
643
- realm: string;
642
+ // realm
643
+ realm: string;
644
644
  }
645
645
 
646
646
  export interface GetUserRealmUsersQuery {
647
- // Max number of records to return. Defaults to 100
648
- max?: number;
649
- // Last modified date greater than this parameter
650
- lastmodified_start?: string;
651
- // Use ACL permission system
652
- acl?: boolean;
653
- // Graphql query string
654
- _query?: string;
647
+ // Max number of records to return. Defaults to 100
648
+ max?: number;
649
+ // Last modified date greater than this parameter
650
+ lastmodified_start?: string;
651
+ // Use ACL permission system
652
+ acl?: boolean;
653
+ // Graphql query string
654
+ _query?: string;
655
655
  }
656
656
 
657
657
  export type GetUserRealmUsersResponse = Users;
658
658
 
659
659
  export interface GetUserRealmUsersRequest
660
- extends BaseRequest,
661
- RequestQuery<GetUserRealmUsersQuery>,
662
- GetUserRealmUsersPath {}
660
+ extends BaseRequest,
661
+ RequestQuery<GetUserRealmUsersQuery>,
662
+ GetUserRealmUsersPath {}
663
663
 
664
664
  // GET /user/{id}/permissions - Get user permissions
665
665
 
666
666
  export interface GetUserPermissionsPath {
667
- // user
668
- id: string;
667
+ // user
668
+ id: string;
669
669
  }
670
670
 
671
671
  export interface GetUserPermissionsQuery {
672
- // Use ACL permission system
673
- acl?: boolean;
674
- // Graphql query string
675
- _query?: string;
672
+ // Use ACL permission system
673
+ acl?: boolean;
674
+ // Graphql query string
675
+ _query?: string;
676
676
  }
677
677
 
678
678
  export type GetUserPermissionsResponse = User;
679
679
 
680
680
  export interface GetUserPermissionsRequest
681
- extends BaseRequest,
682
- RequestQuery<GetUserPermissionsQuery>,
683
- GetUserPermissionsPath {}
681
+ extends BaseRequest,
682
+ RequestQuery<GetUserPermissionsQuery>,
683
+ GetUserPermissionsPath {}
684
684
 
685
685
  // PUT /user/{id}/permissions - Update user permissions
686
686
 
687
687
  export interface PutUserPermissionsPath {
688
- // user
689
- id: string;
688
+ // user
689
+ id: string;
690
690
  }
691
691
 
692
692
  export interface PutUserPermissionsQuery {
693
- // Use ACL permission system
694
- acl?: boolean;
693
+ // Use ACL permission system
694
+ acl?: boolean;
695
695
  }
696
696
 
697
697
  export interface PutUserPermissionsBody {
698
- permissions?: {
699
- scopes?: Permission[];
700
- };
698
+ permissions?: {
699
+ scopes?: Permission[];
700
+ };
701
701
  }
702
702
 
703
703
  export type PutUserPermissionsResponse = User;
704
704
 
705
705
  export interface PutUserPermissionsRequest
706
- extends BaseRequest,
707
- RequestQuery<PutUserPermissionsQuery>,
708
- PutUserPermissionsPath {
709
- body: PutUserPermissionsBody;
706
+ extends BaseRequest,
707
+ RequestQuery<PutUserPermissionsQuery>,
708
+ PutUserPermissionsPath {
709
+ body: PutUserPermissionsBody;
710
710
  }
711
711
 
712
712
  // POST /user/{id}/checkin - Create check-in for user
713
713
 
714
714
  export interface PostUserCheckInPath {
715
- // UserId of user who wants to checkin
716
- id: string;
715
+ // UserId of user who wants to checkin
716
+ id: string;
717
717
  }
718
718
 
719
719
  export type PostUserCheckInBody = CheckInUserInfo;
@@ -721,44 +721,44 @@ export type PostUserCheckInBody = CheckInUserInfo;
721
721
  export type PostUserCheckInResponse = Checkin;
722
722
 
723
723
  export interface PostUserCheckInRequest extends BaseRequest, PostUserCheckInPath {
724
- body: PostUserCheckInBody;
724
+ body: PostUserCheckInBody;
725
725
  }
726
726
 
727
727
  // GET /user/checkin/search - Search check-in
728
728
 
729
729
  export interface GetUserSearchCheckInQuery {
730
- // Check-in UUID
731
- checkin_uuid?: string;
732
- // Visit UUID that corresponds to the check-in
733
- visit_uuid?: string;
734
- // Graphql query string
735
- _query?: string;
730
+ // Check-in UUID
731
+ checkin_uuid?: string;
732
+ // Visit UUID that corresponds to the check-in
733
+ visit_uuid?: string;
734
+ // Graphql query string
735
+ _query?: string;
736
736
  }
737
737
 
738
738
  export type GetUserSearchCheckInResponse = Checkin;
739
739
 
740
740
  export interface GetUserSearchCheckInRequest
741
- extends BaseRequest,
742
- RequestQuery<GetUserSearchCheckInQuery> {}
741
+ extends BaseRequest,
742
+ RequestQuery<GetUserSearchCheckInQuery> {}
743
743
 
744
744
  // POST /user/{id}/verification - Send email verification to user
745
745
 
746
746
  export interface PostUserSendEmailVerificationPath {
747
- // realm
748
- id: string;
747
+ // realm
748
+ id: string;
749
749
  }
750
750
 
751
751
  export type PostUserSendEmailVerificationResponse = success;
752
752
 
753
753
  export interface PostUserSendEmailVerificationRequest
754
- extends BaseRequest,
755
- PostUserSendEmailVerificationPath {}
754
+ extends BaseRequest,
755
+ PostUserSendEmailVerificationPath {}
756
756
 
757
757
  // PUT /user/{id}/verification/confirm - Verify a users email
758
758
 
759
759
  export interface PutUserVerifyUserEmailPath {
760
- // realm
761
- id: string;
760
+ // realm
761
+ id: string;
762
762
  }
763
763
 
764
764
  export type PutUserVerifyUserEmailBody = VerifyEmail;
@@ -766,7 +766,7 @@ export type PutUserVerifyUserEmailBody = VerifyEmail;
766
766
  export type PutUserVerifyUserEmailResponse = success;
767
767
 
768
768
  export interface PutUserVerifyUserEmailRequest extends BaseRequest, PutUserVerifyUserEmailPath {
769
- body: PutUserVerifyUserEmailBody;
769
+ body: PutUserVerifyUserEmailBody;
770
770
  }
771
771
 
772
772
  // POST /user/guest - Creates a guest user
@@ -776,7 +776,7 @@ export type PostUserGuestUserBody = GuestUserCreate;
776
776
  export type PostUserGuestUserResponse = guestAuth;
777
777
 
778
778
  export interface PostUserGuestUserRequest extends BaseRequest {
779
- body: PostUserGuestUserBody;
779
+ body: PostUserGuestUserBody;
780
780
  }
781
781
 
782
782
  // POST /user/guest/token - Creates a temporary guest token
@@ -786,56 +786,56 @@ export type PostUserGuestTokenBody = GuestUserToken;
786
786
  export type PostUserGuestTokenResponse = guestAuthToken;
787
787
 
788
788
  export interface PostUserGuestTokenRequest extends BaseRequest {
789
- body: PostUserGuestTokenBody;
789
+ body: PostUserGuestTokenBody;
790
790
  }
791
791
 
792
792
  // POST /user/looker/embedurl - Create looker embed url
793
793
 
794
794
  export interface PostUserEmbedurlBody {
795
- // Url to be embedded
796
- url?: string;
795
+ // Url to be embedded
796
+ url?: string;
797
797
  }
798
798
 
799
799
  export interface PostUserEmbedurlResponse {
800
- // Embed url
801
- embed_url?: string;
800
+ // Embed url
801
+ embed_url?: string;
802
802
  }
803
803
 
804
804
  export interface PostUserEmbedurlRequest extends BaseRequest {
805
- body: PostUserEmbedurlBody;
805
+ body: PostUserEmbedurlBody;
806
806
  }
807
807
 
808
808
  // GET /user/profile - Returns user profile with limited information
809
809
 
810
810
  export interface GetUserProfileQuery {
811
- // user's email address
812
- email: string;
813
- // app realm
814
- realm: string;
815
- // Graphql query string
816
- _query?: string;
811
+ // user's email address
812
+ email: string;
813
+ // app realm
814
+ realm: string;
815
+ // Graphql query string
816
+ _query?: string;
817
817
  }
818
818
 
819
819
  export interface GetUserProfileResponse {
820
- // user
821
- id: string;
822
- name: {
823
- first?: string;
824
- last?: string;
825
- };
826
- email: string;
827
- // User phone number
828
- phone?: number;
829
- date: {
830
- created?: string;
831
- modified?: string;
832
- };
833
- meta?: UserMeta;
834
- ssoId?: string;
835
- is?: {
836
- disabled?: boolean;
837
- verified?: boolean;
838
- };
820
+ // user
821
+ id: string;
822
+ name: {
823
+ first?: string;
824
+ last?: string;
825
+ };
826
+ email: string;
827
+ // User phone number
828
+ phone?: number;
829
+ date: {
830
+ created?: string;
831
+ modified?: string;
832
+ };
833
+ meta?: UserMeta;
834
+ ssoId?: string;
835
+ is?: {
836
+ disabled?: boolean;
837
+ verified?: boolean;
838
+ };
839
839
  }
840
840
 
841
841
  export interface GetUserProfileRequest extends BaseRequest, RequestQuery<GetUserProfileQuery> {}