@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.
- package/lib/index.d.ts +58 -57
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +503 -501
- package/lib/index.js.map +1 -1
- package/lib/interface/ai.d.ts +1 -1
- package/lib/interface/ai.d.ts.map +1 -1
- package/lib/interface/announcement.d.ts +1 -1
- package/lib/interface/announcement.d.ts.map +1 -1
- package/lib/interface/auth.d.ts +3 -3
- package/lib/interface/auth.d.ts.map +1 -1
- package/lib/interface/calendar.d.ts +2 -2
- package/lib/interface/calendar.d.ts.map +1 -1
- package/lib/interface/centricos.d.ts +11 -11
- package/lib/interface/centricos.d.ts.map +1 -1
- package/lib/interface/compassconnect.d.ts +1 -1
- package/lib/interface/compassconnect.d.ts.map +1 -1
- package/lib/interface/config.d.ts +1 -1
- package/lib/interface/config.d.ts.map +1 -1
- package/lib/interface/datalake.d.ts +1 -1
- package/lib/interface/datalake.d.ts.map +1 -1
- package/lib/interface/email.d.ts +1 -1
- package/lib/interface/email.d.ts.map +1 -1
- package/lib/interface/file.d.ts +2 -2
- package/lib/interface/file.d.ts.map +1 -1
- package/lib/interface/frictionless.d.ts +9 -9
- package/lib/interface/frictionless.d.ts.map +1 -1
- package/lib/interface/kds.d.ts +1 -1
- package/lib/interface/kds.d.ts.map +1 -1
- package/lib/interface/location.d.ts +5 -3
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/mealplan.d.ts +2 -1
- package/lib/interface/mealplan.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +149 -109
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/notification.d.ts +3 -3
- package/lib/interface/notification.d.ts.map +1 -1
- package/lib/interface/order.d.ts +7 -7
- package/lib/interface/order.d.ts.map +1 -1
- package/lib/interface/partner.d.ts +10 -10
- package/lib/interface/partner.d.ts.map +1 -1
- package/lib/interface/payment.d.ts +3 -3
- package/lib/interface/payment.d.ts.map +1 -1
- package/lib/interface/promo.d.ts +8 -8
- package/lib/interface/promo.d.ts.map +1 -1
- package/lib/interface/report.d.ts +10 -10
- package/lib/interface/report.d.ts.map +1 -1
- package/lib/interface/search.d.ts +8 -8
- package/lib/interface/search.d.ts.map +1 -1
- package/lib/interface/shoppingcart.d.ts +7 -7
- package/lib/interface/shoppingcart.d.ts.map +1 -1
- package/lib/interface/task.d.ts +8 -8
- package/lib/interface/task.d.ts.map +1 -1
- package/lib/interface/tax.d.ts +2 -2
- package/lib/interface/tax.d.ts.map +1 -1
- package/lib/interface/user.d.ts +16 -16
- package/lib/interface/user.d.ts.map +1 -1
- package/lib/interface/vendor.d.ts +6 -6
- package/lib/interface/vendor.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +10395 -10394
- package/src/interface/ai.ts +22 -22
- package/src/interface/announcement.ts +60 -60
- package/src/interface/auth.ts +68 -68
- package/src/interface/calendar.ts +94 -94
- package/src/interface/centricos.ts +145 -145
- package/src/interface/compassconnect.ts +59 -59
- package/src/interface/config.ts +166 -166
- package/src/interface/datalake.ts +13 -13
- package/src/interface/email.ts +13 -13
- package/src/interface/file.ts +18 -18
- package/src/interface/frictionless.ts +177 -177
- package/src/interface/kds.ts +49 -49
- package/src/interface/location.ts +771 -769
- package/src/interface/mealplan.ts +155 -154
- package/src/interface/menu.ts +4079 -4018
- package/src/interface/notification.ts +51 -51
- package/src/interface/order.ts +464 -464
- package/src/interface/partner.ts +823 -823
- package/src/interface/payment.ts +278 -278
- package/src/interface/promo.ts +373 -373
- package/src/interface/report.ts +348 -348
- package/src/interface/search.ts +135 -135
- package/src/interface/shoppingcart.ts +429 -429
- package/src/interface/task.ts +212 -212
- package/src/interface/tax.ts +69 -69
- package/src/interface/user.ts +410 -410
- package/src/interface/vendor.ts +215 -215
|
@@ -1,112 +1,112 @@
|
|
|
1
1
|
/* eslint-disable */
|
|
2
2
|
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
3
3
|
|
|
4
|
-
import { RequestQuery, BaseRequest } from
|
|
4
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
5
5
|
|
|
6
6
|
export interface AIItemDescriptionRequest {
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
name: string;
|
|
8
|
+
modifiers?: string[];
|
|
9
9
|
}
|
|
10
10
|
|
|
11
11
|
export interface AIItemDescriptionResponse {
|
|
12
|
-
|
|
12
|
+
description: string;
|
|
13
13
|
}
|
|
14
14
|
|
|
15
15
|
export interface BadRequestErrorDTO {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
message: string;
|
|
17
|
+
code: number;
|
|
18
|
+
data: Record<string, any>;
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
export interface UnauthorizedErrorDTO {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
22
|
+
message: string;
|
|
23
|
+
code: number;
|
|
24
|
+
data: Record<string, any>;
|
|
25
25
|
}
|
|
26
26
|
|
|
27
27
|
export type InternalServerErrorException = Record<string, any>;
|
|
28
28
|
|
|
29
29
|
export interface AIItemImageRequest {
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
30
|
+
name?: string;
|
|
31
|
+
modifiers?: string[];
|
|
32
|
+
description: string;
|
|
33
|
+
number_of_images: number;
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
export interface ImageData {
|
|
37
|
-
|
|
38
|
-
|
|
37
|
+
data: string;
|
|
38
|
+
mime_type: string;
|
|
39
39
|
}
|
|
40
40
|
|
|
41
41
|
export interface AIItemImageResponse {
|
|
42
|
-
|
|
43
|
-
|
|
42
|
+
// Array of images
|
|
43
|
+
images: ImageData[];
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
export interface OrdersExportResponse {
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
47
|
+
// Order data in CSV
|
|
48
|
+
csv: string;
|
|
49
|
+
// CSV file name
|
|
50
|
+
fileName: string;
|
|
51
51
|
}
|
|
52
52
|
|
|
53
53
|
export interface DayPart {
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
54
|
+
label: string;
|
|
55
|
+
start: string;
|
|
56
|
+
end: string;
|
|
57
57
|
}
|
|
58
58
|
|
|
59
59
|
export interface ReportGroupConfigResponse {
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
60
|
+
location_group_id: string;
|
|
61
|
+
day_time: string;
|
|
62
|
+
day_parts: DayPart[];
|
|
63
|
+
is_default: boolean;
|
|
64
64
|
}
|
|
65
65
|
|
|
66
66
|
export interface ReportGroupConfigRequest {
|
|
67
|
-
|
|
68
|
-
|
|
67
|
+
day_time: string;
|
|
68
|
+
day_parts: DayPart[];
|
|
69
69
|
}
|
|
70
70
|
|
|
71
71
|
export interface LookerEmbedURLResponse {
|
|
72
|
-
|
|
72
|
+
url: string;
|
|
73
73
|
}
|
|
74
74
|
|
|
75
75
|
export interface SiteDevicesResponse {
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
76
|
+
site_devices: {
|
|
77
|
+
[index: string]: any;
|
|
78
|
+
};
|
|
79
79
|
}
|
|
80
80
|
|
|
81
81
|
export interface PageMetadata {
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
82
|
+
page: number;
|
|
83
|
+
limit: number;
|
|
84
|
+
totalResults: number;
|
|
85
|
+
totalPages: number;
|
|
86
|
+
resultsCount: number;
|
|
87
|
+
sortOrder: 'ASC' | 'DESC';
|
|
88
|
+
sortBy: string;
|
|
89
89
|
}
|
|
90
90
|
|
|
91
91
|
export interface LocalMenuGroup {
|
|
92
|
-
|
|
93
|
-
|
|
92
|
+
id: string;
|
|
93
|
+
name: string;
|
|
94
94
|
}
|
|
95
95
|
|
|
96
96
|
export interface Site {
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
97
|
+
id: string;
|
|
98
|
+
name: string;
|
|
99
|
+
sector: string;
|
|
100
|
+
app: 'thrive' | 'boost';
|
|
101
|
+
unit_number: string;
|
|
102
|
+
visible_stations: number;
|
|
103
|
+
local_menu_group?: LocalMenuGroup[];
|
|
104
|
+
menu_sources: ('admin' | 'centric')[];
|
|
105
105
|
}
|
|
106
106
|
|
|
107
107
|
export interface GetSitesResponse {
|
|
108
|
-
|
|
109
|
-
|
|
108
|
+
meta: PageMetadata;
|
|
109
|
+
results: Site[];
|
|
110
110
|
}
|
|
111
111
|
|
|
112
112
|
// POST /centricos/ai/item/description - Generate item description
|
|
@@ -116,7 +116,7 @@ export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
|
|
|
116
116
|
export type PostCentricosAiItemDescriptionResponse = AIItemDescriptionResponse;
|
|
117
117
|
|
|
118
118
|
export interface PostCentricosAiItemDescriptionRequest extends BaseRequest {
|
|
119
|
-
|
|
119
|
+
body: PostCentricosAiItemDescriptionBody;
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
// POST /centricos/ai/item/image - Generate item image
|
|
@@ -126,86 +126,86 @@ export type PostCentricosAiItemImageBody = AIItemImageRequest;
|
|
|
126
126
|
export type PostCentricosAiItemImageResponse = AIItemImageResponse;
|
|
127
127
|
|
|
128
128
|
export interface PostCentricosAiItemImageRequest extends BaseRequest {
|
|
129
|
-
|
|
129
|
+
body: PostCentricosAiItemImageBody;
|
|
130
130
|
}
|
|
131
131
|
|
|
132
132
|
// GET /centricos/orders/export - Get orders in csv format
|
|
133
133
|
|
|
134
134
|
export interface PostCentricosOrdersExportQuery {
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
135
|
+
// Filter orders by site id
|
|
136
|
+
source_group_id: string;
|
|
137
|
+
// Filter orders with created date not earlier than
|
|
138
|
+
date_created_start: string;
|
|
139
|
+
// Filter orders with created date not later than this date
|
|
140
|
+
date_created_end?: string;
|
|
141
|
+
// Filter orders by brand id
|
|
142
|
+
source_brand_id?: string;
|
|
143
|
+
// Filter orders by order/pickup number
|
|
144
|
+
pickup_id?: string;
|
|
145
|
+
// Filter orders by user customer name
|
|
146
|
+
pickup_name?: string;
|
|
147
|
+
// Filter orders by customer email
|
|
148
|
+
email?: string;
|
|
149
|
+
// Filter orders by payment category
|
|
150
|
+
payment_category?: ('digital wallet' | 'badge pay' | 'credit card' | 'mealplan')[];
|
|
151
|
+
// Search order by refund_status
|
|
152
|
+
refund_status?: ('partial' | 'full' | '')[];
|
|
153
|
+
// Search order by order_type
|
|
154
|
+
order_type?: ('frictionless' | 'delivery' | 'pickup' | 'scan_and_go')[];
|
|
155
|
+
// Search order by status
|
|
156
|
+
status?: ('ready' | 'accepted' | 'delivered' | 'in_progress' | 'out_for_delivery' | 'created')[];
|
|
157
|
+
// Return items sorted by this column
|
|
158
|
+
sortBy?:
|
|
159
|
+
| 'date_created'
|
|
160
|
+
| 'destination'
|
|
161
|
+
| 'id'
|
|
162
|
+
| 'pickup'
|
|
163
|
+
| 'pickup_id'
|
|
164
|
+
| 'pickup_name'
|
|
165
|
+
| 'source_id'
|
|
166
|
+
| 'sub_total'
|
|
167
|
+
| 'total'
|
|
168
|
+
| 'site_name'
|
|
169
|
+
| 'status'
|
|
170
|
+
| 'order_type'
|
|
171
|
+
| 'fulfillment_date';
|
|
172
|
+
sortOrder?: 'ASC' | 'DESC';
|
|
173
|
+
// Export Personal Identifiable Information
|
|
174
|
+
include_pii?: string;
|
|
175
|
+
// Graphql query string
|
|
176
|
+
_query?: string;
|
|
177
177
|
}
|
|
178
178
|
|
|
179
179
|
export type PostCentricosOrdersExportResponse = OrdersExportResponse;
|
|
180
180
|
|
|
181
181
|
export interface PostCentricosOrdersExportRequest
|
|
182
|
-
|
|
183
|
-
|
|
182
|
+
extends BaseRequest,
|
|
183
|
+
RequestQuery<PostCentricosOrdersExportQuery> {}
|
|
184
184
|
|
|
185
185
|
// GET /centricos/report/group/{location_group}/config - Get report configuration for a location group. Times are in site's local timezone.
|
|
186
186
|
|
|
187
187
|
export interface GetCentricosReportGroupConfigPath {
|
|
188
|
-
|
|
189
|
-
|
|
188
|
+
// TODO: add parameter to swagger.json
|
|
189
|
+
location_group: string;
|
|
190
190
|
}
|
|
191
191
|
|
|
192
192
|
export interface GetCentricosReportGroupConfigQuery {
|
|
193
|
-
|
|
194
|
-
|
|
193
|
+
// Graphql query string
|
|
194
|
+
_query?: string;
|
|
195
195
|
}
|
|
196
196
|
|
|
197
197
|
export type GetCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
|
|
198
198
|
|
|
199
199
|
export interface GetCentricosReportGroupConfigRequest
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
200
|
+
extends BaseRequest,
|
|
201
|
+
RequestQuery<GetCentricosReportGroupConfigQuery>,
|
|
202
|
+
GetCentricosReportGroupConfigPath {}
|
|
203
203
|
|
|
204
204
|
// PUT /centricos/report/group/{location_group}/config - Update report configuration for a location group. Times are in site's local timezone.
|
|
205
205
|
|
|
206
206
|
export interface PutCentricosReportGroupConfigPath {
|
|
207
|
-
|
|
208
|
-
|
|
207
|
+
// TODO: add parameter to swagger.json
|
|
208
|
+
location_group: string;
|
|
209
209
|
}
|
|
210
210
|
|
|
211
211
|
export type PutCentricosReportGroupConfigBody = ReportGroupConfigRequest;
|
|
@@ -213,91 +213,91 @@ export type PutCentricosReportGroupConfigBody = ReportGroupConfigRequest;
|
|
|
213
213
|
export type PutCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
|
|
214
214
|
|
|
215
215
|
export interface PutCentricosReportGroupConfigRequest
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
216
|
+
extends BaseRequest,
|
|
217
|
+
PutCentricosReportGroupConfigPath {
|
|
218
|
+
body: PutCentricosReportGroupConfigBody;
|
|
219
219
|
}
|
|
220
220
|
|
|
221
221
|
// DELETE /centricos/report/group/{location_group}/config - Delete report configuration for a location group. Times are in site's local timezone.
|
|
222
222
|
|
|
223
223
|
export interface DeleteCentricosReportGroupConfigPath {
|
|
224
|
-
|
|
225
|
-
|
|
224
|
+
// TODO: add parameter to swagger.json
|
|
225
|
+
location_group: string;
|
|
226
226
|
}
|
|
227
227
|
|
|
228
228
|
export type DeleteCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
|
|
229
229
|
|
|
230
230
|
export interface DeleteCentricosReportGroupConfigRequest
|
|
231
|
-
|
|
232
|
-
|
|
231
|
+
extends BaseRequest,
|
|
232
|
+
DeleteCentricosReportGroupConfigPath {}
|
|
233
233
|
|
|
234
234
|
// GET /centricos/report/group/{location_group}/config/default - Get default report configuration. Times are in site's local timezone.
|
|
235
235
|
|
|
236
236
|
export interface GetCentricosReportConfigDefaultPath {
|
|
237
|
-
|
|
238
|
-
|
|
237
|
+
// TODO: add parameter to swagger.json
|
|
238
|
+
location_group: string;
|
|
239
239
|
}
|
|
240
240
|
|
|
241
241
|
export interface GetCentricosReportConfigDefaultQuery {
|
|
242
|
-
|
|
243
|
-
|
|
242
|
+
// Graphql query string
|
|
243
|
+
_query?: string;
|
|
244
244
|
}
|
|
245
245
|
|
|
246
246
|
export type GetCentricosReportConfigDefaultResponse = ReportGroupConfigResponse;
|
|
247
247
|
|
|
248
248
|
export interface GetCentricosReportConfigDefaultRequest
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
249
|
+
extends BaseRequest,
|
|
250
|
+
RequestQuery<GetCentricosReportConfigDefaultQuery>,
|
|
251
|
+
GetCentricosReportConfigDefaultPath {}
|
|
252
252
|
|
|
253
253
|
// GET /centricos/looker/embedurl - Get a signed URL for looker embeding
|
|
254
254
|
|
|
255
255
|
export interface GetCentricosLookerEmbedurlQuery {
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
256
|
+
src: string;
|
|
257
|
+
// Graphql query string
|
|
258
|
+
_query?: string;
|
|
259
259
|
}
|
|
260
260
|
|
|
261
261
|
export type GetCentricosLookerEmbedurlResponse = LookerEmbedURLResponse;
|
|
262
262
|
|
|
263
263
|
export interface GetCentricosLookerEmbedurlRequest
|
|
264
|
-
|
|
265
|
-
|
|
264
|
+
extends BaseRequest,
|
|
265
|
+
RequestQuery<GetCentricosLookerEmbedurlQuery> {}
|
|
266
266
|
|
|
267
267
|
// GET /centricos/devices/{site_id} - Get site devices
|
|
268
268
|
|
|
269
269
|
export interface GetSiteDevicesPath {
|
|
270
|
-
|
|
271
|
-
|
|
270
|
+
// ID of the site to retrieve devices for
|
|
271
|
+
site_id: string;
|
|
272
272
|
}
|
|
273
273
|
|
|
274
274
|
export interface GetSiteDevicesQuery {
|
|
275
|
-
|
|
276
|
-
|
|
275
|
+
// Graphql query string
|
|
276
|
+
_query?: string;
|
|
277
277
|
}
|
|
278
278
|
|
|
279
279
|
export type GetSiteDevicesResponse = SiteDevicesResponse;
|
|
280
280
|
|
|
281
281
|
export interface GetSiteDevicesRequest
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
282
|
+
extends BaseRequest,
|
|
283
|
+
RequestQuery<GetSiteDevicesQuery>,
|
|
284
|
+
GetSiteDevicesPath {}
|
|
285
285
|
|
|
286
286
|
// GET /centricos/sites - Get a list of sites. This endpoint is paginated and supports filtering, sorting, and searching.
|
|
287
287
|
|
|
288
288
|
export interface GetCentricosSitesQuery {
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
289
|
+
id_multigroups?: string[];
|
|
290
|
+
filter?: string;
|
|
291
|
+
limit: number;
|
|
292
|
+
page: number;
|
|
293
|
+
sortOrder: 'ASC' | 'DESC';
|
|
294
|
+
sortBy?: string;
|
|
295
|
+
// Graphql query string
|
|
296
|
+
_query?: string;
|
|
297
297
|
}
|
|
298
298
|
|
|
299
299
|
export type GetCentricosSitesResponse = GetSitesResponse;
|
|
300
300
|
|
|
301
301
|
export interface GetCentricosSitesRequest
|
|
302
|
-
|
|
303
|
-
|
|
302
|
+
extends BaseRequest,
|
|
303
|
+
RequestQuery<GetCentricosSitesQuery> {}
|
|
@@ -1,86 +1,86 @@
|
|
|
1
1
|
/* eslint-disable */
|
|
2
2
|
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
3
3
|
|
|
4
|
-
import { RequestQuery, BaseRequest } from
|
|
4
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
5
5
|
|
|
6
6
|
export interface OMSRequest {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
7
|
+
code: string;
|
|
8
|
+
client_id: string;
|
|
9
|
+
callback_uri: string;
|
|
10
|
+
oms_url: string;
|
|
11
11
|
}
|
|
12
12
|
|
|
13
13
|
export interface Error {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
message?: string;
|
|
15
|
+
code?: number;
|
|
16
|
+
data?: Record<string, any>;
|
|
17
17
|
}
|
|
18
18
|
|
|
19
19
|
export interface Auth {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
20
|
+
access?: {
|
|
21
|
+
token?: string;
|
|
22
|
+
expires?: string;
|
|
23
|
+
};
|
|
24
|
+
refresh?: {
|
|
25
|
+
token?: string;
|
|
26
|
+
expires?: string;
|
|
27
|
+
};
|
|
28
|
+
// Access token string (should be moved inside access object under real scenarios)
|
|
29
|
+
access_token?: string;
|
|
30
|
+
// Duration in seconds until the access token expires (should be moved inside access object under real scenarios)
|
|
31
|
+
expires_in?: number;
|
|
32
|
+
// Unix timestamp when the token expires (should be moved inside access object under real scenarios)
|
|
33
|
+
expires_at?: number;
|
|
34
|
+
attributes?: {
|
|
35
|
+
clientName?: string;
|
|
36
|
+
company?: string;
|
|
37
|
+
country?: string;
|
|
38
|
+
credentialType?: string;
|
|
39
|
+
department?: string;
|
|
40
|
+
email?: string;
|
|
41
|
+
first_name?: string;
|
|
42
|
+
full_name?: string;
|
|
43
|
+
last_name?: string;
|
|
44
|
+
locale?: string;
|
|
45
|
+
logon_username?: string;
|
|
46
|
+
mobile?: string;
|
|
47
|
+
samlAuthenticationStatementAuthMethod?: string;
|
|
48
|
+
telephone?: string;
|
|
49
|
+
title?: string;
|
|
50
|
+
userPrincipalName?: string;
|
|
51
|
+
};
|
|
52
|
+
// Identifier of the user or session
|
|
53
|
+
id?: string;
|
|
54
|
+
// Refresh token string (should be moved inside refresh object under real scenarios)
|
|
55
|
+
refresh_token?: string;
|
|
56
56
|
}
|
|
57
57
|
|
|
58
58
|
export interface Compassconnect {
|
|
59
|
-
|
|
60
|
-
|
|
59
|
+
// compassconnect
|
|
60
|
+
id: string;
|
|
61
61
|
}
|
|
62
62
|
|
|
63
63
|
export interface Compassconnects {
|
|
64
|
-
|
|
64
|
+
compassconnects: Compassconnect[];
|
|
65
65
|
}
|
|
66
66
|
|
|
67
67
|
// GET /compassconnect/oms_token - Gets an OMS token
|
|
68
68
|
|
|
69
69
|
export interface GetCompassconnectOmsTokenQuery {
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
70
|
+
// The SSO code recieved from login
|
|
71
|
+
code: string;
|
|
72
|
+
// The client id of the application getting the token
|
|
73
|
+
client_id: string;
|
|
74
|
+
// The callback uri of the application calling the service
|
|
75
|
+
callback_uri: string;
|
|
76
|
+
// The url
|
|
77
|
+
oms_url: string;
|
|
78
|
+
// Graphql query string
|
|
79
|
+
_query?: string;
|
|
80
80
|
}
|
|
81
81
|
|
|
82
82
|
export type GetCompassconnectOmsTokenResponse = Auth;
|
|
83
83
|
|
|
84
84
|
export interface GetCompassconnectOmsTokenRequest
|
|
85
|
-
|
|
86
|
-
|
|
85
|
+
extends BaseRequest,
|
|
86
|
+
RequestQuery<GetCompassconnectOmsTokenQuery> {}
|