@compassdigital/sdk.typescript 3.0.0-beta.5 → 3.0.0-beta.6
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/README.md +9 -5
- package/gen.ts +1 -1
- package/lib/base.d.ts +13 -1
- package/lib/base.d.ts.map +1 -1
- package/lib/base.js +45 -3
- package/lib/base.js.map +1 -1
- package/lib/index.d.ts +306 -306
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/package.json +1 -1
- package/src/base.ts +29 -3
- package/src/index.ts +728 -611
- package/template.ejs +2 -2
package/lib/index.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ import { PostVoteBody, PostVoteResponse, GetVoteIdfaQuery, GetVoteIdfaResponse }
|
|
|
22
22
|
import { PostFileBody, PostFileResponse } from "./file";
|
|
23
23
|
import { PostMessageBody, PostMessageResponse, GetMessageResponse } from "./message";
|
|
24
24
|
import { GetLoggerBrandStatusQuery, GetLoggerBrandStatusResponse } from "./logger";
|
|
25
|
-
import { BaseServiceClient, RequestOptions } from "./base";
|
|
25
|
+
import { BaseServiceClient, RequestOptions, ResponseType } from "./base";
|
|
26
26
|
export { RequestOptions } from "./base";
|
|
27
27
|
export declare class ServiceClient extends BaseServiceClient {
|
|
28
28
|
/**
|
|
@@ -32,7 +32,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
32
32
|
* @param body
|
|
33
33
|
* @param options - additional request options
|
|
34
34
|
*/
|
|
35
|
-
post_payment_transaction(id: string, body: PostPaymentTransactionBody, options?:
|
|
35
|
+
post_payment_transaction<Options extends RequestOptions>(id: string, body: PostPaymentTransactionBody, options?: Options): ResponseType<PostPaymentTransactionResponse, Options>;
|
|
36
36
|
/**
|
|
37
37
|
* POST /payment/{id}/transaction/{transaction_id}/refund
|
|
38
38
|
*
|
|
@@ -41,14 +41,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
41
41
|
* @param body
|
|
42
42
|
* @param options - additional request options
|
|
43
43
|
*/
|
|
44
|
-
post_payment_transaction_refund(id: string, transaction_id: string, body: PostPaymentTransactionRefundBody, options?:
|
|
44
|
+
post_payment_transaction_refund<Options extends RequestOptions>(id: string, transaction_id: string, body: PostPaymentTransactionRefundBody, options?: Options): ResponseType<PostPaymentTransactionRefundResponse, Options>;
|
|
45
45
|
/**
|
|
46
46
|
* GET /payment/{id}/clienttoken
|
|
47
47
|
*
|
|
48
48
|
* @param id - TODO: add parameter to swagger.json
|
|
49
49
|
* @param options - additional request options
|
|
50
50
|
*/
|
|
51
|
-
get_payment_clienttoken(id: string, options?:
|
|
51
|
+
get_payment_clienttoken<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetPaymentClienttokenResponse, Options>;
|
|
52
52
|
/**
|
|
53
53
|
* POST /payment/{id}/paymenttoken
|
|
54
54
|
*
|
|
@@ -56,30 +56,30 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
56
56
|
* @param body
|
|
57
57
|
* @param options - additional request options
|
|
58
58
|
*/
|
|
59
|
-
post_payment_paymenttoken(id: string, body: PostPaymentPaymenttokenBody, options?:
|
|
59
|
+
post_payment_paymenttoken<Options extends RequestOptions>(id: string, body: PostPaymentPaymenttokenBody, options?: Options): ResponseType<PostPaymentPaymenttokenResponse, Options>;
|
|
60
60
|
/**
|
|
61
61
|
* POST /payment/consumer
|
|
62
62
|
*
|
|
63
63
|
* @param body
|
|
64
64
|
* @param options - additional request options
|
|
65
65
|
*/
|
|
66
|
-
post_payment_consumer(body: PostPaymentConsumerBody, options?:
|
|
66
|
+
post_payment_consumer<Options extends RequestOptions>(body: PostPaymentConsumerBody, options?: Options): ResponseType<PostPaymentConsumerResponse, Options>;
|
|
67
67
|
/**
|
|
68
68
|
* POST /payment/method
|
|
69
69
|
*
|
|
70
70
|
* @param body
|
|
71
71
|
* @param options - additional request options
|
|
72
72
|
*/
|
|
73
|
-
post_payment_method(body: PostPaymentMethodBody, options?:
|
|
73
|
+
post_payment_method<Options extends RequestOptions>(body: PostPaymentMethodBody, options?: Options): ResponseType<PostPaymentMethodResponse, Options>;
|
|
74
74
|
/**
|
|
75
75
|
* GET /payment/{id}/method - Get a users available payment methods
|
|
76
76
|
*
|
|
77
77
|
* @param id - TODO: add parameter to swagger.json
|
|
78
78
|
* @param options - additional request options
|
|
79
79
|
*/
|
|
80
|
-
get_payment_method(id: string, options: {
|
|
80
|
+
get_payment_method<Options extends RequestOptions>(id: string, options: {
|
|
81
81
|
query: GetPaymentMethodQuery;
|
|
82
|
-
} &
|
|
82
|
+
} & Options): ResponseType<GetPaymentMethodResponse, Options>;
|
|
83
83
|
/**
|
|
84
84
|
* DELETE /payment/{id}/method/{method_id}
|
|
85
85
|
*
|
|
@@ -88,75 +88,75 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
88
88
|
* @param body
|
|
89
89
|
* @param options - additional request options
|
|
90
90
|
*/
|
|
91
|
-
delete_payment_method(id: string, method_id: string, body: DeletePaymentMethodBody, options?:
|
|
91
|
+
delete_payment_method<Options extends RequestOptions>(id: string, method_id: string, body: DeletePaymentMethodBody, options?: Options): ResponseType<DeletePaymentMethodResponse, Options>;
|
|
92
92
|
/**
|
|
93
93
|
* GET /payment/token
|
|
94
94
|
*
|
|
95
95
|
* @param options - additional request options
|
|
96
96
|
*/
|
|
97
|
-
get_payment_token(options: {
|
|
97
|
+
get_payment_token<Options extends RequestOptions>(options: {
|
|
98
98
|
query: GetPaymentTokenQuery;
|
|
99
|
-
} &
|
|
99
|
+
} & Options): ResponseType<GetPaymentTokenResponse, Options>;
|
|
100
100
|
/**
|
|
101
101
|
* POST /payment/token
|
|
102
102
|
*
|
|
103
103
|
* @param body
|
|
104
104
|
* @param options - additional request options
|
|
105
105
|
*/
|
|
106
|
-
post_payment_token(body: PostPaymentTokenBody, options?:
|
|
106
|
+
post_payment_token<Options extends RequestOptions>(body: PostPaymentTokenBody, options?: Options): ResponseType<PostPaymentTokenResponse, Options>;
|
|
107
107
|
/**
|
|
108
108
|
* PUT /payment/token
|
|
109
109
|
*
|
|
110
110
|
* @param body
|
|
111
111
|
* @param options - additional request options
|
|
112
112
|
*/
|
|
113
|
-
put_payment_token(body: PutPaymentTokenBody, options?:
|
|
113
|
+
put_payment_token<Options extends RequestOptions>(body: PutPaymentTokenBody, options?: Options): ResponseType<PutPaymentTokenResponse, Options>;
|
|
114
114
|
/**
|
|
115
115
|
* DELETE /payment/token
|
|
116
116
|
*
|
|
117
117
|
* @param body
|
|
118
118
|
* @param options - additional request options
|
|
119
119
|
*/
|
|
120
|
-
delete_payment_token(body: DeletePaymentTokenBody, options?:
|
|
120
|
+
delete_payment_token<Options extends RequestOptions>(body: DeletePaymentTokenBody, options?: Options): ResponseType<DeletePaymentTokenResponse, Options>;
|
|
121
121
|
/**
|
|
122
122
|
* GET /payment/methods
|
|
123
123
|
*
|
|
124
124
|
* @param options - additional request options
|
|
125
125
|
*/
|
|
126
|
-
get_payment_methods(options: {
|
|
126
|
+
get_payment_methods<Options extends RequestOptions>(options: {
|
|
127
127
|
query: GetPaymentMethodsQuery;
|
|
128
|
-
} &
|
|
128
|
+
} & Options): ResponseType<GetPaymentMethodsResponse, Options>;
|
|
129
129
|
/**
|
|
130
130
|
* GET /payment/hpc
|
|
131
131
|
*
|
|
132
132
|
* @param options - additional request options
|
|
133
133
|
*/
|
|
134
|
-
get_payment_hpc(options: {
|
|
134
|
+
get_payment_hpc<Options extends RequestOptions>(options: {
|
|
135
135
|
query: GetPaymentHpcQuery;
|
|
136
|
-
} &
|
|
136
|
+
} & Options): ResponseType<GetPaymentHpcResponse, Options>;
|
|
137
137
|
/**
|
|
138
138
|
* POST /order - Create an Order
|
|
139
139
|
*
|
|
140
140
|
* @param body - Order object that needs to be created
|
|
141
141
|
* @param options - additional request options
|
|
142
142
|
*/
|
|
143
|
-
post_order(body: PostOrderBody, options?: {
|
|
143
|
+
post_order<Options extends RequestOptions>(body: PostOrderBody, options?: {
|
|
144
144
|
query?: PostOrderQuery;
|
|
145
|
-
} &
|
|
145
|
+
} & Options): ResponseType<PostOrderResponse, Options>;
|
|
146
146
|
/**
|
|
147
147
|
* GET /order/{id} - Get an individual order
|
|
148
148
|
*
|
|
149
149
|
* @param id - The order ID
|
|
150
150
|
* @param options - additional request options
|
|
151
151
|
*/
|
|
152
|
-
get_order(id: string, options?:
|
|
152
|
+
get_order<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetOrderResponse, Options>;
|
|
153
153
|
/**
|
|
154
154
|
* PUT /order/{id} - Update an individual order
|
|
155
155
|
*
|
|
156
156
|
* @param id - The order ID
|
|
157
157
|
* @param options - additional request options
|
|
158
158
|
*/
|
|
159
|
-
put_order(id: string, options?:
|
|
159
|
+
put_order<Options extends RequestOptions>(id: string, options?: Options): ResponseType<PutOrderResponse, Options>;
|
|
160
160
|
/**
|
|
161
161
|
* PATCH /order/{id} - Update an existing order
|
|
162
162
|
*
|
|
@@ -164,7 +164,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
164
164
|
* @param body - Order properties to be updated
|
|
165
165
|
* @param options - additional request options
|
|
166
166
|
*/
|
|
167
|
-
patch_order(id: string, body: PatchOrderBody, options?:
|
|
167
|
+
patch_order<Options extends RequestOptions>(id: string, body: PatchOrderBody, options?: Options): ResponseType<PatchOrderResponse, Options>;
|
|
168
168
|
/**
|
|
169
169
|
* POST /order/{id}/issue - Create an issue with an order
|
|
170
170
|
*
|
|
@@ -172,7 +172,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
172
172
|
* @param body - Order issue payload. If reporting dispute please use type as 'DISPUTE'. In case of dispute 'item id' and 'reason' are mandatory params in body.
|
|
173
173
|
* @param options - additional request options
|
|
174
174
|
*/
|
|
175
|
-
post_order_issue(id: string, body: PostOrderIssueBody, options?:
|
|
175
|
+
post_order_issue<Options extends RequestOptions>(id: string, body: PostOrderIssueBody, options?: Options): ResponseType<PostOrderIssueResponse, Options>;
|
|
176
176
|
/**
|
|
177
177
|
* PATCH /order/{id}/refund - Issue a refund on an existing order
|
|
178
178
|
*
|
|
@@ -180,16 +180,16 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
180
180
|
* @param body - Items with pricing and quanitity to be refunded
|
|
181
181
|
* @param options - additional request options
|
|
182
182
|
*/
|
|
183
|
-
patch_order_refund(id: string, body: PatchOrderRefundBody, options?:
|
|
183
|
+
patch_order_refund<Options extends RequestOptions>(id: string, body: PatchOrderRefundBody, options?: Options): ResponseType<PatchOrderRefundResponse, Options>;
|
|
184
184
|
/**
|
|
185
185
|
* GET /order/customer/{id} - Get all orders for a Customer
|
|
186
186
|
*
|
|
187
187
|
* @param id - The user ID
|
|
188
188
|
* @param options - additional request options
|
|
189
189
|
*/
|
|
190
|
-
get_order_customer_orders(id: string, options?: {
|
|
190
|
+
get_order_customer_orders<Options extends RequestOptions>(id: string, options?: {
|
|
191
191
|
query?: GetOrderCustomerOrdersQuery;
|
|
192
|
-
} &
|
|
192
|
+
} & Options): ResponseType<GetOrderCustomerOrdersResponse, Options>;
|
|
193
193
|
/**
|
|
194
194
|
* GET /order/customer/{id}/location/brand/{location_brand} - Get all orders for a Customer for a specific Location Brand
|
|
195
195
|
*
|
|
@@ -197,64 +197,64 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
197
197
|
* @param location_brand - Brand id
|
|
198
198
|
* @param options - additional request options
|
|
199
199
|
*/
|
|
200
|
-
get_order_customer_orders_brand(id: string, location_brand: string, options?:
|
|
200
|
+
get_order_customer_orders_brand<Options extends RequestOptions>(id: string, location_brand: string, options?: Options): ResponseType<GetOrderCustomerOrdersBrandResponse, Options>;
|
|
201
201
|
/**
|
|
202
202
|
* GET /order/location/brand/{id} - Get all orders for a location Brand
|
|
203
203
|
*
|
|
204
204
|
* @param id - The location brand ID
|
|
205
205
|
* @param options - additional request options
|
|
206
206
|
*/
|
|
207
|
-
get_order_brand_orders(id: string, options?: {
|
|
207
|
+
get_order_brand_orders<Options extends RequestOptions>(id: string, options?: {
|
|
208
208
|
query?: GetOrderBrandOrdersQuery;
|
|
209
|
-
} &
|
|
209
|
+
} & Options): ResponseType<GetOrderBrandOrdersResponse, Options>;
|
|
210
210
|
/**
|
|
211
211
|
* GET /order/location/{id} - Get all orders for a location
|
|
212
212
|
*
|
|
213
213
|
* @param id - The location ID
|
|
214
214
|
* @param options - additional request options
|
|
215
215
|
*/
|
|
216
|
-
get_order_location_orders(id: string, options?: {
|
|
216
|
+
get_order_location_orders<Options extends RequestOptions>(id: string, options?: {
|
|
217
217
|
query?: GetOrderLocationOrdersQuery;
|
|
218
|
-
} &
|
|
218
|
+
} & Options): ResponseType<GetOrderLocationOrdersResponse, Options>;
|
|
219
219
|
/**
|
|
220
220
|
* GET /order/location/group/{id} - Get all orders for a location group
|
|
221
221
|
*
|
|
222
222
|
* @param id - Get orders by their associated group
|
|
223
223
|
* @param options - additional request options
|
|
224
224
|
*/
|
|
225
|
-
get_order_group_orders(id: string, options?: {
|
|
225
|
+
get_order_group_orders<Options extends RequestOptions>(id: string, options?: {
|
|
226
226
|
query?: GetOrderGroupOrdersQuery;
|
|
227
|
-
} &
|
|
227
|
+
} & Options): ResponseType<GetOrderGroupOrdersResponse, Options>;
|
|
228
228
|
/**
|
|
229
229
|
* POST /location - Create a new location
|
|
230
230
|
*
|
|
231
231
|
* @param body
|
|
232
232
|
* @param options - additional request options
|
|
233
233
|
*/
|
|
234
|
-
post_location(body: PostLocationBody, options?:
|
|
234
|
+
post_location<Options extends RequestOptions>(body: PostLocationBody, options?: Options): ResponseType<PostLocationResponse, Options>;
|
|
235
235
|
/**
|
|
236
236
|
* GET /location - Get all location
|
|
237
237
|
*
|
|
238
238
|
* @param options - additional request options
|
|
239
239
|
*/
|
|
240
|
-
get_locations(options?:
|
|
240
|
+
get_locations<Options extends RequestOptions>(options?: Options): ResponseType<GetLocationsResponse, Options>;
|
|
241
241
|
/**
|
|
242
242
|
* GET /location/search - Gets Location within a radius of the provided point
|
|
243
243
|
*
|
|
244
244
|
* @param options - additional request options
|
|
245
245
|
*/
|
|
246
|
-
get_location_search(options?: {
|
|
246
|
+
get_location_search<Options extends RequestOptions>(options?: {
|
|
247
247
|
query?: GetLocationSearchQuery;
|
|
248
|
-
} &
|
|
248
|
+
} & Options): ResponseType<GetLocationSearchResponse, Options>;
|
|
249
249
|
/**
|
|
250
250
|
* GET /location/{id} - Get an individual Location
|
|
251
251
|
*
|
|
252
252
|
* @param id - location id
|
|
253
253
|
* @param options - additional request options
|
|
254
254
|
*/
|
|
255
|
-
get_location(id: string, options?: {
|
|
255
|
+
get_location<Options extends RequestOptions>(id: string, options?: {
|
|
256
256
|
query?: GetLocationQuery;
|
|
257
|
-
} &
|
|
257
|
+
} & Options): ResponseType<GetLocationResponse, Options>;
|
|
258
258
|
/**
|
|
259
259
|
* PUT /location/{id} - Override a complete Location
|
|
260
260
|
*
|
|
@@ -262,7 +262,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
262
262
|
* @param body
|
|
263
263
|
* @param options - additional request options
|
|
264
264
|
*/
|
|
265
|
-
put_location(id: string, body: PutLocationBody, options?:
|
|
265
|
+
put_location<Options extends RequestOptions>(id: string, body: PutLocationBody, options?: Options): ResponseType<PutLocationResponse, Options>;
|
|
266
266
|
/**
|
|
267
267
|
* DELETE /location/{id} - Delete brands from a Location
|
|
268
268
|
*
|
|
@@ -270,7 +270,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
270
270
|
* @param body
|
|
271
271
|
* @param options - additional request options
|
|
272
272
|
*/
|
|
273
|
-
delete_location(id: string, body: DeleteLocationBody, options?:
|
|
273
|
+
delete_location<Options extends RequestOptions>(id: string, body: DeleteLocationBody, options?: Options): ResponseType<DeleteLocationResponse, Options>;
|
|
274
274
|
/**
|
|
275
275
|
* PATCH /location/{id} - Update a Location
|
|
276
276
|
*
|
|
@@ -278,14 +278,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
278
278
|
* @param body
|
|
279
279
|
* @param options - additional request options
|
|
280
280
|
*/
|
|
281
|
-
patch_location(id: string, body: PatchLocationBody, options?:
|
|
281
|
+
patch_location<Options extends RequestOptions>(id: string, body: PatchLocationBody, options?: Options): ResponseType<PatchLocationResponse, Options>;
|
|
282
282
|
/**
|
|
283
283
|
* GET /location/pos/{id} - Get information about a POS
|
|
284
284
|
*
|
|
285
285
|
* @param id - POS ID
|
|
286
286
|
* @param options - additional request options
|
|
287
287
|
*/
|
|
288
|
-
get_location_pos(id: string, options?:
|
|
288
|
+
get_location_pos<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetLocationPosResponse, Options>;
|
|
289
289
|
/**
|
|
290
290
|
* PUT /location/pos/{id} - Set information about a POS
|
|
291
291
|
*
|
|
@@ -293,29 +293,29 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
293
293
|
* @param body
|
|
294
294
|
* @param options - additional request options
|
|
295
295
|
*/
|
|
296
|
-
put_location_pos(id: string, body: PutLocationPosBody, options?:
|
|
296
|
+
put_location_pos<Options extends RequestOptions>(id: string, body: PutLocationPosBody, options?: Options): ResponseType<PutLocationPosResponse, Options>;
|
|
297
297
|
/**
|
|
298
298
|
* GET /location/multigroup - Get all the top level multigroups
|
|
299
299
|
*
|
|
300
300
|
* @param options - additional request options
|
|
301
301
|
*/
|
|
302
|
-
get_location_multigroups(options?:
|
|
302
|
+
get_location_multigroups<Options extends RequestOptions>(options?: Options): ResponseType<GetLocationMultigroupsResponse, Options>;
|
|
303
303
|
/**
|
|
304
304
|
* POST /location/multigroup - Create a new multigroup
|
|
305
305
|
*
|
|
306
306
|
* @param body
|
|
307
307
|
* @param options - additional request options
|
|
308
308
|
*/
|
|
309
|
-
post_location_multigroup(body: PostLocationMultigroupBody, options?:
|
|
309
|
+
post_location_multigroup<Options extends RequestOptions>(body: PostLocationMultigroupBody, options?: Options): ResponseType<PostLocationMultigroupResponse, Options>;
|
|
310
310
|
/**
|
|
311
311
|
* GET /location/multigroup/{id} - Get a multigroup
|
|
312
312
|
*
|
|
313
313
|
* @param id - multigroup id
|
|
314
314
|
* @param options - additional request options
|
|
315
315
|
*/
|
|
316
|
-
get_location_multigroup(id: string, options?: {
|
|
316
|
+
get_location_multigroup<Options extends RequestOptions>(id: string, options?: {
|
|
317
317
|
query?: GetLocationMultigroupQuery;
|
|
318
|
-
} &
|
|
318
|
+
} & Options): ResponseType<GetLocationMultigroupResponse, Options>;
|
|
319
319
|
/**
|
|
320
320
|
* PUT /location/multigroup/{id} - Override a complete multigroup
|
|
321
321
|
*
|
|
@@ -323,7 +323,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
323
323
|
* @param body
|
|
324
324
|
* @param options - additional request options
|
|
325
325
|
*/
|
|
326
|
-
put_location_multigroup(id: string, body: PutLocationMultigroupBody, options?:
|
|
326
|
+
put_location_multigroup<Options extends RequestOptions>(id: string, body: PutLocationMultigroupBody, options?: Options): ResponseType<PutLocationMultigroupResponse, Options>;
|
|
327
327
|
/**
|
|
328
328
|
* DELETE /location/multigroup/{id} - Delete groups from a multigroup
|
|
329
329
|
*
|
|
@@ -331,7 +331,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
331
331
|
* @param body
|
|
332
332
|
* @param options - additional request options
|
|
333
333
|
*/
|
|
334
|
-
delete_location_multigroup(id: string, body: DeleteLocationMultigroupBody, options?:
|
|
334
|
+
delete_location_multigroup<Options extends RequestOptions>(id: string, body: DeleteLocationMultigroupBody, options?: Options): ResponseType<DeleteLocationMultigroupResponse, Options>;
|
|
335
335
|
/**
|
|
336
336
|
* PATCH /location/multigroup/{id} - Update a multigroup
|
|
337
337
|
*
|
|
@@ -339,7 +339,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
339
339
|
* @param body
|
|
340
340
|
* @param options - additional request options
|
|
341
341
|
*/
|
|
342
|
-
patch_location_multigroup(id: string, body: PatchLocationMultigroupBody, options?:
|
|
342
|
+
patch_location_multigroup<Options extends RequestOptions>(id: string, body: PatchLocationMultigroupBody, options?: Options): ResponseType<PatchLocationMultigroupResponse, Options>;
|
|
343
343
|
/**
|
|
344
344
|
* GET /location/multigroup/{id}/user/{user_id} - Get all the groups in a multigroup specific to user permissions
|
|
345
345
|
*
|
|
@@ -347,25 +347,25 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
347
347
|
* @param user_id - user
|
|
348
348
|
* @param options - additional request options
|
|
349
349
|
*/
|
|
350
|
-
get_location_user_multigroup(id: string, user_id: string, options?: {
|
|
350
|
+
get_location_user_multigroup<Options extends RequestOptions>(id: string, user_id: string, options?: {
|
|
351
351
|
query?: GetLocationUserMultigroupQuery;
|
|
352
|
-
} &
|
|
352
|
+
} & Options): ResponseType<GetLocationUserMultigroupResponse, Options>;
|
|
353
353
|
/**
|
|
354
354
|
* POST /location/group - Create a new group
|
|
355
355
|
*
|
|
356
356
|
* @param body
|
|
357
357
|
* @param options - additional request options
|
|
358
358
|
*/
|
|
359
|
-
post_location_group(body: PostLocationGroupBody, options?:
|
|
359
|
+
post_location_group<Options extends RequestOptions>(body: PostLocationGroupBody, options?: Options): ResponseType<PostLocationGroupResponse, Options>;
|
|
360
360
|
/**
|
|
361
361
|
* GET /location/group/{id} - Get an individual Group based on id or latitude/longitude
|
|
362
362
|
*
|
|
363
363
|
* @param id - group id
|
|
364
364
|
* @param options - additional request options
|
|
365
365
|
*/
|
|
366
|
-
get_location_group(id: string, options?: {
|
|
366
|
+
get_location_group<Options extends RequestOptions>(id: string, options?: {
|
|
367
367
|
query?: GetLocationGroupQuery;
|
|
368
|
-
} &
|
|
368
|
+
} & Options): ResponseType<GetLocationGroupResponse, Options>;
|
|
369
369
|
/**
|
|
370
370
|
* PUT /location/group/{id} - Override a complete Group
|
|
371
371
|
*
|
|
@@ -373,7 +373,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
373
373
|
* @param body
|
|
374
374
|
* @param options - additional request options
|
|
375
375
|
*/
|
|
376
|
-
put_location_group(id: string, body: PutLocationGroupBody, options?:
|
|
376
|
+
put_location_group<Options extends RequestOptions>(id: string, body: PutLocationGroupBody, options?: Options): ResponseType<PutLocationGroupResponse, Options>;
|
|
377
377
|
/**
|
|
378
378
|
* DELETE /location/group/{id} - Delete locations from a Group
|
|
379
379
|
*
|
|
@@ -381,7 +381,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
381
381
|
* @param body
|
|
382
382
|
* @param options - additional request options
|
|
383
383
|
*/
|
|
384
|
-
delete_location_group(id: string, body: DeleteLocationGroupBody, options?:
|
|
384
|
+
delete_location_group<Options extends RequestOptions>(id: string, body: DeleteLocationGroupBody, options?: Options): ResponseType<DeleteLocationGroupResponse, Options>;
|
|
385
385
|
/**
|
|
386
386
|
* PATCH /location/group/{id} - Update a Group
|
|
387
387
|
*
|
|
@@ -389,16 +389,16 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
389
389
|
* @param body
|
|
390
390
|
* @param options - additional request options
|
|
391
391
|
*/
|
|
392
|
-
patch_location_group(id: string, body: PatchLocationGroupBody, options?:
|
|
392
|
+
patch_location_group<Options extends RequestOptions>(id: string, body: PatchLocationGroupBody, options?: Options): ResponseType<PatchLocationGroupResponse, Options>;
|
|
393
393
|
/**
|
|
394
394
|
* GET /location/group/{id}/deliverydestination - Get all delivery destinations for group
|
|
395
395
|
*
|
|
396
396
|
* @param id - Group ID
|
|
397
397
|
* @param options - additional request options
|
|
398
398
|
*/
|
|
399
|
-
get_location_group_deliverydestinations(id: string, options?: {
|
|
399
|
+
get_location_group_deliverydestinations<Options extends RequestOptions>(id: string, options?: {
|
|
400
400
|
query?: GetLocationGroupDeliverydestinationsQuery;
|
|
401
|
-
} &
|
|
401
|
+
} & Options): ResponseType<GetLocationGroupDeliverydestinationsResponse, Options>;
|
|
402
402
|
/**
|
|
403
403
|
* POST /location/group/{id}/deliverydestination - Create a new location group delivery destination
|
|
404
404
|
*
|
|
@@ -406,7 +406,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
406
406
|
* @param body
|
|
407
407
|
* @param options - additional request options
|
|
408
408
|
*/
|
|
409
|
-
post_location_group_deliverydestination(id: string, body: PostLocationGroupDeliverydestinationBody, options?:
|
|
409
|
+
post_location_group_deliverydestination<Options extends RequestOptions>(id: string, body: PostLocationGroupDeliverydestinationBody, options?: Options): ResponseType<PostLocationGroupDeliverydestinationResponse, Options>;
|
|
410
410
|
/**
|
|
411
411
|
* GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
|
|
412
412
|
*
|
|
@@ -414,7 +414,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
414
414
|
* @param delivery_destination - Delivery Destination ID
|
|
415
415
|
* @param options - additional request options
|
|
416
416
|
*/
|
|
417
|
-
get_location_group_deliverydestination(id: string, delivery_destination: string, options?:
|
|
417
|
+
get_location_group_deliverydestination<Options extends RequestOptions>(id: string, delivery_destination: string, options?: Options): ResponseType<GetLocationGroupDeliverydestinationResponse, Options>;
|
|
418
418
|
/**
|
|
419
419
|
* PATCH /location/group/{id}/deliverydestination/{delivery_destination} - Patch a delivery destination
|
|
420
420
|
*
|
|
@@ -423,7 +423,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
423
423
|
* @param body
|
|
424
424
|
* @param options - additional request options
|
|
425
425
|
*/
|
|
426
|
-
patch_location_group_deliverydestination(id: string, delivery_destination: string, body: PatchLocationGroupDeliverydestinationBody, options?:
|
|
426
|
+
patch_location_group_deliverydestination<Options extends RequestOptions>(id: string, delivery_destination: string, body: PatchLocationGroupDeliverydestinationBody, options?: Options): ResponseType<PatchLocationGroupDeliverydestinationResponse, Options>;
|
|
427
427
|
/**
|
|
428
428
|
* DELETE /location/group/{id}/deliverydestination/{delivery_destination} - Delete a delivery destination
|
|
429
429
|
*
|
|
@@ -431,7 +431,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
431
431
|
* @param delivery_destination - Delivery Destination ID
|
|
432
432
|
* @param options - additional request options
|
|
433
433
|
*/
|
|
434
|
-
delete_location_group_deliverydestination(id: string, delivery_destination: string, options?:
|
|
434
|
+
delete_location_group_deliverydestination<Options extends RequestOptions>(id: string, delivery_destination: string, options?: Options): ResponseType<DeleteLocationGroupDeliverydestinationResponse, Options>;
|
|
435
435
|
/**
|
|
436
436
|
* GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
|
|
437
437
|
*
|
|
@@ -439,22 +439,22 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
439
439
|
* @param user_id - user
|
|
440
440
|
* @param options - additional request options
|
|
441
441
|
*/
|
|
442
|
-
get_location_user_group(id: string, user_id: string, options?: {
|
|
442
|
+
get_location_user_group<Options extends RequestOptions>(id: string, user_id: string, options?: {
|
|
443
443
|
query?: GetLocationUserGroupQuery;
|
|
444
|
-
} &
|
|
444
|
+
} & Options): ResponseType<GetLocationUserGroupResponse, Options>;
|
|
445
445
|
/**
|
|
446
446
|
* GET /location/brands - Get all location brands
|
|
447
447
|
*
|
|
448
448
|
* @param options - additional request options
|
|
449
449
|
*/
|
|
450
|
-
get_location_brands(options?:
|
|
450
|
+
get_location_brands<Options extends RequestOptions>(options?: Options): ResponseType<GetLocationBrandsResponse, Options>;
|
|
451
451
|
/**
|
|
452
452
|
* GET /location/brand/{id}/deliverydestinations - Get delivery destinations for a brand
|
|
453
453
|
*
|
|
454
454
|
* @param id - Brand ID
|
|
455
455
|
* @param options - additional request options
|
|
456
456
|
*/
|
|
457
|
-
get_location_brand_destinations(id: string, options?:
|
|
457
|
+
get_location_brand_destinations<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetLocationBrandDestinationsResponse, Options>;
|
|
458
458
|
/**
|
|
459
459
|
* POST /location/brand/{id}/document - Attach document to a brand
|
|
460
460
|
*
|
|
@@ -462,55 +462,55 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
462
462
|
* @param body
|
|
463
463
|
* @param options - additional request options
|
|
464
464
|
*/
|
|
465
|
-
post_location_brand_document(id: string, body: PostLocationBrandDocumentBody, options?:
|
|
465
|
+
post_location_brand_document<Options extends RequestOptions>(id: string, body: PostLocationBrandDocumentBody, options?: Options): ResponseType<PostLocationBrandDocumentResponse, Options>;
|
|
466
466
|
/**
|
|
467
467
|
* PATCH /location/brand/{id}/document - Edit location document
|
|
468
468
|
*
|
|
469
469
|
* @param id - Brand ID
|
|
470
470
|
* @param options - additional request options
|
|
471
471
|
*/
|
|
472
|
-
patch_location_brand_document(id: string, options?:
|
|
472
|
+
patch_location_brand_document<Options extends RequestOptions>(id: string, options?: Options): ResponseType<PatchLocationBrandDocumentResponse, Options>;
|
|
473
473
|
/**
|
|
474
474
|
* DELETE /location/brand/{id}/document - Deleted brand document
|
|
475
475
|
*
|
|
476
476
|
* @param id - Brand ID
|
|
477
477
|
* @param options - additional request options
|
|
478
478
|
*/
|
|
479
|
-
delete_location_brand_document(id: string, options?:
|
|
479
|
+
delete_location_brand_document<Options extends RequestOptions>(id: string, options?: Options): ResponseType<DeleteLocationBrandDocumentResponse, Options>;
|
|
480
480
|
/**
|
|
481
481
|
* GET /location/brand/{id}/documents - Get location brand attached documents
|
|
482
482
|
*
|
|
483
483
|
* @param id - Brand ID
|
|
484
484
|
* @param options - additional request options
|
|
485
485
|
*/
|
|
486
|
-
get_location_brand_documents(id: string, options?:
|
|
486
|
+
get_location_brand_documents<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetLocationBrandDocumentsResponse, Options>;
|
|
487
487
|
/**
|
|
488
488
|
* GET /location/brand/{id}/timeslots - Get location brand timeslots
|
|
489
489
|
*
|
|
490
490
|
* @param id - Brand ID
|
|
491
491
|
* @param options - additional request options
|
|
492
492
|
*/
|
|
493
|
-
get_location_brand_timeslots(id: string, options?: {
|
|
493
|
+
get_location_brand_timeslots<Options extends RequestOptions>(id: string, options?: {
|
|
494
494
|
query?: GetLocationBrandTimeslotsQuery;
|
|
495
|
-
} &
|
|
495
|
+
} & Options): ResponseType<GetLocationBrandTimeslotsResponse, Options>;
|
|
496
496
|
/**
|
|
497
497
|
* POST /location/marketplace/timeslots - Get Market Place timeslots
|
|
498
498
|
*
|
|
499
499
|
* @param body
|
|
500
500
|
* @param options - additional request options
|
|
501
501
|
*/
|
|
502
|
-
post_location_marketplace_timeslots(body: PostLocationMarketplaceTimeslotsBody, options?: {
|
|
502
|
+
post_location_marketplace_timeslots<Options extends RequestOptions>(body: PostLocationMarketplaceTimeslotsBody, options?: {
|
|
503
503
|
query?: PostLocationMarketplaceTimeslotsQuery;
|
|
504
|
-
} &
|
|
504
|
+
} & Options): ResponseType<PostLocationMarketplaceTimeslotsResponse, Options>;
|
|
505
505
|
/**
|
|
506
506
|
* POST /location/marketplace/timeslots/delivery - Get Marketplace delivery timeslots
|
|
507
507
|
*
|
|
508
508
|
* @param body
|
|
509
509
|
* @param options - additional request options
|
|
510
510
|
*/
|
|
511
|
-
post_location_marketplace_timeslots_delivery(body: PostLocationMarketplaceTimeslotsDeliveryBody, options?: {
|
|
511
|
+
post_location_marketplace_timeslots_delivery<Options extends RequestOptions>(body: PostLocationMarketplaceTimeslotsDeliveryBody, options?: {
|
|
512
512
|
query?: PostLocationMarketplaceTimeslotsDeliveryQuery;
|
|
513
|
-
} &
|
|
513
|
+
} & Options): ResponseType<PostLocationMarketplaceTimeslotsDeliveryResponse, Options>;
|
|
514
514
|
/**
|
|
515
515
|
* GET /location/brand/{id}/timeslots/menu/{menu} - Get location brand timeslots for menu
|
|
516
516
|
*
|
|
@@ -518,18 +518,18 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
518
518
|
* @param menu - Menu ID
|
|
519
519
|
* @param options - additional request options
|
|
520
520
|
*/
|
|
521
|
-
get_location_brand_menu_timeslots(id: string, menu: string, options?: {
|
|
521
|
+
get_location_brand_menu_timeslots<Options extends RequestOptions>(id: string, menu: string, options?: {
|
|
522
522
|
query?: GetLocationBrandMenuTimeslotsQuery;
|
|
523
|
-
} &
|
|
523
|
+
} & Options): ResponseType<GetLocationBrandMenuTimeslotsResponse, Options>;
|
|
524
524
|
/**
|
|
525
525
|
* GET /location/brand/{id}/timeslots/delivery - Get location brand delivery timeslots
|
|
526
526
|
*
|
|
527
527
|
* @param id - Brand ID
|
|
528
528
|
* @param options - additional request options
|
|
529
529
|
*/
|
|
530
|
-
get_location_brand_delivery_timeslots(id: string, options?: {
|
|
530
|
+
get_location_brand_delivery_timeslots<Options extends RequestOptions>(id: string, options?: {
|
|
531
531
|
query?: GetLocationBrandDeliveryTimeslotsQuery;
|
|
532
|
-
} &
|
|
532
|
+
} & Options): ResponseType<GetLocationBrandDeliveryTimeslotsResponse, Options>;
|
|
533
533
|
/**
|
|
534
534
|
* GET /location/brand/{id}/timeslots/delivery/menu/{menu} - Get location brand delivery timeslots for menu
|
|
535
535
|
*
|
|
@@ -537,25 +537,25 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
537
537
|
* @param menu - Menu ID
|
|
538
538
|
* @param options - additional request options
|
|
539
539
|
*/
|
|
540
|
-
get_location_brand_menu_delivery_timeslosts(id: string, menu: string, options?: {
|
|
540
|
+
get_location_brand_menu_delivery_timeslosts<Options extends RequestOptions>(id: string, menu: string, options?: {
|
|
541
541
|
query?: GetLocationBrandMenuDeliveryTimeslostsQuery;
|
|
542
|
-
} &
|
|
542
|
+
} & Options): ResponseType<GetLocationBrandMenuDeliveryTimeslostsResponse, Options>;
|
|
543
543
|
/**
|
|
544
544
|
* POST /location/brand - Create a new Brand
|
|
545
545
|
*
|
|
546
546
|
* @param body
|
|
547
547
|
* @param options - additional request options
|
|
548
548
|
*/
|
|
549
|
-
post_location_brand(body: PostLocationBrandBody, options?:
|
|
549
|
+
post_location_brand<Options extends RequestOptions>(body: PostLocationBrandBody, options?: Options): ResponseType<PostLocationBrandResponse, Options>;
|
|
550
550
|
/**
|
|
551
551
|
* GET /location/brand/{id} - Get location brand
|
|
552
552
|
*
|
|
553
553
|
* @param id - Brand ID
|
|
554
554
|
* @param options - additional request options
|
|
555
555
|
*/
|
|
556
|
-
get_location_brand(id: string, options?: {
|
|
556
|
+
get_location_brand<Options extends RequestOptions>(id: string, options?: {
|
|
557
557
|
query?: GetLocationBrandQuery;
|
|
558
|
-
} &
|
|
558
|
+
} & Options): ResponseType<GetLocationBrandResponse, Options>;
|
|
559
559
|
/**
|
|
560
560
|
* PATCH /location/brand/{id} - Update location brand
|
|
561
561
|
*
|
|
@@ -563,7 +563,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
563
563
|
* @param body
|
|
564
564
|
* @param options - additional request options
|
|
565
565
|
*/
|
|
566
|
-
patch_location_brand(id: string, body: PatchLocationBrandBody, options?:
|
|
566
|
+
patch_location_brand<Options extends RequestOptions>(id: string, body: PatchLocationBrandBody, options?: Options): ResponseType<PatchLocationBrandResponse, Options>;
|
|
567
567
|
/**
|
|
568
568
|
* DELETE /location/brand/{id} - Delete data from a Brand
|
|
569
569
|
*
|
|
@@ -571,7 +571,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
571
571
|
* @param body
|
|
572
572
|
* @param options - additional request options
|
|
573
573
|
*/
|
|
574
|
-
delete_location_brand(id: string, body: DeleteLocationBrandBody, options?:
|
|
574
|
+
delete_location_brand<Options extends RequestOptions>(id: string, body: DeleteLocationBrandBody, options?: Options): ResponseType<DeleteLocationBrandResponse, Options>;
|
|
575
575
|
/**
|
|
576
576
|
* PUT /location/brand/{id} - Update location brand
|
|
577
577
|
*
|
|
@@ -579,29 +579,29 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
579
579
|
* @param body
|
|
580
580
|
* @param options - additional request options
|
|
581
581
|
*/
|
|
582
|
-
put_location_brand(id: string, body: PutLocationBrandBody, options?:
|
|
582
|
+
put_location_brand<Options extends RequestOptions>(id: string, body: PutLocationBrandBody, options?: Options): ResponseType<PutLocationBrandResponse, Options>;
|
|
583
583
|
/**
|
|
584
584
|
* GET /location/sector - Get list of all the sectors
|
|
585
585
|
*
|
|
586
586
|
* @param options - additional request options
|
|
587
587
|
*/
|
|
588
|
-
get_location_sectors(options?:
|
|
588
|
+
get_location_sectors<Options extends RequestOptions>(options?: Options): ResponseType<GetLocationSectorsResponse, Options>;
|
|
589
589
|
/**
|
|
590
590
|
* POST /location/sector - Create a new sector
|
|
591
591
|
*
|
|
592
592
|
* @param body
|
|
593
593
|
* @param options - additional request options
|
|
594
594
|
*/
|
|
595
|
-
post_location_sector(body: PostLocationSectorBody, options?:
|
|
595
|
+
post_location_sector<Options extends RequestOptions>(body: PostLocationSectorBody, options?: Options): ResponseType<PostLocationSectorResponse, Options>;
|
|
596
596
|
/**
|
|
597
597
|
* GET /location/sector/{id} - Get a sector
|
|
598
598
|
*
|
|
599
599
|
* @param id - sector
|
|
600
600
|
* @param options - additional request options
|
|
601
601
|
*/
|
|
602
|
-
get_location_sector(id: string, options?: {
|
|
602
|
+
get_location_sector<Options extends RequestOptions>(id: string, options?: {
|
|
603
603
|
query?: GetLocationSectorQuery;
|
|
604
|
-
} &
|
|
604
|
+
} & Options): ResponseType<GetLocationSectorResponse, Options>;
|
|
605
605
|
/**
|
|
606
606
|
* PATCH /location/sector/{id} - Update a sector
|
|
607
607
|
*
|
|
@@ -609,25 +609,25 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
609
609
|
* @param body
|
|
610
610
|
* @param options - additional request options
|
|
611
611
|
*/
|
|
612
|
-
patch_location_sector(id: string, body: PatchLocationSectorBody, options?: {
|
|
612
|
+
patch_location_sector<Options extends RequestOptions>(id: string, body: PatchLocationSectorBody, options?: {
|
|
613
613
|
query?: PatchLocationSectorQuery;
|
|
614
|
-
} &
|
|
614
|
+
} & Options): ResponseType<PatchLocationSectorResponse, Options>;
|
|
615
615
|
/**
|
|
616
616
|
* POST /location/company - Create a new company
|
|
617
617
|
*
|
|
618
618
|
* @param body
|
|
619
619
|
* @param options - additional request options
|
|
620
620
|
*/
|
|
621
|
-
post_location_company(body: PostLocationCompanyBody, options?:
|
|
621
|
+
post_location_company<Options extends RequestOptions>(body: PostLocationCompanyBody, options?: Options): ResponseType<PostLocationCompanyResponse, Options>;
|
|
622
622
|
/**
|
|
623
623
|
* GET /location/company/{id} - Get a company within sector
|
|
624
624
|
*
|
|
625
625
|
* @param id - Company ID
|
|
626
626
|
* @param options - additional request options
|
|
627
627
|
*/
|
|
628
|
-
get_location_company(id: string, options?: {
|
|
628
|
+
get_location_company<Options extends RequestOptions>(id: string, options?: {
|
|
629
629
|
query?: GetLocationCompanyQuery;
|
|
630
|
-
} &
|
|
630
|
+
} & Options): ResponseType<GetLocationCompanyResponse, Options>;
|
|
631
631
|
/**
|
|
632
632
|
* PATCH /location/company/{id} - Update a company
|
|
633
633
|
*
|
|
@@ -635,14 +635,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
635
635
|
* @param body
|
|
636
636
|
* @param options - additional request options
|
|
637
637
|
*/
|
|
638
|
-
patch_location_company(id: string, body: PatchLocationCompanyBody, options?:
|
|
638
|
+
patch_location_company<Options extends RequestOptions>(id: string, body: PatchLocationCompanyBody, options?: Options): ResponseType<PatchLocationCompanyResponse, Options>;
|
|
639
639
|
/**
|
|
640
640
|
* POST /shoppingcart/ - Create a new ShoppingCart
|
|
641
641
|
*
|
|
642
642
|
* @param body
|
|
643
643
|
* @param options - additional request options
|
|
644
644
|
*/
|
|
645
|
-
post_shoppingcart_cart(body: PostShoppingcartCartBody, options?:
|
|
645
|
+
post_shoppingcart_cart<Options extends RequestOptions>(body: PostShoppingcartCartBody, options?: Options): ResponseType<PostShoppingcartCartResponse, Options>;
|
|
646
646
|
/**
|
|
647
647
|
* PUT /shoppingcart/{id} - Put a menu item into a ShoppingCart
|
|
648
648
|
*
|
|
@@ -650,7 +650,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
650
650
|
* @param body
|
|
651
651
|
* @param options - additional request options
|
|
652
652
|
*/
|
|
653
|
-
put_shoppingcart_cart_items(id: string, body: PutShoppingcartCartItemsBody, options?:
|
|
653
|
+
put_shoppingcart_cart_items<Options extends RequestOptions>(id: string, body: PutShoppingcartCartItemsBody, options?: Options): ResponseType<PutShoppingcartCartItemsResponse, Options>;
|
|
654
654
|
/**
|
|
655
655
|
* DELETE /shoppingcart/{id} - Delete a menu item from a ShoppingCart
|
|
656
656
|
*
|
|
@@ -658,21 +658,21 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
658
658
|
* @param body
|
|
659
659
|
* @param options - additional request options
|
|
660
660
|
*/
|
|
661
|
-
delete_shoppingcart_cart_items(id: string, body: DeleteShoppingcartCartItemsBody, options?:
|
|
661
|
+
delete_shoppingcart_cart_items<Options extends RequestOptions>(id: string, body: DeleteShoppingcartCartItemsBody, options?: Options): ResponseType<DeleteShoppingcartCartItemsResponse, Options>;
|
|
662
662
|
/**
|
|
663
663
|
* GET /shoppingcart/{id} - Get an individual ShoppingCart
|
|
664
664
|
*
|
|
665
665
|
* @param id - Shopping cart ID
|
|
666
666
|
* @param options - additional request options
|
|
667
667
|
*/
|
|
668
|
-
get_shoppingcart_cart(id: string, options?:
|
|
668
|
+
get_shoppingcart_cart<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetShoppingcartCartResponse, Options>;
|
|
669
669
|
/**
|
|
670
670
|
* PATCH /shoppingcart/{id} - Update a ShoppingCart
|
|
671
671
|
*
|
|
672
672
|
* @param id - Shopping cart ID
|
|
673
673
|
* @param options - additional request options
|
|
674
674
|
*/
|
|
675
|
-
patch_shoppingcart_cart(id: string, options?:
|
|
675
|
+
patch_shoppingcart_cart<Options extends RequestOptions>(id: string, options?: Options): ResponseType<PatchShoppingcartCartResponse, Options>;
|
|
676
676
|
/**
|
|
677
677
|
* PUT /shoppingcart/{id}/promo - Put a promo in a ShoppingCart
|
|
678
678
|
*
|
|
@@ -680,14 +680,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
680
680
|
* @param body
|
|
681
681
|
* @param options - additional request options
|
|
682
682
|
*/
|
|
683
|
-
put_shoppingcart_cart_promo(id: string, body: PutShoppingcartCartPromoBody, options?:
|
|
683
|
+
put_shoppingcart_cart_promo<Options extends RequestOptions>(id: string, body: PutShoppingcartCartPromoBody, options?: Options): ResponseType<PutShoppingcartCartPromoResponse, Options>;
|
|
684
684
|
/**
|
|
685
685
|
* DELETE /shoppingcart/{id}/promo - Delete the promo in a ShoppingCart
|
|
686
686
|
*
|
|
687
687
|
* @param id - Shopping cart ID
|
|
688
688
|
* @param options - additional request options
|
|
689
689
|
*/
|
|
690
|
-
delete_shoppingcart_cart_promo(id: string, options?:
|
|
690
|
+
delete_shoppingcart_cart_promo<Options extends RequestOptions>(id: string, options?: Options): ResponseType<DeleteShoppingcartCartPromoResponse, Options>;
|
|
691
691
|
/**
|
|
692
692
|
* PUT /shoppingcart/{id}/paymentmethod/ - Change payment method used in shopping cart
|
|
693
693
|
*
|
|
@@ -695,7 +695,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
695
695
|
* @param body
|
|
696
696
|
* @param options - additional request options
|
|
697
697
|
*/
|
|
698
|
-
put_shoppingcart_cart_payment(id: string, body: PutShoppingcartCartPaymentBody, options?:
|
|
698
|
+
put_shoppingcart_cart_payment<Options extends RequestOptions>(id: string, body: PutShoppingcartCartPaymentBody, options?: Options): ResponseType<PutShoppingcartCartPaymentResponse, Options>;
|
|
699
699
|
/**
|
|
700
700
|
* PUT /shoppingcart/{id}/order/ - Store information about the order created with this shopping cart
|
|
701
701
|
*
|
|
@@ -703,7 +703,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
703
703
|
* @param body
|
|
704
704
|
* @param options - additional request options
|
|
705
705
|
*/
|
|
706
|
-
put_shoppingcart_cart_order(id: string, body: PutShoppingcartCartOrderBody, options?:
|
|
706
|
+
put_shoppingcart_cart_order<Options extends RequestOptions>(id: string, body: PutShoppingcartCartOrderBody, options?: Options): ResponseType<PutShoppingcartCartOrderResponse, Options>;
|
|
707
707
|
/**
|
|
708
708
|
* PUT /shoppingcart/{id}/loyalty/{user_id} - Apply a loyalty coupon in a ShoppingCart
|
|
709
709
|
*
|
|
@@ -712,7 +712,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
712
712
|
* @param body
|
|
713
713
|
* @param options - additional request options
|
|
714
714
|
*/
|
|
715
|
-
put_shoppingcart_cart_loyalty(id: string, user_id: string, body: PutShoppingcartCartLoyaltyBody, options?:
|
|
715
|
+
put_shoppingcart_cart_loyalty<Options extends RequestOptions>(id: string, user_id: string, body: PutShoppingcartCartLoyaltyBody, options?: Options): ResponseType<PutShoppingcartCartLoyaltyResponse, Options>;
|
|
716
716
|
/**
|
|
717
717
|
* DELETE /shoppingcart/{id}/loyalty/{user_id} - Delete loyalty coupon in shoppingCart
|
|
718
718
|
*
|
|
@@ -720,7 +720,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
720
720
|
* @param user_id - User ID
|
|
721
721
|
* @param options - additional request options
|
|
722
722
|
*/
|
|
723
|
-
delete_shoppingcart_cart_loyalty(id: string, user_id: string, options?:
|
|
723
|
+
delete_shoppingcart_cart_loyalty<Options extends RequestOptions>(id: string, user_id: string, options?: Options): ResponseType<DeleteShoppingcartCartLoyaltyResponse, Options>;
|
|
724
724
|
/**
|
|
725
725
|
* POST /shoppingcart/{id}/clone - Create a shopping cart from existing shopping cart
|
|
726
726
|
*
|
|
@@ -728,60 +728,60 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
728
728
|
* @param body
|
|
729
729
|
* @param options - additional request options
|
|
730
730
|
*/
|
|
731
|
-
post_shoppingcart_clone_cart(id: string, body: PostShoppingcartCloneCartBody, options?:
|
|
731
|
+
post_shoppingcart_clone_cart<Options extends RequestOptions>(id: string, body: PostShoppingcartCloneCartBody, options?: Options): ResponseType<PostShoppingcartCloneCartResponse, Options>;
|
|
732
732
|
/**
|
|
733
733
|
* POST /shoppingcart/bulk - Get multiple ShoppingCarts
|
|
734
734
|
*
|
|
735
735
|
* @param body
|
|
736
736
|
* @param options - additional request options
|
|
737
737
|
*/
|
|
738
|
-
post_shoppingcart_bulk(body: PostShoppingcartBulkBody, options?:
|
|
738
|
+
post_shoppingcart_bulk<Options extends RequestOptions>(body: PostShoppingcartBulkBody, options?: Options): ResponseType<PostShoppingcartBulkResponse, Options>;
|
|
739
739
|
/**
|
|
740
740
|
* POST /partner/standardcognition/shoppingcart - Calculates a shoppingcart
|
|
741
741
|
*
|
|
742
742
|
* @param body
|
|
743
743
|
* @param options - additional request options
|
|
744
744
|
*/
|
|
745
|
-
post_partner_standardcognition_shoppingcart(body: PostPartnerStandardcognitionShoppingcartBody, options?:
|
|
745
|
+
post_partner_standardcognition_shoppingcart<Options extends RequestOptions>(body: PostPartnerStandardcognitionShoppingcartBody, options?: Options): ResponseType<PostPartnerStandardcognitionShoppingcartResponse, Options>;
|
|
746
746
|
/**
|
|
747
747
|
* GET /partner/standardcognition/locations - Gets the locations where Standard Cognition is available
|
|
748
748
|
*
|
|
749
749
|
* @param options - additional request options
|
|
750
750
|
*/
|
|
751
|
-
get_partner_standardcognition_locations(options?:
|
|
751
|
+
get_partner_standardcognition_locations<Options extends RequestOptions>(options?: Options): ResponseType<GetPartnerStandardcognitionLocationsResponse, Options>;
|
|
752
752
|
/**
|
|
753
753
|
* GET /partner/coolr/locations - Gets the locations where Coolr is available
|
|
754
754
|
*
|
|
755
755
|
* @param options - additional request options
|
|
756
756
|
*/
|
|
757
|
-
get_partner_coolr_locations(options?:
|
|
757
|
+
get_partner_coolr_locations<Options extends RequestOptions>(options?: Options): ResponseType<GetPartnerCoolrLocationsResponse, Options>;
|
|
758
758
|
/**
|
|
759
759
|
* GET /partner/coolr/{id}/images - Gets the latest images for Coolr Location AssetID
|
|
760
760
|
*
|
|
761
761
|
* @param id - location
|
|
762
762
|
* @param options - additional request options
|
|
763
763
|
*/
|
|
764
|
-
get_partner_coolr_images(id: string, options?:
|
|
764
|
+
get_partner_coolr_images<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetPartnerCoolrImagesResponse, Options>;
|
|
765
765
|
/**
|
|
766
766
|
* GET /partner/swagger.json
|
|
767
767
|
*
|
|
768
768
|
* @param options - additional request options
|
|
769
769
|
*/
|
|
770
|
-
get_partner_swagger(options?:
|
|
770
|
+
get_partner_swagger<Options extends RequestOptions>(options?: Options): ResponseType<GetPartnerSwaggerResponse, Options>;
|
|
771
771
|
/**
|
|
772
772
|
* POST /task/ - Create new Task
|
|
773
773
|
*
|
|
774
774
|
* @param body - Task Information
|
|
775
775
|
* @param options - additional request options
|
|
776
776
|
*/
|
|
777
|
-
post_task(body: PostTaskBody, options?:
|
|
777
|
+
post_task<Options extends RequestOptions>(body: PostTaskBody, options?: Options): ResponseType<PostTaskResponse, Options>;
|
|
778
778
|
/**
|
|
779
779
|
* GET /task/{id} - Get task based on passed ID
|
|
780
780
|
*
|
|
781
781
|
* @param id - Task ID
|
|
782
782
|
* @param options - additional request options
|
|
783
783
|
*/
|
|
784
|
-
get_task(id: string, options?:
|
|
784
|
+
get_task<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetTaskResponse, Options>;
|
|
785
785
|
/**
|
|
786
786
|
* PATCH /task/{id} - Update Task
|
|
787
787
|
*
|
|
@@ -789,28 +789,28 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
789
789
|
* @param body - Task Information
|
|
790
790
|
* @param options - additional request options
|
|
791
791
|
*/
|
|
792
|
-
patch_task(id: string, body: PatchTaskBody, options?:
|
|
792
|
+
patch_task<Options extends RequestOptions>(id: string, body: PatchTaskBody, options?: Options): ResponseType<PatchTaskResponse, Options>;
|
|
793
793
|
/**
|
|
794
794
|
* DELETE /task/{id} - Delete Task
|
|
795
795
|
*
|
|
796
796
|
* @param id - Task ID
|
|
797
797
|
* @param options - additional request options
|
|
798
798
|
*/
|
|
799
|
-
delete_task(id: string, options?:
|
|
799
|
+
delete_task<Options extends RequestOptions>(id: string, options?: Options): ResponseType<DeleteTaskResponse, Options>;
|
|
800
800
|
/**
|
|
801
801
|
* GET /task/order/{id} - Get task based on passed order ID
|
|
802
802
|
*
|
|
803
803
|
* @param id - Order ID
|
|
804
804
|
* @param options - additional request options
|
|
805
805
|
*/
|
|
806
|
-
get_task_order(id: string, options?:
|
|
806
|
+
get_task_order<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetTaskOrderResponse, Options>;
|
|
807
807
|
/**
|
|
808
808
|
* GET /task/order/{id}/kds - Get KDS tasks based on passed order ID
|
|
809
809
|
*
|
|
810
810
|
* @param id - Order ID
|
|
811
811
|
* @param options - additional request options
|
|
812
812
|
*/
|
|
813
|
-
get_task_order_kds(id: string, options?:
|
|
813
|
+
get_task_order_kds<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetTaskOrderKdsResponse, Options>;
|
|
814
814
|
/**
|
|
815
815
|
* PATCH /task/order/{id}/kds - Update an order and its associated tasks
|
|
816
816
|
*
|
|
@@ -818,62 +818,62 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
818
818
|
* @param body - Order information that you wish to update
|
|
819
819
|
* @param options - additional request options
|
|
820
820
|
*/
|
|
821
|
-
patch_task_order_kds(id: string, body: PatchTaskOrderKdsBody, options?:
|
|
821
|
+
patch_task_order_kds<Options extends RequestOptions>(id: string, body: PatchTaskOrderKdsBody, options?: Options): ResponseType<PatchTaskOrderKdsResponse, Options>;
|
|
822
822
|
/**
|
|
823
823
|
* GET /task/assignee/{id} - Get Assignee tasks
|
|
824
824
|
*
|
|
825
825
|
* @param id - Assignee ID
|
|
826
826
|
* @param options - additional request options
|
|
827
827
|
*/
|
|
828
|
-
get_task_assignee(id: string, options?: {
|
|
828
|
+
get_task_assignee<Options extends RequestOptions>(id: string, options?: {
|
|
829
829
|
query?: GetTaskAssigneeQuery;
|
|
830
|
-
} &
|
|
830
|
+
} & Options): ResponseType<GetTaskAssigneeResponse, Options>;
|
|
831
831
|
/**
|
|
832
832
|
* GET /task/location/brand/{id} - Get location brand tasks
|
|
833
833
|
*
|
|
834
834
|
* @param id - location brand ID
|
|
835
835
|
* @param options - additional request options
|
|
836
836
|
*/
|
|
837
|
-
get_task_location_brand(id: string, options?: {
|
|
837
|
+
get_task_location_brand<Options extends RequestOptions>(id: string, options?: {
|
|
838
838
|
query?: GetTaskLocationBrandQuery;
|
|
839
|
-
} &
|
|
839
|
+
} & Options): ResponseType<GetTaskLocationBrandResponse, Options>;
|
|
840
840
|
/**
|
|
841
841
|
* GET /task/location/group/{id} - Get location group tasks
|
|
842
842
|
*
|
|
843
843
|
* @param id - Location group ID
|
|
844
844
|
* @param options - additional request options
|
|
845
845
|
*/
|
|
846
|
-
get_task_location_group(id: string, options?: {
|
|
846
|
+
get_task_location_group<Options extends RequestOptions>(id: string, options?: {
|
|
847
847
|
query?: GetTaskLocationGroupQuery;
|
|
848
|
-
} &
|
|
848
|
+
} & Options): ResponseType<GetTaskLocationGroupResponse, Options>;
|
|
849
849
|
/**
|
|
850
850
|
* GET /kds/devices - Get kds devices for a specified unit number
|
|
851
851
|
*
|
|
852
852
|
* @param options - additional request options
|
|
853
853
|
*/
|
|
854
|
-
get_kds_devices(options: {
|
|
854
|
+
get_kds_devices<Options extends RequestOptions>(options: {
|
|
855
855
|
query: GetKdsDevicesQuery;
|
|
856
|
-
} &
|
|
856
|
+
} & Options): ResponseType<GetKdsDevicesResponse, Options>;
|
|
857
857
|
/**
|
|
858
858
|
* POST /kds/device/auth - Get auth token for a device
|
|
859
859
|
*
|
|
860
860
|
* @param body - AuthPostBody object
|
|
861
861
|
* @param options - additional request options
|
|
862
862
|
*/
|
|
863
|
-
post_kds_device_auth(body: PostKdsDeviceAuthBody, options?:
|
|
863
|
+
post_kds_device_auth<Options extends RequestOptions>(body: PostKdsDeviceAuthBody, options?: Options): ResponseType<PostKdsDeviceAuthResponse, Options>;
|
|
864
864
|
/**
|
|
865
865
|
* DELETE /kds/device/auth/{device_id} - Delete authorization for specified serial_number
|
|
866
866
|
*
|
|
867
867
|
* @param device_id - serial number encoded as cdl id
|
|
868
868
|
* @param options - additional request options
|
|
869
869
|
*/
|
|
870
|
-
delete_kds_device_auth(device_id: string, options?:
|
|
870
|
+
delete_kds_device_auth<Options extends RequestOptions>(device_id: string, options?: Options): ResponseType<DeleteKdsDeviceAuthResponse, Options>;
|
|
871
871
|
/**
|
|
872
872
|
* GET /kds/swagger.json - Get a swagger for kds service
|
|
873
873
|
*
|
|
874
874
|
* @param options - additional request options
|
|
875
875
|
*/
|
|
876
|
-
get_kds_swagger(options?:
|
|
876
|
+
get_kds_swagger<Options extends RequestOptions>(options?: Options): ResponseType<GetKdsSwaggerResponse, Options>;
|
|
877
877
|
/**
|
|
878
878
|
* POST /mealplan/{id} - Authenticate against the meal plan provider
|
|
879
879
|
*
|
|
@@ -881,7 +881,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
881
881
|
* @param body - User credentials
|
|
882
882
|
* @param options - additional request options
|
|
883
883
|
*/
|
|
884
|
-
post_mealplan(id: string, body: PostMealplanBody, options?:
|
|
884
|
+
post_mealplan<Options extends RequestOptions>(id: string, body: PostMealplanBody, options?: Options): ResponseType<PostMealplanResponse, Options>;
|
|
885
885
|
/**
|
|
886
886
|
* PUT /mealplan/{id} - Save a token for access to the meal plan
|
|
887
887
|
*
|
|
@@ -889,14 +889,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
889
889
|
* @param body
|
|
890
890
|
* @param options - additional request options
|
|
891
891
|
*/
|
|
892
|
-
put_mealplan(id: string, body: PutMealplanBody, options?:
|
|
892
|
+
put_mealplan<Options extends RequestOptions>(id: string, body: PutMealplanBody, options?: Options): ResponseType<PutMealplanResponse, Options>;
|
|
893
893
|
/**
|
|
894
894
|
* GET /mealplan/{id} - Check the user's meal plan tenders and get the authentication configuration
|
|
895
895
|
*
|
|
896
896
|
* @param id - Meal plan ID
|
|
897
897
|
* @param options - additional request options
|
|
898
898
|
*/
|
|
899
|
-
get_mealplan(id: string, options?:
|
|
899
|
+
get_mealplan<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetMealplanResponse, Options>;
|
|
900
900
|
/**
|
|
901
901
|
* DELETE /mealplan/{id} - Delete a mealplan or a tender from the user's account
|
|
902
902
|
*
|
|
@@ -904,14 +904,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
904
904
|
* @param body - Tenders to be deleted. If not passed, it will delete all the tenders for this user
|
|
905
905
|
* @param options - additional request options
|
|
906
906
|
*/
|
|
907
|
-
delete_mealplan(id: string, body: DeleteMealplanBody, options?:
|
|
907
|
+
delete_mealplan<Options extends RequestOptions>(id: string, body: DeleteMealplanBody, options?: Options): ResponseType<DeleteMealplanResponse, Options>;
|
|
908
908
|
/**
|
|
909
909
|
* POST /mealplan/{id}/callback - Callback endpoint for meal plans that make a call back from a webview workflow
|
|
910
910
|
*
|
|
911
911
|
* @param id - Meal plan ID
|
|
912
912
|
* @param options - additional request options
|
|
913
913
|
*/
|
|
914
|
-
post_mealplan_callback(id: string, options?:
|
|
914
|
+
post_mealplan_callback<Options extends RequestOptions>(id: string, options?: Options): ResponseType<PostMealplanCallbackResponse, Options>;
|
|
915
915
|
/**
|
|
916
916
|
* GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
|
|
917
917
|
*
|
|
@@ -919,7 +919,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
919
919
|
* @param tender - Tender ID
|
|
920
920
|
* @param options - additional request options
|
|
921
921
|
*/
|
|
922
|
-
get_mealplan_tender(id: string, tender: string, options?:
|
|
922
|
+
get_mealplan_tender<Options extends RequestOptions>(id: string, tender: string, options?: Options): ResponseType<GetMealplanTenderResponse, Options>;
|
|
923
923
|
/**
|
|
924
924
|
* DELETE /mealplan/{id}/tender/{tender} - Debit an amount from the tender balance
|
|
925
925
|
*
|
|
@@ -927,7 +927,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
927
927
|
* @param tender - Tender ID
|
|
928
928
|
* @param options - additional request options
|
|
929
929
|
*/
|
|
930
|
-
delete_mealplan_tender(id: string, tender: string, options?:
|
|
930
|
+
delete_mealplan_tender<Options extends RequestOptions>(id: string, tender: string, options?: Options): ResponseType<DeleteMealplanTenderResponse, Options>;
|
|
931
931
|
/**
|
|
932
932
|
* PATCH /mealplan/{id}/tender/{tender} - Refund an amount to the tender balance
|
|
933
933
|
*
|
|
@@ -936,7 +936,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
936
936
|
* @param body
|
|
937
937
|
* @param options - additional request options
|
|
938
938
|
*/
|
|
939
|
-
patch_mealplan_tender(id: string, tender: string, body: PatchMealplanTenderBody, options?:
|
|
939
|
+
patch_mealplan_tender<Options extends RequestOptions>(id: string, tender: string, body: PatchMealplanTenderBody, options?: Options): ResponseType<PatchMealplanTenderResponse, Options>;
|
|
940
940
|
/**
|
|
941
941
|
* POST /mealplan/{id}/verify - Send verification email to user linking a mealplan
|
|
942
942
|
*
|
|
@@ -944,9 +944,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
944
944
|
* @param body - Verification Email Parameters
|
|
945
945
|
* @param options - additional request options
|
|
946
946
|
*/
|
|
947
|
-
post_mealplan_verify(id: string, body: PostMealplanVerifyBody, options?: {
|
|
947
|
+
post_mealplan_verify<Options extends RequestOptions>(id: string, body: PostMealplanVerifyBody, options?: {
|
|
948
948
|
query?: PostMealplanVerifyQuery;
|
|
949
|
-
} &
|
|
949
|
+
} & Options): ResponseType<PostMealplanVerifyResponse, Options>;
|
|
950
950
|
/**
|
|
951
951
|
* PUT /mealplan/{id}/verify - Verify email address using provided payload
|
|
952
952
|
*
|
|
@@ -954,7 +954,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
954
954
|
* @param body - Verify Email Parameters
|
|
955
955
|
* @param options - additional request options
|
|
956
956
|
*/
|
|
957
|
-
put_mealplan_verify(id: string, body: PutMealplanVerifyBody, options?:
|
|
957
|
+
put_mealplan_verify<Options extends RequestOptions>(id: string, body: PutMealplanVerifyBody, options?: Options): ResponseType<PutMealplanVerifyResponse, Options>;
|
|
958
958
|
/**
|
|
959
959
|
* POST /mealplan/{id}/authorize - Authorize Transaction
|
|
960
960
|
*
|
|
@@ -962,44 +962,44 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
962
962
|
* @param body
|
|
963
963
|
* @param options - additional request options
|
|
964
964
|
*/
|
|
965
|
-
post_mealplan_authorize(id: string, body: PostMealplanAuthorizeBody, options?:
|
|
965
|
+
post_mealplan_authorize<Options extends RequestOptions>(id: string, body: PostMealplanAuthorizeBody, options?: Options): ResponseType<PostMealplanAuthorizeResponse, Options>;
|
|
966
966
|
/**
|
|
967
967
|
* POST /datalake/sql - Query datalake for data
|
|
968
968
|
*
|
|
969
969
|
* @param body
|
|
970
970
|
* @param options - additional request options
|
|
971
971
|
*/
|
|
972
|
-
post_datalake_sql(body: PostDatalakeSqlBody, options?:
|
|
972
|
+
post_datalake_sql<Options extends RequestOptions>(body: PostDatalakeSqlBody, options?: Options): ResponseType<PostDatalakeSqlResponse, Options>;
|
|
973
973
|
/**
|
|
974
974
|
* GET /swagger.json
|
|
975
975
|
*
|
|
976
976
|
* @param options - additional request options
|
|
977
977
|
*/
|
|
978
|
-
get_swagger(options?:
|
|
978
|
+
get_swagger<Options extends RequestOptions>(options?: Options): ResponseType<GetSwaggerResponse, Options>;
|
|
979
979
|
/**
|
|
980
980
|
* POST /promo - Create a new promotion
|
|
981
981
|
*
|
|
982
982
|
* @param body
|
|
983
983
|
* @param options - additional request options
|
|
984
984
|
*/
|
|
985
|
-
post_promo(body: PostPromoBody, options?:
|
|
985
|
+
post_promo<Options extends RequestOptions>(body: PostPromoBody, options?: Options): ResponseType<PostPromoResponse, Options>;
|
|
986
986
|
/**
|
|
987
987
|
* GET /promo - Get all promotions
|
|
988
988
|
*
|
|
989
989
|
* @param options - additional request options
|
|
990
990
|
*/
|
|
991
|
-
get_promos(options?: {
|
|
991
|
+
get_promos<Options extends RequestOptions>(options?: {
|
|
992
992
|
query?: GetPromosQuery;
|
|
993
|
-
} &
|
|
993
|
+
} & Options): ResponseType<GetPromosResponse, Options>;
|
|
994
994
|
/**
|
|
995
995
|
* GET /promo/{id} - Get an individual promotion
|
|
996
996
|
*
|
|
997
997
|
* @param id - promo
|
|
998
998
|
* @param options - additional request options
|
|
999
999
|
*/
|
|
1000
|
-
get_promo(id: string, options?: {
|
|
1000
|
+
get_promo<Options extends RequestOptions>(id: string, options?: {
|
|
1001
1001
|
query?: GetPromoQuery;
|
|
1002
|
-
} &
|
|
1002
|
+
} & Options): ResponseType<GetPromoResponse, Options>;
|
|
1003
1003
|
/**
|
|
1004
1004
|
* PUT /promo/{id} - Update a promotion
|
|
1005
1005
|
*
|
|
@@ -1007,14 +1007,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1007
1007
|
* @param body
|
|
1008
1008
|
* @param options - additional request options
|
|
1009
1009
|
*/
|
|
1010
|
-
put_promo(id: string, body: PutPromoBody, options?:
|
|
1010
|
+
put_promo<Options extends RequestOptions>(id: string, body: PutPromoBody, options?: Options): ResponseType<PutPromoResponse, Options>;
|
|
1011
1011
|
/**
|
|
1012
1012
|
* DELETE /promo/{id} - Delete promotion
|
|
1013
1013
|
*
|
|
1014
1014
|
* @param id - Id of a promotion
|
|
1015
1015
|
* @param options - additional request options
|
|
1016
1016
|
*/
|
|
1017
|
-
delete_promo(id: string, options?:
|
|
1017
|
+
delete_promo<Options extends RequestOptions>(id: string, options?: Options): ResponseType<DeletePromoResponse, Options>;
|
|
1018
1018
|
/**
|
|
1019
1019
|
* GET /promo/company/{company}/location/group/{location_group} - Get all promotions within company for a location group
|
|
1020
1020
|
*
|
|
@@ -1022,30 +1022,30 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1022
1022
|
* @param location_group - Show promotions for selected location group
|
|
1023
1023
|
* @param options - additional request options
|
|
1024
1024
|
*/
|
|
1025
|
-
get_promo_company_location_group(company: string, location_group: string, options?: {
|
|
1025
|
+
get_promo_company_location_group<Options extends RequestOptions>(company: string, location_group: string, options?: {
|
|
1026
1026
|
query?: GetPromoCompanyLocationGroupQuery;
|
|
1027
|
-
} &
|
|
1027
|
+
} & Options): ResponseType<GetPromoCompanyLocationGroupResponse, Options>;
|
|
1028
1028
|
/**
|
|
1029
1029
|
* POST /promo/validate/voucher - Validate a promo voucher
|
|
1030
1030
|
*
|
|
1031
1031
|
* @param body
|
|
1032
1032
|
* @param options - additional request options
|
|
1033
1033
|
*/
|
|
1034
|
-
post_promo_validate_voucher(body: PostPromoValidateVoucherBody, options?:
|
|
1034
|
+
post_promo_validate_voucher<Options extends RequestOptions>(body: PostPromoValidateVoucherBody, options?: Options): ResponseType<PostPromoValidateVoucherResponse, Options>;
|
|
1035
1035
|
/**
|
|
1036
1036
|
* POST /promo/redeem/voucher - Redeem a promo voucher
|
|
1037
1037
|
*
|
|
1038
1038
|
* @param body
|
|
1039
1039
|
* @param options - additional request options
|
|
1040
1040
|
*/
|
|
1041
|
-
post_promo_redeem_voucher(body: PostPromoRedeemVoucherBody, options?:
|
|
1041
|
+
post_promo_redeem_voucher<Options extends RequestOptions>(body: PostPromoRedeemVoucherBody, options?: Options): ResponseType<PostPromoRedeemVoucherResponse, Options>;
|
|
1042
1042
|
/**
|
|
1043
1043
|
* POST /promo/voucher - Create new voucher
|
|
1044
1044
|
*
|
|
1045
1045
|
* @param body
|
|
1046
1046
|
* @param options - additional request options
|
|
1047
1047
|
*/
|
|
1048
|
-
post_promo_voucher(body: PostPromoVoucherBody, options?:
|
|
1048
|
+
post_promo_voucher<Options extends RequestOptions>(body: PostPromoVoucherBody, options?: Options): ResponseType<PostPromoVoucherResponse, Options>;
|
|
1049
1049
|
/**
|
|
1050
1050
|
* PUT /promo/voucher/{id} - Update voucher
|
|
1051
1051
|
*
|
|
@@ -1053,30 +1053,30 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1053
1053
|
* @param body
|
|
1054
1054
|
* @param options - additional request options
|
|
1055
1055
|
*/
|
|
1056
|
-
put_promo_voucher(id: string, body: PutPromoVoucherBody, options?:
|
|
1056
|
+
put_promo_voucher<Options extends RequestOptions>(id: string, body: PutPromoVoucherBody, options?: Options): ResponseType<PutPromoVoucherResponse, Options>;
|
|
1057
1057
|
/**
|
|
1058
1058
|
* DELETE /promo/voucher/{id} - Delete voucher
|
|
1059
1059
|
*
|
|
1060
1060
|
* @param id - TODO: add parameter to swagger.json
|
|
1061
1061
|
* @param options - additional request options
|
|
1062
1062
|
*/
|
|
1063
|
-
delete_promo_voucher(id: string, options?: {
|
|
1063
|
+
delete_promo_voucher<Options extends RequestOptions>(id: string, options?: {
|
|
1064
1064
|
query?: DeletePromoVoucherQuery;
|
|
1065
|
-
} &
|
|
1065
|
+
} & Options): ResponseType<DeletePromoVoucherResponse, Options>;
|
|
1066
1066
|
/**
|
|
1067
1067
|
* POST /promo/customer/ - Add user to voucherify
|
|
1068
1068
|
*
|
|
1069
1069
|
* @param body
|
|
1070
1070
|
* @param options - additional request options
|
|
1071
1071
|
*/
|
|
1072
|
-
post_promo_customer(body: PostPromoCustomerBody, options?:
|
|
1072
|
+
post_promo_customer<Options extends RequestOptions>(body: PostPromoCustomerBody, options?: Options): ResponseType<PostPromoCustomerResponse, Options>;
|
|
1073
1073
|
/**
|
|
1074
1074
|
* DELETE /promo/customer/ - Delete user from voucherify
|
|
1075
1075
|
*
|
|
1076
1076
|
* @param body
|
|
1077
1077
|
* @param options - additional request options
|
|
1078
1078
|
*/
|
|
1079
|
-
delete_promo_customer(body: DeletePromoCustomerBody, options?:
|
|
1079
|
+
delete_promo_customer<Options extends RequestOptions>(body: DeletePromoCustomerBody, options?: Options): ResponseType<DeletePromoCustomerResponse, Options>;
|
|
1080
1080
|
/**
|
|
1081
1081
|
* POST /promo/voucher/{id}/reverse - Reverse a redemption from a promo voucher
|
|
1082
1082
|
*
|
|
@@ -1084,33 +1084,33 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1084
1084
|
* @param body
|
|
1085
1085
|
* @param options - additional request options
|
|
1086
1086
|
*/
|
|
1087
|
-
post_promo_voucher_reverse(id: string, body: PostPromoVoucherReverseBody, options?:
|
|
1087
|
+
post_promo_voucher_reverse<Options extends RequestOptions>(id: string, body: PostPromoVoucherReverseBody, options?: Options): ResponseType<PostPromoVoucherReverseResponse, Options>;
|
|
1088
1088
|
/**
|
|
1089
1089
|
* POST /promo/voucherify/activity/execute - Execute a Journey custom Activity request
|
|
1090
1090
|
*
|
|
1091
1091
|
* @param body
|
|
1092
1092
|
* @param options - additional request options
|
|
1093
1093
|
*/
|
|
1094
|
-
post_promo_voucherify_activity_execute(body: PostPromoVoucherifyActivityExecuteBody, options?:
|
|
1094
|
+
post_promo_voucherify_activity_execute<Options extends RequestOptions>(body: PostPromoVoucherifyActivityExecuteBody, options?: Options): ResponseType<PostPromoVoucherifyActivityExecuteResponse, Options>;
|
|
1095
1095
|
/**
|
|
1096
1096
|
* GET /promo/voucherify/activity/config.json - Get SFMC Journey Custom Activity configuration
|
|
1097
1097
|
*
|
|
1098
1098
|
* @param options - additional request options
|
|
1099
1099
|
*/
|
|
1100
|
-
get_promo_voucherify_activity_config(options?:
|
|
1100
|
+
get_promo_voucherify_activity_config<Options extends RequestOptions>(options?: Options): ResponseType<GetPromoVoucherifyActivityConfigResponse, Options>;
|
|
1101
1101
|
/**
|
|
1102
1102
|
* POST /dh/sql
|
|
1103
1103
|
*
|
|
1104
1104
|
* @param options - additional request options
|
|
1105
1105
|
*/
|
|
1106
|
-
post_dh_sql(options?:
|
|
1106
|
+
post_dh_sql<Options extends RequestOptions>(options?: Options): ResponseType<PostDhSqlResponse, Options>;
|
|
1107
1107
|
/**
|
|
1108
1108
|
* GET /config/{key} - get a configuration
|
|
1109
1109
|
*
|
|
1110
1110
|
* @param key - configuration key
|
|
1111
1111
|
* @param options - additional request options
|
|
1112
1112
|
*/
|
|
1113
|
-
get_config(key: string, options?:
|
|
1113
|
+
get_config<Options extends RequestOptions>(key: string, options?: Options): ResponseType<GetConfigResponse, Options>;
|
|
1114
1114
|
/**
|
|
1115
1115
|
* POST /config/{key} - Create a configuration
|
|
1116
1116
|
*
|
|
@@ -1118,7 +1118,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1118
1118
|
* @param body
|
|
1119
1119
|
* @param options - additional request options
|
|
1120
1120
|
*/
|
|
1121
|
-
post_config(key: string, body: PostConfigBody, options?:
|
|
1121
|
+
post_config<Options extends RequestOptions>(key: string, body: PostConfigBody, options?: Options): ResponseType<PostConfigResponse, Options>;
|
|
1122
1122
|
/**
|
|
1123
1123
|
* PUT /config/{key} - Update a configuration
|
|
1124
1124
|
*
|
|
@@ -1126,21 +1126,21 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1126
1126
|
* @param body
|
|
1127
1127
|
* @param options - additional request options
|
|
1128
1128
|
*/
|
|
1129
|
-
put_config(key: string, body: PutConfigBody, options?:
|
|
1129
|
+
put_config<Options extends RequestOptions>(key: string, body: PutConfigBody, options?: Options): ResponseType<PutConfigResponse, Options>;
|
|
1130
1130
|
/**
|
|
1131
1131
|
* DELETE /config/{key} - Delete a configuration
|
|
1132
1132
|
*
|
|
1133
1133
|
* @param key - configuration key
|
|
1134
1134
|
* @param options - additional request options
|
|
1135
1135
|
*/
|
|
1136
|
-
delete_config(key: string, options?:
|
|
1136
|
+
delete_config<Options extends RequestOptions>(key: string, options?: Options): ResponseType<DeleteConfigResponse, Options>;
|
|
1137
1137
|
/**
|
|
1138
1138
|
* GET /config/public/{key} - get a public configuration
|
|
1139
1139
|
*
|
|
1140
1140
|
* @param key - configuration key
|
|
1141
1141
|
* @param options - additional request options
|
|
1142
1142
|
*/
|
|
1143
|
-
get_config_public(key: string, options?:
|
|
1143
|
+
get_config_public<Options extends RequestOptions>(key: string, options?: Options): ResponseType<GetConfigPublicResponse, Options>;
|
|
1144
1144
|
/**
|
|
1145
1145
|
* POST /config/public/{key} - Create a public configuration
|
|
1146
1146
|
*
|
|
@@ -1148,7 +1148,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1148
1148
|
* @param body
|
|
1149
1149
|
* @param options - additional request options
|
|
1150
1150
|
*/
|
|
1151
|
-
post_config_public(key: string, body: PostConfigPublicBody, options?:
|
|
1151
|
+
post_config_public<Options extends RequestOptions>(key: string, body: PostConfigPublicBody, options?: Options): ResponseType<PostConfigPublicResponse, Options>;
|
|
1152
1152
|
/**
|
|
1153
1153
|
* PUT /config/public/{key} - Update a public configuration
|
|
1154
1154
|
*
|
|
@@ -1156,45 +1156,45 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1156
1156
|
* @param body
|
|
1157
1157
|
* @param options - additional request options
|
|
1158
1158
|
*/
|
|
1159
|
-
put_config_public(key: string, body: PutConfigPublicBody, options?:
|
|
1159
|
+
put_config_public<Options extends RequestOptions>(key: string, body: PutConfigPublicBody, options?: Options): ResponseType<PutConfigPublicResponse, Options>;
|
|
1160
1160
|
/**
|
|
1161
1161
|
* DELETE /config/public/{key} - Delete a public configuration
|
|
1162
1162
|
*
|
|
1163
1163
|
* @param key - configuration key
|
|
1164
1164
|
* @param options - additional request options
|
|
1165
1165
|
*/
|
|
1166
|
-
delete_config_public(key: string, options?:
|
|
1166
|
+
delete_config_public<Options extends RequestOptions>(key: string, options?: Options): ResponseType<DeleteConfigPublicResponse, Options>;
|
|
1167
1167
|
/**
|
|
1168
1168
|
* POST /announcement - Create Announcement
|
|
1169
1169
|
*
|
|
1170
1170
|
* @param body - Announcement
|
|
1171
1171
|
* @param options - additional request options
|
|
1172
1172
|
*/
|
|
1173
|
-
post_announcement(body: PostAnnouncementBody, options?:
|
|
1173
|
+
post_announcement<Options extends RequestOptions>(body: PostAnnouncementBody, options?: Options): ResponseType<PostAnnouncementResponse, Options>;
|
|
1174
1174
|
/**
|
|
1175
1175
|
* GET /announcement/resource/{id} - Get Announcements for a specific entity
|
|
1176
1176
|
*
|
|
1177
1177
|
* @param id - Id of the entity to which announcement is specifically related.; TODO: mark parameter as required in swagger
|
|
1178
1178
|
* @param options - additional request options
|
|
1179
1179
|
*/
|
|
1180
|
-
get_announcement_resource(id: string, options?: {
|
|
1180
|
+
get_announcement_resource<Options extends RequestOptions>(id: string, options?: {
|
|
1181
1181
|
query?: GetAnnouncementResourceQuery;
|
|
1182
|
-
} &
|
|
1182
|
+
} & Options): ResponseType<GetAnnouncementResourceResponse, Options>;
|
|
1183
1183
|
/**
|
|
1184
1184
|
* GET /announcement/resource - Get Announcements
|
|
1185
1185
|
*
|
|
1186
1186
|
* @param options - additional request options
|
|
1187
1187
|
*/
|
|
1188
|
-
get_announcement_resources(options?: {
|
|
1188
|
+
get_announcement_resources<Options extends RequestOptions>(options?: {
|
|
1189
1189
|
query?: GetAnnouncementResourcesQuery;
|
|
1190
|
-
} &
|
|
1190
|
+
} & Options): ResponseType<GetAnnouncementResourcesResponse, Options>;
|
|
1191
1191
|
/**
|
|
1192
1192
|
* GET /announcement/{id} - Get Announcement
|
|
1193
1193
|
*
|
|
1194
1194
|
* @param id - Id of the entity to which announcement is specifically related.
|
|
1195
1195
|
* @param options - additional request options
|
|
1196
1196
|
*/
|
|
1197
|
-
get_announcement(id: string, options?:
|
|
1197
|
+
get_announcement<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetAnnouncementResponse, Options>;
|
|
1198
1198
|
/**
|
|
1199
1199
|
* PUT /announcement/{id} - Update Announcement
|
|
1200
1200
|
*
|
|
@@ -1202,14 +1202,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1202
1202
|
* @param body - Announcement
|
|
1203
1203
|
* @param options - additional request options
|
|
1204
1204
|
*/
|
|
1205
|
-
put_announcement(id: string, body: PutAnnouncementBody, options?:
|
|
1205
|
+
put_announcement<Options extends RequestOptions>(id: string, body: PutAnnouncementBody, options?: Options): ResponseType<PutAnnouncementResponse, Options>;
|
|
1206
1206
|
/**
|
|
1207
1207
|
* DELETE /announcement/{id} - Delete announcement item
|
|
1208
1208
|
*
|
|
1209
1209
|
* @param id - Id of the announcement
|
|
1210
1210
|
* @param options - additional request options
|
|
1211
1211
|
*/
|
|
1212
|
-
delete_announcement(id: string, options?:
|
|
1212
|
+
delete_announcement<Options extends RequestOptions>(id: string, options?: Options): ResponseType<DeleteAnnouncementResponse, Options>;
|
|
1213
1213
|
/**
|
|
1214
1214
|
* GET /report/analytics/group/{location_group}/{report_type}
|
|
1215
1215
|
*
|
|
@@ -1217,65 +1217,65 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1217
1217
|
* @param report_type
|
|
1218
1218
|
* @param options - additional request options
|
|
1219
1219
|
*/
|
|
1220
|
-
get_report_analytics_group(location_group: string, report_type: string, options: {
|
|
1220
|
+
get_report_analytics_group<Options extends RequestOptions>(location_group: string, report_type: string, options: {
|
|
1221
1221
|
query: GetReportAnalyticsGroupQuery;
|
|
1222
|
-
} &
|
|
1222
|
+
} & Options): ResponseType<GetReportAnalyticsGroupResponse, Options>;
|
|
1223
1223
|
/**
|
|
1224
1224
|
* GET /report/analytics/combined/group/{location_group}
|
|
1225
1225
|
*
|
|
1226
1226
|
* @param location_group
|
|
1227
1227
|
* @param options - additional request options
|
|
1228
1228
|
*/
|
|
1229
|
-
get_report_analytics_combined_group(location_group: string, options: {
|
|
1229
|
+
get_report_analytics_combined_group<Options extends RequestOptions>(location_group: string, options: {
|
|
1230
1230
|
query: GetReportAnalyticsCombinedGroupQuery;
|
|
1231
|
-
} &
|
|
1231
|
+
} & Options): ResponseType<GetReportAnalyticsCombinedGroupResponse, Options>;
|
|
1232
1232
|
/**
|
|
1233
1233
|
* GET /report/analytics/exactmobile/totals
|
|
1234
1234
|
*
|
|
1235
1235
|
* @param options - additional request options
|
|
1236
1236
|
*/
|
|
1237
|
-
get_report_analytics_exactmobile_totals(options: {
|
|
1237
|
+
get_report_analytics_exactmobile_totals<Options extends RequestOptions>(options: {
|
|
1238
1238
|
query: GetReportAnalyticsExactmobileTotalsQuery;
|
|
1239
|
-
} &
|
|
1239
|
+
} & Options): ResponseType<GetReportAnalyticsExactmobileTotalsResponse, Options>;
|
|
1240
1240
|
/**
|
|
1241
1241
|
* GET /report/analytics/exactmobile/transactions
|
|
1242
1242
|
*
|
|
1243
1243
|
* @param options - additional request options
|
|
1244
1244
|
*/
|
|
1245
|
-
get_report_analytics_exactmobile_transactions(options: {
|
|
1245
|
+
get_report_analytics_exactmobile_transactions<Options extends RequestOptions>(options: {
|
|
1246
1246
|
query: GetReportAnalyticsExactmobileTransactionsQuery;
|
|
1247
|
-
} &
|
|
1247
|
+
} & Options): ResponseType<GetReportAnalyticsExactmobileTransactionsResponse, Options>;
|
|
1248
1248
|
/**
|
|
1249
1249
|
* GET /report/analytics/exactmobile/discrepancies
|
|
1250
1250
|
*
|
|
1251
1251
|
* @param options - additional request options
|
|
1252
1252
|
*/
|
|
1253
|
-
get_report_analytics_exactmobile_discrepancies(options: {
|
|
1253
|
+
get_report_analytics_exactmobile_discrepancies<Options extends RequestOptions>(options: {
|
|
1254
1254
|
query: GetReportAnalyticsExactmobileDiscrepanciesQuery;
|
|
1255
|
-
} &
|
|
1255
|
+
} & Options): ResponseType<GetReportAnalyticsExactmobileDiscrepanciesResponse, Options>;
|
|
1256
1256
|
/**
|
|
1257
1257
|
* GET /report/analytics/tracker/report/{id}
|
|
1258
1258
|
*
|
|
1259
1259
|
* @param id
|
|
1260
1260
|
* @param options - additional request options
|
|
1261
1261
|
*/
|
|
1262
|
-
get_report_analytics_tracker_report(id: string, options?:
|
|
1262
|
+
get_report_analytics_tracker_report<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetReportAnalyticsTrackerReportResponse, Options>;
|
|
1263
1263
|
/**
|
|
1264
1264
|
* GET /report/eod/group/{id} - Get reports for selected location group
|
|
1265
1265
|
*
|
|
1266
1266
|
* @param id
|
|
1267
1267
|
* @param options - additional request options
|
|
1268
1268
|
*/
|
|
1269
|
-
get_report_eod_group(id: string, options?: {
|
|
1269
|
+
get_report_eod_group<Options extends RequestOptions>(id: string, options?: {
|
|
1270
1270
|
query?: GetReportEodGroupQuery;
|
|
1271
|
-
} &
|
|
1271
|
+
} & Options): ResponseType<GetReportEodGroupResponse, Options>;
|
|
1272
1272
|
/**
|
|
1273
1273
|
* GET /report/eod/group/{id}/subscribers - Get reports for selected location group
|
|
1274
1274
|
*
|
|
1275
1275
|
* @param id
|
|
1276
1276
|
* @param options - additional request options
|
|
1277
1277
|
*/
|
|
1278
|
-
get_report_eod_group_subscribers(id: string, options?:
|
|
1278
|
+
get_report_eod_group_subscribers<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetReportEodGroupSubscribersResponse, Options>;
|
|
1279
1279
|
/**
|
|
1280
1280
|
* POST /report/eod/group/{id}/subscribers - Add emails to selected location group
|
|
1281
1281
|
*
|
|
@@ -1283,14 +1283,14 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1283
1283
|
* @param body
|
|
1284
1284
|
* @param options - additional request options
|
|
1285
1285
|
*/
|
|
1286
|
-
post_report_eod_group_subscribers(id: string, body: PostReportEodGroupSubscribersBody, options?:
|
|
1286
|
+
post_report_eod_group_subscribers<Options extends RequestOptions>(id: string, body: PostReportEodGroupSubscribersBody, options?: Options): ResponseType<PostReportEodGroupSubscribersResponse, Options>;
|
|
1287
1287
|
/**
|
|
1288
1288
|
* DELETE /report/eod/group/{id}/subscribers - deletes subscribers from selected group
|
|
1289
1289
|
*
|
|
1290
1290
|
* @param id
|
|
1291
1291
|
* @param options - additional request options
|
|
1292
1292
|
*/
|
|
1293
|
-
delete_report_eod_group_subscribers(id: string, options?:
|
|
1293
|
+
delete_report_eod_group_subscribers<Options extends RequestOptions>(id: string, options?: Options): ResponseType<DeleteReportEodGroupSubscribersResponse, Options>;
|
|
1294
1294
|
/**
|
|
1295
1295
|
* PUT /report/eod/group/{id}/subscribers - replace all subscribers from selected location group with payload
|
|
1296
1296
|
*
|
|
@@ -1298,69 +1298,69 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1298
1298
|
* @param body
|
|
1299
1299
|
* @param options - additional request options
|
|
1300
1300
|
*/
|
|
1301
|
-
put_report_eod_group_subscribers(id: string, body: PutReportEodGroupSubscribersBody, options?:
|
|
1301
|
+
put_report_eod_group_subscribers<Options extends RequestOptions>(id: string, body: PutReportEodGroupSubscribersBody, options?: Options): ResponseType<PutReportEodGroupSubscribersResponse, Options>;
|
|
1302
1302
|
/**
|
|
1303
1303
|
* GET /report/discrepancy/subscribers - Get subscribers for discrepency widget
|
|
1304
1304
|
*
|
|
1305
1305
|
* @param options - additional request options
|
|
1306
1306
|
*/
|
|
1307
|
-
get_report_discrepancy_subscribers(options?: {
|
|
1307
|
+
get_report_discrepancy_subscribers<Options extends RequestOptions>(options?: {
|
|
1308
1308
|
query?: GetReportDiscrepancySubscribersQuery;
|
|
1309
|
-
} &
|
|
1309
|
+
} & Options): ResponseType<GetReportDiscrepancySubscribersResponse, Options>;
|
|
1310
1310
|
/**
|
|
1311
1311
|
* DELETE /report/discrepancy/subscribers - deletes subscriber from discrepency
|
|
1312
1312
|
*
|
|
1313
1313
|
* @param options - additional request options
|
|
1314
1314
|
*/
|
|
1315
|
-
delete_report_discrepancy_subscribers(options: {
|
|
1315
|
+
delete_report_discrepancy_subscribers<Options extends RequestOptions>(options: {
|
|
1316
1316
|
query: DeleteReportDiscrepancySubscribersQuery;
|
|
1317
|
-
} &
|
|
1317
|
+
} & Options): ResponseType<DeleteReportDiscrepancySubscribersResponse, Options>;
|
|
1318
1318
|
/**
|
|
1319
1319
|
* POST /report/discrepancy/subscribers - Create new discrepancy subscriber
|
|
1320
1320
|
*
|
|
1321
1321
|
* @param body
|
|
1322
1322
|
* @param options - additional request options
|
|
1323
1323
|
*/
|
|
1324
|
-
post_report_discrepancy_subscribers(body: PostReportDiscrepancySubscribersBody, options?:
|
|
1324
|
+
post_report_discrepancy_subscribers<Options extends RequestOptions>(body: PostReportDiscrepancySubscribersBody, options?: Options): ResponseType<PostReportDiscrepancySubscribersResponse, Options>;
|
|
1325
1325
|
/**
|
|
1326
1326
|
* GET /user/auth - Gets the JWT token for a user
|
|
1327
1327
|
*
|
|
1328
1328
|
* @param options - additional request options
|
|
1329
1329
|
*/
|
|
1330
|
-
get_user_auth(options?: {
|
|
1330
|
+
get_user_auth<Options extends RequestOptions>(options?: {
|
|
1331
1331
|
query?: GetUserAuthQuery;
|
|
1332
|
-
} &
|
|
1332
|
+
} & Options): ResponseType<GetUserAuthResponse, Options>;
|
|
1333
1333
|
/**
|
|
1334
1334
|
* POST /user/auth - Use refresh token to generate a new access token and refresh token
|
|
1335
1335
|
*
|
|
1336
1336
|
* @param body
|
|
1337
1337
|
* @param options - additional request options
|
|
1338
1338
|
*/
|
|
1339
|
-
post_user_auth(body: PostUserAuthBody, options?:
|
|
1339
|
+
post_user_auth<Options extends RequestOptions>(body: PostUserAuthBody, options?: Options): ResponseType<PostUserAuthResponse, Options>;
|
|
1340
1340
|
/**
|
|
1341
1341
|
* GET /user/zendesk - Get zendesk JWT token to allow web widget to search restricted articles
|
|
1342
1342
|
*
|
|
1343
1343
|
* @param options - additional request options
|
|
1344
1344
|
*/
|
|
1345
|
-
get_user_zendesk(options?:
|
|
1345
|
+
get_user_zendesk<Options extends RequestOptions>(options?: Options): ResponseType<GetUserZendeskResponse, Options>;
|
|
1346
1346
|
/**
|
|
1347
1347
|
* POST /user - Create an User
|
|
1348
1348
|
*
|
|
1349
1349
|
* @param body - User object that needs to be created
|
|
1350
1350
|
* @param options - additional request options
|
|
1351
1351
|
*/
|
|
1352
|
-
post_user(body: PostUserBody, options?: {
|
|
1352
|
+
post_user<Options extends RequestOptions>(body: PostUserBody, options?: {
|
|
1353
1353
|
query?: PostUserQuery;
|
|
1354
|
-
} &
|
|
1354
|
+
} & Options): ResponseType<PostUserResponse, Options>;
|
|
1355
1355
|
/**
|
|
1356
1356
|
* GET /user/{id} - Get an individual user
|
|
1357
1357
|
*
|
|
1358
1358
|
* @param id - User ID
|
|
1359
1359
|
* @param options - additional request options
|
|
1360
1360
|
*/
|
|
1361
|
-
get_user(id: string, options?: {
|
|
1361
|
+
get_user<Options extends RequestOptions>(id: string, options?: {
|
|
1362
1362
|
query?: GetUserQuery;
|
|
1363
|
-
} &
|
|
1363
|
+
} & Options): ResponseType<GetUserResponse, Options>;
|
|
1364
1364
|
/**
|
|
1365
1365
|
* PUT /user/{id} - Update an individual user
|
|
1366
1366
|
*
|
|
@@ -1368,9 +1368,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1368
1368
|
* @param body - User object that needs to be updated
|
|
1369
1369
|
* @param options - additional request options
|
|
1370
1370
|
*/
|
|
1371
|
-
put_user(id: string, body: PutUserBody, options?: {
|
|
1371
|
+
put_user<Options extends RequestOptions>(id: string, body: PutUserBody, options?: {
|
|
1372
1372
|
query?: PutUserQuery;
|
|
1373
|
-
} &
|
|
1373
|
+
} & Options): ResponseType<PutUserResponse, Options>;
|
|
1374
1374
|
/**
|
|
1375
1375
|
* PATCH /user/{id} - Update an individual user
|
|
1376
1376
|
*
|
|
@@ -1378,47 +1378,47 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1378
1378
|
* @param body - User properties which should be updated
|
|
1379
1379
|
* @param options - additional request options
|
|
1380
1380
|
*/
|
|
1381
|
-
patch_user(id: string, body: PatchUserBody, options?: {
|
|
1381
|
+
patch_user<Options extends RequestOptions>(id: string, body: PatchUserBody, options?: {
|
|
1382
1382
|
query?: PatchUserQuery;
|
|
1383
|
-
} &
|
|
1383
|
+
} & Options): ResponseType<PatchUserResponse, Options>;
|
|
1384
1384
|
/**
|
|
1385
1385
|
* DELETE /user/{id} - delete an individual user
|
|
1386
1386
|
*
|
|
1387
1387
|
* @param id - User ID
|
|
1388
1388
|
* @param options - additional request options
|
|
1389
1389
|
*/
|
|
1390
|
-
delete_user(id: string, options?: {
|
|
1390
|
+
delete_user<Options extends RequestOptions>(id: string, options?: {
|
|
1391
1391
|
query?: DeleteUserQuery;
|
|
1392
|
-
} &
|
|
1392
|
+
} & Options): ResponseType<DeleteUserResponse, Options>;
|
|
1393
1393
|
/**
|
|
1394
1394
|
* POST /user/device/auth - Endpoint for generating/retrieving KDS device token
|
|
1395
1395
|
*
|
|
1396
1396
|
* @param body
|
|
1397
1397
|
* @param options - additional request options
|
|
1398
1398
|
*/
|
|
1399
|
-
post_user_kds_token(body: PostUserKdsTokenBody, options?:
|
|
1399
|
+
post_user_kds_token<Options extends RequestOptions>(body: PostUserKdsTokenBody, options?: Options): ResponseType<PostUserKdsTokenResponse, Options>;
|
|
1400
1400
|
/**
|
|
1401
1401
|
* GET /user/device/auth - Endpoint retrieving KDS device token
|
|
1402
1402
|
*
|
|
1403
1403
|
* @param options - additional request options
|
|
1404
1404
|
*/
|
|
1405
|
-
get_user_kds_token(options?: {
|
|
1405
|
+
get_user_kds_token<Options extends RequestOptions>(options?: {
|
|
1406
1406
|
query?: GetUserKdsTokenQuery;
|
|
1407
|
-
} &
|
|
1407
|
+
} & Options): ResponseType<GetUserKdsTokenResponse, Options>;
|
|
1408
1408
|
/**
|
|
1409
1409
|
* DELETE /user/device/auth/{device_id} - Endpoint for deleting a device by specified device_id
|
|
1410
1410
|
*
|
|
1411
1411
|
* @param device_id - KDS device ID
|
|
1412
1412
|
* @param options - additional request options
|
|
1413
1413
|
*/
|
|
1414
|
-
delete_user_device_auth(device_id: string, options?:
|
|
1414
|
+
delete_user_device_auth<Options extends RequestOptions>(device_id: string, options?: Options): ResponseType<DeleteUserDeviceAuthResponse, Options>;
|
|
1415
1415
|
/**
|
|
1416
1416
|
* PATCH /user/device/auth/{device_id} - Endpoint for authorizing device to retrieve valid kds token
|
|
1417
1417
|
*
|
|
1418
1418
|
* @param device_id - KDS device ID
|
|
1419
1419
|
* @param options - additional request options
|
|
1420
1420
|
*/
|
|
1421
|
-
patch_user_auth_kds(device_id: string, options?:
|
|
1421
|
+
patch_user_auth_kds<Options extends RequestOptions>(device_id: string, options?: Options): ResponseType<PatchUserAuthKdsResponse, Options>;
|
|
1422
1422
|
/**
|
|
1423
1423
|
* POST /user/{id}/changepassword - Change the users password
|
|
1424
1424
|
*
|
|
@@ -1426,13 +1426,13 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1426
1426
|
* @param body
|
|
1427
1427
|
* @param options - additional request options
|
|
1428
1428
|
*/
|
|
1429
|
-
post_user_change_password(id: string, body: PostUserChangePasswordBody, options?:
|
|
1429
|
+
post_user_change_password<Options extends RequestOptions>(id: string, body: PostUserChangePasswordBody, options?: Options): ResponseType<PostUserChangePasswordResponse, Options>;
|
|
1430
1430
|
/**
|
|
1431
1431
|
* DELETE /user/logout - Logs out current user
|
|
1432
1432
|
*
|
|
1433
1433
|
* @param options - additional request options
|
|
1434
1434
|
*/
|
|
1435
|
-
delete_user_logout(options?:
|
|
1435
|
+
delete_user_logout<Options extends RequestOptions>(options?: Options): ResponseType<DeleteUserLogoutResponse, Options>;
|
|
1436
1436
|
/**
|
|
1437
1437
|
* POST /user/{id}/secret/{key} - Add a secret key
|
|
1438
1438
|
*
|
|
@@ -1441,7 +1441,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1441
1441
|
* @param body - Secret to be stored
|
|
1442
1442
|
* @param options - additional request options
|
|
1443
1443
|
*/
|
|
1444
|
-
post_user_add_secret(id: string, key: string, body: PostUserAddSecretBody, options?:
|
|
1444
|
+
post_user_add_secret<Options extends RequestOptions>(id: string, key: string, body: PostUserAddSecretBody, options?: Options): ResponseType<PostUserAddSecretResponse, Options>;
|
|
1445
1445
|
/**
|
|
1446
1446
|
* GET /user/{id}/secret/{key} - Get back a secret key
|
|
1447
1447
|
*
|
|
@@ -1449,16 +1449,16 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1449
1449
|
* @param key
|
|
1450
1450
|
* @param options - additional request options
|
|
1451
1451
|
*/
|
|
1452
|
-
get_user_secret(id: string, key: string, options?:
|
|
1452
|
+
get_user_secret<Options extends RequestOptions>(id: string, key: string, options?: Options): ResponseType<GetUserSecretResponse, Options>;
|
|
1453
1453
|
/**
|
|
1454
1454
|
* POST /user/forgotpassword - Reset the users password
|
|
1455
1455
|
*
|
|
1456
1456
|
* @param body
|
|
1457
1457
|
* @param options - additional request options
|
|
1458
1458
|
*/
|
|
1459
|
-
post_user_reset_password(body: PostUserResetPasswordBody, options?: {
|
|
1459
|
+
post_user_reset_password<Options extends RequestOptions>(body: PostUserResetPasswordBody, options?: {
|
|
1460
1460
|
query?: PostUserResetPasswordQuery;
|
|
1461
|
-
} &
|
|
1461
|
+
} & Options): ResponseType<PostUserResetPasswordResponse, Options>;
|
|
1462
1462
|
/**
|
|
1463
1463
|
* POST /user/{id}/resetpassword - Reset the users password using a reset token
|
|
1464
1464
|
*
|
|
@@ -1466,27 +1466,27 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1466
1466
|
* @param body
|
|
1467
1467
|
* @param options - additional request options
|
|
1468
1468
|
*/
|
|
1469
|
-
post_user_reset_password_token(id: string, body: PostUserResetPasswordTokenBody, options: {
|
|
1469
|
+
post_user_reset_password_token<Options extends RequestOptions>(id: string, body: PostUserResetPasswordTokenBody, options: {
|
|
1470
1470
|
query: PostUserResetPasswordTokenQuery;
|
|
1471
|
-
} &
|
|
1471
|
+
} & Options): ResponseType<PostUserResetPasswordTokenResponse, Options>;
|
|
1472
1472
|
/**
|
|
1473
1473
|
* GET /user/realm/{realm} - Get all the users in a realm
|
|
1474
1474
|
*
|
|
1475
1475
|
* @param realm - realm
|
|
1476
1476
|
* @param options - additional request options
|
|
1477
1477
|
*/
|
|
1478
|
-
get_user_realm_users(realm: string, options?: {
|
|
1478
|
+
get_user_realm_users<Options extends RequestOptions>(realm: string, options?: {
|
|
1479
1479
|
query?: GetUserRealmUsersQuery;
|
|
1480
|
-
} &
|
|
1480
|
+
} & Options): ResponseType<GetUserRealmUsersResponse, Options>;
|
|
1481
1481
|
/**
|
|
1482
1482
|
* GET /user/{id}/permissions - Get user permissions
|
|
1483
1483
|
*
|
|
1484
1484
|
* @param id - user
|
|
1485
1485
|
* @param options - additional request options
|
|
1486
1486
|
*/
|
|
1487
|
-
get_user_permissions(id: string, options?: {
|
|
1487
|
+
get_user_permissions<Options extends RequestOptions>(id: string, options?: {
|
|
1488
1488
|
query?: GetUserPermissionsQuery;
|
|
1489
|
-
} &
|
|
1489
|
+
} & Options): ResponseType<GetUserPermissionsResponse, Options>;
|
|
1490
1490
|
/**
|
|
1491
1491
|
* PUT /user/{id}/permissions - Update user permissions
|
|
1492
1492
|
*
|
|
@@ -1494,9 +1494,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1494
1494
|
* @param body
|
|
1495
1495
|
* @param options - additional request options
|
|
1496
1496
|
*/
|
|
1497
|
-
put_user_permissions(id: string, body: PutUserPermissionsBody, options?: {
|
|
1497
|
+
put_user_permissions<Options extends RequestOptions>(id: string, body: PutUserPermissionsBody, options?: {
|
|
1498
1498
|
query?: PutUserPermissionsQuery;
|
|
1499
|
-
} &
|
|
1499
|
+
} & Options): ResponseType<PutUserPermissionsResponse, Options>;
|
|
1500
1500
|
/**
|
|
1501
1501
|
* POST /user/{id}/checkin - Create check-in for user
|
|
1502
1502
|
*
|
|
@@ -1504,7 +1504,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1504
1504
|
* @param body
|
|
1505
1505
|
* @param options - additional request options
|
|
1506
1506
|
*/
|
|
1507
|
-
post_user_check_in(id: string, body: PostUserCheckInBody, options?:
|
|
1507
|
+
post_user_check_in<Options extends RequestOptions>(id: string, body: PostUserCheckInBody, options?: Options): ResponseType<PostUserCheckInResponse, Options>;
|
|
1508
1508
|
/**
|
|
1509
1509
|
* PATCH /user/{id}/checkin/{checkin_id} - Update check-in
|
|
1510
1510
|
*
|
|
@@ -1513,22 +1513,22 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1513
1513
|
* @param body - The updated state/date_queued of the check-in
|
|
1514
1514
|
* @param options - additional request options
|
|
1515
1515
|
*/
|
|
1516
|
-
patch_user_checkin(id: string, checkin_id: string, body: PatchUserCheckinBody, options?:
|
|
1516
|
+
patch_user_checkin<Options extends RequestOptions>(id: string, checkin_id: string, body: PatchUserCheckinBody, options?: Options): ResponseType<PatchUserCheckinResponse, Options>;
|
|
1517
1517
|
/**
|
|
1518
1518
|
* GET /user/checkin/search - Search check-in
|
|
1519
1519
|
*
|
|
1520
1520
|
* @param options - additional request options
|
|
1521
1521
|
*/
|
|
1522
|
-
get_user_search_check_in(options?: {
|
|
1522
|
+
get_user_search_check_in<Options extends RequestOptions>(options?: {
|
|
1523
1523
|
query?: GetUserSearchCheckInQuery;
|
|
1524
|
-
} &
|
|
1524
|
+
} & Options): ResponseType<GetUserSearchCheckInResponse, Options>;
|
|
1525
1525
|
/**
|
|
1526
1526
|
* POST /user/{id}/verification - Send email verification to user
|
|
1527
1527
|
*
|
|
1528
1528
|
* @param id - realm
|
|
1529
1529
|
* @param options - additional request options
|
|
1530
1530
|
*/
|
|
1531
|
-
post_user_send_email_verification(id: string, options?:
|
|
1531
|
+
post_user_send_email_verification<Options extends RequestOptions>(id: string, options?: Options): ResponseType<PostUserSendEmailVerificationResponse, Options>;
|
|
1532
1532
|
/**
|
|
1533
1533
|
* PUT /user/{id}/verification/confirm - Verify a users email
|
|
1534
1534
|
*
|
|
@@ -1536,7 +1536,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1536
1536
|
* @param body
|
|
1537
1537
|
* @param options - additional request options
|
|
1538
1538
|
*/
|
|
1539
|
-
put_user_verify_user_email(id: string, body: PutUserVerifyUserEmailBody, options?:
|
|
1539
|
+
put_user_verify_user_email<Options extends RequestOptions>(id: string, body: PutUserVerifyUserEmailBody, options?: Options): ResponseType<PutUserVerifyUserEmailResponse, Options>;
|
|
1540
1540
|
/**
|
|
1541
1541
|
* POST /loyalty/{id}/enroll/{user_id} - Enroll logged in user in Loyalty program
|
|
1542
1542
|
*
|
|
@@ -1544,18 +1544,18 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1544
1544
|
* @param user_id - CompassDigital User id
|
|
1545
1545
|
* @param options - additional request options
|
|
1546
1546
|
*/
|
|
1547
|
-
post_loyalty_enroll(id: string, user_id: string, options?: {
|
|
1547
|
+
post_loyalty_enroll<Options extends RequestOptions>(id: string, user_id: string, options?: {
|
|
1548
1548
|
query?: PostLoyaltyEnrollQuery;
|
|
1549
|
-
} &
|
|
1549
|
+
} & Options): ResponseType<PostLoyaltyEnrollResponse, Options>;
|
|
1550
1550
|
/**
|
|
1551
1551
|
* GET /loyalty/{id}/points - Get potential points user could earn from certain event in Loyalty program
|
|
1552
1552
|
*
|
|
1553
1553
|
* @param id - Loyalty Provider id
|
|
1554
1554
|
* @param options - additional request options
|
|
1555
1555
|
*/
|
|
1556
|
-
get_loyalty_points(id: string, options: {
|
|
1556
|
+
get_loyalty_points<Options extends RequestOptions>(id: string, options: {
|
|
1557
1557
|
query: GetLoyaltyPointsQuery;
|
|
1558
|
-
} &
|
|
1558
|
+
} & Options): ResponseType<GetLoyaltyPointsResponse, Options>;
|
|
1559
1559
|
/**
|
|
1560
1560
|
* GET /loyalty/{id}/offers/{user_id} - Get offers for the logged in user
|
|
1561
1561
|
*
|
|
@@ -1563,7 +1563,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1563
1563
|
* @param user_id - CompassDigital User id
|
|
1564
1564
|
* @param options - additional request options
|
|
1565
1565
|
*/
|
|
1566
|
-
get_loyalty_offers(id: string, user_id: string, options?:
|
|
1566
|
+
get_loyalty_offers<Options extends RequestOptions>(id: string, user_id: string, options?: Options): ResponseType<GetLoyaltyOffersResponse, Options>;
|
|
1567
1567
|
/**
|
|
1568
1568
|
* GET /loyalty/{id}/enrollmentstatus/{user_id} - Get enrollment status for logged in user
|
|
1569
1569
|
*
|
|
@@ -1571,7 +1571,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1571
1571
|
* @param user_id - CompassDigital User id
|
|
1572
1572
|
* @param options - additional request options
|
|
1573
1573
|
*/
|
|
1574
|
-
get_loyalty_enrollmentstatus(id: string, user_id: string, options?:
|
|
1574
|
+
get_loyalty_enrollmentstatus<Options extends RequestOptions>(id: string, user_id: string, options?: Options): ResponseType<GetLoyaltyEnrollmentstatusResponse, Options>;
|
|
1575
1575
|
/**
|
|
1576
1576
|
* GET /loyalty/{id}/balance/{user_id} - Get loyalty point balance for logged in user
|
|
1577
1577
|
*
|
|
@@ -1579,7 +1579,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1579
1579
|
* @param user_id - CompassDigital User id
|
|
1580
1580
|
* @param options - additional request options
|
|
1581
1581
|
*/
|
|
1582
|
-
get_loyalty_balance(id: string, user_id: string, options?:
|
|
1582
|
+
get_loyalty_balance<Options extends RequestOptions>(id: string, user_id: string, options?: Options): ResponseType<GetLoyaltyBalanceResponse, Options>;
|
|
1583
1583
|
/**
|
|
1584
1584
|
* GET /loyalty/{id}/opportunities/{user_id} - Get earning opportunities for the logged in user
|
|
1585
1585
|
*
|
|
@@ -1587,9 +1587,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1587
1587
|
* @param user_id - CompassDigital User id
|
|
1588
1588
|
* @param options - additional request options
|
|
1589
1589
|
*/
|
|
1590
|
-
get_loyalty_opportunities(id: string, user_id: string, options?: {
|
|
1590
|
+
get_loyalty_opportunities<Options extends RequestOptions>(id: string, user_id: string, options?: {
|
|
1591
1591
|
query?: GetLoyaltyOpportunitiesQuery;
|
|
1592
|
-
} &
|
|
1592
|
+
} & Options): ResponseType<GetLoyaltyOpportunitiesResponse, Options>;
|
|
1593
1593
|
/**
|
|
1594
1594
|
* POST /loyalty/{id}/opportunities/{user_id} - Record an event for the logged in user
|
|
1595
1595
|
*
|
|
@@ -1597,9 +1597,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1597
1597
|
* @param user_id - CompassDigital User id
|
|
1598
1598
|
* @param options - additional request options
|
|
1599
1599
|
*/
|
|
1600
|
-
post_loyalty_opportunities(id: string, user_id: string, options: {
|
|
1600
|
+
post_loyalty_opportunities<Options extends RequestOptions>(id: string, user_id: string, options: {
|
|
1601
1601
|
query: PostLoyaltyOpportunitiesQuery;
|
|
1602
|
-
} &
|
|
1602
|
+
} & Options): ResponseType<PostLoyaltyOpportunitiesResponse, Options>;
|
|
1603
1603
|
/**
|
|
1604
1604
|
* GET /loyalty/{id}/rewards/{user_id} - Get rewards available for the logged in user
|
|
1605
1605
|
*
|
|
@@ -1607,7 +1607,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1607
1607
|
* @param user_id - CompassDigital User id
|
|
1608
1608
|
* @param options - additional request options
|
|
1609
1609
|
*/
|
|
1610
|
-
get_loyalty_rewards(id: string, user_id: string, options?:
|
|
1610
|
+
get_loyalty_rewards<Options extends RequestOptions>(id: string, user_id: string, options?: Options): ResponseType<GetLoyaltyRewardsResponse, Options>;
|
|
1611
1611
|
/**
|
|
1612
1612
|
* GET /loyalty/{id}/coupons/{user_id} - Get coupons available for the logged in user
|
|
1613
1613
|
*
|
|
@@ -1615,7 +1615,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1615
1615
|
* @param user_id - CompassDigital User id
|
|
1616
1616
|
* @param options - additional request options
|
|
1617
1617
|
*/
|
|
1618
|
-
get_loyalty_coupons(id: string, user_id: string, options?:
|
|
1618
|
+
get_loyalty_coupons<Options extends RequestOptions>(id: string, user_id: string, options?: Options): ResponseType<GetLoyaltyCouponsResponse, Options>;
|
|
1619
1619
|
/**
|
|
1620
1620
|
* GET /loyalty/{id}/orderpoints/{user_id} - Get potential loyalty point points for an order based on amount.
|
|
1621
1621
|
*
|
|
@@ -1623,9 +1623,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1623
1623
|
* @param user_id - CompassDigital User id
|
|
1624
1624
|
* @param options - additional request options
|
|
1625
1625
|
*/
|
|
1626
|
-
get_loyalty_orderpoints(id: string, user_id: string, options: {
|
|
1626
|
+
get_loyalty_orderpoints<Options extends RequestOptions>(id: string, user_id: string, options: {
|
|
1627
1627
|
query: GetLoyaltyOrderpointsQuery;
|
|
1628
|
-
} &
|
|
1628
|
+
} & Options): ResponseType<GetLoyaltyOrderpointsResponse, Options>;
|
|
1629
1629
|
/**
|
|
1630
1630
|
* POST /loyalty/{id}/orderpoints/{user_id} - Get potential loyalty point points for a order based on amount and items
|
|
1631
1631
|
*
|
|
@@ -1634,7 +1634,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1634
1634
|
* @param body
|
|
1635
1635
|
* @param options - additional request options
|
|
1636
1636
|
*/
|
|
1637
|
-
post_loyalty_orderpoints(id: string, user_id: string, body: PostLoyaltyOrderpointsBody, options?:
|
|
1637
|
+
post_loyalty_orderpoints<Options extends RequestOptions>(id: string, user_id: string, body: PostLoyaltyOrderpointsBody, options?: Options): ResponseType<PostLoyaltyOrderpointsResponse, Options>;
|
|
1638
1638
|
/**
|
|
1639
1639
|
* POST /loyalty/{id}/purchase/{user_id} - Record purchase event
|
|
1640
1640
|
*
|
|
@@ -1643,9 +1643,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1643
1643
|
* @param body
|
|
1644
1644
|
* @param options - additional request options
|
|
1645
1645
|
*/
|
|
1646
|
-
post_loyalty_purchase(id: string, user_id: string, body: PostLoyaltyPurchaseBody, options?: {
|
|
1646
|
+
post_loyalty_purchase<Options extends RequestOptions>(id: string, user_id: string, body: PostLoyaltyPurchaseBody, options?: {
|
|
1647
1647
|
query?: PostLoyaltyPurchaseQuery;
|
|
1648
|
-
} &
|
|
1648
|
+
} & Options): ResponseType<PostLoyaltyPurchaseResponse, Options>;
|
|
1649
1649
|
/**
|
|
1650
1650
|
* POST /loyalty/{id}/buyreward/{user_id} - Redeem rewards to coupons
|
|
1651
1651
|
*
|
|
@@ -1654,9 +1654,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1654
1654
|
* @param body
|
|
1655
1655
|
* @param options - additional request options
|
|
1656
1656
|
*/
|
|
1657
|
-
post_loyalty_buyreward(id: string, user_id: string, body: PostLoyaltyBuyrewardBody, options?: {
|
|
1657
|
+
post_loyalty_buyreward<Options extends RequestOptions>(id: string, user_id: string, body: PostLoyaltyBuyrewardBody, options?: {
|
|
1658
1658
|
query?: PostLoyaltyBuyrewardQuery;
|
|
1659
|
-
} &
|
|
1659
|
+
} & Options): ResponseType<PostLoyaltyBuyrewardResponse, Options>;
|
|
1660
1660
|
/**
|
|
1661
1661
|
* GET /loyalty/{id}/history/{user_id} - Get history of loyalty transactions for user
|
|
1662
1662
|
*
|
|
@@ -1664,9 +1664,9 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1664
1664
|
* @param user_id - CompassDigital User id
|
|
1665
1665
|
* @param options - additional request options
|
|
1666
1666
|
*/
|
|
1667
|
-
get_loyalty_history(id: string, user_id: string, options?: {
|
|
1667
|
+
get_loyalty_history<Options extends RequestOptions>(id: string, user_id: string, options?: {
|
|
1668
1668
|
query?: GetLoyaltyHistoryQuery;
|
|
1669
|
-
} &
|
|
1669
|
+
} & Options): ResponseType<GetLoyaltyHistoryResponse, Options>;
|
|
1670
1670
|
/**
|
|
1671
1671
|
* GET /loyalty/{id}/coupon/{user_id}/{coupon_id} - get coupon's information
|
|
1672
1672
|
*
|
|
@@ -1675,7 +1675,7 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1675
1675
|
* @param coupon_id - Coupon code to get coupon information
|
|
1676
1676
|
* @param options - additional request options
|
|
1677
1677
|
*/
|
|
1678
|
-
get_loyalty_coupon(id: string, user_id: string, coupon_id: string, options?:
|
|
1678
|
+
get_loyalty_coupon<Options extends RequestOptions>(id: string, user_id: string, coupon_id: string, options?: Options): ResponseType<GetLoyaltyCouponResponse, Options>;
|
|
1679
1679
|
/**
|
|
1680
1680
|
* PATCH /loyalty/{id}/coupon/{user_id}/{coupon_id} - Update coupon's status
|
|
1681
1681
|
*
|
|
@@ -1685,54 +1685,54 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1685
1685
|
* @param body
|
|
1686
1686
|
* @param options - additional request options
|
|
1687
1687
|
*/
|
|
1688
|
-
patch_loyalty_coupon(id: string, user_id: string, coupon_id: string, body: PatchLoyaltyCouponBody, options?:
|
|
1688
|
+
patch_loyalty_coupon<Options extends RequestOptions>(id: string, user_id: string, coupon_id: string, body: PatchLoyaltyCouponBody, options?: Options): ResponseType<PatchLoyaltyCouponResponse, Options>;
|
|
1689
1689
|
/**
|
|
1690
1690
|
* GET /loyalty/{id}/search - Search CDL user id by internal 500friends id
|
|
1691
1691
|
*
|
|
1692
1692
|
* @param id - Loyalty Provider id
|
|
1693
1693
|
* @param options - additional request options
|
|
1694
1694
|
*/
|
|
1695
|
-
get_loyalty_search(id: string, options: {
|
|
1695
|
+
get_loyalty_search<Options extends RequestOptions>(id: string, options: {
|
|
1696
1696
|
query: GetLoyaltySearchQuery;
|
|
1697
|
-
} &
|
|
1697
|
+
} & Options): ResponseType<GetLoyaltySearchResponse, Options>;
|
|
1698
1698
|
/**
|
|
1699
1699
|
* GET /loyalty/{id}/users - Get all loyalty users updated after specific date
|
|
1700
1700
|
*
|
|
1701
1701
|
* @param id - Loyalty Provider id
|
|
1702
1702
|
* @param options - additional request options
|
|
1703
1703
|
*/
|
|
1704
|
-
get_loyalty_users(id: string, options: {
|
|
1704
|
+
get_loyalty_users<Options extends RequestOptions>(id: string, options: {
|
|
1705
1705
|
query: GetLoyaltyUsersQuery;
|
|
1706
|
-
} &
|
|
1706
|
+
} & Options): ResponseType<GetLoyaltyUsersResponse, Options>;
|
|
1707
1707
|
/**
|
|
1708
1708
|
* GET /loyalty/{id}/events - Get all loyalty events updated after specific date
|
|
1709
1709
|
*
|
|
1710
1710
|
* @param id - Loyalty Provider id
|
|
1711
1711
|
* @param options - additional request options
|
|
1712
1712
|
*/
|
|
1713
|
-
get_loyalty_events(id: string, options: {
|
|
1713
|
+
get_loyalty_events<Options extends RequestOptions>(id: string, options: {
|
|
1714
1714
|
query: GetLoyaltyEventsQuery;
|
|
1715
|
-
} &
|
|
1715
|
+
} & Options): ResponseType<GetLoyaltyEventsResponse, Options>;
|
|
1716
1716
|
/**
|
|
1717
1717
|
* GET /brand/{id}
|
|
1718
1718
|
*
|
|
1719
1719
|
* @param id - TODO: add parameter to swagger.json
|
|
1720
1720
|
* @param options - additional request options
|
|
1721
1721
|
*/
|
|
1722
|
-
get_brand(id: string, options?:
|
|
1722
|
+
get_brand<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetBrandResponse, Options>;
|
|
1723
1723
|
/**
|
|
1724
1724
|
* GET /brand
|
|
1725
1725
|
*
|
|
1726
1726
|
* @param options - additional request options
|
|
1727
1727
|
*/
|
|
1728
|
-
get_brands(options?:
|
|
1728
|
+
get_brands<Options extends RequestOptions>(options?: Options): ResponseType<GetBrandsResponse, Options>;
|
|
1729
1729
|
/**
|
|
1730
1730
|
* GET /calendar/{id}
|
|
1731
1731
|
*
|
|
1732
1732
|
* @param id - brand
|
|
1733
1733
|
* @param options - additional request options
|
|
1734
1734
|
*/
|
|
1735
|
-
get_calendar(id: string, options?:
|
|
1735
|
+
get_calendar<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetCalendarResponse, Options>;
|
|
1736
1736
|
/**
|
|
1737
1737
|
* PUT /calendar/{id} - Set the calendar for an id. Overrides previous record
|
|
1738
1738
|
*
|
|
@@ -1740,72 +1740,72 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1740
1740
|
* @param body
|
|
1741
1741
|
* @param options - additional request options
|
|
1742
1742
|
*/
|
|
1743
|
-
put_calendar(id: string, body: PutCalendarBody, options?:
|
|
1743
|
+
put_calendar<Options extends RequestOptions>(id: string, body: PutCalendarBody, options?: Options): ResponseType<PutCalendarResponse, Options>;
|
|
1744
1744
|
/**
|
|
1745
1745
|
* GET /calendar/{id}/cdl - Get the calendar events in a CDL compatible format for next 7 days
|
|
1746
1746
|
*
|
|
1747
1747
|
* @param id - brand
|
|
1748
1748
|
* @param options - additional request options
|
|
1749
1749
|
*/
|
|
1750
|
-
get_calendar_cdl(id: string, options?: {
|
|
1750
|
+
get_calendar_cdl<Options extends RequestOptions>(id: string, options?: {
|
|
1751
1751
|
query?: GetCalendarCdlQuery;
|
|
1752
|
-
} &
|
|
1752
|
+
} & Options): ResponseType<GetCalendarCdlResponse, Options>;
|
|
1753
1753
|
/**
|
|
1754
1754
|
* GET /calendar/swagger.json
|
|
1755
1755
|
*
|
|
1756
1756
|
* @param options - additional request options
|
|
1757
1757
|
*/
|
|
1758
|
-
get_calendar_swagger(options?:
|
|
1758
|
+
get_calendar_swagger<Options extends RequestOptions>(options?: Options): ResponseType<GetCalendarSwaggerResponse, Options>;
|
|
1759
1759
|
/**
|
|
1760
1760
|
* POST /calendar/{id}/sync - Trigger synchronization of calendar to location API
|
|
1761
1761
|
*
|
|
1762
1762
|
* @param id - brand
|
|
1763
1763
|
* @param options - additional request options
|
|
1764
1764
|
*/
|
|
1765
|
-
post_calendar_sync(id: string, options?:
|
|
1765
|
+
post_calendar_sync<Options extends RequestOptions>(id: string, options?: Options): ResponseType<PostCalendarSyncResponse, Options>;
|
|
1766
1766
|
/**
|
|
1767
1767
|
* POST /delivery/order - make reservation
|
|
1768
1768
|
*
|
|
1769
1769
|
* @param body - reservation
|
|
1770
1770
|
* @param options - additional request options
|
|
1771
1771
|
*/
|
|
1772
|
-
post_delivery_order(body: PostDeliveryOrderBody, options?:
|
|
1772
|
+
post_delivery_order<Options extends RequestOptions>(body: PostDeliveryOrderBody, options?: Options): ResponseType<PostDeliveryOrderResponse, Options>;
|
|
1773
1773
|
/**
|
|
1774
1774
|
* PATCH /delivery/order/{order_id} - confirm order
|
|
1775
1775
|
*
|
|
1776
1776
|
* @param order_id - TODO: add parameter to swagger.json
|
|
1777
1777
|
* @param options - additional request options
|
|
1778
1778
|
*/
|
|
1779
|
-
patch_delivery_order(order_id: string, options?:
|
|
1779
|
+
patch_delivery_order<Options extends RequestOptions>(order_id: string, options?: Options): ResponseType<PatchDeliveryOrderResponse, Options>;
|
|
1780
1780
|
/**
|
|
1781
1781
|
* GET /delivery/order/{order_id} - get order
|
|
1782
1782
|
*
|
|
1783
1783
|
* @param order_id - TODO: add parameter to swagger.json
|
|
1784
1784
|
* @param options - additional request options
|
|
1785
1785
|
*/
|
|
1786
|
-
get_delivery_order(order_id: string, options?:
|
|
1786
|
+
get_delivery_order<Options extends RequestOptions>(order_id: string, options?: Options): ResponseType<GetDeliveryOrderResponse, Options>;
|
|
1787
1787
|
/**
|
|
1788
1788
|
* POST /schedule - Create a new schedule
|
|
1789
1789
|
*
|
|
1790
1790
|
* @param body
|
|
1791
1791
|
* @param options - additional request options
|
|
1792
1792
|
*/
|
|
1793
|
-
post_schedule(body: PostScheduleBody, options?:
|
|
1793
|
+
post_schedule<Options extends RequestOptions>(body: PostScheduleBody, options?: Options): ResponseType<PostScheduleResponse, Options>;
|
|
1794
1794
|
/**
|
|
1795
1795
|
* GET /schedule - Get schedule
|
|
1796
1796
|
*
|
|
1797
1797
|
* @param options - additional request options
|
|
1798
1798
|
*/
|
|
1799
|
-
get_schedules(options: {
|
|
1799
|
+
get_schedules<Options extends RequestOptions>(options: {
|
|
1800
1800
|
query: GetSchedulesQuery;
|
|
1801
|
-
} &
|
|
1801
|
+
} & Options): ResponseType<GetSchedulesResponse, Options>;
|
|
1802
1802
|
/**
|
|
1803
1803
|
* GET /schedule/{id} - Get an individual schedule
|
|
1804
1804
|
*
|
|
1805
1805
|
* @param id - schedule id
|
|
1806
1806
|
* @param options - additional request options
|
|
1807
1807
|
*/
|
|
1808
|
-
get_schedule(id: string, options?:
|
|
1808
|
+
get_schedule<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetScheduleResponse, Options>;
|
|
1809
1809
|
/**
|
|
1810
1810
|
* PUT /schedule/{id} - Update a schedule
|
|
1811
1811
|
*
|
|
@@ -1813,59 +1813,59 @@ export declare class ServiceClient extends BaseServiceClient {
|
|
|
1813
1813
|
* @param body
|
|
1814
1814
|
* @param options - additional request options
|
|
1815
1815
|
*/
|
|
1816
|
-
put_schedule(id: string, body: PutScheduleBody, options?:
|
|
1816
|
+
put_schedule<Options extends RequestOptions>(id: string, body: PutScheduleBody, options?: Options): ResponseType<PutScheduleResponse, Options>;
|
|
1817
1817
|
/**
|
|
1818
1818
|
* DELETE /schedule/{id} - Delete schedule
|
|
1819
1819
|
*
|
|
1820
1820
|
* @param id - Id of a schedule
|
|
1821
1821
|
* @param options - additional request options
|
|
1822
1822
|
*/
|
|
1823
|
-
delete_schedule(id: string, options?:
|
|
1823
|
+
delete_schedule<Options extends RequestOptions>(id: string, options?: Options): ResponseType<DeleteScheduleResponse, Options>;
|
|
1824
1824
|
/**
|
|
1825
1825
|
* POST /vote - Submit a vote for an item
|
|
1826
1826
|
*
|
|
1827
1827
|
* @param body
|
|
1828
1828
|
* @param options - additional request options
|
|
1829
1829
|
*/
|
|
1830
|
-
post_vote(body: PostVoteBody, options?:
|
|
1830
|
+
post_vote<Options extends RequestOptions>(body: PostVoteBody, options?: Options): ResponseType<PostVoteResponse, Options>;
|
|
1831
1831
|
/**
|
|
1832
1832
|
* GET /vote/idfa/{idfa} - Get votes for an idfa
|
|
1833
1833
|
*
|
|
1834
1834
|
* @param idfa - TODO: add parameter to swagger.json
|
|
1835
1835
|
* @param options - additional request options
|
|
1836
1836
|
*/
|
|
1837
|
-
get_vote_idfa(idfa: string, options?: {
|
|
1837
|
+
get_vote_idfa<Options extends RequestOptions>(idfa: string, options?: {
|
|
1838
1838
|
query?: GetVoteIdfaQuery;
|
|
1839
|
-
} &
|
|
1839
|
+
} & Options): ResponseType<GetVoteIdfaResponse, Options>;
|
|
1840
1840
|
/**
|
|
1841
1841
|
* POST /file - Upload a file to CDL S3
|
|
1842
1842
|
*
|
|
1843
1843
|
* @param body
|
|
1844
1844
|
* @param options - additional request options
|
|
1845
1845
|
*/
|
|
1846
|
-
post_file(body: PostFileBody, options?:
|
|
1846
|
+
post_file<Options extends RequestOptions>(body: PostFileBody, options?: Options): ResponseType<PostFileResponse, Options>;
|
|
1847
1847
|
/**
|
|
1848
1848
|
* POST /message - Create a Message
|
|
1849
1849
|
*
|
|
1850
1850
|
* @param body - Message object that needs to be created
|
|
1851
1851
|
* @param options - additional request options
|
|
1852
1852
|
*/
|
|
1853
|
-
post_message(body: PostMessageBody, options?:
|
|
1853
|
+
post_message<Options extends RequestOptions>(body: PostMessageBody, options?: Options): ResponseType<PostMessageResponse, Options>;
|
|
1854
1854
|
/**
|
|
1855
1855
|
* GET /message/{id} - Get a Message
|
|
1856
1856
|
*
|
|
1857
1857
|
* @param id - Message CDL encoded id
|
|
1858
1858
|
* @param options - additional request options
|
|
1859
1859
|
*/
|
|
1860
|
-
get_message(id: string, options?:
|
|
1860
|
+
get_message<Options extends RequestOptions>(id: string, options?: Options): ResponseType<GetMessageResponse, Options>;
|
|
1861
1861
|
/**
|
|
1862
1862
|
* GET /logger/{id}/brand/status - Get status changes of all brands
|
|
1863
1863
|
*
|
|
1864
1864
|
* @param id - action
|
|
1865
1865
|
* @param options - additional request options
|
|
1866
1866
|
*/
|
|
1867
|
-
get_logger_brand_status(id: string, options?: {
|
|
1867
|
+
get_logger_brand_status<Options extends RequestOptions>(id: string, options?: {
|
|
1868
1868
|
query?: GetLoggerBrandStatusQuery;
|
|
1869
|
-
} &
|
|
1869
|
+
} & Options): ResponseType<GetLoggerBrandStatusResponse, Options>;
|
|
1870
1870
|
}
|
|
1871
1871
|
//# sourceMappingURL=index.d.ts.map
|