@teemill/platform 0.33.1 → 0.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -4
- package/api.ts +211 -2152
- package/base.ts +1 -25
- package/common.ts +1 -2
- package/configuration.ts +1 -18
- package/dist/api.d.ts +128 -2155
- package/dist/api.js +123 -131
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -18
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +128 -2155
- package/dist/esm/api.js +123 -131
- package/dist/esm/base.d.ts +1 -25
- package/dist/esm/base.js +1 -20
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -18
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CustomersApi.md +81 -0
- package/docs/InlineObject1.md +4 -2
- package/docs/InlineObject2.md +20 -0
- package/docs/ListCustomerTags200Response.md +22 -0
- package/docs/ListDomains200Response.md +22 -0
- package/docs/PaymentApi.md +2 -2
- package/docs/Platform.md +2 -0
- package/docs/PlatformApi.md +4 -4
- package/docs/UpdatePlatformRequest.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.35.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -15,107 +15,52 @@ import type { RequestArgs } from './base';
|
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
16
|
/**
|
|
17
17
|
* A person\'s address.
|
|
18
|
-
* @export
|
|
19
|
-
* @interface Address
|
|
20
18
|
*/
|
|
21
19
|
export interface Address {
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof Address
|
|
26
|
-
*/
|
|
27
20
|
'contactName': string;
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @type {string}
|
|
31
|
-
* @memberof Address
|
|
32
|
-
*/
|
|
33
21
|
'company'?: string;
|
|
34
22
|
/**
|
|
35
23
|
* First line of the address.
|
|
36
|
-
* @type {string}
|
|
37
|
-
* @memberof Address
|
|
38
24
|
*/
|
|
39
25
|
'line1': string;
|
|
40
26
|
/**
|
|
41
27
|
* Second line of the address.
|
|
42
|
-
* @type {string}
|
|
43
|
-
* @memberof Address
|
|
44
28
|
*/
|
|
45
29
|
'line2'?: string;
|
|
46
30
|
/**
|
|
47
31
|
* City of the address.
|
|
48
|
-
* @type {string}
|
|
49
|
-
* @memberof Address
|
|
50
32
|
*/
|
|
51
33
|
'city': string;
|
|
52
34
|
/**
|
|
53
35
|
* Postal code of the address.
|
|
54
|
-
* @type {string}
|
|
55
|
-
* @memberof Address
|
|
56
36
|
*/
|
|
57
37
|
'postalCode'?: string;
|
|
58
38
|
/**
|
|
59
39
|
* Country of the address (ISO 3166-1 alpha-2).
|
|
60
|
-
* @type {string}
|
|
61
|
-
* @memberof Address
|
|
62
40
|
*/
|
|
63
41
|
'country': string;
|
|
64
42
|
/**
|
|
65
43
|
* State of the address.
|
|
66
|
-
* @type {string}
|
|
67
|
-
* @memberof Address
|
|
68
44
|
*/
|
|
69
45
|
'state'?: string;
|
|
70
46
|
}
|
|
71
|
-
/**
|
|
72
|
-
*
|
|
73
|
-
* @export
|
|
74
|
-
* @interface AmendOrderRequest
|
|
75
|
-
*/
|
|
76
47
|
export interface AmendOrderRequest {
|
|
77
|
-
/**
|
|
78
|
-
*
|
|
79
|
-
* @type {Array<AmendOrderRequestAmendmentsInner>}
|
|
80
|
-
* @memberof AmendOrderRequest
|
|
81
|
-
*/
|
|
82
48
|
'amendments': Array<AmendOrderRequestAmendmentsInner>;
|
|
83
49
|
}
|
|
84
|
-
/**
|
|
85
|
-
*
|
|
86
|
-
* @export
|
|
87
|
-
* @interface AmendOrderRequestAmendmentsInner
|
|
88
|
-
*/
|
|
89
50
|
export interface AmendOrderRequestAmendmentsInner {
|
|
90
51
|
/**
|
|
91
52
|
* Unique order item identifier
|
|
92
|
-
* @type {string}
|
|
93
|
-
* @memberof AmendOrderRequestAmendmentsInner
|
|
94
53
|
*/
|
|
95
54
|
'id': string;
|
|
96
|
-
/**
|
|
97
|
-
*
|
|
98
|
-
* @type {string}
|
|
99
|
-
* @memberof AmendOrderRequestAmendmentsInner
|
|
100
|
-
*/
|
|
101
55
|
'action': AmendOrderRequestAmendmentsInnerActionEnum;
|
|
102
56
|
/**
|
|
103
57
|
* The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order.
|
|
104
|
-
* @type {number}
|
|
105
|
-
* @memberof AmendOrderRequestAmendmentsInner
|
|
106
58
|
*/
|
|
107
59
|
'quantity': number;
|
|
108
60
|
/**
|
|
109
61
|
* A reference to the variant being ordered
|
|
110
|
-
* @type {string}
|
|
111
|
-
* @memberof AmendOrderRequestAmendmentsInner
|
|
112
62
|
*/
|
|
113
63
|
'newVariantRef'?: string;
|
|
114
|
-
/**
|
|
115
|
-
*
|
|
116
|
-
* @type {AmendOrderRequestAmendmentsInnerReason}
|
|
117
|
-
* @memberof AmendOrderRequestAmendmentsInner
|
|
118
|
-
*/
|
|
119
64
|
'reason': AmendOrderRequestAmendmentsInnerReason;
|
|
120
65
|
}
|
|
121
66
|
export declare const AmendOrderRequestAmendmentsInnerActionEnum: {
|
|
@@ -123,65 +68,33 @@ export declare const AmendOrderRequestAmendmentsInnerActionEnum: {
|
|
|
123
68
|
readonly Exchange: "exchange";
|
|
124
69
|
};
|
|
125
70
|
export type AmendOrderRequestAmendmentsInnerActionEnum = typeof AmendOrderRequestAmendmentsInnerActionEnum[keyof typeof AmendOrderRequestAmendmentsInnerActionEnum];
|
|
126
|
-
/**
|
|
127
|
-
*
|
|
128
|
-
* @export
|
|
129
|
-
* @interface AmendOrderRequestAmendmentsInnerReason
|
|
130
|
-
*/
|
|
131
71
|
export interface AmendOrderRequestAmendmentsInnerReason {
|
|
132
72
|
/**
|
|
133
73
|
* A reference to the resource location
|
|
134
|
-
* @type {string}
|
|
135
|
-
* @memberof AmendOrderRequestAmendmentsInnerReason
|
|
136
74
|
*/
|
|
137
75
|
'reasonRef': string;
|
|
138
76
|
/**
|
|
139
77
|
* Additional comments as to why the item is being returned or exchanged.
|
|
140
|
-
* @type {string}
|
|
141
|
-
* @memberof AmendOrderRequestAmendmentsInnerReason
|
|
142
78
|
*/
|
|
143
79
|
'additionalComments'?: string | null;
|
|
144
80
|
}
|
|
145
|
-
/**
|
|
146
|
-
*
|
|
147
|
-
* @export
|
|
148
|
-
* @interface AmendmentLog
|
|
149
|
-
*/
|
|
150
81
|
export interface AmendmentLog {
|
|
151
82
|
/**
|
|
152
83
|
* Unique object identifier
|
|
153
|
-
* @type {string}
|
|
154
|
-
* @memberof AmendmentLog
|
|
155
84
|
*/
|
|
156
85
|
'id': string;
|
|
157
86
|
/**
|
|
158
87
|
* A reference to the order item that was amended.
|
|
159
|
-
* @type {string}
|
|
160
|
-
* @memberof AmendmentLog
|
|
161
88
|
*/
|
|
162
89
|
'orderItemId': string;
|
|
163
90
|
/**
|
|
164
91
|
* A reference to the top level order item that was amended, useful for finding the original item within a chain of exchanges, for example.
|
|
165
|
-
* @type {string}
|
|
166
|
-
* @memberof AmendmentLog
|
|
167
92
|
*/
|
|
168
93
|
'originalOrderItemId': string;
|
|
169
|
-
/**
|
|
170
|
-
*
|
|
171
|
-
* @type {string}
|
|
172
|
-
* @memberof AmendmentLog
|
|
173
|
-
*/
|
|
174
94
|
'amendmentType': AmendmentLogAmendmentTypeEnum;
|
|
175
|
-
/**
|
|
176
|
-
*
|
|
177
|
-
* @type {number}
|
|
178
|
-
* @memberof AmendmentLog
|
|
179
|
-
*/
|
|
180
95
|
'quantity': number;
|
|
181
96
|
/**
|
|
182
97
|
* ISO 8601 Timestamp
|
|
183
|
-
* @type {string}
|
|
184
|
-
* @memberof AmendmentLog
|
|
185
98
|
*/
|
|
186
99
|
'createdAt': string;
|
|
187
100
|
}
|
|
@@ -190,489 +103,197 @@ export declare const AmendmentLogAmendmentTypeEnum: {
|
|
|
190
103
|
readonly Exchange: "exchange";
|
|
191
104
|
};
|
|
192
105
|
export type AmendmentLogAmendmentTypeEnum = typeof AmendmentLogAmendmentTypeEnum[keyof typeof AmendmentLogAmendmentTypeEnum];
|
|
193
|
-
/**
|
|
194
|
-
*
|
|
195
|
-
* @export
|
|
196
|
-
* @interface ApiError
|
|
197
|
-
*/
|
|
198
106
|
export interface ApiError {
|
|
199
|
-
/**
|
|
200
|
-
*
|
|
201
|
-
* @type {string}
|
|
202
|
-
* @memberof ApiError
|
|
203
|
-
*/
|
|
204
107
|
'code'?: string;
|
|
205
|
-
/**
|
|
206
|
-
*
|
|
207
|
-
* @type {string}
|
|
208
|
-
* @memberof ApiError
|
|
209
|
-
*/
|
|
210
108
|
'message': string;
|
|
211
109
|
}
|
|
212
|
-
|
|
213
|
-
*
|
|
214
|
-
* @export
|
|
215
|
-
* @interface BulkCreateReviewPayload
|
|
216
|
-
*/
|
|
217
|
-
export interface BulkCreateReviewPayload {
|
|
110
|
+
export interface AuthorizeStripe200Response {
|
|
218
111
|
/**
|
|
219
|
-
*
|
|
220
|
-
* @type {Array<CreateReviewPayload>}
|
|
221
|
-
* @memberof BulkCreateReviewPayload
|
|
112
|
+
* The URL to redirect to
|
|
222
113
|
*/
|
|
114
|
+
'redirect_url': string;
|
|
115
|
+
}
|
|
116
|
+
export interface BulkCreateReviewPayload {
|
|
223
117
|
'reviews': Array<CreateReviewPayload>;
|
|
224
118
|
}
|
|
225
|
-
/**
|
|
226
|
-
*
|
|
227
|
-
* @export
|
|
228
|
-
* @interface BulkCreatedReviews
|
|
229
|
-
*/
|
|
230
119
|
export interface BulkCreatedReviews {
|
|
231
|
-
/**
|
|
232
|
-
*
|
|
233
|
-
* @type {Array<Review>}
|
|
234
|
-
* @memberof BulkCreatedReviews
|
|
235
|
-
*/
|
|
236
120
|
'reviews': Array<Review>;
|
|
237
121
|
}
|
|
238
|
-
/**
|
|
239
|
-
*
|
|
240
|
-
* @export
|
|
241
|
-
* @interface Client
|
|
242
|
-
*/
|
|
243
122
|
export interface Client {
|
|
244
|
-
/**
|
|
245
|
-
*
|
|
246
|
-
* @type {string}
|
|
247
|
-
* @memberof Client
|
|
248
|
-
*/
|
|
249
123
|
'id'?: string;
|
|
250
124
|
/**
|
|
251
125
|
* API reference for the client
|
|
252
|
-
* @type {string}
|
|
253
|
-
* @memberof Client
|
|
254
126
|
*/
|
|
255
127
|
'ref'?: string;
|
|
256
|
-
/**
|
|
257
|
-
*
|
|
258
|
-
* @type {string}
|
|
259
|
-
* @memberof Client
|
|
260
|
-
*/
|
|
261
128
|
'name'?: string;
|
|
262
129
|
}
|
|
263
|
-
/**
|
|
264
|
-
*
|
|
265
|
-
* @export
|
|
266
|
-
* @interface ConfirmOrderFulfillment
|
|
267
|
-
*/
|
|
268
130
|
export interface ConfirmOrderFulfillment {
|
|
269
131
|
/**
|
|
270
132
|
* Unique object identifier
|
|
271
|
-
* @type {string}
|
|
272
|
-
* @memberof ConfirmOrderFulfillment
|
|
273
133
|
*/
|
|
274
134
|
'fulfillmentId': string;
|
|
275
135
|
/**
|
|
276
136
|
* Unique object identifier
|
|
277
|
-
* @type {string}
|
|
278
|
-
* @memberof ConfirmOrderFulfillment
|
|
279
137
|
*/
|
|
280
138
|
'shippingMethodId'?: string;
|
|
281
|
-
/**
|
|
282
|
-
*
|
|
283
|
-
* @type {ConfirmOrderFulfillmentShipment}
|
|
284
|
-
* @memberof ConfirmOrderFulfillment
|
|
285
|
-
*/
|
|
286
139
|
'shipment'?: ConfirmOrderFulfillmentShipment;
|
|
287
140
|
}
|
|
288
141
|
/**
|
|
289
142
|
* This field is only required if you are using your own shipping label.
|
|
290
|
-
* @export
|
|
291
|
-
* @interface ConfirmOrderFulfillmentShipment
|
|
292
143
|
*/
|
|
293
144
|
export interface ConfirmOrderFulfillmentShipment {
|
|
294
145
|
/**
|
|
295
146
|
* Only required if you are generating shipping labels outside of PodOS
|
|
296
|
-
* @type {string}
|
|
297
|
-
* @memberof ConfirmOrderFulfillmentShipment
|
|
298
147
|
*/
|
|
299
148
|
'image': string;
|
|
300
149
|
}
|
|
301
|
-
/**
|
|
302
|
-
*
|
|
303
|
-
* @export
|
|
304
|
-
* @interface ConfirmOrderRequest
|
|
305
|
-
*/
|
|
306
150
|
export interface ConfirmOrderRequest {
|
|
307
|
-
/**
|
|
308
|
-
*
|
|
309
|
-
* @type {Array<ConfirmOrderFulfillment>}
|
|
310
|
-
* @memberof ConfirmOrderRequest
|
|
311
|
-
*/
|
|
312
151
|
'fulfillments': Array<ConfirmOrderFulfillment>;
|
|
313
152
|
}
|
|
314
153
|
/**
|
|
315
154
|
* Order recipient contact information, used only for courier tracking/updates.
|
|
316
|
-
* @export
|
|
317
|
-
* @interface ContactInformation
|
|
318
155
|
*/
|
|
319
156
|
export interface ContactInformation {
|
|
320
|
-
/**
|
|
321
|
-
*
|
|
322
|
-
* @type {string}
|
|
323
|
-
* @memberof ContactInformation
|
|
324
|
-
*/
|
|
325
157
|
'email': string;
|
|
326
|
-
/**
|
|
327
|
-
*
|
|
328
|
-
* @type {string}
|
|
329
|
-
* @memberof ContactInformation
|
|
330
|
-
*/
|
|
331
158
|
'phone'?: string | null;
|
|
332
159
|
}
|
|
333
|
-
/**
|
|
334
|
-
*
|
|
335
|
-
* @export
|
|
336
|
-
* @interface Coupon
|
|
337
|
-
*/
|
|
338
160
|
export interface Coupon {
|
|
339
161
|
/**
|
|
340
162
|
* Unique object identifier
|
|
341
|
-
* @type {string}
|
|
342
|
-
* @memberof Coupon
|
|
343
163
|
*/
|
|
344
164
|
'id': string;
|
|
345
|
-
/**
|
|
346
|
-
*
|
|
347
|
-
* @type {string}
|
|
348
|
-
* @memberof Coupon
|
|
349
|
-
*/
|
|
350
165
|
'code': string;
|
|
351
166
|
}
|
|
352
|
-
/**
|
|
353
|
-
*
|
|
354
|
-
* @export
|
|
355
|
-
* @interface CreateChatChannel200Response
|
|
356
|
-
*/
|
|
357
167
|
export interface CreateChatChannel200Response {
|
|
358
168
|
/**
|
|
359
169
|
* Reference to the chat channel resource
|
|
360
|
-
* @type {string}
|
|
361
|
-
* @memberof CreateChatChannel200Response
|
|
362
170
|
*/
|
|
363
171
|
'chatChannelRef': string;
|
|
364
172
|
}
|
|
365
|
-
/**
|
|
366
|
-
*
|
|
367
|
-
* @export
|
|
368
|
-
* @interface CreateDomainRequest
|
|
369
|
-
*/
|
|
370
173
|
export interface CreateDomainRequest {
|
|
371
|
-
/**
|
|
372
|
-
*
|
|
373
|
-
* @type {string}
|
|
374
|
-
* @memberof CreateDomainRequest
|
|
375
|
-
*/
|
|
376
174
|
'domain'?: string;
|
|
377
175
|
}
|
|
378
176
|
/**
|
|
379
177
|
* Create an order
|
|
380
|
-
* @export
|
|
381
|
-
* @interface CreateOrder
|
|
382
178
|
*/
|
|
383
179
|
export interface CreateOrder {
|
|
384
180
|
/**
|
|
385
181
|
* A custom reference to the merchant\'s order.
|
|
386
|
-
* @type {string}
|
|
387
|
-
* @memberof CreateOrder
|
|
388
182
|
*/
|
|
389
183
|
'merchantReference'?: string | null;
|
|
390
|
-
/**
|
|
391
|
-
*
|
|
392
|
-
* @type {CreateOrderContactInformation}
|
|
393
|
-
* @memberof CreateOrder
|
|
394
|
-
*/
|
|
395
184
|
'contactInformation': CreateOrderContactInformation;
|
|
396
|
-
/**
|
|
397
|
-
*
|
|
398
|
-
* @type {Address}
|
|
399
|
-
* @memberof CreateOrder
|
|
400
|
-
*/
|
|
401
185
|
'shippingAddress': Address;
|
|
402
|
-
/**
|
|
403
|
-
*
|
|
404
|
-
* @type {CustomsInformation}
|
|
405
|
-
* @memberof CreateOrder
|
|
406
|
-
*/
|
|
407
186
|
'customsInformation'?: CustomsInformation;
|
|
408
187
|
/**
|
|
409
188
|
* Items to be ordered
|
|
410
|
-
* @type {Array<OrderItem1>}
|
|
411
|
-
* @memberof CreateOrder
|
|
412
189
|
*/
|
|
413
190
|
'items': Array<OrderItem1>;
|
|
414
|
-
/**
|
|
415
|
-
*
|
|
416
|
-
* @type {Array<string>}
|
|
417
|
-
* @memberof CreateOrder
|
|
418
|
-
*/
|
|
419
191
|
'preferredFulfillers'?: Array<string>;
|
|
420
192
|
/**
|
|
421
193
|
* A reference to the resource location
|
|
422
|
-
* @type {string}
|
|
423
|
-
* @memberof CreateOrder
|
|
424
194
|
*/
|
|
425
195
|
'originalOrderRef'?: string;
|
|
426
196
|
}
|
|
427
197
|
/**
|
|
428
198
|
* Contact information for the order
|
|
429
|
-
* @export
|
|
430
|
-
* @interface CreateOrderContactInformation
|
|
431
199
|
*/
|
|
432
200
|
export interface CreateOrderContactInformation {
|
|
433
|
-
/**
|
|
434
|
-
*
|
|
435
|
-
* @type {string}
|
|
436
|
-
* @memberof CreateOrderContactInformation
|
|
437
|
-
*/
|
|
438
201
|
'email': string;
|
|
439
|
-
/**
|
|
440
|
-
*
|
|
441
|
-
* @type {string}
|
|
442
|
-
* @memberof CreateOrderContactInformation
|
|
443
|
-
*/
|
|
444
202
|
'phone'?: string | null;
|
|
445
203
|
}
|
|
446
|
-
/**
|
|
447
|
-
*
|
|
448
|
-
* @export
|
|
449
|
-
* @interface CreatePixelRequest
|
|
450
|
-
*/
|
|
451
204
|
export interface CreatePixelRequest {
|
|
452
|
-
/**
|
|
453
|
-
*
|
|
454
|
-
* @type {string}
|
|
455
|
-
* @memberof CreatePixelRequest
|
|
456
|
-
*/
|
|
457
205
|
'name': string;
|
|
458
|
-
/**
|
|
459
|
-
*
|
|
460
|
-
* @type {Array<string>}
|
|
461
|
-
* @memberof CreatePixelRequest
|
|
462
|
-
*/
|
|
463
206
|
'sourceProjects': Array<string>;
|
|
464
|
-
/**
|
|
465
|
-
*
|
|
466
|
-
* @type {CreatePixelRequestFilters}
|
|
467
|
-
* @memberof CreatePixelRequest
|
|
468
|
-
*/
|
|
469
207
|
'filters': CreatePixelRequestFilters;
|
|
470
208
|
}
|
|
471
|
-
/**
|
|
472
|
-
*
|
|
473
|
-
* @export
|
|
474
|
-
* @interface CreatePixelRequestFilters
|
|
475
|
-
*/
|
|
476
209
|
export interface CreatePixelRequestFilters {
|
|
477
|
-
/**
|
|
478
|
-
*
|
|
479
|
-
* @type {Array<string>}
|
|
480
|
-
* @memberof CreatePixelRequestFilters
|
|
481
|
-
*/
|
|
482
210
|
'projects': Array<string> | null;
|
|
483
|
-
/**
|
|
484
|
-
*
|
|
485
|
-
* @type {Array<string>}
|
|
486
|
-
* @memberof CreatePixelRequestFilters
|
|
487
|
-
*/
|
|
488
211
|
'demographics': Array<string> | null;
|
|
489
|
-
/**
|
|
490
|
-
*
|
|
491
|
-
* @type {Array<string>}
|
|
492
|
-
* @memberof CreatePixelRequestFilters
|
|
493
|
-
*/
|
|
494
212
|
'tags': Array<string> | null;
|
|
495
213
|
}
|
|
496
214
|
/**
|
|
497
215
|
* @type CreateReview201Response
|
|
498
|
-
* @export
|
|
499
216
|
*/
|
|
500
217
|
export type CreateReview201Response = BulkCreatedReviews | Review;
|
|
501
|
-
/**
|
|
502
|
-
*
|
|
503
|
-
* @export
|
|
504
|
-
* @interface CreateReviewPayload
|
|
505
|
-
*/
|
|
506
218
|
export interface CreateReviewPayload {
|
|
507
|
-
/**
|
|
508
|
-
*
|
|
509
|
-
* @type {CreateReviewPayloadAuthor}
|
|
510
|
-
* @memberof CreateReviewPayload
|
|
511
|
-
*/
|
|
512
219
|
'author': CreateReviewPayloadAuthor;
|
|
513
220
|
/**
|
|
514
221
|
* The title of the review
|
|
515
|
-
* @type {string}
|
|
516
|
-
* @memberof CreateReviewPayload
|
|
517
222
|
*/
|
|
518
223
|
'title'?: string;
|
|
519
224
|
/**
|
|
520
225
|
* The text of the review
|
|
521
|
-
* @type {string}
|
|
522
|
-
* @memberof CreateReviewPayload
|
|
523
226
|
*/
|
|
524
227
|
'text': string;
|
|
525
228
|
/**
|
|
526
229
|
* A reference to the product being ordered
|
|
527
|
-
* @type {string}
|
|
528
|
-
* @memberof CreateReviewPayload
|
|
529
230
|
*/
|
|
530
231
|
'productRef': string;
|
|
531
232
|
/**
|
|
532
233
|
* The rating of the review
|
|
533
|
-
* @type {number}
|
|
534
|
-
* @memberof CreateReviewPayload
|
|
535
234
|
*/
|
|
536
235
|
'rating': number;
|
|
537
|
-
/**
|
|
538
|
-
*
|
|
539
|
-
* @type {Array<Image>}
|
|
540
|
-
* @memberof CreateReviewPayload
|
|
541
|
-
*/
|
|
542
236
|
'images'?: Array<Image>;
|
|
543
237
|
/**
|
|
544
238
|
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
545
|
-
* @type {boolean}
|
|
546
|
-
* @memberof CreateReviewPayload
|
|
547
239
|
*/
|
|
548
240
|
'enabled': boolean;
|
|
549
241
|
/**
|
|
550
242
|
* A reference to the project being ordered
|
|
551
|
-
* @type {string}
|
|
552
|
-
* @memberof CreateReviewPayload
|
|
553
243
|
*/
|
|
554
244
|
'projectRef': string;
|
|
555
245
|
}
|
|
556
|
-
/**
|
|
557
|
-
*
|
|
558
|
-
* @export
|
|
559
|
-
* @interface CreateReviewPayloadAuthor
|
|
560
|
-
*/
|
|
561
246
|
export interface CreateReviewPayloadAuthor {
|
|
562
247
|
/**
|
|
563
248
|
* The name of the author
|
|
564
|
-
* @type {string}
|
|
565
|
-
* @memberof CreateReviewPayloadAuthor
|
|
566
249
|
*/
|
|
567
250
|
'name'?: string;
|
|
568
251
|
/**
|
|
569
252
|
* The email of the author
|
|
570
|
-
* @type {string}
|
|
571
|
-
* @memberof CreateReviewPayloadAuthor
|
|
572
253
|
*/
|
|
573
254
|
'email'?: string;
|
|
574
255
|
}
|
|
575
256
|
/**
|
|
576
257
|
* @type CreateReviewRequest
|
|
577
|
-
* @export
|
|
578
258
|
*/
|
|
579
259
|
export type CreateReviewRequest = BulkCreateReviewPayload | CreateReviewPayload;
|
|
580
260
|
/**
|
|
581
261
|
* The customer that has placed an order on your platform
|
|
582
|
-
* @export
|
|
583
|
-
* @interface Customer
|
|
584
262
|
*/
|
|
585
263
|
export interface Customer {
|
|
586
264
|
/**
|
|
587
265
|
* Unique object identifier
|
|
588
|
-
* @type {string}
|
|
589
|
-
* @memberof Customer
|
|
590
266
|
*/
|
|
591
267
|
'id': string;
|
|
592
|
-
/**
|
|
593
|
-
*
|
|
594
|
-
* @type {string}
|
|
595
|
-
* @memberof Customer
|
|
596
|
-
*/
|
|
597
268
|
'email': string;
|
|
598
|
-
/**
|
|
599
|
-
*
|
|
600
|
-
* @type {string}
|
|
601
|
-
* @memberof Customer
|
|
602
|
-
*/
|
|
603
269
|
'firstName': string;
|
|
604
|
-
/**
|
|
605
|
-
*
|
|
606
|
-
* @type {string}
|
|
607
|
-
* @memberof Customer
|
|
608
|
-
*/
|
|
609
270
|
'lastName': string;
|
|
610
|
-
/**
|
|
611
|
-
*
|
|
612
|
-
* @type {string}
|
|
613
|
-
* @memberof Customer
|
|
614
|
-
*/
|
|
615
271
|
'gender': string | null;
|
|
616
|
-
/**
|
|
617
|
-
*
|
|
618
|
-
* @type {string}
|
|
619
|
-
* @memberof Customer
|
|
620
|
-
*/
|
|
621
272
|
'country': string | null;
|
|
622
|
-
/**
|
|
623
|
-
*
|
|
624
|
-
* @type {Statistics}
|
|
625
|
-
* @memberof Customer
|
|
626
|
-
*/
|
|
627
273
|
'statistics': Statistics;
|
|
628
274
|
}
|
|
629
|
-
/**
|
|
630
|
-
*
|
|
631
|
-
* @export
|
|
632
|
-
* @interface CustomersResponse
|
|
633
|
-
*/
|
|
634
275
|
export interface CustomersResponse {
|
|
635
|
-
/**
|
|
636
|
-
*
|
|
637
|
-
* @type {Array<Customer>}
|
|
638
|
-
* @memberof CustomersResponse
|
|
639
|
-
*/
|
|
640
276
|
'customers': Array<Customer>;
|
|
641
|
-
/**
|
|
642
|
-
*
|
|
643
|
-
* @type {number}
|
|
644
|
-
* @memberof CustomersResponse
|
|
645
|
-
*/
|
|
646
277
|
'nextPageToken'?: number | null;
|
|
647
278
|
}
|
|
648
279
|
/**
|
|
649
280
|
* Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
|
|
650
|
-
* @export
|
|
651
|
-
* @interface CustomsInformation
|
|
652
281
|
*/
|
|
653
282
|
export interface CustomsInformation {
|
|
654
283
|
/**
|
|
655
284
|
* Pre-registration type
|
|
656
|
-
* @type {string}
|
|
657
|
-
* @memberof CustomsInformation
|
|
658
285
|
*/
|
|
659
286
|
'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
|
|
660
287
|
/**
|
|
661
288
|
* Pre-registration number
|
|
662
|
-
* @type {string}
|
|
663
|
-
* @memberof CustomsInformation
|
|
664
289
|
*/
|
|
665
290
|
'preRegistrationNumber'?: string;
|
|
666
291
|
/**
|
|
667
292
|
* VAT number
|
|
668
|
-
* @type {string}
|
|
669
|
-
* @memberof CustomsInformation
|
|
670
293
|
*/
|
|
671
294
|
'vatNumber'?: string;
|
|
672
295
|
/**
|
|
673
296
|
* EORI number
|
|
674
|
-
* @type {string}
|
|
675
|
-
* @memberof CustomsInformation
|
|
676
297
|
*/
|
|
677
298
|
'eoriNumber'?: string;
|
|
678
299
|
}
|
|
@@ -680,189 +301,54 @@ export declare const CustomsInformationPreRegistrationTypeEnum: {
|
|
|
680
301
|
readonly Ioss: "IOSS";
|
|
681
302
|
};
|
|
682
303
|
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
683
|
-
/**
|
|
684
|
-
*
|
|
685
|
-
* @export
|
|
686
|
-
* @interface DashboardItem
|
|
687
|
-
*/
|
|
688
304
|
export interface DashboardItem {
|
|
689
|
-
/**
|
|
690
|
-
*
|
|
691
|
-
* @type {string}
|
|
692
|
-
* @memberof DashboardItem
|
|
693
|
-
*/
|
|
694
305
|
'id': string;
|
|
695
|
-
/**
|
|
696
|
-
*
|
|
697
|
-
* @type {string}
|
|
698
|
-
* @memberof DashboardItem
|
|
699
|
-
*/
|
|
700
306
|
'type': string;
|
|
701
|
-
/**
|
|
702
|
-
*
|
|
703
|
-
* @type {{ [key: string]: any; }}
|
|
704
|
-
* @memberof DashboardItem
|
|
705
|
-
*/
|
|
706
307
|
'properties': {
|
|
707
308
|
[key: string]: any;
|
|
708
309
|
} | null;
|
|
709
|
-
/**
|
|
710
|
-
*
|
|
711
|
-
* @type {boolean}
|
|
712
|
-
* @memberof DashboardItem
|
|
713
|
-
*/
|
|
714
310
|
'published': boolean;
|
|
715
|
-
/**
|
|
716
|
-
*
|
|
717
|
-
* @type {number}
|
|
718
|
-
* @memberof DashboardItem
|
|
719
|
-
*/
|
|
720
311
|
'sortOrder': number;
|
|
721
|
-
/**
|
|
722
|
-
*
|
|
723
|
-
* @type {Array<DashboardItem>}
|
|
724
|
-
* @memberof DashboardItem
|
|
725
|
-
*/
|
|
726
312
|
'items'?: Array<DashboardItem> | null;
|
|
727
313
|
}
|
|
728
|
-
/**
|
|
729
|
-
*
|
|
730
|
-
* @export
|
|
731
|
-
* @interface DeliveryEstimates
|
|
732
|
-
*/
|
|
733
314
|
export interface DeliveryEstimates {
|
|
734
315
|
/**
|
|
735
316
|
* ISO 8601 Timestamp
|
|
736
|
-
* @type {string}
|
|
737
|
-
* @memberof DeliveryEstimates
|
|
738
317
|
*/
|
|
739
318
|
'min'?: string;
|
|
740
319
|
/**
|
|
741
320
|
* ISO 8601 Timestamp
|
|
742
|
-
* @type {string}
|
|
743
|
-
* @memberof DeliveryEstimates
|
|
744
321
|
*/
|
|
745
322
|
'max'?: string;
|
|
746
323
|
}
|
|
747
|
-
/**
|
|
748
|
-
*
|
|
749
|
-
* @export
|
|
750
|
-
* @interface Domain
|
|
751
|
-
*/
|
|
752
324
|
export interface Domain {
|
|
753
|
-
/**
|
|
754
|
-
*
|
|
755
|
-
* @type {number}
|
|
756
|
-
* @memberof Domain
|
|
757
|
-
*/
|
|
758
325
|
'id': number;
|
|
759
|
-
/**
|
|
760
|
-
*
|
|
761
|
-
* @type {string}
|
|
762
|
-
* @memberof Domain
|
|
763
|
-
*/
|
|
764
326
|
'name': string;
|
|
765
|
-
/**
|
|
766
|
-
*
|
|
767
|
-
* @type {number}
|
|
768
|
-
* @memberof Domain
|
|
769
|
-
*/
|
|
770
327
|
'priority': number;
|
|
771
|
-
/**
|
|
772
|
-
*
|
|
773
|
-
* @type {string}
|
|
774
|
-
* @memberof Domain
|
|
775
|
-
*/
|
|
776
328
|
'enabledAt': string | null;
|
|
777
329
|
}
|
|
778
|
-
/**
|
|
779
|
-
*
|
|
780
|
-
* @export
|
|
781
|
-
* @interface Enquiry
|
|
782
|
-
*/
|
|
783
330
|
export interface Enquiry {
|
|
784
|
-
/**
|
|
785
|
-
*
|
|
786
|
-
* @type {string}
|
|
787
|
-
* @memberof Enquiry
|
|
788
|
-
*/
|
|
789
331
|
'id': string;
|
|
790
332
|
/**
|
|
791
333
|
* API reference for the enquiry
|
|
792
|
-
* @type {string}
|
|
793
|
-
* @memberof Enquiry
|
|
794
334
|
*/
|
|
795
335
|
'ref': string;
|
|
796
|
-
/**
|
|
797
|
-
*
|
|
798
|
-
* @type {ListCustomerEnquiryLogs200ResponseLogsInnerCustomer}
|
|
799
|
-
* @memberof Enquiry
|
|
800
|
-
*/
|
|
801
336
|
'customer': ListCustomerEnquiryLogs200ResponseLogsInnerCustomer;
|
|
802
|
-
/**
|
|
803
|
-
*
|
|
804
|
-
* @type {Client}
|
|
805
|
-
* @memberof Enquiry
|
|
806
|
-
*/
|
|
807
337
|
'client': Client;
|
|
808
|
-
/**
|
|
809
|
-
*
|
|
810
|
-
* @type {string}
|
|
811
|
-
* @memberof Enquiry
|
|
812
|
-
*/
|
|
813
338
|
'subject': string;
|
|
814
|
-
/**
|
|
815
|
-
*
|
|
816
|
-
* @type {string}
|
|
817
|
-
* @memberof Enquiry
|
|
818
|
-
*/
|
|
819
339
|
'body': string;
|
|
820
|
-
/**
|
|
821
|
-
*
|
|
822
|
-
* @type {string}
|
|
823
|
-
* @memberof Enquiry
|
|
824
|
-
*/
|
|
825
340
|
'createdAt': string;
|
|
826
|
-
/**
|
|
827
|
-
*
|
|
828
|
-
* @type {string}
|
|
829
|
-
* @memberof Enquiry
|
|
830
|
-
*/
|
|
831
341
|
'updatedAt': string;
|
|
832
|
-
/**
|
|
833
|
-
*
|
|
834
|
-
* @type {Array<string>}
|
|
835
|
-
* @memberof Enquiry
|
|
836
|
-
*/
|
|
837
342
|
'tags': Array<string>;
|
|
838
|
-
/**
|
|
839
|
-
*
|
|
840
|
-
* @type {string}
|
|
841
|
-
* @memberof Enquiry
|
|
842
|
-
*/
|
|
843
343
|
'status': EnquiryStatusEnum;
|
|
844
|
-
/**
|
|
845
|
-
*
|
|
846
|
-
* @type {boolean}
|
|
847
|
-
* @memberof Enquiry
|
|
848
|
-
*/
|
|
849
344
|
'read': boolean;
|
|
850
|
-
/**
|
|
851
|
-
*
|
|
852
|
-
* @type {Array<EnquiryExtraInputsInner>}
|
|
853
|
-
* @memberof Enquiry
|
|
854
|
-
*/
|
|
855
345
|
'extraInputs': Array<EnquiryExtraInputsInner> | null;
|
|
856
346
|
/**
|
|
857
347
|
* Reference to the chat channel resource
|
|
858
|
-
* @type {string}
|
|
859
|
-
* @memberof Enquiry
|
|
860
348
|
*/
|
|
861
349
|
'chatChannelRef'?: string | null;
|
|
862
350
|
/**
|
|
863
351
|
* The unique id of the user who owns the enquiry
|
|
864
|
-
* @type {string}
|
|
865
|
-
* @memberof Enquiry
|
|
866
352
|
*/
|
|
867
353
|
'owner': string | null;
|
|
868
354
|
}
|
|
@@ -872,650 +358,225 @@ export declare const EnquiryStatusEnum: {
|
|
|
872
358
|
readonly Priority: "Priority";
|
|
873
359
|
};
|
|
874
360
|
export type EnquiryStatusEnum = typeof EnquiryStatusEnum[keyof typeof EnquiryStatusEnum];
|
|
875
|
-
/**
|
|
876
|
-
*
|
|
877
|
-
* @export
|
|
878
|
-
* @interface EnquiryExtraInputsInner
|
|
879
|
-
*/
|
|
880
361
|
export interface EnquiryExtraInputsInner {
|
|
881
|
-
/**
|
|
882
|
-
*
|
|
883
|
-
* @type {string}
|
|
884
|
-
* @memberof EnquiryExtraInputsInner
|
|
885
|
-
*/
|
|
886
362
|
'name': string;
|
|
887
|
-
/**
|
|
888
|
-
*
|
|
889
|
-
* @type {string}
|
|
890
|
-
* @memberof EnquiryExtraInputsInner
|
|
891
|
-
*/
|
|
892
363
|
'type': string;
|
|
893
|
-
/**
|
|
894
|
-
*
|
|
895
|
-
* @type {EnquiryExtraInputsInnerValue}
|
|
896
|
-
* @memberof EnquiryExtraInputsInner
|
|
897
|
-
*/
|
|
898
364
|
'value': EnquiryExtraInputsInnerValue;
|
|
899
365
|
}
|
|
900
366
|
/**
|
|
901
367
|
* @type EnquiryExtraInputsInnerValue
|
|
902
|
-
* @export
|
|
903
368
|
*/
|
|
904
369
|
export type EnquiryExtraInputsInnerValue = Array<string | null> | string;
|
|
905
|
-
/**
|
|
906
|
-
*
|
|
907
|
-
* @export
|
|
908
|
-
* @interface ExportOrders202Response
|
|
909
|
-
*/
|
|
910
370
|
export interface ExportOrders202Response {
|
|
911
371
|
/**
|
|
912
372
|
* A message describing the export status
|
|
913
|
-
* @type {string}
|
|
914
|
-
* @memberof ExportOrders202Response
|
|
915
373
|
*/
|
|
916
374
|
'message'?: string;
|
|
917
375
|
}
|
|
918
376
|
/**
|
|
919
377
|
* The fulfiller that will be processing this order.
|
|
920
|
-
* @export
|
|
921
|
-
* @interface Fulfiller
|
|
922
378
|
*/
|
|
923
379
|
export interface Fulfiller {
|
|
924
380
|
/**
|
|
925
381
|
* Unique object identifier
|
|
926
|
-
* @type {string}
|
|
927
|
-
* @memberof Fulfiller
|
|
928
382
|
*/
|
|
929
383
|
'id'?: string;
|
|
930
|
-
/**
|
|
931
|
-
*
|
|
932
|
-
* @type {FulfillerLocation}
|
|
933
|
-
* @memberof Fulfiller
|
|
934
|
-
*/
|
|
935
384
|
'location'?: FulfillerLocation;
|
|
936
385
|
}
|
|
937
|
-
/**
|
|
938
|
-
*
|
|
939
|
-
* @export
|
|
940
|
-
* @interface FulfillerLocation
|
|
941
|
-
*/
|
|
942
386
|
export interface FulfillerLocation {
|
|
943
|
-
/**
|
|
944
|
-
*
|
|
945
|
-
* @type {string}
|
|
946
|
-
* @memberof FulfillerLocation
|
|
947
|
-
*/
|
|
948
387
|
'city'?: string | null;
|
|
949
|
-
/**
|
|
950
|
-
*
|
|
951
|
-
* @type {string}
|
|
952
|
-
* @memberof FulfillerLocation
|
|
953
|
-
*/
|
|
954
388
|
'country'?: string | null;
|
|
955
389
|
}
|
|
956
|
-
/**
|
|
957
|
-
*
|
|
958
|
-
* @export
|
|
959
|
-
* @interface FulfillersResponse
|
|
960
|
-
*/
|
|
961
390
|
export interface FulfillersResponse {
|
|
962
|
-
/**
|
|
963
|
-
*
|
|
964
|
-
* @type {Array<Fulfiller>}
|
|
965
|
-
* @memberof FulfillersResponse
|
|
966
|
-
*/
|
|
967
391
|
'fulfillers'?: Array<Fulfiller>;
|
|
968
|
-
/**
|
|
969
|
-
*
|
|
970
|
-
* @type {number}
|
|
971
|
-
* @memberof FulfillersResponse
|
|
972
|
-
*/
|
|
973
392
|
'nextPageToken'?: number;
|
|
974
393
|
}
|
|
975
|
-
/**
|
|
976
|
-
*
|
|
977
|
-
* @export
|
|
978
|
-
* @interface Fulfillment
|
|
979
|
-
*/
|
|
980
394
|
export interface Fulfillment {
|
|
981
395
|
/**
|
|
982
396
|
* Unique fulfillment id
|
|
983
|
-
* @type {string}
|
|
984
|
-
* @memberof Fulfillment
|
|
985
397
|
*/
|
|
986
398
|
'id'?: string;
|
|
987
|
-
/**
|
|
988
|
-
*
|
|
989
|
-
* @type {OrderStatus}
|
|
990
|
-
* @memberof Fulfillment
|
|
991
|
-
*/
|
|
992
399
|
'status'?: OrderStatus;
|
|
993
|
-
/**
|
|
994
|
-
*
|
|
995
|
-
* @type {Fulfiller}
|
|
996
|
-
* @memberof Fulfillment
|
|
997
|
-
*/
|
|
998
400
|
'fulfiller'?: Fulfiller;
|
|
999
|
-
/**
|
|
1000
|
-
*
|
|
1001
|
-
* @type {Array<FulfillmentItem>}
|
|
1002
|
-
* @memberof Fulfillment
|
|
1003
|
-
*/
|
|
1004
401
|
'items'?: Array<FulfillmentItem>;
|
|
1005
|
-
/**
|
|
1006
|
-
*
|
|
1007
|
-
* @type {OrderTracking}
|
|
1008
|
-
* @memberof Fulfillment
|
|
1009
|
-
*/
|
|
1010
402
|
'tracking'?: OrderTracking | null;
|
|
1011
403
|
/**
|
|
1012
404
|
* Shipping method currently set
|
|
1013
|
-
* @type {ShippingMethod}
|
|
1014
|
-
* @memberof Fulfillment
|
|
1015
405
|
*/
|
|
1016
406
|
'shippingMethod'?: ShippingMethod;
|
|
1017
407
|
/**
|
|
1018
408
|
* Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment.
|
|
1019
|
-
* @type {Array<ShippingMethod>}
|
|
1020
|
-
* @memberof Fulfillment
|
|
1021
409
|
*/
|
|
1022
410
|
'availableShippingMethods'?: Array<ShippingMethod>;
|
|
1023
411
|
/**
|
|
1024
412
|
* Weight of the package being shipped in grams
|
|
1025
|
-
* @type {number}
|
|
1026
|
-
* @memberof Fulfillment
|
|
1027
413
|
*/
|
|
1028
414
|
'packageWeight'?: number;
|
|
1029
415
|
}
|
|
1030
|
-
/**
|
|
1031
|
-
*
|
|
1032
|
-
* @export
|
|
1033
|
-
* @interface FulfillmentItem
|
|
1034
|
-
*/
|
|
1035
416
|
export interface FulfillmentItem {
|
|
1036
417
|
/**
|
|
1037
418
|
* Unique fulfillment item id
|
|
1038
|
-
* @type {string}
|
|
1039
|
-
* @memberof FulfillmentItem
|
|
1040
419
|
*/
|
|
1041
420
|
'id'?: string;
|
|
1042
421
|
/**
|
|
1043
422
|
* Id of the order item being fulfilled
|
|
1044
|
-
* @type {string}
|
|
1045
|
-
* @memberof FulfillmentItem
|
|
1046
423
|
*/
|
|
1047
424
|
'itemId'?: string;
|
|
1048
425
|
/**
|
|
1049
426
|
* Number of this item being fulfilled
|
|
1050
|
-
* @type {number}
|
|
1051
|
-
* @memberof FulfillmentItem
|
|
1052
427
|
*/
|
|
1053
428
|
'quantity'?: number;
|
|
1054
429
|
}
|
|
1055
|
-
/**
|
|
1056
|
-
*
|
|
1057
|
-
* @export
|
|
1058
|
-
* @interface GetDashboardResponse
|
|
1059
|
-
*/
|
|
1060
430
|
export interface GetDashboardResponse {
|
|
1061
|
-
/**
|
|
1062
|
-
*
|
|
1063
|
-
* @type {Array<DashboardItem>}
|
|
1064
|
-
* @memberof GetDashboardResponse
|
|
1065
|
-
*/
|
|
1066
431
|
'items'?: Array<DashboardItem>;
|
|
1067
432
|
}
|
|
1068
433
|
/**
|
|
1069
434
|
* Image description
|
|
1070
|
-
* @export
|
|
1071
|
-
* @interface Image
|
|
1072
435
|
*/
|
|
1073
436
|
export interface Image {
|
|
1074
437
|
/**
|
|
1075
438
|
* Unique object identifier
|
|
1076
|
-
* @type {string}
|
|
1077
|
-
* @memberof Image
|
|
1078
439
|
*/
|
|
1079
440
|
'id'?: string;
|
|
1080
|
-
/**
|
|
1081
|
-
*
|
|
1082
|
-
* @type {string}
|
|
1083
|
-
* @memberof Image
|
|
1084
|
-
*/
|
|
1085
441
|
'src'?: string;
|
|
1086
|
-
/**
|
|
1087
|
-
*
|
|
1088
|
-
* @type {string}
|
|
1089
|
-
* @memberof Image
|
|
1090
|
-
*/
|
|
1091
442
|
'alt'?: string;
|
|
1092
|
-
/**
|
|
1093
|
-
*
|
|
1094
|
-
* @type {number}
|
|
1095
|
-
* @memberof Image
|
|
1096
|
-
*/
|
|
1097
443
|
'sortOrder'?: number;
|
|
1098
444
|
}
|
|
1099
|
-
/**
|
|
1100
|
-
*
|
|
1101
|
-
* @export
|
|
1102
|
-
* @interface InlineObject
|
|
1103
|
-
*/
|
|
1104
|
-
export interface InlineObject {
|
|
1105
|
-
/**
|
|
1106
|
-
*
|
|
1107
|
-
* @type {Array<Domain>}
|
|
1108
|
-
* @memberof InlineObject
|
|
1109
|
-
*/
|
|
1110
|
-
'domains': Array<Domain>;
|
|
1111
|
-
/**
|
|
1112
|
-
*
|
|
1113
|
-
* @type {number}
|
|
1114
|
-
* @memberof InlineObject
|
|
1115
|
-
*/
|
|
1116
|
-
'nextPageToken': number;
|
|
1117
|
-
}
|
|
1118
|
-
/**
|
|
1119
|
-
*
|
|
1120
|
-
* @export
|
|
1121
|
-
* @interface InlineObject1
|
|
1122
|
-
*/
|
|
1123
|
-
export interface InlineObject1 {
|
|
1124
|
-
/**
|
|
1125
|
-
* The URL to redirect to
|
|
1126
|
-
* @type {string}
|
|
1127
|
-
* @memberof InlineObject1
|
|
1128
|
-
*/
|
|
1129
|
-
'redirect_url': string;
|
|
1130
|
-
}
|
|
1131
|
-
/**
|
|
1132
|
-
*
|
|
1133
|
-
* @export
|
|
1134
|
-
* @interface ListCustomerEnquiries200Response
|
|
1135
|
-
*/
|
|
1136
445
|
export interface ListCustomerEnquiries200Response {
|
|
1137
|
-
/**
|
|
1138
|
-
*
|
|
1139
|
-
* @type {Array<Enquiry>}
|
|
1140
|
-
* @memberof ListCustomerEnquiries200Response
|
|
1141
|
-
*/
|
|
1142
446
|
'enquiries'?: Array<Enquiry>;
|
|
1143
|
-
/**
|
|
1144
|
-
*
|
|
1145
|
-
* @type {number}
|
|
1146
|
-
* @memberof ListCustomerEnquiries200Response
|
|
1147
|
-
*/
|
|
1148
447
|
'nextPageToken'?: number | null;
|
|
1149
448
|
}
|
|
1150
|
-
/**
|
|
1151
|
-
*
|
|
1152
|
-
* @export
|
|
1153
|
-
* @interface ListCustomerEnquiryLogs200Response
|
|
1154
|
-
*/
|
|
1155
449
|
export interface ListCustomerEnquiryLogs200Response {
|
|
1156
|
-
/**
|
|
1157
|
-
*
|
|
1158
|
-
* @type {Array<ListCustomerEnquiryLogs200ResponseLogsInner>}
|
|
1159
|
-
* @memberof ListCustomerEnquiryLogs200Response
|
|
1160
|
-
*/
|
|
1161
450
|
'logs': Array<ListCustomerEnquiryLogs200ResponseLogsInner>;
|
|
1162
451
|
}
|
|
1163
|
-
/**
|
|
1164
|
-
*
|
|
1165
|
-
* @export
|
|
1166
|
-
* @interface ListCustomerEnquiryLogs200ResponseLogsInner
|
|
1167
|
-
*/
|
|
1168
452
|
export interface ListCustomerEnquiryLogs200ResponseLogsInner {
|
|
1169
|
-
/**
|
|
1170
|
-
*
|
|
1171
|
-
* @type {ListCustomerEnquiryLogs200ResponseLogsInnerCustomer}
|
|
1172
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInner
|
|
1173
|
-
*/
|
|
1174
453
|
'customer': ListCustomerEnquiryLogs200ResponseLogsInnerCustomer;
|
|
1175
|
-
/**
|
|
1176
|
-
*
|
|
1177
|
-
* @type {string}
|
|
1178
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInner
|
|
1179
|
-
*/
|
|
1180
454
|
'createdAt': string;
|
|
1181
455
|
}
|
|
1182
|
-
/**
|
|
1183
|
-
*
|
|
1184
|
-
* @export
|
|
1185
|
-
* @interface ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1186
|
-
*/
|
|
1187
456
|
export interface ListCustomerEnquiryLogs200ResponseLogsInnerCustomer {
|
|
1188
|
-
/**
|
|
1189
|
-
*
|
|
1190
|
-
* @type {string}
|
|
1191
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1192
|
-
*/
|
|
1193
457
|
'id'?: string;
|
|
1194
458
|
/**
|
|
1195
459
|
* API reference for the customer
|
|
1196
|
-
* @type {string}
|
|
1197
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1198
460
|
*/
|
|
1199
461
|
'ref'?: string;
|
|
1200
|
-
/**
|
|
1201
|
-
*
|
|
1202
|
-
* @type {string}
|
|
1203
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1204
|
-
*/
|
|
1205
462
|
'firstName'?: string;
|
|
1206
|
-
/**
|
|
1207
|
-
*
|
|
1208
|
-
* @type {string}
|
|
1209
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1210
|
-
*/
|
|
1211
463
|
'lastName'?: string;
|
|
1212
|
-
/**
|
|
1213
|
-
*
|
|
1214
|
-
* @type {string}
|
|
1215
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1216
|
-
*/
|
|
1217
464
|
'email'?: string;
|
|
1218
465
|
}
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
466
|
+
export interface ListCustomerTags200Response {
|
|
467
|
+
'tags': Array<string>;
|
|
468
|
+
'nextPageToken'?: number | null;
|
|
469
|
+
}
|
|
470
|
+
export interface ListDomains200Response {
|
|
471
|
+
'domains': Array<Domain>;
|
|
472
|
+
'nextPageToken': number;
|
|
473
|
+
}
|
|
1224
474
|
export interface ModerateReviewRequest {
|
|
1225
475
|
/**
|
|
1226
476
|
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
1227
|
-
* @type {boolean}
|
|
1228
|
-
* @memberof ModerateReviewRequest
|
|
1229
477
|
*/
|
|
1230
478
|
'enabled'?: boolean;
|
|
1231
479
|
}
|
|
1232
|
-
/**
|
|
1233
|
-
*
|
|
1234
|
-
* @export
|
|
1235
|
-
* @interface Option
|
|
1236
|
-
*/
|
|
1237
480
|
export interface Option {
|
|
1238
481
|
/**
|
|
1239
482
|
* Option name
|
|
1240
|
-
* @type {string}
|
|
1241
|
-
* @memberof Option
|
|
1242
483
|
*/
|
|
1243
484
|
'name': string;
|
|
1244
485
|
/**
|
|
1245
486
|
* Option value
|
|
1246
|
-
* @type {string}
|
|
1247
|
-
* @memberof Option
|
|
1248
487
|
*/
|
|
1249
488
|
'value': string;
|
|
1250
489
|
}
|
|
1251
|
-
/**
|
|
1252
|
-
*
|
|
1253
|
-
* @export
|
|
1254
|
-
* @interface Order
|
|
1255
|
-
*/
|
|
1256
490
|
export interface Order {
|
|
1257
491
|
/**
|
|
1258
492
|
* Unique object identifier
|
|
1259
|
-
* @type {string}
|
|
1260
|
-
* @memberof Order
|
|
1261
493
|
*/
|
|
1262
494
|
'id'?: string;
|
|
1263
495
|
/**
|
|
1264
496
|
* A reference to the resource location
|
|
1265
|
-
* @type {string}
|
|
1266
|
-
* @memberof Order
|
|
1267
497
|
*/
|
|
1268
498
|
'ref'?: string;
|
|
1269
|
-
/**
|
|
1270
|
-
*
|
|
1271
|
-
* @type {OrderStatus}
|
|
1272
|
-
* @memberof Order
|
|
1273
|
-
*/
|
|
1274
499
|
'status'?: OrderStatus;
|
|
1275
|
-
/**
|
|
1276
|
-
*
|
|
1277
|
-
* @type {ContactInformation}
|
|
1278
|
-
* @memberof Order
|
|
1279
|
-
*/
|
|
1280
500
|
'contactInformation': ContactInformation;
|
|
1281
|
-
/**
|
|
1282
|
-
*
|
|
1283
|
-
* @type {Address}
|
|
1284
|
-
* @memberof Order
|
|
1285
|
-
*/
|
|
1286
501
|
'shippingAddress': Address;
|
|
1287
502
|
/**
|
|
1288
503
|
* ISO 8601 Timestamp
|
|
1289
|
-
* @type {string}
|
|
1290
|
-
* @memberof Order
|
|
1291
504
|
*/
|
|
1292
505
|
'createdAt'?: string;
|
|
1293
506
|
/**
|
|
1294
507
|
* ISO 8601 Timestamp
|
|
1295
|
-
* @type {string}
|
|
1296
|
-
* @memberof Order
|
|
1297
508
|
*/
|
|
1298
509
|
'updatedAt'?: string;
|
|
1299
510
|
/**
|
|
1300
511
|
* A custom reference to the merchant\'s order that will be displayed on the shipping label.
|
|
1301
|
-
* @type {string}
|
|
1302
|
-
* @memberof Order
|
|
1303
512
|
*/
|
|
1304
513
|
'merchantReference'?: string | null;
|
|
1305
|
-
/**
|
|
1306
|
-
*
|
|
1307
|
-
* @type {Array<Fulfillment>}
|
|
1308
|
-
* @memberof Order
|
|
1309
|
-
*/
|
|
1310
514
|
'fulfillments'?: Array<Fulfillment>;
|
|
1311
|
-
/**
|
|
1312
|
-
*
|
|
1313
|
-
* @type {Array<OrderItem>}
|
|
1314
|
-
* @memberof Order
|
|
1315
|
-
*/
|
|
1316
515
|
'items': Array<OrderItem>;
|
|
1317
|
-
/**
|
|
1318
|
-
*
|
|
1319
|
-
* @type {Price}
|
|
1320
|
-
* @memberof Order
|
|
1321
|
-
*/
|
|
1322
516
|
'totalPrice'?: Price;
|
|
1323
|
-
/**
|
|
1324
|
-
*
|
|
1325
|
-
* @type {Price}
|
|
1326
|
-
* @memberof Order
|
|
1327
|
-
*/
|
|
1328
517
|
'taxPrice'?: Price;
|
|
1329
|
-
/**
|
|
1330
|
-
*
|
|
1331
|
-
* @type {Price}
|
|
1332
|
-
* @memberof Order
|
|
1333
|
-
*/
|
|
1334
518
|
'subtotalPrice'?: Price;
|
|
1335
|
-
/**
|
|
1336
|
-
*
|
|
1337
|
-
* @type {Price}
|
|
1338
|
-
* @memberof Order
|
|
1339
|
-
*/
|
|
1340
519
|
'discountPrice'?: Price;
|
|
1341
|
-
/**
|
|
1342
|
-
*
|
|
1343
|
-
* @type {Coupon}
|
|
1344
|
-
* @memberof Order
|
|
1345
|
-
*/
|
|
1346
520
|
'coupon'?: Coupon | null;
|
|
1347
|
-
/**
|
|
1348
|
-
*
|
|
1349
|
-
* @type {Price}
|
|
1350
|
-
* @memberof Order
|
|
1351
|
-
*/
|
|
1352
521
|
'shippingPrice'?: Price;
|
|
1353
|
-
/**
|
|
1354
|
-
*
|
|
1355
|
-
* @type {Origin}
|
|
1356
|
-
* @memberof Order
|
|
1357
|
-
*/
|
|
1358
522
|
'origin'?: Origin;
|
|
1359
|
-
/**
|
|
1360
|
-
*
|
|
1361
|
-
* @type {Array<StatusHistoryItem>}
|
|
1362
|
-
* @memberof Order
|
|
1363
|
-
*/
|
|
1364
523
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
1365
|
-
/**
|
|
1366
|
-
*
|
|
1367
|
-
* @type {Project}
|
|
1368
|
-
* @memberof Order
|
|
1369
|
-
*/
|
|
1370
524
|
'project': Project;
|
|
1371
|
-
/**
|
|
1372
|
-
*
|
|
1373
|
-
* @type {Array<PaymentAttempt>}
|
|
1374
|
-
* @memberof Order
|
|
1375
|
-
*/
|
|
1376
525
|
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
1377
526
|
/**
|
|
1378
527
|
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
1379
|
-
* @type {string}
|
|
1380
|
-
* @memberof Order
|
|
1381
528
|
*/
|
|
1382
529
|
'integrationType'?: string;
|
|
1383
530
|
}
|
|
1384
|
-
/**
|
|
1385
|
-
*
|
|
1386
|
-
* @export
|
|
1387
|
-
* @interface OrderItem
|
|
1388
|
-
*/
|
|
1389
531
|
export interface OrderItem {
|
|
1390
532
|
/**
|
|
1391
533
|
* Unique object identifier
|
|
1392
|
-
* @type {string}
|
|
1393
|
-
* @memberof OrderItem
|
|
1394
534
|
*/
|
|
1395
535
|
'id'?: string;
|
|
1396
536
|
/**
|
|
1397
537
|
* Reference URL to the order item variant
|
|
1398
|
-
* @type {string}
|
|
1399
|
-
* @memberof OrderItem
|
|
1400
538
|
* @deprecated
|
|
1401
539
|
*/
|
|
1402
540
|
'variantRef': string;
|
|
1403
|
-
/**
|
|
1404
|
-
*
|
|
1405
|
-
* @type {Variant}
|
|
1406
|
-
* @memberof OrderItem
|
|
1407
|
-
*/
|
|
1408
541
|
'variant': Variant;
|
|
1409
542
|
/**
|
|
1410
543
|
* Options associated to an order item\'s variant, such as color and size.
|
|
1411
|
-
* @type {Array<Option>}
|
|
1412
|
-
* @memberof OrderItem
|
|
1413
544
|
*/
|
|
1414
545
|
'options'?: Array<Option>;
|
|
1415
|
-
/**
|
|
1416
|
-
*
|
|
1417
|
-
* @type {number}
|
|
1418
|
-
* @memberof OrderItem
|
|
1419
|
-
*/
|
|
1420
546
|
'quantity': number;
|
|
1421
547
|
/**
|
|
1422
548
|
* The name of the product
|
|
1423
|
-
* @type {string}
|
|
1424
|
-
* @memberof OrderItem
|
|
1425
549
|
*/
|
|
1426
550
|
'name'?: string;
|
|
1427
551
|
/**
|
|
1428
552
|
* Images
|
|
1429
|
-
* @type {Array<Image>}
|
|
1430
|
-
* @memberof OrderItem
|
|
1431
553
|
*/
|
|
1432
554
|
'images'?: Array<Image>;
|
|
1433
|
-
/**
|
|
1434
|
-
*
|
|
1435
|
-
* @type {Price}
|
|
1436
|
-
* @memberof OrderItem
|
|
1437
|
-
*/
|
|
1438
555
|
'totalPrice'?: Price;
|
|
1439
556
|
/**
|
|
1440
557
|
* This is an estimate until the order has been confirmed
|
|
1441
|
-
* @type {Price}
|
|
1442
|
-
* @memberof OrderItem
|
|
1443
558
|
*/
|
|
1444
559
|
'taxPrice'?: Price;
|
|
1445
|
-
/**
|
|
1446
|
-
*
|
|
1447
|
-
* @type {Price}
|
|
1448
|
-
* @memberof OrderItem
|
|
1449
|
-
*/
|
|
1450
560
|
'subtotalPrice'?: Price;
|
|
1451
|
-
/**
|
|
1452
|
-
*
|
|
1453
|
-
* @type {Price}
|
|
1454
|
-
* @memberof OrderItem
|
|
1455
|
-
*/
|
|
1456
561
|
'discountPrice'?: Price;
|
|
1457
562
|
/**
|
|
1458
563
|
* The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
|
|
1459
|
-
* @type {Price}
|
|
1460
|
-
* @memberof OrderItem
|
|
1461
564
|
*/
|
|
1462
565
|
'recipientCost'?: Price;
|
|
1463
|
-
/**
|
|
1464
|
-
*
|
|
1465
|
-
* @type {Array<AmendmentLog>}
|
|
1466
|
-
* @memberof OrderItem
|
|
1467
|
-
*/
|
|
1468
566
|
'amendmentLogs'?: Array<AmendmentLog>;
|
|
1469
567
|
}
|
|
1470
|
-
/**
|
|
1471
|
-
*
|
|
1472
|
-
* @export
|
|
1473
|
-
* @interface OrderItem1
|
|
1474
|
-
*/
|
|
1475
568
|
export interface OrderItem1 {
|
|
1476
569
|
/**
|
|
1477
570
|
* A reference to the variant being ordered
|
|
1478
|
-
* @type {string}
|
|
1479
|
-
* @memberof OrderItem1
|
|
1480
571
|
*/
|
|
1481
572
|
'variantRef': string;
|
|
1482
|
-
/**
|
|
1483
|
-
*
|
|
1484
|
-
* @type {number}
|
|
1485
|
-
* @memberof OrderItem1
|
|
1486
|
-
*/
|
|
1487
573
|
'quantity': number;
|
|
1488
|
-
/**
|
|
1489
|
-
*
|
|
1490
|
-
* @type {OrderItem1RecipientCost}
|
|
1491
|
-
* @memberof OrderItem1
|
|
1492
|
-
*/
|
|
1493
574
|
'recipientCost'?: OrderItem1RecipientCost;
|
|
1494
575
|
}
|
|
1495
|
-
/**
|
|
1496
|
-
*
|
|
1497
|
-
* @export
|
|
1498
|
-
* @interface OrderItem1RecipientCost
|
|
1499
|
-
*/
|
|
1500
576
|
export interface OrderItem1RecipientCost {
|
|
1501
|
-
/**
|
|
1502
|
-
*
|
|
1503
|
-
* @type {string}
|
|
1504
|
-
* @memberof OrderItem1RecipientCost
|
|
1505
|
-
*/
|
|
1506
577
|
'amount': string;
|
|
1507
|
-
/**
|
|
1508
|
-
*
|
|
1509
|
-
* @type {string}
|
|
1510
|
-
* @memberof OrderItem1RecipientCost
|
|
1511
|
-
*/
|
|
1512
578
|
'currencyCode': string;
|
|
1513
579
|
}
|
|
1514
|
-
/**
|
|
1515
|
-
*
|
|
1516
|
-
* @export
|
|
1517
|
-
* @enum {string}
|
|
1518
|
-
*/
|
|
1519
580
|
export declare const OrderStatus: {
|
|
1520
581
|
readonly New: "new";
|
|
1521
582
|
readonly Paid: "paid";
|
|
@@ -1524,91 +585,30 @@ export declare const OrderStatus: {
|
|
|
1524
585
|
readonly Refunded: "refunded";
|
|
1525
586
|
};
|
|
1526
587
|
export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
|
|
1527
|
-
/**
|
|
1528
|
-
*
|
|
1529
|
-
* @export
|
|
1530
|
-
* @interface OrderTracking
|
|
1531
|
-
*/
|
|
1532
588
|
export interface OrderTracking {
|
|
1533
|
-
/**
|
|
1534
|
-
*
|
|
1535
|
-
* @type {string}
|
|
1536
|
-
* @memberof OrderTracking
|
|
1537
|
-
*/
|
|
1538
589
|
'courier'?: string;
|
|
1539
|
-
/**
|
|
1540
|
-
*
|
|
1541
|
-
* @type {string}
|
|
1542
|
-
* @memberof OrderTracking
|
|
1543
|
-
*/
|
|
1544
590
|
'code'?: string;
|
|
1545
|
-
/**
|
|
1546
|
-
*
|
|
1547
|
-
* @type {string}
|
|
1548
|
-
* @memberof OrderTracking
|
|
1549
|
-
*/
|
|
1550
591
|
'url'?: string;
|
|
1551
592
|
}
|
|
1552
|
-
/**
|
|
1553
|
-
*
|
|
1554
|
-
* @export
|
|
1555
|
-
* @interface OrdersResponse
|
|
1556
|
-
*/
|
|
1557
593
|
export interface OrdersResponse {
|
|
1558
|
-
/**
|
|
1559
|
-
*
|
|
1560
|
-
* @type {Array<Order>}
|
|
1561
|
-
* @memberof OrdersResponse
|
|
1562
|
-
*/
|
|
1563
594
|
'orders'?: Array<Order>;
|
|
1564
|
-
/**
|
|
1565
|
-
*
|
|
1566
|
-
* @type {number}
|
|
1567
|
-
* @memberof OrdersResponse
|
|
1568
|
-
*/
|
|
1569
595
|
'nextPageToken'?: number;
|
|
1570
596
|
}
|
|
1571
|
-
/**
|
|
1572
|
-
*
|
|
1573
|
-
* @export
|
|
1574
|
-
* @interface Origin
|
|
1575
|
-
*/
|
|
1576
597
|
export interface Origin {
|
|
1577
|
-
/**
|
|
1578
|
-
*
|
|
1579
|
-
* @type {string}
|
|
1580
|
-
* @memberof Origin
|
|
1581
|
-
*/
|
|
1582
598
|
'code'?: string;
|
|
1583
|
-
/**
|
|
1584
|
-
*
|
|
1585
|
-
* @type {boolean}
|
|
1586
|
-
* @memberof Origin
|
|
1587
|
-
*/
|
|
1588
599
|
'isPaid'?: boolean;
|
|
1589
600
|
}
|
|
1590
|
-
/**
|
|
1591
|
-
*
|
|
1592
|
-
* @export
|
|
1593
|
-
* @interface PaymentAccount
|
|
1594
|
-
*/
|
|
1595
601
|
export interface PaymentAccount {
|
|
1596
602
|
/**
|
|
1597
603
|
* The name of the payment account
|
|
1598
|
-
* @type {string}
|
|
1599
|
-
* @memberof PaymentAccount
|
|
1600
604
|
*/
|
|
1601
605
|
'name': string;
|
|
1602
606
|
/**
|
|
1603
607
|
* The payment method
|
|
1604
|
-
* @type {string}
|
|
1605
|
-
* @memberof PaymentAccount
|
|
1606
608
|
*/
|
|
1607
609
|
'method': PaymentAccountMethodEnum;
|
|
1608
610
|
/**
|
|
1609
611
|
* The configuration for the payment account
|
|
1610
|
-
* @type {{ [key: string]: string; }}
|
|
1611
|
-
* @memberof PaymentAccount
|
|
1612
612
|
*/
|
|
1613
613
|
'config': {
|
|
1614
614
|
[key: string]: string;
|
|
@@ -1620,38 +620,14 @@ export declare const PaymentAccountMethodEnum: {
|
|
|
1620
620
|
export type PaymentAccountMethodEnum = typeof PaymentAccountMethodEnum[keyof typeof PaymentAccountMethodEnum];
|
|
1621
621
|
/**
|
|
1622
622
|
* List of payment attempts for this order
|
|
1623
|
-
* @export
|
|
1624
|
-
* @interface PaymentAttempt
|
|
1625
623
|
*/
|
|
1626
624
|
export interface PaymentAttempt {
|
|
1627
|
-
/**
|
|
1628
|
-
*
|
|
1629
|
-
* @type {string}
|
|
1630
|
-
* @memberof PaymentAttempt
|
|
1631
|
-
*/
|
|
1632
625
|
'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
|
|
1633
|
-
/**
|
|
1634
|
-
*
|
|
1635
|
-
* @type {string}
|
|
1636
|
-
* @memberof PaymentAttempt
|
|
1637
|
-
*/
|
|
1638
626
|
'status'?: PaymentAttemptStatusEnum;
|
|
1639
|
-
/**
|
|
1640
|
-
*
|
|
1641
|
-
* @type {string}
|
|
1642
|
-
* @memberof PaymentAttempt
|
|
1643
|
-
*/
|
|
1644
627
|
'transactionId'?: string | null;
|
|
1645
|
-
/**
|
|
1646
|
-
*
|
|
1647
|
-
* @type {string}
|
|
1648
|
-
* @memberof PaymentAttempt
|
|
1649
|
-
*/
|
|
1650
628
|
'message'?: string;
|
|
1651
629
|
/**
|
|
1652
630
|
* ISO 8601 Timestamp
|
|
1653
|
-
* @type {string}
|
|
1654
|
-
* @memberof PaymentAttempt
|
|
1655
631
|
*/
|
|
1656
632
|
'createdAt'?: string;
|
|
1657
633
|
}
|
|
@@ -1668,230 +644,90 @@ export declare const PaymentAttemptStatusEnum: {
|
|
|
1668
644
|
readonly Cancelled: "cancelled";
|
|
1669
645
|
};
|
|
1670
646
|
export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
|
|
1671
|
-
/**
|
|
1672
|
-
*
|
|
1673
|
-
* @export
|
|
1674
|
-
* @interface Pixel
|
|
1675
|
-
*/
|
|
1676
647
|
export interface Pixel {
|
|
1677
648
|
/**
|
|
1678
649
|
* Unique object identifier
|
|
1679
|
-
* @type {string}
|
|
1680
|
-
* @memberof Pixel
|
|
1681
650
|
*/
|
|
1682
651
|
'id': string;
|
|
1683
|
-
/**
|
|
1684
|
-
*
|
|
1685
|
-
* @type {string}
|
|
1686
|
-
* @memberof Pixel
|
|
1687
|
-
*/
|
|
1688
652
|
'name': string;
|
|
1689
|
-
/**
|
|
1690
|
-
*
|
|
1691
|
-
* @type {Array<string>}
|
|
1692
|
-
* @memberof Pixel
|
|
1693
|
-
*/
|
|
1694
653
|
'sourceProjects': Array<string>;
|
|
1695
|
-
/**
|
|
1696
|
-
*
|
|
1697
|
-
* @type {CreatePixelRequestFilters}
|
|
1698
|
-
* @memberof Pixel
|
|
1699
|
-
*/
|
|
1700
654
|
'filters': CreatePixelRequestFilters;
|
|
1701
655
|
}
|
|
1702
|
-
/**
|
|
1703
|
-
*
|
|
1704
|
-
* @export
|
|
1705
|
-
* @interface PixelsResponse
|
|
1706
|
-
*/
|
|
1707
656
|
export interface PixelsResponse {
|
|
1708
|
-
/**
|
|
1709
|
-
*
|
|
1710
|
-
* @type {Array<Pixel>}
|
|
1711
|
-
* @memberof PixelsResponse
|
|
1712
|
-
*/
|
|
1713
657
|
'pixels': Array<Pixel>;
|
|
1714
|
-
/**
|
|
1715
|
-
*
|
|
1716
|
-
* @type {number}
|
|
1717
|
-
* @memberof PixelsResponse
|
|
1718
|
-
*/
|
|
1719
658
|
'nextPageToken'?: number | null;
|
|
1720
659
|
}
|
|
1721
|
-
/**
|
|
1722
|
-
*
|
|
1723
|
-
* @export
|
|
1724
|
-
* @interface Platform
|
|
1725
|
-
*/
|
|
1726
660
|
export interface Platform {
|
|
1727
|
-
/**
|
|
1728
|
-
*
|
|
1729
|
-
* @type {string}
|
|
1730
|
-
* @memberof Platform
|
|
1731
|
-
*/
|
|
1732
661
|
'id': string;
|
|
1733
|
-
/**
|
|
1734
|
-
*
|
|
1735
|
-
* @type {string}
|
|
1736
|
-
* @memberof Platform
|
|
1737
|
-
*/
|
|
1738
662
|
'name': string;
|
|
1739
|
-
/**
|
|
1740
|
-
*
|
|
1741
|
-
* @type {Array<string>}
|
|
1742
|
-
* @memberof Platform
|
|
1743
|
-
*/
|
|
1744
663
|
'domains': Array<string>;
|
|
1745
|
-
/**
|
|
1746
|
-
*
|
|
1747
|
-
* @type {Array<PlatformLogo>}
|
|
1748
|
-
* @memberof Platform
|
|
1749
|
-
*/
|
|
1750
664
|
'logos': Array<PlatformLogo>;
|
|
1751
|
-
/**
|
|
1752
|
-
*
|
|
1753
|
-
* @type {string}
|
|
1754
|
-
* @memberof Platform
|
|
1755
|
-
*/
|
|
1756
665
|
'favicon': string | null;
|
|
1757
|
-
/**
|
|
1758
|
-
*
|
|
1759
|
-
* @type {boolean}
|
|
1760
|
-
* @memberof Platform
|
|
1761
|
-
*/
|
|
1762
666
|
'clientGiftWrapAvailable': boolean;
|
|
1763
667
|
/**
|
|
1764
668
|
* The subscription fee for the platform
|
|
1765
|
-
* @type {number}
|
|
1766
|
-
* @memberof Platform
|
|
1767
669
|
*/
|
|
1768
670
|
'storeSubscriptionFee': number;
|
|
1769
671
|
/**
|
|
1770
672
|
* The order handling fee for the platform
|
|
1771
|
-
* @type {number}
|
|
1772
|
-
* @memberof Platform
|
|
1773
673
|
*/
|
|
1774
674
|
'orderHandlingFee': number;
|
|
1775
675
|
/**
|
|
1776
676
|
* The item handling fee for the platform
|
|
1777
|
-
* @type {number}
|
|
1778
|
-
* @memberof Platform
|
|
1779
677
|
*/
|
|
1780
678
|
'itemHandlingFee': number;
|
|
679
|
+
/**
|
|
680
|
+
* The neck print fee for the platform
|
|
681
|
+
*/
|
|
682
|
+
'neckPrintFee': number;
|
|
1781
683
|
/**
|
|
1782
684
|
* Whether the platform can charge clients for orders
|
|
1783
|
-
* @type {boolean}
|
|
1784
|
-
* @memberof Platform
|
|
1785
685
|
*/
|
|
1786
686
|
'chargeClients': boolean;
|
|
1787
687
|
}
|
|
1788
|
-
/**
|
|
1789
|
-
*
|
|
1790
|
-
* @export
|
|
1791
|
-
* @interface PlatformLogo
|
|
1792
|
-
*/
|
|
1793
688
|
export interface PlatformLogo {
|
|
1794
|
-
/**
|
|
1795
|
-
*
|
|
1796
|
-
* @type {string}
|
|
1797
|
-
* @memberof PlatformLogo
|
|
1798
|
-
*/
|
|
1799
689
|
'url': string;
|
|
1800
|
-
/**
|
|
1801
|
-
*
|
|
1802
|
-
* @type {{ [key: string]: string; }}
|
|
1803
|
-
* @memberof PlatformLogo
|
|
1804
|
-
*/
|
|
1805
690
|
'meta': {
|
|
1806
691
|
[key: string]: string;
|
|
1807
692
|
};
|
|
1808
693
|
}
|
|
1809
694
|
/**
|
|
1810
695
|
* Standard price definition that defines the amount and currency.
|
|
1811
|
-
* @export
|
|
1812
|
-
* @interface Price
|
|
1813
696
|
*/
|
|
1814
697
|
export interface Price {
|
|
1815
698
|
/**
|
|
1816
699
|
* Price including tax in the specified currency.
|
|
1817
|
-
* @type {string}
|
|
1818
|
-
* @memberof Price
|
|
1819
700
|
*/
|
|
1820
701
|
'amount'?: string;
|
|
1821
702
|
/**
|
|
1822
703
|
* Currency code for the currency the price is valued in.
|
|
1823
|
-
* @type {string}
|
|
1824
|
-
* @memberof Price
|
|
1825
704
|
*/
|
|
1826
705
|
'currencyCode'?: string;
|
|
1827
706
|
}
|
|
1828
|
-
/**
|
|
1829
|
-
*
|
|
1830
|
-
* @export
|
|
1831
|
-
* @interface Project
|
|
1832
|
-
*/
|
|
1833
707
|
export interface Project {
|
|
1834
|
-
/**
|
|
1835
|
-
*
|
|
1836
|
-
* @type {string}
|
|
1837
|
-
* @memberof Project
|
|
1838
|
-
*/
|
|
1839
708
|
'id': string;
|
|
1840
709
|
/**
|
|
1841
710
|
* The name of the project
|
|
1842
|
-
* @type {string}
|
|
1843
|
-
* @memberof Project
|
|
1844
711
|
*/
|
|
1845
712
|
'name': string;
|
|
1846
713
|
}
|
|
1847
|
-
/**
|
|
1848
|
-
*
|
|
1849
|
-
* @export
|
|
1850
|
-
* @interface ReturnOrderRequest
|
|
1851
|
-
*/
|
|
1852
714
|
export interface ReturnOrderRequest {
|
|
1853
|
-
/**
|
|
1854
|
-
*
|
|
1855
|
-
* @type {Array<ReturnOrderRequestReturnsInner>}
|
|
1856
|
-
* @memberof ReturnOrderRequest
|
|
1857
|
-
*/
|
|
1858
715
|
'returns': Array<ReturnOrderRequestReturnsInner>;
|
|
1859
716
|
}
|
|
1860
|
-
/**
|
|
1861
|
-
*
|
|
1862
|
-
* @export
|
|
1863
|
-
* @interface ReturnOrderRequestReturnsInner
|
|
1864
|
-
*/
|
|
1865
717
|
export interface ReturnOrderRequestReturnsInner {
|
|
1866
718
|
/**
|
|
1867
719
|
* Unique order item identifier
|
|
1868
|
-
* @type {string}
|
|
1869
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1870
720
|
*/
|
|
1871
721
|
'id': string;
|
|
1872
|
-
/**
|
|
1873
|
-
*
|
|
1874
|
-
* @type {string}
|
|
1875
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1876
|
-
*/
|
|
1877
722
|
'action': ReturnOrderRequestReturnsInnerActionEnum;
|
|
1878
723
|
/**
|
|
1879
724
|
* The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order.
|
|
1880
|
-
* @type {number}
|
|
1881
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1882
725
|
*/
|
|
1883
726
|
'quantity': number;
|
|
1884
727
|
/**
|
|
1885
728
|
* A reference to the variant being ordered
|
|
1886
|
-
* @type {string}
|
|
1887
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1888
729
|
*/
|
|
1889
730
|
'newVariantRef'?: string;
|
|
1890
|
-
/**
|
|
1891
|
-
*
|
|
1892
|
-
* @type {ReturnOrderRequestReturnsInnerReason}
|
|
1893
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1894
|
-
*/
|
|
1895
731
|
'reason': ReturnOrderRequestReturnsInnerReason;
|
|
1896
732
|
}
|
|
1897
733
|
export declare const ReturnOrderRequestReturnsInnerActionEnum: {
|
|
@@ -1899,544 +735,192 @@ export declare const ReturnOrderRequestReturnsInnerActionEnum: {
|
|
|
1899
735
|
readonly Exchange: "exchange";
|
|
1900
736
|
};
|
|
1901
737
|
export type ReturnOrderRequestReturnsInnerActionEnum = typeof ReturnOrderRequestReturnsInnerActionEnum[keyof typeof ReturnOrderRequestReturnsInnerActionEnum];
|
|
1902
|
-
/**
|
|
1903
|
-
*
|
|
1904
|
-
* @export
|
|
1905
|
-
* @interface ReturnOrderRequestReturnsInnerReason
|
|
1906
|
-
*/
|
|
1907
738
|
export interface ReturnOrderRequestReturnsInnerReason {
|
|
1908
739
|
/**
|
|
1909
740
|
* A reference to the reason for the return or exchange.
|
|
1910
|
-
* @type {string}
|
|
1911
|
-
* @memberof ReturnOrderRequestReturnsInnerReason
|
|
1912
741
|
*/
|
|
1913
742
|
'reasonRef': string;
|
|
1914
743
|
/**
|
|
1915
744
|
* Additional comments as to why the item is being returned or exchanged.
|
|
1916
|
-
* @type {string}
|
|
1917
|
-
* @memberof ReturnOrderRequestReturnsInnerReason
|
|
1918
745
|
*/
|
|
1919
746
|
'additionalComments'?: string | null;
|
|
1920
747
|
}
|
|
1921
|
-
/**
|
|
1922
|
-
*
|
|
1923
|
-
* @export
|
|
1924
|
-
* @interface Review
|
|
1925
|
-
*/
|
|
1926
748
|
export interface Review {
|
|
1927
749
|
/**
|
|
1928
750
|
* Unique object identifier
|
|
1929
|
-
* @type {string}
|
|
1930
|
-
* @memberof Review
|
|
1931
751
|
*/
|
|
1932
752
|
'id': string;
|
|
1933
753
|
/**
|
|
1934
754
|
* Text content of the review
|
|
1935
|
-
* @type {string}
|
|
1936
|
-
* @memberof Review
|
|
1937
755
|
*/
|
|
1938
756
|
'text': string;
|
|
1939
|
-
/**
|
|
1940
|
-
*
|
|
1941
|
-
* @type {ReviewProduct}
|
|
1942
|
-
* @memberof Review
|
|
1943
|
-
*/
|
|
1944
757
|
'product'?: ReviewProduct;
|
|
1945
|
-
/**
|
|
1946
|
-
*
|
|
1947
|
-
* @type {ReviewAuthor}
|
|
1948
|
-
* @memberof Review
|
|
1949
|
-
*/
|
|
1950
758
|
'author'?: ReviewAuthor;
|
|
1951
759
|
/**
|
|
1952
760
|
* Rating of the review
|
|
1953
|
-
* @type {number}
|
|
1954
|
-
* @memberof Review
|
|
1955
761
|
*/
|
|
1956
762
|
'rating'?: number;
|
|
1957
763
|
/**
|
|
1958
|
-
* Google\'s sentiment analysis score
|
|
1959
|
-
* @type {number}
|
|
1960
|
-
* @memberof Review
|
|
1961
|
-
*/
|
|
1962
|
-
'sentiment'?: number;
|
|
1963
|
-
/**
|
|
1964
|
-
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
1965
|
-
* @type {boolean}
|
|
1966
|
-
* @memberof Review
|
|
1967
|
-
*/
|
|
1968
|
-
'enabled': boolean;
|
|
1969
|
-
/**
|
|
1970
|
-
*
|
|
1971
|
-
* @type {string}
|
|
1972
|
-
* @memberof Review
|
|
1973
|
-
*/
|
|
1974
|
-
'createdAt'?: string;
|
|
1975
|
-
/**
|
|
1976
|
-
*
|
|
1977
|
-
* @type {Project}
|
|
1978
|
-
* @memberof Review
|
|
1979
|
-
*/
|
|
1980
|
-
'project': Project;
|
|
1981
|
-
/**
|
|
1982
|
-
*
|
|
1983
|
-
* @type {Array<ReviewImagesInner>}
|
|
1984
|
-
* @memberof Review
|
|
764
|
+
* Google\'s sentiment analysis score
|
|
1985
765
|
*/
|
|
1986
|
-
'
|
|
766
|
+
'sentiment'?: number;
|
|
1987
767
|
/**
|
|
1988
|
-
*
|
|
1989
|
-
* @type {Array<ReviewReply>}
|
|
1990
|
-
* @memberof Review
|
|
768
|
+
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
1991
769
|
*/
|
|
770
|
+
'enabled': boolean;
|
|
771
|
+
'createdAt'?: string;
|
|
772
|
+
'project': Project;
|
|
773
|
+
'images'?: Array<ReviewImagesInner>;
|
|
1992
774
|
'replies'?: Array<ReviewReply> | null;
|
|
1993
775
|
}
|
|
1994
|
-
/**
|
|
1995
|
-
*
|
|
1996
|
-
* @export
|
|
1997
|
-
* @interface ReviewAuthor
|
|
1998
|
-
*/
|
|
1999
776
|
export interface ReviewAuthor {
|
|
2000
777
|
/**
|
|
2001
778
|
* Name of the review\'s author
|
|
2002
|
-
* @type {string}
|
|
2003
|
-
* @memberof ReviewAuthor
|
|
2004
779
|
*/
|
|
2005
780
|
'name'?: string;
|
|
2006
781
|
/**
|
|
2007
782
|
* Email of the review\'s author
|
|
2008
|
-
* @type {string}
|
|
2009
|
-
* @memberof ReviewAuthor
|
|
2010
783
|
*/
|
|
2011
784
|
'email'?: string;
|
|
2012
785
|
}
|
|
2013
|
-
/**
|
|
2014
|
-
*
|
|
2015
|
-
* @export
|
|
2016
|
-
* @interface ReviewImagesInner
|
|
2017
|
-
*/
|
|
2018
786
|
export interface ReviewImagesInner {
|
|
2019
787
|
/**
|
|
2020
788
|
* URL of the image
|
|
2021
|
-
* @type {string}
|
|
2022
|
-
* @memberof ReviewImagesInner
|
|
2023
789
|
*/
|
|
2024
790
|
'src'?: string;
|
|
2025
791
|
/**
|
|
2026
792
|
* Alternative text for the image
|
|
2027
|
-
* @type {string}
|
|
2028
|
-
* @memberof ReviewImagesInner
|
|
2029
793
|
*/
|
|
2030
794
|
'alt'?: string;
|
|
2031
795
|
}
|
|
2032
796
|
/**
|
|
2033
797
|
* The product that the review is for
|
|
2034
|
-
* @export
|
|
2035
|
-
* @interface ReviewProduct
|
|
2036
798
|
*/
|
|
2037
799
|
export interface ReviewProduct {
|
|
2038
800
|
/**
|
|
2039
801
|
* Unique object identifier
|
|
2040
|
-
* @type {string}
|
|
2041
|
-
* @memberof ReviewProduct
|
|
2042
802
|
*/
|
|
2043
803
|
'id'?: string;
|
|
2044
804
|
/**
|
|
2045
805
|
* The title of the product
|
|
2046
|
-
* @type {string}
|
|
2047
|
-
* @memberof ReviewProduct
|
|
2048
806
|
*/
|
|
2049
807
|
'title'?: string;
|
|
2050
808
|
}
|
|
2051
|
-
/**
|
|
2052
|
-
*
|
|
2053
|
-
* @export
|
|
2054
|
-
* @interface ReviewReply
|
|
2055
|
-
*/
|
|
2056
809
|
export interface ReviewReply {
|
|
2057
810
|
/**
|
|
2058
811
|
* Unique object identifier
|
|
2059
|
-
* @type {string}
|
|
2060
|
-
* @memberof ReviewReply
|
|
2061
812
|
*/
|
|
2062
813
|
'id': string;
|
|
2063
814
|
/**
|
|
2064
815
|
* Text content of the reply
|
|
2065
|
-
* @type {string}
|
|
2066
|
-
* @memberof ReviewReply
|
|
2067
816
|
*/
|
|
2068
817
|
'text': string;
|
|
2069
|
-
/**
|
|
2070
|
-
*
|
|
2071
|
-
* @type {ReviewReplyAuthor}
|
|
2072
|
-
* @memberof ReviewReply
|
|
2073
|
-
*/
|
|
2074
818
|
'author'?: ReviewReplyAuthor;
|
|
2075
|
-
/**
|
|
2076
|
-
*
|
|
2077
|
-
* @type {string}
|
|
2078
|
-
* @memberof ReviewReply
|
|
2079
|
-
*/
|
|
2080
819
|
'createdAt'?: string;
|
|
2081
820
|
}
|
|
2082
|
-
/**
|
|
2083
|
-
*
|
|
2084
|
-
* @export
|
|
2085
|
-
* @interface ReviewReplyAuthor
|
|
2086
|
-
*/
|
|
2087
821
|
export interface ReviewReplyAuthor {
|
|
2088
822
|
/**
|
|
2089
823
|
* Name of the reply\'s author
|
|
2090
|
-
* @type {string}
|
|
2091
|
-
* @memberof ReviewReplyAuthor
|
|
2092
824
|
*/
|
|
2093
825
|
'name'?: string;
|
|
2094
826
|
}
|
|
2095
|
-
/**
|
|
2096
|
-
*
|
|
2097
|
-
* @export
|
|
2098
|
-
* @interface ReviewsResponse
|
|
2099
|
-
*/
|
|
2100
827
|
export interface ReviewsResponse {
|
|
2101
|
-
/**
|
|
2102
|
-
*
|
|
2103
|
-
* @type {Array<Review>}
|
|
2104
|
-
* @memberof ReviewsResponse
|
|
2105
|
-
*/
|
|
2106
828
|
'reviews'?: Array<Review>;
|
|
2107
829
|
/**
|
|
2108
830
|
* The token referencing the next page number
|
|
2109
|
-
* @type {number}
|
|
2110
|
-
* @memberof ReviewsResponse
|
|
2111
831
|
*/
|
|
2112
832
|
'nextPageToken'?: number | null;
|
|
2113
833
|
}
|
|
2114
|
-
/**
|
|
2115
|
-
*
|
|
2116
|
-
* @export
|
|
2117
|
-
* @interface SaveDashboardRequest
|
|
2118
|
-
*/
|
|
2119
834
|
export interface SaveDashboardRequest {
|
|
2120
|
-
/**
|
|
2121
|
-
*
|
|
2122
|
-
* @type {Array<DashboardItem>}
|
|
2123
|
-
* @memberof SaveDashboardRequest
|
|
2124
|
-
*/
|
|
2125
835
|
'items'?: Array<DashboardItem>;
|
|
2126
836
|
}
|
|
2127
|
-
/**
|
|
2128
|
-
*
|
|
2129
|
-
* @export
|
|
2130
|
-
* @interface SaveTermsRequest
|
|
2131
|
-
*/
|
|
2132
837
|
export interface SaveTermsRequest {
|
|
2133
|
-
/**
|
|
2134
|
-
*
|
|
2135
|
-
* @type {string}
|
|
2136
|
-
* @memberof SaveTermsRequest
|
|
2137
|
-
*/
|
|
2138
838
|
'title': string;
|
|
2139
|
-
/**
|
|
2140
|
-
*
|
|
2141
|
-
* @type {string}
|
|
2142
|
-
* @memberof SaveTermsRequest
|
|
2143
|
-
*/
|
|
2144
839
|
'content': string;
|
|
2145
|
-
/**
|
|
2146
|
-
*
|
|
2147
|
-
* @type {boolean}
|
|
2148
|
-
* @memberof SaveTermsRequest
|
|
2149
|
-
*/
|
|
2150
840
|
'enabled': boolean;
|
|
2151
|
-
/**
|
|
2152
|
-
*
|
|
2153
|
-
* @type {boolean}
|
|
2154
|
-
* @memberof SaveTermsRequest
|
|
2155
|
-
*/
|
|
2156
841
|
'updateVersion': boolean;
|
|
2157
842
|
}
|
|
2158
|
-
/**
|
|
2159
|
-
*
|
|
2160
|
-
* @export
|
|
2161
|
-
* @interface ShippingMethod
|
|
2162
|
-
*/
|
|
2163
843
|
export interface ShippingMethod {
|
|
2164
844
|
/**
|
|
2165
845
|
* Unique object identifier
|
|
2166
|
-
* @type {string}
|
|
2167
|
-
* @memberof ShippingMethod
|
|
2168
846
|
*/
|
|
2169
847
|
'id'?: string;
|
|
2170
|
-
/**
|
|
2171
|
-
*
|
|
2172
|
-
* @type {string}
|
|
2173
|
-
* @memberof ShippingMethod
|
|
2174
|
-
*/
|
|
2175
848
|
'name'?: string;
|
|
2176
|
-
/**
|
|
2177
|
-
*
|
|
2178
|
-
* @type {string}
|
|
2179
|
-
* @memberof ShippingMethod
|
|
2180
|
-
*/
|
|
2181
849
|
'description'?: string;
|
|
2182
|
-
/**
|
|
2183
|
-
*
|
|
2184
|
-
* @type {DeliveryEstimates}
|
|
2185
|
-
* @memberof ShippingMethod
|
|
2186
|
-
*/
|
|
2187
850
|
'deliveryEstimates'?: DeliveryEstimates;
|
|
2188
|
-
/**
|
|
2189
|
-
*
|
|
2190
|
-
* @type {Price}
|
|
2191
|
-
* @memberof ShippingMethod
|
|
2192
|
-
*/
|
|
2193
851
|
'totalPrice'?: Price;
|
|
2194
|
-
/**
|
|
2195
|
-
*
|
|
2196
|
-
* @type {Price}
|
|
2197
|
-
* @memberof ShippingMethod
|
|
2198
|
-
*/
|
|
2199
852
|
'taxPrice'?: Price;
|
|
2200
|
-
/**
|
|
2201
|
-
*
|
|
2202
|
-
* @type {Price}
|
|
2203
|
-
* @memberof ShippingMethod
|
|
2204
|
-
*/
|
|
2205
853
|
'subtotalPrice'?: Price;
|
|
2206
|
-
/**
|
|
2207
|
-
*
|
|
2208
|
-
* @type {Price}
|
|
2209
|
-
* @memberof ShippingMethod
|
|
2210
|
-
*/
|
|
2211
854
|
'discountPrice'?: Price;
|
|
2212
855
|
}
|
|
2213
|
-
/**
|
|
2214
|
-
*
|
|
2215
|
-
* @export
|
|
2216
|
-
* @interface Statistics
|
|
2217
|
-
*/
|
|
2218
856
|
export interface Statistics {
|
|
2219
|
-
/**
|
|
2220
|
-
*
|
|
2221
|
-
* @type {number}
|
|
2222
|
-
* @memberof Statistics
|
|
2223
|
-
*/
|
|
2224
857
|
'lifetimeValue': number;
|
|
2225
|
-
/**
|
|
2226
|
-
*
|
|
2227
|
-
* @type {number}
|
|
2228
|
-
* @memberof Statistics
|
|
2229
|
-
*/
|
|
2230
858
|
'totalOrderCount': number;
|
|
2231
|
-
/**
|
|
2232
|
-
*
|
|
2233
|
-
* @type {number}
|
|
2234
|
-
* @memberof Statistics
|
|
2235
|
-
*/
|
|
2236
859
|
'refundedOrderCount': number;
|
|
2237
|
-
/**
|
|
2238
|
-
*
|
|
2239
|
-
* @type {string}
|
|
2240
|
-
* @memberof Statistics
|
|
2241
|
-
*/
|
|
2242
860
|
'lastPurchased': string | null;
|
|
2243
|
-
/**
|
|
2244
|
-
*
|
|
2245
|
-
* @type {boolean}
|
|
2246
|
-
* @memberof Statistics
|
|
2247
|
-
*/
|
|
2248
861
|
'usedDiscount': boolean;
|
|
2249
862
|
}
|
|
2250
|
-
/**
|
|
2251
|
-
*
|
|
2252
|
-
* @export
|
|
2253
|
-
* @interface StatusHistoryItem
|
|
2254
|
-
*/
|
|
2255
863
|
export interface StatusHistoryItem {
|
|
2256
|
-
/**
|
|
2257
|
-
*
|
|
2258
|
-
* @type {OrderStatus}
|
|
2259
|
-
* @memberof StatusHistoryItem
|
|
2260
|
-
*/
|
|
2261
864
|
'status'?: OrderStatus;
|
|
2262
865
|
/**
|
|
2263
866
|
* ISO 8601 Timestamp
|
|
2264
|
-
* @type {string}
|
|
2265
|
-
* @memberof StatusHistoryItem
|
|
2266
867
|
*/
|
|
2267
868
|
'createdAt'?: string;
|
|
2268
869
|
}
|
|
2269
|
-
/**
|
|
2270
|
-
*
|
|
2271
|
-
* @export
|
|
2272
|
-
* @interface Terms
|
|
2273
|
-
*/
|
|
2274
870
|
export interface Terms {
|
|
2275
|
-
/**
|
|
2276
|
-
*
|
|
2277
|
-
* @type {string}
|
|
2278
|
-
* @memberof Terms
|
|
2279
|
-
*/
|
|
2280
871
|
'id': string;
|
|
2281
|
-
/**
|
|
2282
|
-
*
|
|
2283
|
-
* @type {string}
|
|
2284
|
-
* @memberof Terms
|
|
2285
|
-
*/
|
|
2286
872
|
'title': string;
|
|
2287
|
-
/**
|
|
2288
|
-
*
|
|
2289
|
-
* @type {string}
|
|
2290
|
-
* @memberof Terms
|
|
2291
|
-
*/
|
|
2292
873
|
'content': string;
|
|
2293
|
-
/**
|
|
2294
|
-
*
|
|
2295
|
-
* @type {number}
|
|
2296
|
-
* @memberof Terms
|
|
2297
|
-
*/
|
|
2298
874
|
'version': number;
|
|
2299
|
-
/**
|
|
2300
|
-
*
|
|
2301
|
-
* @type {boolean}
|
|
2302
|
-
* @memberof Terms
|
|
2303
|
-
*/
|
|
2304
875
|
'enabled': boolean;
|
|
2305
|
-
/**
|
|
2306
|
-
*
|
|
2307
|
-
* @type {string}
|
|
2308
|
-
* @memberof Terms
|
|
2309
|
-
*/
|
|
2310
876
|
'createdAt': string;
|
|
2311
|
-
/**
|
|
2312
|
-
*
|
|
2313
|
-
* @type {string}
|
|
2314
|
-
* @memberof Terms
|
|
2315
|
-
*/
|
|
2316
877
|
'updatedAt': string;
|
|
2317
878
|
}
|
|
2318
|
-
/**
|
|
2319
|
-
*
|
|
2320
|
-
* @export
|
|
2321
|
-
* @interface UpdateCustomerEnquiryRequest
|
|
2322
|
-
*/
|
|
2323
879
|
export interface UpdateCustomerEnquiryRequest {
|
|
2324
880
|
/**
|
|
2325
881
|
* The unique id of the user who owns the enquiry
|
|
2326
|
-
* @type {string}
|
|
2327
|
-
* @memberof UpdateCustomerEnquiryRequest
|
|
2328
882
|
*/
|
|
2329
883
|
'owner'?: string | null;
|
|
2330
884
|
}
|
|
2331
|
-
/**
|
|
2332
|
-
*
|
|
2333
|
-
* @export
|
|
2334
|
-
* @interface UpdateFulfillmentRequest
|
|
2335
|
-
*/
|
|
2336
885
|
export interface UpdateFulfillmentRequest {
|
|
2337
886
|
/**
|
|
2338
887
|
* Unique object identifier
|
|
2339
|
-
* @type {string}
|
|
2340
|
-
* @memberof UpdateFulfillmentRequest
|
|
2341
888
|
*/
|
|
2342
889
|
'fulfillerId'?: string;
|
|
2343
890
|
}
|
|
2344
|
-
/**
|
|
2345
|
-
*
|
|
2346
|
-
* @export
|
|
2347
|
-
* @interface UpdatePlatformRequest
|
|
2348
|
-
*/
|
|
2349
891
|
export interface UpdatePlatformRequest {
|
|
2350
|
-
/**
|
|
2351
|
-
*
|
|
2352
|
-
* @type {Array<PlatformLogo>}
|
|
2353
|
-
* @memberof UpdatePlatformRequest
|
|
2354
|
-
*/
|
|
2355
892
|
'logos'?: Array<PlatformLogo>;
|
|
2356
|
-
/**
|
|
2357
|
-
*
|
|
2358
|
-
* @type {string}
|
|
2359
|
-
* @memberof UpdatePlatformRequest
|
|
2360
|
-
*/
|
|
2361
893
|
'favicon'?: string;
|
|
2362
|
-
/**
|
|
2363
|
-
*
|
|
2364
|
-
* @type {boolean}
|
|
2365
|
-
* @memberof UpdatePlatformRequest
|
|
2366
|
-
*/
|
|
2367
894
|
'clientGiftWrapAvailable'?: boolean;
|
|
2368
|
-
/**
|
|
2369
|
-
*
|
|
2370
|
-
* @type {number}
|
|
2371
|
-
* @memberof UpdatePlatformRequest
|
|
2372
|
-
*/
|
|
2373
895
|
'storeSubscriptionFee'?: number;
|
|
2374
|
-
/**
|
|
2375
|
-
*
|
|
2376
|
-
* @type {number}
|
|
2377
|
-
* @memberof UpdatePlatformRequest
|
|
2378
|
-
*/
|
|
2379
896
|
'orderHandlingFee'?: number;
|
|
2380
|
-
/**
|
|
2381
|
-
*
|
|
2382
|
-
* @type {number}
|
|
2383
|
-
* @memberof UpdatePlatformRequest
|
|
2384
|
-
*/
|
|
2385
897
|
'itemHandlingFee'?: number;
|
|
2386
|
-
|
|
2387
|
-
*
|
|
2388
|
-
* @type {boolean}
|
|
2389
|
-
* @memberof UpdatePlatformRequest
|
|
2390
|
-
*/
|
|
898
|
+
'neckPrintFee'?: number;
|
|
2391
899
|
'chargeClients'?: boolean;
|
|
2392
900
|
}
|
|
2393
|
-
/**
|
|
2394
|
-
*
|
|
2395
|
-
* @export
|
|
2396
|
-
* @interface ValidationError
|
|
2397
|
-
*/
|
|
2398
901
|
export interface ValidationError {
|
|
2399
|
-
/**
|
|
2400
|
-
*
|
|
2401
|
-
* @type {string}
|
|
2402
|
-
* @memberof ValidationError
|
|
2403
|
-
*/
|
|
2404
902
|
'message': string;
|
|
2405
903
|
}
|
|
2406
|
-
/**
|
|
2407
|
-
*
|
|
2408
|
-
* @export
|
|
2409
|
-
* @interface Variant
|
|
2410
|
-
*/
|
|
2411
904
|
export interface Variant {
|
|
2412
905
|
/**
|
|
2413
906
|
* Unique object identifier
|
|
2414
|
-
* @type {string}
|
|
2415
|
-
* @memberof Variant
|
|
2416
907
|
*/
|
|
2417
908
|
'id': string;
|
|
2418
909
|
/**
|
|
2419
910
|
* A reference to the resource location
|
|
2420
|
-
* @type {string}
|
|
2421
|
-
* @memberof Variant
|
|
2422
911
|
*/
|
|
2423
912
|
'ref': string;
|
|
2424
913
|
/**
|
|
2425
914
|
* A reference to the resource location
|
|
2426
|
-
* @type {string}
|
|
2427
|
-
* @memberof Variant
|
|
2428
915
|
*/
|
|
2429
916
|
'productRef': string;
|
|
2430
917
|
/**
|
|
2431
918
|
* A reference to the resource location
|
|
2432
|
-
* @type {string}
|
|
2433
|
-
* @memberof Variant
|
|
2434
919
|
*/
|
|
2435
920
|
'warehouseVariantRef': string;
|
|
2436
921
|
}
|
|
2437
922
|
/**
|
|
2438
923
|
* CustomersApi - axios parameter creator
|
|
2439
|
-
* @export
|
|
2440
924
|
*/
|
|
2441
925
|
export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2442
926
|
/**
|
|
@@ -2449,6 +933,8 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2449
933
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2450
934
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2451
935
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
936
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
937
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2452
938
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2453
939
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2454
940
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -2461,7 +947,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2461
947
|
* @param {*} [options] Override http request option.
|
|
2462
948
|
* @throws {RequiredError}
|
|
2463
949
|
*/
|
|
2464
|
-
exportCustomers: (project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
950
|
+
exportCustomers: (project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2465
951
|
/**
|
|
2466
952
|
* Get a customer for a platform by a given customer ID.
|
|
2467
953
|
* @summary Get customer
|
|
@@ -2472,6 +958,18 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2472
958
|
* @throws {RequiredError}
|
|
2473
959
|
*/
|
|
2474
960
|
getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
961
|
+
/**
|
|
962
|
+
* List customer tags
|
|
963
|
+
* @summary List customer tags
|
|
964
|
+
* @param {string} project Project unique identifier
|
|
965
|
+
* @param {string} platformId The platform identifier
|
|
966
|
+
* @param {number} [pageToken] Page reference token
|
|
967
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
968
|
+
* @param {string} [search] Search term to filter results
|
|
969
|
+
* @param {*} [options] Override http request option.
|
|
970
|
+
* @throws {RequiredError}
|
|
971
|
+
*/
|
|
972
|
+
listCustomerTags: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2475
973
|
/**
|
|
2476
974
|
* List customers for a platform
|
|
2477
975
|
* @summary List customers
|
|
@@ -2485,6 +983,8 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2485
983
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2486
984
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2487
985
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
986
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
987
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2488
988
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2489
989
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2490
990
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -2497,11 +997,10 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2497
997
|
* @param {*} [options] Override http request option.
|
|
2498
998
|
* @throws {RequiredError}
|
|
2499
999
|
*/
|
|
2500
|
-
listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1000
|
+
listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2501
1001
|
};
|
|
2502
1002
|
/**
|
|
2503
1003
|
* CustomersApi - functional programming interface
|
|
2504
|
-
* @export
|
|
2505
1004
|
*/
|
|
2506
1005
|
export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
2507
1006
|
/**
|
|
@@ -2514,6 +1013,8 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
2514
1013
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2515
1014
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2516
1015
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
1016
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
1017
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2517
1018
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2518
1019
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2519
1020
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -2526,7 +1027,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
2526
1027
|
* @param {*} [options] Override http request option.
|
|
2527
1028
|
* @throws {RequiredError}
|
|
2528
1029
|
*/
|
|
2529
|
-
exportCustomers(project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1030
|
+
exportCustomers(project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2530
1031
|
/**
|
|
2531
1032
|
* Get a customer for a platform by a given customer ID.
|
|
2532
1033
|
* @summary Get customer
|
|
@@ -2537,6 +1038,18 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
2537
1038
|
* @throws {RequiredError}
|
|
2538
1039
|
*/
|
|
2539
1040
|
getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
|
|
1041
|
+
/**
|
|
1042
|
+
* List customer tags
|
|
1043
|
+
* @summary List customer tags
|
|
1044
|
+
* @param {string} project Project unique identifier
|
|
1045
|
+
* @param {string} platformId The platform identifier
|
|
1046
|
+
* @param {number} [pageToken] Page reference token
|
|
1047
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1048
|
+
* @param {string} [search] Search term to filter results
|
|
1049
|
+
* @param {*} [options] Override http request option.
|
|
1050
|
+
* @throws {RequiredError}
|
|
1051
|
+
*/
|
|
1052
|
+
listCustomerTags(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerTags200Response>>;
|
|
2540
1053
|
/**
|
|
2541
1054
|
* List customers for a platform
|
|
2542
1055
|
* @summary List customers
|
|
@@ -2550,6 +1063,8 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
2550
1063
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2551
1064
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2552
1065
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
1066
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
1067
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2553
1068
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2554
1069
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2555
1070
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -2562,11 +1077,10 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
2562
1077
|
* @param {*} [options] Override http request option.
|
|
2563
1078
|
* @throws {RequiredError}
|
|
2564
1079
|
*/
|
|
2565
|
-
listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
1080
|
+
listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
2566
1081
|
};
|
|
2567
1082
|
/**
|
|
2568
1083
|
* CustomersApi - factory interface
|
|
2569
|
-
* @export
|
|
2570
1084
|
*/
|
|
2571
1085
|
export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2572
1086
|
/**
|
|
@@ -2585,6 +1099,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
2585
1099
|
* @throws {RequiredError}
|
|
2586
1100
|
*/
|
|
2587
1101
|
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
|
|
1102
|
+
/**
|
|
1103
|
+
* List customer tags
|
|
1104
|
+
* @summary List customer tags
|
|
1105
|
+
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
1106
|
+
* @param {*} [options] Override http request option.
|
|
1107
|
+
* @throws {RequiredError}
|
|
1108
|
+
*/
|
|
1109
|
+
listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerTags200Response>;
|
|
2588
1110
|
/**
|
|
2589
1111
|
* List customers for a platform
|
|
2590
1112
|
* @summary List customers
|
|
@@ -2596,258 +1118,214 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
2596
1118
|
};
|
|
2597
1119
|
/**
|
|
2598
1120
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
2599
|
-
* @export
|
|
2600
|
-
* @interface CustomersApiExportCustomersRequest
|
|
2601
1121
|
*/
|
|
2602
1122
|
export interface CustomersApiExportCustomersRequest {
|
|
2603
1123
|
/**
|
|
2604
1124
|
* Project unique identifier
|
|
2605
|
-
* @type {string}
|
|
2606
|
-
* @memberof CustomersApiExportCustomers
|
|
2607
1125
|
*/
|
|
2608
1126
|
readonly project: string;
|
|
2609
1127
|
/**
|
|
2610
1128
|
* The platform identifier
|
|
2611
|
-
* @type {string}
|
|
2612
|
-
* @memberof CustomersApiExportCustomers
|
|
2613
1129
|
*/
|
|
2614
1130
|
readonly platformId: string;
|
|
2615
1131
|
/**
|
|
2616
1132
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2617
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
|
|
2618
|
-
* @memberof CustomersApiExportCustomers
|
|
2619
1133
|
*/
|
|
2620
1134
|
readonly sortBy?: Array<ExportCustomersSortByEnum>;
|
|
2621
1135
|
/**
|
|
2622
1136
|
* Filter customers by country code
|
|
2623
|
-
* @type {Array<string>}
|
|
2624
|
-
* @memberof CustomersApiExportCustomers
|
|
2625
1137
|
*/
|
|
2626
1138
|
readonly countries?: Array<string>;
|
|
2627
1139
|
/**
|
|
2628
1140
|
* Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2629
|
-
* @type {Array<string>}
|
|
2630
|
-
* @memberof CustomersApiExportCustomers
|
|
2631
1141
|
*/
|
|
2632
1142
|
readonly projects?: Array<string>;
|
|
2633
1143
|
/**
|
|
2634
1144
|
* Filter customers by gender equal to the value provided
|
|
2635
|
-
* @type {'male' | 'female'}
|
|
2636
|
-
* @memberof CustomersApiExportCustomers
|
|
2637
1145
|
*/
|
|
2638
1146
|
readonly gender?: ExportCustomersGenderEnum;
|
|
2639
1147
|
/**
|
|
2640
1148
|
* Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2641
|
-
* @type {Array<number>}
|
|
2642
|
-
* @memberof CustomersApiExportCustomers
|
|
2643
1149
|
*/
|
|
2644
1150
|
readonly productTypes?: Array<number>;
|
|
1151
|
+
/**
|
|
1152
|
+
* Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
1153
|
+
*/
|
|
1154
|
+
readonly demographics?: Array<string>;
|
|
1155
|
+
/**
|
|
1156
|
+
* Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
1157
|
+
*/
|
|
1158
|
+
readonly tags?: Array<string>;
|
|
2645
1159
|
/**
|
|
2646
1160
|
* Filter customers by whether they have used a discount
|
|
2647
|
-
* @type {boolean}
|
|
2648
|
-
* @memberof CustomersApiExportCustomers
|
|
2649
1161
|
*/
|
|
2650
1162
|
readonly usedDiscount?: boolean;
|
|
2651
1163
|
/**
|
|
2652
1164
|
* Filter customers by total order count greater than or equal to the value provided
|
|
2653
|
-
* @type {number}
|
|
2654
|
-
* @memberof CustomersApiExportCustomers
|
|
2655
1165
|
*/
|
|
2656
1166
|
readonly minimumTotalOrderCount?: number;
|
|
2657
1167
|
/**
|
|
2658
1168
|
* Filter customers by total order count less than or equal to the value provided
|
|
2659
|
-
* @type {number}
|
|
2660
|
-
* @memberof CustomersApiExportCustomers
|
|
2661
1169
|
*/
|
|
2662
1170
|
readonly maximumTotalOrderCount?: number;
|
|
2663
1171
|
/**
|
|
2664
1172
|
* Filter customers by refunded order count greater than or equal to the value provided
|
|
2665
|
-
* @type {number}
|
|
2666
|
-
* @memberof CustomersApiExportCustomers
|
|
2667
1173
|
*/
|
|
2668
1174
|
readonly minimumRefundedOrderCount?: number;
|
|
2669
1175
|
/**
|
|
2670
1176
|
* Filter customers by refunded order count less than or equal to the value provided
|
|
2671
|
-
* @type {number}
|
|
2672
|
-
* @memberof CustomersApiExportCustomers
|
|
2673
1177
|
*/
|
|
2674
1178
|
readonly maximumRefundedOrderCount?: number;
|
|
2675
1179
|
/**
|
|
2676
1180
|
* Filter customers by lifetime value greater than or equal to the value provided
|
|
2677
|
-
* @type {number}
|
|
2678
|
-
* @memberof CustomersApiExportCustomers
|
|
2679
1181
|
*/
|
|
2680
1182
|
readonly minimumLifetimeValue?: number;
|
|
2681
1183
|
/**
|
|
2682
1184
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2683
|
-
* @type {number}
|
|
2684
|
-
* @memberof CustomersApiExportCustomers
|
|
2685
1185
|
*/
|
|
2686
1186
|
readonly maximumLifetimeValue?: number;
|
|
2687
1187
|
/**
|
|
2688
1188
|
* Start of date range to filter customers by last purchase date
|
|
2689
|
-
* @type {string}
|
|
2690
|
-
* @memberof CustomersApiExportCustomers
|
|
2691
1189
|
*/
|
|
2692
1190
|
readonly lastPurchasedStart?: string;
|
|
2693
1191
|
/**
|
|
2694
1192
|
* End of date range to filter customers by last purchase date
|
|
2695
|
-
* @type {string}
|
|
2696
|
-
* @memberof CustomersApiExportCustomers
|
|
2697
1193
|
*/
|
|
2698
1194
|
readonly lastPurchasedEnd?: string;
|
|
2699
1195
|
}
|
|
2700
1196
|
/**
|
|
2701
1197
|
* Request parameters for getCustomer operation in CustomersApi.
|
|
2702
|
-
* @export
|
|
2703
|
-
* @interface CustomersApiGetCustomerRequest
|
|
2704
1198
|
*/
|
|
2705
1199
|
export interface CustomersApiGetCustomerRequest {
|
|
2706
1200
|
/**
|
|
2707
1201
|
* Project unique identifier
|
|
2708
|
-
* @type {string}
|
|
2709
|
-
* @memberof CustomersApiGetCustomer
|
|
2710
1202
|
*/
|
|
2711
1203
|
readonly project: string;
|
|
2712
1204
|
/**
|
|
2713
1205
|
* The platform identifier
|
|
2714
|
-
* @type {string}
|
|
2715
|
-
* @memberof CustomersApiGetCustomer
|
|
2716
1206
|
*/
|
|
2717
1207
|
readonly platformId: string;
|
|
2718
1208
|
/**
|
|
2719
1209
|
* The customer identifier
|
|
2720
|
-
* @type {string}
|
|
2721
|
-
* @memberof CustomersApiGetCustomer
|
|
2722
1210
|
*/
|
|
2723
1211
|
readonly customerId: string;
|
|
2724
1212
|
}
|
|
1213
|
+
/**
|
|
1214
|
+
* Request parameters for listCustomerTags operation in CustomersApi.
|
|
1215
|
+
*/
|
|
1216
|
+
export interface CustomersApiListCustomerTagsRequest {
|
|
1217
|
+
/**
|
|
1218
|
+
* Project unique identifier
|
|
1219
|
+
*/
|
|
1220
|
+
readonly project: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* The platform identifier
|
|
1223
|
+
*/
|
|
1224
|
+
readonly platformId: string;
|
|
1225
|
+
/**
|
|
1226
|
+
* Page reference token
|
|
1227
|
+
*/
|
|
1228
|
+
readonly pageToken?: number;
|
|
1229
|
+
/**
|
|
1230
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1231
|
+
*/
|
|
1232
|
+
readonly pageSize?: number;
|
|
1233
|
+
/**
|
|
1234
|
+
* Search term to filter results
|
|
1235
|
+
*/
|
|
1236
|
+
readonly search?: string;
|
|
1237
|
+
}
|
|
2725
1238
|
/**
|
|
2726
1239
|
* Request parameters for listCustomers operation in CustomersApi.
|
|
2727
|
-
* @export
|
|
2728
|
-
* @interface CustomersApiListCustomersRequest
|
|
2729
1240
|
*/
|
|
2730
1241
|
export interface CustomersApiListCustomersRequest {
|
|
2731
1242
|
/**
|
|
2732
1243
|
* Project unique identifier
|
|
2733
|
-
* @type {string}
|
|
2734
|
-
* @memberof CustomersApiListCustomers
|
|
2735
1244
|
*/
|
|
2736
1245
|
readonly project: string;
|
|
2737
1246
|
/**
|
|
2738
1247
|
* The platform identifier
|
|
2739
|
-
* @type {string}
|
|
2740
|
-
* @memberof CustomersApiListCustomers
|
|
2741
1248
|
*/
|
|
2742
1249
|
readonly platformId: string;
|
|
2743
1250
|
/**
|
|
2744
1251
|
* Page reference token
|
|
2745
|
-
* @type {number}
|
|
2746
|
-
* @memberof CustomersApiListCustomers
|
|
2747
1252
|
*/
|
|
2748
1253
|
readonly pageToken?: number;
|
|
2749
1254
|
/**
|
|
2750
1255
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2751
|
-
* @type {number}
|
|
2752
|
-
* @memberof CustomersApiListCustomers
|
|
2753
1256
|
*/
|
|
2754
1257
|
readonly pageSize?: number;
|
|
2755
1258
|
/**
|
|
2756
1259
|
* Search term to filter results
|
|
2757
|
-
* @type {string}
|
|
2758
|
-
* @memberof CustomersApiListCustomers
|
|
2759
1260
|
*/
|
|
2760
1261
|
readonly search?: string;
|
|
2761
1262
|
/**
|
|
2762
1263
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2763
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
|
|
2764
|
-
* @memberof CustomersApiListCustomers
|
|
2765
1264
|
*/
|
|
2766
1265
|
readonly sortBy?: Array<ListCustomersSortByEnum>;
|
|
2767
1266
|
/**
|
|
2768
1267
|
* Filter customers by country code
|
|
2769
|
-
* @type {Array<string>}
|
|
2770
|
-
* @memberof CustomersApiListCustomers
|
|
2771
1268
|
*/
|
|
2772
1269
|
readonly countries?: Array<string>;
|
|
2773
1270
|
/**
|
|
2774
1271
|
* Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2775
|
-
* @type {Array<string>}
|
|
2776
|
-
* @memberof CustomersApiListCustomers
|
|
2777
1272
|
*/
|
|
2778
1273
|
readonly projects?: Array<string>;
|
|
2779
1274
|
/**
|
|
2780
1275
|
* Filter customers by gender equal to the value provided
|
|
2781
|
-
* @type {'male' | 'female'}
|
|
2782
|
-
* @memberof CustomersApiListCustomers
|
|
2783
1276
|
*/
|
|
2784
1277
|
readonly gender?: ListCustomersGenderEnum;
|
|
2785
1278
|
/**
|
|
2786
1279
|
* Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2787
|
-
* @type {Array<number>}
|
|
2788
|
-
* @memberof CustomersApiListCustomers
|
|
2789
1280
|
*/
|
|
2790
1281
|
readonly productTypes?: Array<number>;
|
|
1282
|
+
/**
|
|
1283
|
+
* Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
1284
|
+
*/
|
|
1285
|
+
readonly demographics?: Array<string>;
|
|
1286
|
+
/**
|
|
1287
|
+
* Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
1288
|
+
*/
|
|
1289
|
+
readonly tags?: Array<string>;
|
|
2791
1290
|
/**
|
|
2792
1291
|
* Filter customers by whether they have used a discount
|
|
2793
|
-
* @type {boolean}
|
|
2794
|
-
* @memberof CustomersApiListCustomers
|
|
2795
1292
|
*/
|
|
2796
1293
|
readonly usedDiscount?: boolean;
|
|
2797
1294
|
/**
|
|
2798
1295
|
* Filter customers by total order count greater than or equal to the value provided
|
|
2799
|
-
* @type {number}
|
|
2800
|
-
* @memberof CustomersApiListCustomers
|
|
2801
1296
|
*/
|
|
2802
1297
|
readonly minimumTotalOrderCount?: number;
|
|
2803
1298
|
/**
|
|
2804
1299
|
* Filter customers by total order count less than or equal to the value provided
|
|
2805
|
-
* @type {number}
|
|
2806
|
-
* @memberof CustomersApiListCustomers
|
|
2807
1300
|
*/
|
|
2808
1301
|
readonly maximumTotalOrderCount?: number;
|
|
2809
1302
|
/**
|
|
2810
1303
|
* Filter customers by refunded order count greater than or equal to the value provided
|
|
2811
|
-
* @type {number}
|
|
2812
|
-
* @memberof CustomersApiListCustomers
|
|
2813
1304
|
*/
|
|
2814
1305
|
readonly minimumRefundedOrderCount?: number;
|
|
2815
1306
|
/**
|
|
2816
1307
|
* Filter customers by refunded order count less than or equal to the value provided
|
|
2817
|
-
* @type {number}
|
|
2818
|
-
* @memberof CustomersApiListCustomers
|
|
2819
1308
|
*/
|
|
2820
1309
|
readonly maximumRefundedOrderCount?: number;
|
|
2821
1310
|
/**
|
|
2822
1311
|
* Filter customers by lifetime value greater than or equal to the value provided
|
|
2823
|
-
* @type {number}
|
|
2824
|
-
* @memberof CustomersApiListCustomers
|
|
2825
1312
|
*/
|
|
2826
1313
|
readonly minimumLifetimeValue?: number;
|
|
2827
1314
|
/**
|
|
2828
1315
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2829
|
-
* @type {number}
|
|
2830
|
-
* @memberof CustomersApiListCustomers
|
|
2831
1316
|
*/
|
|
2832
1317
|
readonly maximumLifetimeValue?: number;
|
|
2833
1318
|
/**
|
|
2834
1319
|
* Start of date range to filter customers by last purchase date
|
|
2835
|
-
* @type {string}
|
|
2836
|
-
* @memberof CustomersApiListCustomers
|
|
2837
1320
|
*/
|
|
2838
1321
|
readonly lastPurchasedStart?: string;
|
|
2839
1322
|
/**
|
|
2840
1323
|
* End of date range to filter customers by last purchase date
|
|
2841
|
-
* @type {string}
|
|
2842
|
-
* @memberof CustomersApiListCustomers
|
|
2843
1324
|
*/
|
|
2844
1325
|
readonly lastPurchasedEnd?: string;
|
|
2845
1326
|
}
|
|
2846
1327
|
/**
|
|
2847
1328
|
* CustomersApi - object-oriented interface
|
|
2848
|
-
* @export
|
|
2849
|
-
* @class CustomersApi
|
|
2850
|
-
* @extends {BaseAPI}
|
|
2851
1329
|
*/
|
|
2852
1330
|
export declare class CustomersApi extends BaseAPI {
|
|
2853
1331
|
/**
|
|
@@ -2856,7 +1334,6 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
2856
1334
|
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
2857
1335
|
* @param {*} [options] Override http request option.
|
|
2858
1336
|
* @throws {RequiredError}
|
|
2859
|
-
* @memberof CustomersApi
|
|
2860
1337
|
*/
|
|
2861
1338
|
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
2862
1339
|
/**
|
|
@@ -2865,22 +1342,25 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
2865
1342
|
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
2866
1343
|
* @param {*} [options] Override http request option.
|
|
2867
1344
|
* @throws {RequiredError}
|
|
2868
|
-
* @memberof CustomersApi
|
|
2869
1345
|
*/
|
|
2870
1346
|
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
|
|
1347
|
+
/**
|
|
1348
|
+
* List customer tags
|
|
1349
|
+
* @summary List customer tags
|
|
1350
|
+
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
1351
|
+
* @param {*} [options] Override http request option.
|
|
1352
|
+
* @throws {RequiredError}
|
|
1353
|
+
*/
|
|
1354
|
+
listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerTags200Response, any>>;
|
|
2871
1355
|
/**
|
|
2872
1356
|
* List customers for a platform
|
|
2873
1357
|
* @summary List customers
|
|
2874
1358
|
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
2875
1359
|
* @param {*} [options] Override http request option.
|
|
2876
1360
|
* @throws {RequiredError}
|
|
2877
|
-
* @memberof CustomersApi
|
|
2878
1361
|
*/
|
|
2879
1362
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
|
|
2880
1363
|
}
|
|
2881
|
-
/**
|
|
2882
|
-
* @export
|
|
2883
|
-
*/
|
|
2884
1364
|
export declare const ExportCustomersSortByEnum: {
|
|
2885
1365
|
readonly LifetimeValue: "+lifetimeValue";
|
|
2886
1366
|
readonly LifetimeValue2: "-lifetimeValue";
|
|
@@ -2894,17 +1374,11 @@ export declare const ExportCustomersSortByEnum: {
|
|
|
2894
1374
|
readonly UsedDiscount2: "-usedDiscount";
|
|
2895
1375
|
};
|
|
2896
1376
|
export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
|
|
2897
|
-
/**
|
|
2898
|
-
* @export
|
|
2899
|
-
*/
|
|
2900
1377
|
export declare const ExportCustomersGenderEnum: {
|
|
2901
1378
|
readonly Male: "male";
|
|
2902
1379
|
readonly Female: "female";
|
|
2903
1380
|
};
|
|
2904
1381
|
export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
|
|
2905
|
-
/**
|
|
2906
|
-
* @export
|
|
2907
|
-
*/
|
|
2908
1382
|
export declare const ListCustomersSortByEnum: {
|
|
2909
1383
|
readonly LifetimeValue: "+lifetimeValue";
|
|
2910
1384
|
readonly LifetimeValue2: "-lifetimeValue";
|
|
@@ -2918,9 +1392,6 @@ export declare const ListCustomersSortByEnum: {
|
|
|
2918
1392
|
readonly UsedDiscount2: "-usedDiscount";
|
|
2919
1393
|
};
|
|
2920
1394
|
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
2921
|
-
/**
|
|
2922
|
-
* @export
|
|
2923
|
-
*/
|
|
2924
1395
|
export declare const ListCustomersGenderEnum: {
|
|
2925
1396
|
readonly Male: "male";
|
|
2926
1397
|
readonly Female: "female";
|
|
@@ -2928,7 +1399,6 @@ export declare const ListCustomersGenderEnum: {
|
|
|
2928
1399
|
export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
|
|
2929
1400
|
/**
|
|
2930
1401
|
* DashboardApi - axios parameter creator
|
|
2931
|
-
* @export
|
|
2932
1402
|
*/
|
|
2933
1403
|
export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2934
1404
|
/**
|
|
@@ -2953,7 +1423,6 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2953
1423
|
};
|
|
2954
1424
|
/**
|
|
2955
1425
|
* DashboardApi - functional programming interface
|
|
2956
|
-
* @export
|
|
2957
1426
|
*/
|
|
2958
1427
|
export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
2959
1428
|
/**
|
|
@@ -2978,7 +1447,6 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
2978
1447
|
};
|
|
2979
1448
|
/**
|
|
2980
1449
|
* DashboardApi - factory interface
|
|
2981
|
-
* @export
|
|
2982
1450
|
*/
|
|
2983
1451
|
export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2984
1452
|
/**
|
|
@@ -3000,53 +1468,36 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
3000
1468
|
};
|
|
3001
1469
|
/**
|
|
3002
1470
|
* Request parameters for getDashboard operation in DashboardApi.
|
|
3003
|
-
* @export
|
|
3004
|
-
* @interface DashboardApiGetDashboardRequest
|
|
3005
1471
|
*/
|
|
3006
1472
|
export interface DashboardApiGetDashboardRequest {
|
|
3007
1473
|
/**
|
|
3008
1474
|
* Project unique identifier
|
|
3009
|
-
* @type {string}
|
|
3010
|
-
* @memberof DashboardApiGetDashboard
|
|
3011
1475
|
*/
|
|
3012
1476
|
readonly project: string;
|
|
3013
1477
|
/**
|
|
3014
1478
|
* The platform identifier
|
|
3015
|
-
* @type {string}
|
|
3016
|
-
* @memberof DashboardApiGetDashboard
|
|
3017
1479
|
*/
|
|
3018
1480
|
readonly platformId: string;
|
|
3019
1481
|
}
|
|
3020
1482
|
/**
|
|
3021
1483
|
* Request parameters for saveDashboard operation in DashboardApi.
|
|
3022
|
-
* @export
|
|
3023
|
-
* @interface DashboardApiSaveDashboardRequest
|
|
3024
1484
|
*/
|
|
3025
1485
|
export interface DashboardApiSaveDashboardRequest {
|
|
3026
1486
|
/**
|
|
3027
1487
|
* Project unique identifier
|
|
3028
|
-
* @type {string}
|
|
3029
|
-
* @memberof DashboardApiSaveDashboard
|
|
3030
1488
|
*/
|
|
3031
1489
|
readonly project: string;
|
|
3032
1490
|
/**
|
|
3033
1491
|
* The platform identifier
|
|
3034
|
-
* @type {string}
|
|
3035
|
-
* @memberof DashboardApiSaveDashboard
|
|
3036
1492
|
*/
|
|
3037
1493
|
readonly platformId: string;
|
|
3038
1494
|
/**
|
|
3039
1495
|
* Save dashboard
|
|
3040
|
-
* @type {SaveDashboardRequest}
|
|
3041
|
-
* @memberof DashboardApiSaveDashboard
|
|
3042
1496
|
*/
|
|
3043
1497
|
readonly saveDashboardRequest: SaveDashboardRequest;
|
|
3044
1498
|
}
|
|
3045
1499
|
/**
|
|
3046
1500
|
* DashboardApi - object-oriented interface
|
|
3047
|
-
* @export
|
|
3048
|
-
* @class DashboardApi
|
|
3049
|
-
* @extends {BaseAPI}
|
|
3050
1501
|
*/
|
|
3051
1502
|
export declare class DashboardApi extends BaseAPI {
|
|
3052
1503
|
/**
|
|
@@ -3055,7 +1506,6 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
3055
1506
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
3056
1507
|
* @param {*} [options] Override http request option.
|
|
3057
1508
|
* @throws {RequiredError}
|
|
3058
|
-
* @memberof DashboardApi
|
|
3059
1509
|
*/
|
|
3060
1510
|
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
|
|
3061
1511
|
/**
|
|
@@ -3064,13 +1514,11 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
3064
1514
|
* @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
|
|
3065
1515
|
* @param {*} [options] Override http request option.
|
|
3066
1516
|
* @throws {RequiredError}
|
|
3067
|
-
* @memberof DashboardApi
|
|
3068
1517
|
*/
|
|
3069
1518
|
saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
|
|
3070
1519
|
}
|
|
3071
1520
|
/**
|
|
3072
1521
|
* EnquiriesApi - axios parameter creator
|
|
3073
|
-
* @export
|
|
3074
1522
|
*/
|
|
3075
1523
|
export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3076
1524
|
/**
|
|
@@ -3131,7 +1579,6 @@ export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3131
1579
|
};
|
|
3132
1580
|
/**
|
|
3133
1581
|
* EnquiriesApi - functional programming interface
|
|
3134
|
-
* @export
|
|
3135
1582
|
*/
|
|
3136
1583
|
export declare const EnquiriesApiFp: (configuration?: Configuration) => {
|
|
3137
1584
|
/**
|
|
@@ -3192,7 +1639,6 @@ export declare const EnquiriesApiFp: (configuration?: Configuration) => {
|
|
|
3192
1639
|
};
|
|
3193
1640
|
/**
|
|
3194
1641
|
* EnquiriesApi - factory interface
|
|
3195
|
-
* @export
|
|
3196
1642
|
*/
|
|
3197
1643
|
export declare const EnquiriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3198
1644
|
/**
|
|
@@ -3238,164 +1684,111 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
|
|
|
3238
1684
|
};
|
|
3239
1685
|
/**
|
|
3240
1686
|
* Request parameters for createChatChannel operation in EnquiriesApi.
|
|
3241
|
-
* @export
|
|
3242
|
-
* @interface EnquiriesApiCreateChatChannelRequest
|
|
3243
1687
|
*/
|
|
3244
1688
|
export interface EnquiriesApiCreateChatChannelRequest {
|
|
3245
1689
|
/**
|
|
3246
1690
|
* Project unique identifier
|
|
3247
|
-
* @type {string}
|
|
3248
|
-
* @memberof EnquiriesApiCreateChatChannel
|
|
3249
1691
|
*/
|
|
3250
1692
|
readonly project: string;
|
|
3251
1693
|
/**
|
|
3252
1694
|
* The platform identifier
|
|
3253
|
-
* @type {string}
|
|
3254
|
-
* @memberof EnquiriesApiCreateChatChannel
|
|
3255
1695
|
*/
|
|
3256
1696
|
readonly platformId: string;
|
|
3257
1697
|
/**
|
|
3258
1698
|
* The enquiry identifier
|
|
3259
|
-
* @type {string}
|
|
3260
|
-
* @memberof EnquiriesApiCreateChatChannel
|
|
3261
1699
|
*/
|
|
3262
1700
|
readonly enquiryId: string;
|
|
3263
1701
|
}
|
|
3264
1702
|
/**
|
|
3265
1703
|
* Request parameters for getCustomerEnquiry operation in EnquiriesApi.
|
|
3266
|
-
* @export
|
|
3267
|
-
* @interface EnquiriesApiGetCustomerEnquiryRequest
|
|
3268
1704
|
*/
|
|
3269
1705
|
export interface EnquiriesApiGetCustomerEnquiryRequest {
|
|
3270
1706
|
/**
|
|
3271
1707
|
* Project unique identifier
|
|
3272
|
-
* @type {string}
|
|
3273
|
-
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
3274
1708
|
*/
|
|
3275
1709
|
readonly project: string;
|
|
3276
1710
|
/**
|
|
3277
1711
|
* The platform identifier
|
|
3278
|
-
* @type {string}
|
|
3279
|
-
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
3280
1712
|
*/
|
|
3281
1713
|
readonly platformId: string;
|
|
3282
1714
|
/**
|
|
3283
1715
|
* The enquiry identifier
|
|
3284
|
-
* @type {string}
|
|
3285
|
-
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
3286
1716
|
*/
|
|
3287
1717
|
readonly enquiryId: string;
|
|
3288
1718
|
}
|
|
3289
1719
|
/**
|
|
3290
1720
|
* Request parameters for listCustomerEnquiries operation in EnquiriesApi.
|
|
3291
|
-
* @export
|
|
3292
|
-
* @interface EnquiriesApiListCustomerEnquiriesRequest
|
|
3293
1721
|
*/
|
|
3294
1722
|
export interface EnquiriesApiListCustomerEnquiriesRequest {
|
|
3295
1723
|
/**
|
|
3296
1724
|
* Project unique identifier
|
|
3297
|
-
* @type {string}
|
|
3298
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3299
1725
|
*/
|
|
3300
1726
|
readonly project: string;
|
|
3301
1727
|
/**
|
|
3302
1728
|
* The platform identifier
|
|
3303
|
-
* @type {string}
|
|
3304
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3305
1729
|
*/
|
|
3306
1730
|
readonly platformId: string;
|
|
3307
1731
|
/**
|
|
3308
1732
|
* Page reference token
|
|
3309
|
-
* @type {number}
|
|
3310
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3311
1733
|
*/
|
|
3312
1734
|
readonly pageToken?: number;
|
|
3313
1735
|
/**
|
|
3314
1736
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3315
|
-
* @type {number}
|
|
3316
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3317
1737
|
*/
|
|
3318
1738
|
readonly pageSize?: number;
|
|
3319
1739
|
/**
|
|
3320
1740
|
* Search term to filter based on enquiry title, content, customer name and customer email.
|
|
3321
|
-
* @type {string}
|
|
3322
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3323
1741
|
*/
|
|
3324
1742
|
readonly search?: string;
|
|
3325
1743
|
/**
|
|
3326
1744
|
* Start of date range to filter by
|
|
3327
|
-
* @type {string}
|
|
3328
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3329
1745
|
*/
|
|
3330
1746
|
readonly start?: string;
|
|
3331
1747
|
/**
|
|
3332
1748
|
* End of date range to filter by
|
|
3333
|
-
* @type {string}
|
|
3334
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3335
1749
|
*/
|
|
3336
1750
|
readonly end?: string;
|
|
3337
1751
|
}
|
|
3338
1752
|
/**
|
|
3339
1753
|
* Request parameters for listCustomerEnquiryLogs operation in EnquiriesApi.
|
|
3340
|
-
* @export
|
|
3341
|
-
* @interface EnquiriesApiListCustomerEnquiryLogsRequest
|
|
3342
1754
|
*/
|
|
3343
1755
|
export interface EnquiriesApiListCustomerEnquiryLogsRequest {
|
|
3344
1756
|
/**
|
|
3345
1757
|
* Project unique identifier
|
|
3346
|
-
* @type {string}
|
|
3347
|
-
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
3348
1758
|
*/
|
|
3349
1759
|
readonly project: string;
|
|
3350
1760
|
/**
|
|
3351
1761
|
* The platform identifier
|
|
3352
|
-
* @type {string}
|
|
3353
|
-
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
3354
1762
|
*/
|
|
3355
1763
|
readonly platformId: string;
|
|
3356
1764
|
/**
|
|
3357
1765
|
* The enquiry identifier
|
|
3358
|
-
* @type {string}
|
|
3359
|
-
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
3360
1766
|
*/
|
|
3361
1767
|
readonly enquiryId: string;
|
|
3362
1768
|
}
|
|
3363
1769
|
/**
|
|
3364
1770
|
* Request parameters for updateCustomerEnquiry operation in EnquiriesApi.
|
|
3365
|
-
* @export
|
|
3366
|
-
* @interface EnquiriesApiUpdateCustomerEnquiryRequest
|
|
3367
1771
|
*/
|
|
3368
1772
|
export interface EnquiriesApiUpdateCustomerEnquiryRequest {
|
|
3369
1773
|
/**
|
|
3370
1774
|
* Project unique identifier
|
|
3371
|
-
* @type {string}
|
|
3372
|
-
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3373
1775
|
*/
|
|
3374
1776
|
readonly project: string;
|
|
3375
1777
|
/**
|
|
3376
1778
|
* The platform identifier
|
|
3377
|
-
* @type {string}
|
|
3378
|
-
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3379
1779
|
*/
|
|
3380
1780
|
readonly platformId: string;
|
|
3381
1781
|
/**
|
|
3382
1782
|
* The enquiry identifier
|
|
3383
|
-
* @type {string}
|
|
3384
|
-
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3385
1783
|
*/
|
|
3386
1784
|
readonly enquiryId: string;
|
|
3387
1785
|
/**
|
|
3388
1786
|
* Enquiry update
|
|
3389
|
-
* @type {UpdateCustomerEnquiryRequest}
|
|
3390
|
-
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3391
1787
|
*/
|
|
3392
1788
|
readonly updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest;
|
|
3393
1789
|
}
|
|
3394
1790
|
/**
|
|
3395
1791
|
* EnquiriesApi - object-oriented interface
|
|
3396
|
-
* @export
|
|
3397
|
-
* @class EnquiriesApi
|
|
3398
|
-
* @extends {BaseAPI}
|
|
3399
1792
|
*/
|
|
3400
1793
|
export declare class EnquiriesApi extends BaseAPI {
|
|
3401
1794
|
/**
|
|
@@ -3404,7 +1797,6 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3404
1797
|
* @param {EnquiriesApiCreateChatChannelRequest} requestParameters Request parameters.
|
|
3405
1798
|
* @param {*} [options] Override http request option.
|
|
3406
1799
|
* @throws {RequiredError}
|
|
3407
|
-
* @memberof EnquiriesApi
|
|
3408
1800
|
*/
|
|
3409
1801
|
createChatChannel(requestParameters: EnquiriesApiCreateChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateChatChannel200Response, any>>;
|
|
3410
1802
|
/**
|
|
@@ -3413,7 +1805,6 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3413
1805
|
* @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
|
|
3414
1806
|
* @param {*} [options] Override http request option.
|
|
3415
1807
|
* @throws {RequiredError}
|
|
3416
|
-
* @memberof EnquiriesApi
|
|
3417
1808
|
*/
|
|
3418
1809
|
getCustomerEnquiry(requestParameters: EnquiriesApiGetCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Enquiry, any>>;
|
|
3419
1810
|
/**
|
|
@@ -3422,7 +1813,6 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3422
1813
|
* @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
|
|
3423
1814
|
* @param {*} [options] Override http request option.
|
|
3424
1815
|
* @throws {RequiredError}
|
|
3425
|
-
* @memberof EnquiriesApi
|
|
3426
1816
|
*/
|
|
3427
1817
|
listCustomerEnquiries(requestParameters: EnquiriesApiListCustomerEnquiriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerEnquiries200Response, any>>;
|
|
3428
1818
|
/**
|
|
@@ -3431,7 +1821,6 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3431
1821
|
* @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
|
|
3432
1822
|
* @param {*} [options] Override http request option.
|
|
3433
1823
|
* @throws {RequiredError}
|
|
3434
|
-
* @memberof EnquiriesApi
|
|
3435
1824
|
*/
|
|
3436
1825
|
listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerEnquiryLogs200Response, any>>;
|
|
3437
1826
|
/**
|
|
@@ -3440,13 +1829,11 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3440
1829
|
* @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
|
|
3441
1830
|
* @param {*} [options] Override http request option.
|
|
3442
1831
|
* @throws {RequiredError}
|
|
3443
|
-
* @memberof EnquiriesApi
|
|
3444
1832
|
*/
|
|
3445
1833
|
updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Enquiry, any>>;
|
|
3446
1834
|
}
|
|
3447
1835
|
/**
|
|
3448
1836
|
* OrdersApi - axios parameter creator
|
|
3449
|
-
* @export
|
|
3450
1837
|
*/
|
|
3451
1838
|
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3452
1839
|
/**
|
|
@@ -3595,7 +1982,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3595
1982
|
};
|
|
3596
1983
|
/**
|
|
3597
1984
|
* OrdersApi - functional programming interface
|
|
3598
|
-
* @export
|
|
3599
1985
|
*/
|
|
3600
1986
|
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
3601
1987
|
/**
|
|
@@ -3744,7 +2130,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
3744
2130
|
};
|
|
3745
2131
|
/**
|
|
3746
2132
|
* OrdersApi - factory interface
|
|
3747
|
-
* @export
|
|
3748
2133
|
*/
|
|
3749
2134
|
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3750
2135
|
/**
|
|
@@ -3854,412 +2239,276 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
3854
2239
|
};
|
|
3855
2240
|
/**
|
|
3856
2241
|
* Request parameters for amendOrder operation in OrdersApi.
|
|
3857
|
-
* @export
|
|
3858
|
-
* @interface OrdersApiAmendOrderRequest
|
|
3859
2242
|
*/
|
|
3860
2243
|
export interface OrdersApiAmendOrderRequest {
|
|
3861
2244
|
/**
|
|
3862
2245
|
* Project unique identifier
|
|
3863
|
-
* @type {string}
|
|
3864
|
-
* @memberof OrdersApiAmendOrder
|
|
3865
2246
|
*/
|
|
3866
2247
|
readonly project: string;
|
|
3867
2248
|
/**
|
|
3868
2249
|
* The platform identifier
|
|
3869
|
-
* @type {string}
|
|
3870
|
-
* @memberof OrdersApiAmendOrder
|
|
3871
2250
|
*/
|
|
3872
2251
|
readonly platformId: string;
|
|
3873
2252
|
/**
|
|
3874
2253
|
* The order identifier
|
|
3875
|
-
* @type {string}
|
|
3876
|
-
* @memberof OrdersApiAmendOrder
|
|
3877
2254
|
*/
|
|
3878
2255
|
readonly orderId: string;
|
|
3879
2256
|
/**
|
|
3880
2257
|
* AmendOrder schema
|
|
3881
|
-
* @type {AmendOrderRequest}
|
|
3882
|
-
* @memberof OrdersApiAmendOrder
|
|
3883
2258
|
*/
|
|
3884
2259
|
readonly amendOrderRequest: AmendOrderRequest;
|
|
3885
2260
|
}
|
|
3886
2261
|
/**
|
|
3887
2262
|
* Request parameters for confirmOrder operation in OrdersApi.
|
|
3888
|
-
* @export
|
|
3889
|
-
* @interface OrdersApiConfirmOrderRequest
|
|
3890
2263
|
*/
|
|
3891
2264
|
export interface OrdersApiConfirmOrderRequest {
|
|
3892
2265
|
/**
|
|
3893
2266
|
* Project unique identifier
|
|
3894
|
-
* @type {string}
|
|
3895
|
-
* @memberof OrdersApiConfirmOrder
|
|
3896
2267
|
*/
|
|
3897
2268
|
readonly project: string;
|
|
3898
2269
|
/**
|
|
3899
2270
|
* The platform identifier
|
|
3900
|
-
* @type {string}
|
|
3901
|
-
* @memberof OrdersApiConfirmOrder
|
|
3902
2271
|
*/
|
|
3903
2272
|
readonly platformId: string;
|
|
3904
2273
|
/**
|
|
3905
2274
|
* The order identifier
|
|
3906
|
-
* @type {string}
|
|
3907
|
-
* @memberof OrdersApiConfirmOrder
|
|
3908
2275
|
*/
|
|
3909
2276
|
readonly orderId: string;
|
|
3910
2277
|
/**
|
|
3911
2278
|
* ConfirmFulfillment schema
|
|
3912
|
-
* @type {ConfirmOrderRequest}
|
|
3913
|
-
* @memberof OrdersApiConfirmOrder
|
|
3914
2279
|
*/
|
|
3915
2280
|
readonly confirmOrderRequest: ConfirmOrderRequest;
|
|
3916
2281
|
}
|
|
3917
2282
|
/**
|
|
3918
2283
|
* Request parameters for createOrder operation in OrdersApi.
|
|
3919
|
-
* @export
|
|
3920
|
-
* @interface OrdersApiCreateOrderRequest
|
|
3921
2284
|
*/
|
|
3922
2285
|
export interface OrdersApiCreateOrderRequest {
|
|
3923
2286
|
/**
|
|
3924
2287
|
* Project unique identifier
|
|
3925
|
-
* @type {string}
|
|
3926
|
-
* @memberof OrdersApiCreateOrder
|
|
3927
2288
|
*/
|
|
3928
2289
|
readonly project: string;
|
|
3929
2290
|
/**
|
|
3930
2291
|
* The platform identifier
|
|
3931
|
-
* @type {string}
|
|
3932
|
-
* @memberof OrdersApiCreateOrder
|
|
3933
2292
|
*/
|
|
3934
2293
|
readonly platformId: string;
|
|
3935
2294
|
/**
|
|
3936
2295
|
* Create Order schema
|
|
3937
|
-
* @type {CreateOrder}
|
|
3938
|
-
* @memberof OrdersApiCreateOrder
|
|
3939
2296
|
*/
|
|
3940
2297
|
readonly createOrder: CreateOrder;
|
|
3941
2298
|
}
|
|
3942
2299
|
/**
|
|
3943
2300
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
3944
|
-
* @export
|
|
3945
|
-
* @interface OrdersApiExportOrdersRequest
|
|
3946
2301
|
*/
|
|
3947
2302
|
export interface OrdersApiExportOrdersRequest {
|
|
3948
2303
|
/**
|
|
3949
2304
|
* Project unique identifier
|
|
3950
|
-
* @type {string}
|
|
3951
|
-
* @memberof OrdersApiExportOrders
|
|
3952
2305
|
*/
|
|
3953
2306
|
readonly project: string;
|
|
3954
2307
|
/**
|
|
3955
2308
|
* The platform identifier
|
|
3956
|
-
* @type {string}
|
|
3957
|
-
* @memberof OrdersApiExportOrders
|
|
3958
2309
|
*/
|
|
3959
2310
|
readonly platformId: string;
|
|
3960
2311
|
/**
|
|
3961
2312
|
* Start of date range to filter by when orders were placed
|
|
3962
|
-
* @type {string}
|
|
3963
|
-
* @memberof OrdersApiExportOrders
|
|
3964
2313
|
*/
|
|
3965
2314
|
readonly start: string;
|
|
3966
2315
|
/**
|
|
3967
2316
|
* End of date range to filter when orders were placed
|
|
3968
|
-
* @type {string}
|
|
3969
|
-
* @memberof OrdersApiExportOrders
|
|
3970
2317
|
*/
|
|
3971
2318
|
readonly end?: string;
|
|
3972
2319
|
/**
|
|
3973
2320
|
* Search term to filter based on order reference, customer name and email
|
|
3974
|
-
* @type {string}
|
|
3975
|
-
* @memberof OrdersApiExportOrders
|
|
3976
2321
|
*/
|
|
3977
2322
|
readonly search?: string;
|
|
3978
2323
|
}
|
|
3979
2324
|
/**
|
|
3980
2325
|
* Request parameters for getFulfillment operation in OrdersApi.
|
|
3981
|
-
* @export
|
|
3982
|
-
* @interface OrdersApiGetFulfillmentRequest
|
|
3983
2326
|
*/
|
|
3984
2327
|
export interface OrdersApiGetFulfillmentRequest {
|
|
3985
2328
|
/**
|
|
3986
2329
|
* Project unique identifier
|
|
3987
|
-
* @type {string}
|
|
3988
|
-
* @memberof OrdersApiGetFulfillment
|
|
3989
2330
|
*/
|
|
3990
2331
|
readonly project: string;
|
|
3991
2332
|
/**
|
|
3992
2333
|
* The platform identifier
|
|
3993
|
-
* @type {string}
|
|
3994
|
-
* @memberof OrdersApiGetFulfillment
|
|
3995
2334
|
*/
|
|
3996
2335
|
readonly platformId: string;
|
|
3997
2336
|
/**
|
|
3998
2337
|
* The fulfillment identifier
|
|
3999
|
-
* @type {string}
|
|
4000
|
-
* @memberof OrdersApiGetFulfillment
|
|
4001
2338
|
*/
|
|
4002
2339
|
readonly fulfillmentId: string;
|
|
4003
2340
|
}
|
|
4004
2341
|
/**
|
|
4005
2342
|
* Request parameters for getOrder operation in OrdersApi.
|
|
4006
|
-
* @export
|
|
4007
|
-
* @interface OrdersApiGetOrderRequest
|
|
4008
2343
|
*/
|
|
4009
2344
|
export interface OrdersApiGetOrderRequest {
|
|
4010
2345
|
/**
|
|
4011
2346
|
* Project unique identifier
|
|
4012
|
-
* @type {string}
|
|
4013
|
-
* @memberof OrdersApiGetOrder
|
|
4014
2347
|
*/
|
|
4015
2348
|
readonly project: string;
|
|
4016
2349
|
/**
|
|
4017
2350
|
* The platform identifier
|
|
4018
|
-
* @type {string}
|
|
4019
|
-
* @memberof OrdersApiGetOrder
|
|
4020
2351
|
*/
|
|
4021
2352
|
readonly platformId: string;
|
|
4022
2353
|
/**
|
|
4023
2354
|
* The order identifier
|
|
4024
|
-
* @type {string}
|
|
4025
|
-
* @memberof OrdersApiGetOrder
|
|
4026
2355
|
*/
|
|
4027
2356
|
readonly orderId: string;
|
|
4028
2357
|
}
|
|
4029
2358
|
/**
|
|
4030
2359
|
* Request parameters for getOrderReceipt operation in OrdersApi.
|
|
4031
|
-
* @export
|
|
4032
|
-
* @interface OrdersApiGetOrderReceiptRequest
|
|
4033
2360
|
*/
|
|
4034
2361
|
export interface OrdersApiGetOrderReceiptRequest {
|
|
4035
2362
|
/**
|
|
4036
2363
|
* Project unique identifier
|
|
4037
|
-
* @type {string}
|
|
4038
|
-
* @memberof OrdersApiGetOrderReceipt
|
|
4039
2364
|
*/
|
|
4040
2365
|
readonly project: string;
|
|
4041
2366
|
/**
|
|
4042
2367
|
* The platform identifier
|
|
4043
|
-
* @type {string}
|
|
4044
|
-
* @memberof OrdersApiGetOrderReceipt
|
|
4045
2368
|
*/
|
|
4046
2369
|
readonly platformId: string;
|
|
4047
2370
|
/**
|
|
4048
2371
|
* The order identifier
|
|
4049
|
-
* @type {string}
|
|
4050
|
-
* @memberof OrdersApiGetOrderReceipt
|
|
4051
2372
|
*/
|
|
4052
2373
|
readonly orderId: string;
|
|
4053
2374
|
}
|
|
4054
2375
|
/**
|
|
4055
2376
|
* Request parameters for listAvailableFulfillers operation in OrdersApi.
|
|
4056
|
-
* @export
|
|
4057
|
-
* @interface OrdersApiListAvailableFulfillersRequest
|
|
4058
2377
|
*/
|
|
4059
2378
|
export interface OrdersApiListAvailableFulfillersRequest {
|
|
4060
2379
|
/**
|
|
4061
2380
|
* Project unique identifier
|
|
4062
|
-
* @type {string}
|
|
4063
|
-
* @memberof OrdersApiListAvailableFulfillers
|
|
4064
2381
|
*/
|
|
4065
2382
|
readonly project: string;
|
|
4066
2383
|
/**
|
|
4067
2384
|
* The platform identifier
|
|
4068
|
-
* @type {string}
|
|
4069
|
-
* @memberof OrdersApiListAvailableFulfillers
|
|
4070
2385
|
*/
|
|
4071
2386
|
readonly platformId: string;
|
|
4072
2387
|
/**
|
|
4073
2388
|
* The fulfillment identifier
|
|
4074
|
-
* @type {string}
|
|
4075
|
-
* @memberof OrdersApiListAvailableFulfillers
|
|
4076
2389
|
*/
|
|
4077
2390
|
readonly fulfillmentId: string;
|
|
4078
2391
|
}
|
|
4079
2392
|
/**
|
|
4080
2393
|
* Request parameters for listOrders operation in OrdersApi.
|
|
4081
|
-
* @export
|
|
4082
|
-
* @interface OrdersApiListOrdersRequest
|
|
4083
2394
|
*/
|
|
4084
2395
|
export interface OrdersApiListOrdersRequest {
|
|
4085
2396
|
/**
|
|
4086
2397
|
* Project unique identifier
|
|
4087
|
-
* @type {string}
|
|
4088
|
-
* @memberof OrdersApiListOrders
|
|
4089
2398
|
*/
|
|
4090
2399
|
readonly project: string;
|
|
4091
2400
|
/**
|
|
4092
2401
|
* The platform identifier
|
|
4093
|
-
* @type {string}
|
|
4094
|
-
* @memberof OrdersApiListOrders
|
|
4095
2402
|
*/
|
|
4096
2403
|
readonly platformId: string;
|
|
4097
2404
|
/**
|
|
4098
2405
|
* Page reference token
|
|
4099
|
-
* @type {number}
|
|
4100
|
-
* @memberof OrdersApiListOrders
|
|
4101
2406
|
*/
|
|
4102
2407
|
readonly pageToken?: number;
|
|
4103
2408
|
/**
|
|
4104
2409
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4105
|
-
* @type {number}
|
|
4106
|
-
* @memberof OrdersApiListOrders
|
|
4107
2410
|
*/
|
|
4108
2411
|
readonly pageSize?: number;
|
|
4109
2412
|
/**
|
|
4110
2413
|
* Search term to filter based on order reference, customer name and email
|
|
4111
|
-
* @type {string}
|
|
4112
|
-
* @memberof OrdersApiListOrders
|
|
4113
2414
|
*/
|
|
4114
2415
|
readonly search?: string;
|
|
4115
2416
|
/**
|
|
4116
2417
|
* Start of date range to filter when orders were placed
|
|
4117
|
-
* @type {string}
|
|
4118
|
-
* @memberof OrdersApiListOrders
|
|
4119
2418
|
*/
|
|
4120
2419
|
readonly start?: string;
|
|
4121
2420
|
/**
|
|
4122
2421
|
* End of date range to filter when orders were placed
|
|
4123
|
-
* @type {string}
|
|
4124
|
-
* @memberof OrdersApiListOrders
|
|
4125
2422
|
*/
|
|
4126
2423
|
readonly end?: string;
|
|
4127
2424
|
/**
|
|
4128
2425
|
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4129
|
-
* @type {'createdAt' | 'updatedAt' | 'statusChangedAt'}
|
|
4130
|
-
* @memberof OrdersApiListOrders
|
|
4131
2426
|
*/
|
|
4132
2427
|
readonly dateFilterType?: ListOrdersDateFilterTypeEnum;
|
|
4133
2428
|
/**
|
|
4134
2429
|
* The maximum value of the order
|
|
4135
|
-
* @type {number}
|
|
4136
|
-
* @memberof OrdersApiListOrders
|
|
4137
2430
|
*/
|
|
4138
2431
|
readonly maxOrderTotal?: number;
|
|
4139
2432
|
/**
|
|
4140
2433
|
* The minimum value of the order
|
|
4141
|
-
* @type {number}
|
|
4142
|
-
* @memberof OrdersApiListOrders
|
|
4143
2434
|
*/
|
|
4144
2435
|
readonly minOrderTotal?: number;
|
|
4145
2436
|
}
|
|
4146
2437
|
/**
|
|
4147
2438
|
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
4148
|
-
* @export
|
|
4149
|
-
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
4150
2439
|
*/
|
|
4151
2440
|
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
4152
2441
|
/**
|
|
4153
2442
|
* Project unique identifier
|
|
4154
|
-
* @type {string}
|
|
4155
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
4156
2443
|
*/
|
|
4157
2444
|
readonly project: string;
|
|
4158
2445
|
/**
|
|
4159
2446
|
* The platform identifier
|
|
4160
|
-
* @type {string}
|
|
4161
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
4162
2447
|
*/
|
|
4163
2448
|
readonly platformId: string;
|
|
4164
2449
|
/**
|
|
4165
2450
|
* The order identifier
|
|
4166
|
-
* @type {string}
|
|
4167
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
4168
2451
|
*/
|
|
4169
2452
|
readonly orderId: string;
|
|
4170
2453
|
}
|
|
4171
2454
|
/**
|
|
4172
2455
|
* Request parameters for returnOrder operation in OrdersApi.
|
|
4173
|
-
* @export
|
|
4174
|
-
* @interface OrdersApiReturnOrderRequest
|
|
4175
2456
|
*/
|
|
4176
2457
|
export interface OrdersApiReturnOrderRequest {
|
|
4177
2458
|
/**
|
|
4178
2459
|
* Project unique identifier
|
|
4179
|
-
* @type {string}
|
|
4180
|
-
* @memberof OrdersApiReturnOrder
|
|
4181
2460
|
*/
|
|
4182
2461
|
readonly project: string;
|
|
4183
2462
|
/**
|
|
4184
2463
|
* The platform identifier
|
|
4185
|
-
* @type {string}
|
|
4186
|
-
* @memberof OrdersApiReturnOrder
|
|
4187
2464
|
*/
|
|
4188
2465
|
readonly platformId: string;
|
|
4189
2466
|
/**
|
|
4190
2467
|
* The order identifier
|
|
4191
|
-
* @type {string}
|
|
4192
|
-
* @memberof OrdersApiReturnOrder
|
|
4193
2468
|
*/
|
|
4194
2469
|
readonly orderId: string;
|
|
4195
2470
|
/**
|
|
4196
2471
|
* ReturnOrder schema
|
|
4197
|
-
* @type {ReturnOrderRequest}
|
|
4198
|
-
* @memberof OrdersApiReturnOrder
|
|
4199
2472
|
*/
|
|
4200
2473
|
readonly returnOrderRequest: ReturnOrderRequest;
|
|
4201
2474
|
}
|
|
4202
2475
|
/**
|
|
4203
2476
|
* Request parameters for sendOrderReceipt operation in OrdersApi.
|
|
4204
|
-
* @export
|
|
4205
|
-
* @interface OrdersApiSendOrderReceiptRequest
|
|
4206
2477
|
*/
|
|
4207
2478
|
export interface OrdersApiSendOrderReceiptRequest {
|
|
4208
2479
|
/**
|
|
4209
2480
|
* Project unique identifier
|
|
4210
|
-
* @type {string}
|
|
4211
|
-
* @memberof OrdersApiSendOrderReceipt
|
|
4212
2481
|
*/
|
|
4213
2482
|
readonly project: string;
|
|
4214
2483
|
/**
|
|
4215
2484
|
* The platform identifier
|
|
4216
|
-
* @type {string}
|
|
4217
|
-
* @memberof OrdersApiSendOrderReceipt
|
|
4218
2485
|
*/
|
|
4219
2486
|
readonly platformId: string;
|
|
4220
2487
|
/**
|
|
4221
2488
|
* The order identifier
|
|
4222
|
-
* @type {string}
|
|
4223
|
-
* @memberof OrdersApiSendOrderReceipt
|
|
4224
2489
|
*/
|
|
4225
2490
|
readonly orderId: string;
|
|
4226
2491
|
}
|
|
4227
2492
|
/**
|
|
4228
2493
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
4229
|
-
* @export
|
|
4230
|
-
* @interface OrdersApiUpdateFulfillmentRequest
|
|
4231
2494
|
*/
|
|
4232
2495
|
export interface OrdersApiUpdateFulfillmentRequest {
|
|
4233
2496
|
/**
|
|
4234
2497
|
* Project unique identifier
|
|
4235
|
-
* @type {string}
|
|
4236
|
-
* @memberof OrdersApiUpdateFulfillment
|
|
4237
2498
|
*/
|
|
4238
2499
|
readonly project: string;
|
|
4239
2500
|
/**
|
|
4240
2501
|
* The platform identifier
|
|
4241
|
-
* @type {string}
|
|
4242
|
-
* @memberof OrdersApiUpdateFulfillment
|
|
4243
2502
|
*/
|
|
4244
2503
|
readonly platformId: string;
|
|
4245
2504
|
/**
|
|
4246
2505
|
* The fulfillment identifier
|
|
4247
|
-
* @type {string}
|
|
4248
|
-
* @memberof OrdersApiUpdateFulfillment
|
|
4249
2506
|
*/
|
|
4250
2507
|
readonly fulfillmentId: string;
|
|
4251
|
-
/**
|
|
4252
|
-
*
|
|
4253
|
-
* @type {UpdateFulfillmentRequest}
|
|
4254
|
-
* @memberof OrdersApiUpdateFulfillment
|
|
4255
|
-
*/
|
|
4256
2508
|
readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
|
|
4257
2509
|
}
|
|
4258
2510
|
/**
|
|
4259
2511
|
* OrdersApi - object-oriented interface
|
|
4260
|
-
* @export
|
|
4261
|
-
* @class OrdersApi
|
|
4262
|
-
* @extends {BaseAPI}
|
|
4263
2512
|
*/
|
|
4264
2513
|
export declare class OrdersApi extends BaseAPI {
|
|
4265
2514
|
/**
|
|
@@ -4268,7 +2517,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4268
2517
|
* @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
|
|
4269
2518
|
* @param {*} [options] Override http request option.
|
|
4270
2519
|
* @throws {RequiredError}
|
|
4271
|
-
* @memberof OrdersApi
|
|
4272
2520
|
*/
|
|
4273
2521
|
amendOrder(requestParameters: OrdersApiAmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4274
2522
|
/**
|
|
@@ -4277,7 +2525,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4277
2525
|
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
4278
2526
|
* @param {*} [options] Override http request option.
|
|
4279
2527
|
* @throws {RequiredError}
|
|
4280
|
-
* @memberof OrdersApi
|
|
4281
2528
|
*/
|
|
4282
2529
|
confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4283
2530
|
/**
|
|
@@ -4286,7 +2533,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4286
2533
|
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
4287
2534
|
* @param {*} [options] Override http request option.
|
|
4288
2535
|
* @throws {RequiredError}
|
|
4289
|
-
* @memberof OrdersApi
|
|
4290
2536
|
*/
|
|
4291
2537
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4292
2538
|
/**
|
|
@@ -4295,7 +2541,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4295
2541
|
* @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
|
|
4296
2542
|
* @param {*} [options] Override http request option.
|
|
4297
2543
|
* @throws {RequiredError}
|
|
4298
|
-
* @memberof OrdersApi
|
|
4299
2544
|
*/
|
|
4300
2545
|
exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
4301
2546
|
/**
|
|
@@ -4304,7 +2549,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4304
2549
|
* @param {OrdersApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
4305
2550
|
* @param {*} [options] Override http request option.
|
|
4306
2551
|
* @throws {RequiredError}
|
|
4307
|
-
* @memberof OrdersApi
|
|
4308
2552
|
*/
|
|
4309
2553
|
getFulfillment(requestParameters: OrdersApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
4310
2554
|
/**
|
|
@@ -4313,7 +2557,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4313
2557
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
4314
2558
|
* @param {*} [options] Override http request option.
|
|
4315
2559
|
* @throws {RequiredError}
|
|
4316
|
-
* @memberof OrdersApi
|
|
4317
2560
|
*/
|
|
4318
2561
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4319
2562
|
/**
|
|
@@ -4322,7 +2565,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4322
2565
|
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
4323
2566
|
* @param {*} [options] Override http request option.
|
|
4324
2567
|
* @throws {RequiredError}
|
|
4325
|
-
* @memberof OrdersApi
|
|
4326
2568
|
*/
|
|
4327
2569
|
getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
4328
2570
|
/**
|
|
@@ -4331,7 +2573,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4331
2573
|
* @param {OrdersApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
4332
2574
|
* @param {*} [options] Override http request option.
|
|
4333
2575
|
* @throws {RequiredError}
|
|
4334
|
-
* @memberof OrdersApi
|
|
4335
2576
|
*/
|
|
4336
2577
|
listAvailableFulfillers(requestParameters: OrdersApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
|
|
4337
2578
|
/**
|
|
@@ -4340,7 +2581,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4340
2581
|
* @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
|
|
4341
2582
|
* @param {*} [options] Override http request option.
|
|
4342
2583
|
* @throws {RequiredError}
|
|
4343
|
-
* @memberof OrdersApi
|
|
4344
2584
|
*/
|
|
4345
2585
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
4346
2586
|
/**
|
|
@@ -4349,7 +2589,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4349
2589
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
4350
2590
|
* @param {*} [options] Override http request option.
|
|
4351
2591
|
* @throws {RequiredError}
|
|
4352
|
-
* @memberof OrdersApi
|
|
4353
2592
|
*/
|
|
4354
2593
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4355
2594
|
/**
|
|
@@ -4358,7 +2597,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4358
2597
|
* @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
|
|
4359
2598
|
* @param {*} [options] Override http request option.
|
|
4360
2599
|
* @throws {RequiredError}
|
|
4361
|
-
* @memberof OrdersApi
|
|
4362
2600
|
*/
|
|
4363
2601
|
returnOrder(requestParameters: OrdersApiReturnOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4364
2602
|
/**
|
|
@@ -4367,7 +2605,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4367
2605
|
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
4368
2606
|
* @param {*} [options] Override http request option.
|
|
4369
2607
|
* @throws {RequiredError}
|
|
4370
|
-
* @memberof OrdersApi
|
|
4371
2608
|
*/
|
|
4372
2609
|
sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4373
2610
|
/**
|
|
@@ -4376,13 +2613,9 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4376
2613
|
* @param {OrdersApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
4377
2614
|
* @param {*} [options] Override http request option.
|
|
4378
2615
|
* @throws {RequiredError}
|
|
4379
|
-
* @memberof OrdersApi
|
|
4380
2616
|
*/
|
|
4381
2617
|
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
4382
2618
|
}
|
|
4383
|
-
/**
|
|
4384
|
-
* @export
|
|
4385
|
-
*/
|
|
4386
2619
|
export declare const ListOrdersDateFilterTypeEnum: {
|
|
4387
2620
|
readonly CreatedAt: "createdAt";
|
|
4388
2621
|
readonly UpdatedAt: "updatedAt";
|
|
@@ -4391,7 +2624,6 @@ export declare const ListOrdersDateFilterTypeEnum: {
|
|
|
4391
2624
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
4392
2625
|
/**
|
|
4393
2626
|
* PaymentApi - axios parameter creator
|
|
4394
|
-
* @export
|
|
4395
2627
|
*/
|
|
4396
2628
|
export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4397
2629
|
/**
|
|
@@ -4421,7 +2653,6 @@ export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4421
2653
|
};
|
|
4422
2654
|
/**
|
|
4423
2655
|
* PaymentApi - functional programming interface
|
|
4424
|
-
* @export
|
|
4425
2656
|
*/
|
|
4426
2657
|
export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
4427
2658
|
/**
|
|
@@ -4431,7 +2662,7 @@ export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
|
4431
2662
|
* @param {*} [options] Override http request option.
|
|
4432
2663
|
* @throws {RequiredError}
|
|
4433
2664
|
*/
|
|
4434
|
-
authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2665
|
+
authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizeStripe200Response>>;
|
|
4435
2666
|
/**
|
|
4436
2667
|
* Deauthorize a Stripe payment account
|
|
4437
2668
|
* @summary Deauthorize Stripe
|
|
@@ -4451,7 +2682,6 @@ export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
|
4451
2682
|
};
|
|
4452
2683
|
/**
|
|
4453
2684
|
* PaymentApi - factory interface
|
|
4454
|
-
* @export
|
|
4455
2685
|
*/
|
|
4456
2686
|
export declare const PaymentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4457
2687
|
/**
|
|
@@ -4461,7 +2691,7 @@ export declare const PaymentApiFactory: (configuration?: Configuration, basePath
|
|
|
4461
2691
|
* @param {*} [options] Override http request option.
|
|
4462
2692
|
* @throws {RequiredError}
|
|
4463
2693
|
*/
|
|
4464
|
-
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2694
|
+
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizeStripe200Response>;
|
|
4465
2695
|
/**
|
|
4466
2696
|
* Deauthorize a Stripe payment account
|
|
4467
2697
|
* @summary Deauthorize Stripe
|
|
@@ -4481,48 +2711,33 @@ export declare const PaymentApiFactory: (configuration?: Configuration, basePath
|
|
|
4481
2711
|
};
|
|
4482
2712
|
/**
|
|
4483
2713
|
* Request parameters for authorizeStripe operation in PaymentApi.
|
|
4484
|
-
* @export
|
|
4485
|
-
* @interface PaymentApiAuthorizeStripeRequest
|
|
4486
2714
|
*/
|
|
4487
2715
|
export interface PaymentApiAuthorizeStripeRequest {
|
|
4488
2716
|
/**
|
|
4489
2717
|
* Project unique identifier
|
|
4490
|
-
* @type {string}
|
|
4491
|
-
* @memberof PaymentApiAuthorizeStripe
|
|
4492
2718
|
*/
|
|
4493
2719
|
readonly project: string;
|
|
4494
2720
|
}
|
|
4495
2721
|
/**
|
|
4496
2722
|
* Request parameters for deauthorizeStripe operation in PaymentApi.
|
|
4497
|
-
* @export
|
|
4498
|
-
* @interface PaymentApiDeauthorizeStripeRequest
|
|
4499
2723
|
*/
|
|
4500
2724
|
export interface PaymentApiDeauthorizeStripeRequest {
|
|
4501
2725
|
/**
|
|
4502
2726
|
* Project unique identifier
|
|
4503
|
-
* @type {string}
|
|
4504
|
-
* @memberof PaymentApiDeauthorizeStripe
|
|
4505
2727
|
*/
|
|
4506
2728
|
readonly project: string;
|
|
4507
2729
|
}
|
|
4508
2730
|
/**
|
|
4509
2731
|
* Request parameters for getStripePaymentAccount operation in PaymentApi.
|
|
4510
|
-
* @export
|
|
4511
|
-
* @interface PaymentApiGetStripePaymentAccountRequest
|
|
4512
2732
|
*/
|
|
4513
2733
|
export interface PaymentApiGetStripePaymentAccountRequest {
|
|
4514
2734
|
/**
|
|
4515
2735
|
* Project unique identifier
|
|
4516
|
-
* @type {string}
|
|
4517
|
-
* @memberof PaymentApiGetStripePaymentAccount
|
|
4518
2736
|
*/
|
|
4519
2737
|
readonly project: string;
|
|
4520
2738
|
}
|
|
4521
2739
|
/**
|
|
4522
2740
|
* PaymentApi - object-oriented interface
|
|
4523
|
-
* @export
|
|
4524
|
-
* @class PaymentApi
|
|
4525
|
-
* @extends {BaseAPI}
|
|
4526
2741
|
*/
|
|
4527
2742
|
export declare class PaymentApi extends BaseAPI {
|
|
4528
2743
|
/**
|
|
@@ -4531,16 +2746,14 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
4531
2746
|
* @param {PaymentApiAuthorizeStripeRequest} requestParameters Request parameters.
|
|
4532
2747
|
* @param {*} [options] Override http request option.
|
|
4533
2748
|
* @throws {RequiredError}
|
|
4534
|
-
* @memberof PaymentApi
|
|
4535
2749
|
*/
|
|
4536
|
-
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2750
|
+
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizeStripe200Response, any>>;
|
|
4537
2751
|
/**
|
|
4538
2752
|
* Deauthorize a Stripe payment account
|
|
4539
2753
|
* @summary Deauthorize Stripe
|
|
4540
2754
|
* @param {PaymentApiDeauthorizeStripeRequest} requestParameters Request parameters.
|
|
4541
2755
|
* @param {*} [options] Override http request option.
|
|
4542
2756
|
* @throws {RequiredError}
|
|
4543
|
-
* @memberof PaymentApi
|
|
4544
2757
|
*/
|
|
4545
2758
|
deauthorizeStripe(requestParameters: PaymentApiDeauthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4546
2759
|
/**
|
|
@@ -4549,13 +2762,11 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
4549
2762
|
* @param {PaymentApiGetStripePaymentAccountRequest} requestParameters Request parameters.
|
|
4550
2763
|
* @param {*} [options] Override http request option.
|
|
4551
2764
|
* @throws {RequiredError}
|
|
4552
|
-
* @memberof PaymentApi
|
|
4553
2765
|
*/
|
|
4554
2766
|
getStripePaymentAccount(requestParameters: PaymentApiGetStripePaymentAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentAccount, any>>;
|
|
4555
2767
|
}
|
|
4556
2768
|
/**
|
|
4557
2769
|
* PixelsApi - axios parameter creator
|
|
4558
|
-
* @export
|
|
4559
2770
|
*/
|
|
4560
2771
|
export declare const PixelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4561
2772
|
/**
|
|
@@ -4617,7 +2828,6 @@ export declare const PixelsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
4617
2828
|
};
|
|
4618
2829
|
/**
|
|
4619
2830
|
* PixelsApi - functional programming interface
|
|
4620
|
-
* @export
|
|
4621
2831
|
*/
|
|
4622
2832
|
export declare const PixelsApiFp: (configuration?: Configuration) => {
|
|
4623
2833
|
/**
|
|
@@ -4679,7 +2889,6 @@ export declare const PixelsApiFp: (configuration?: Configuration) => {
|
|
|
4679
2889
|
};
|
|
4680
2890
|
/**
|
|
4681
2891
|
* PixelsApi - factory interface
|
|
4682
|
-
* @export
|
|
4683
2892
|
*/
|
|
4684
2893
|
export declare const PixelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4685
2894
|
/**
|
|
@@ -4725,170 +2934,109 @@ export declare const PixelsApiFactory: (configuration?: Configuration, basePath?
|
|
|
4725
2934
|
};
|
|
4726
2935
|
/**
|
|
4727
2936
|
* Request parameters for createPixel operation in PixelsApi.
|
|
4728
|
-
* @export
|
|
4729
|
-
* @interface PixelsApiCreatePixelRequest
|
|
4730
2937
|
*/
|
|
4731
2938
|
export interface PixelsApiCreatePixelRequest {
|
|
4732
2939
|
/**
|
|
4733
2940
|
* Project unique identifier
|
|
4734
|
-
* @type {string}
|
|
4735
|
-
* @memberof PixelsApiCreatePixel
|
|
4736
2941
|
*/
|
|
4737
2942
|
readonly project: string;
|
|
4738
2943
|
/**
|
|
4739
2944
|
* The platform identifier
|
|
4740
|
-
* @type {string}
|
|
4741
|
-
* @memberof PixelsApiCreatePixel
|
|
4742
2945
|
*/
|
|
4743
2946
|
readonly platformId: string;
|
|
4744
2947
|
/**
|
|
4745
2948
|
* Page reference token
|
|
4746
|
-
* @type {number}
|
|
4747
|
-
* @memberof PixelsApiCreatePixel
|
|
4748
2949
|
*/
|
|
4749
2950
|
readonly pageToken?: number;
|
|
4750
2951
|
/**
|
|
4751
2952
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4752
|
-
* @type {number}
|
|
4753
|
-
* @memberof PixelsApiCreatePixel
|
|
4754
2953
|
*/
|
|
4755
2954
|
readonly pageSize?: number;
|
|
4756
2955
|
/**
|
|
4757
2956
|
* Search term to filter results
|
|
4758
|
-
* @type {string}
|
|
4759
|
-
* @memberof PixelsApiCreatePixel
|
|
4760
2957
|
*/
|
|
4761
2958
|
readonly search?: string;
|
|
4762
|
-
/**
|
|
4763
|
-
*
|
|
4764
|
-
* @type {CreatePixelRequest}
|
|
4765
|
-
* @memberof PixelsApiCreatePixel
|
|
4766
|
-
*/
|
|
4767
2959
|
readonly createPixelRequest?: CreatePixelRequest;
|
|
4768
2960
|
}
|
|
4769
2961
|
/**
|
|
4770
2962
|
* Request parameters for deletePixel operation in PixelsApi.
|
|
4771
|
-
* @export
|
|
4772
|
-
* @interface PixelsApiDeletePixelRequest
|
|
4773
2963
|
*/
|
|
4774
2964
|
export interface PixelsApiDeletePixelRequest {
|
|
4775
2965
|
/**
|
|
4776
2966
|
* Project unique identifier
|
|
4777
|
-
* @type {string}
|
|
4778
|
-
* @memberof PixelsApiDeletePixel
|
|
4779
2967
|
*/
|
|
4780
2968
|
readonly project: string;
|
|
4781
2969
|
/**
|
|
4782
2970
|
* The platform identifier
|
|
4783
|
-
* @type {string}
|
|
4784
|
-
* @memberof PixelsApiDeletePixel
|
|
4785
2971
|
*/
|
|
4786
2972
|
readonly platformId: string;
|
|
4787
2973
|
/**
|
|
4788
2974
|
* The pixel identifier
|
|
4789
|
-
* @type {string}
|
|
4790
|
-
* @memberof PixelsApiDeletePixel
|
|
4791
2975
|
*/
|
|
4792
2976
|
readonly pixelId: string;
|
|
4793
2977
|
}
|
|
4794
2978
|
/**
|
|
4795
2979
|
* Request parameters for getPixel operation in PixelsApi.
|
|
4796
|
-
* @export
|
|
4797
|
-
* @interface PixelsApiGetPixelRequest
|
|
4798
2980
|
*/
|
|
4799
2981
|
export interface PixelsApiGetPixelRequest {
|
|
4800
2982
|
/**
|
|
4801
2983
|
* Project unique identifier
|
|
4802
|
-
* @type {string}
|
|
4803
|
-
* @memberof PixelsApiGetPixel
|
|
4804
2984
|
*/
|
|
4805
2985
|
readonly project: string;
|
|
4806
2986
|
/**
|
|
4807
2987
|
* The platform identifier
|
|
4808
|
-
* @type {string}
|
|
4809
|
-
* @memberof PixelsApiGetPixel
|
|
4810
2988
|
*/
|
|
4811
2989
|
readonly platformId: string;
|
|
4812
2990
|
/**
|
|
4813
2991
|
* The pixel identifier
|
|
4814
|
-
* @type {string}
|
|
4815
|
-
* @memberof PixelsApiGetPixel
|
|
4816
2992
|
*/
|
|
4817
2993
|
readonly pixelId: string;
|
|
4818
2994
|
}
|
|
4819
2995
|
/**
|
|
4820
2996
|
* Request parameters for listPixels operation in PixelsApi.
|
|
4821
|
-
* @export
|
|
4822
|
-
* @interface PixelsApiListPixelsRequest
|
|
4823
2997
|
*/
|
|
4824
2998
|
export interface PixelsApiListPixelsRequest {
|
|
4825
2999
|
/**
|
|
4826
3000
|
* Project unique identifier
|
|
4827
|
-
* @type {string}
|
|
4828
|
-
* @memberof PixelsApiListPixels
|
|
4829
3001
|
*/
|
|
4830
3002
|
readonly project: string;
|
|
4831
3003
|
/**
|
|
4832
3004
|
* The platform identifier
|
|
4833
|
-
* @type {string}
|
|
4834
|
-
* @memberof PixelsApiListPixels
|
|
4835
3005
|
*/
|
|
4836
3006
|
readonly platformId: string;
|
|
4837
3007
|
/**
|
|
4838
3008
|
* Page reference token
|
|
4839
|
-
* @type {number}
|
|
4840
|
-
* @memberof PixelsApiListPixels
|
|
4841
3009
|
*/
|
|
4842
3010
|
readonly pageToken?: number;
|
|
4843
3011
|
/**
|
|
4844
3012
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4845
|
-
* @type {number}
|
|
4846
|
-
* @memberof PixelsApiListPixels
|
|
4847
3013
|
*/
|
|
4848
3014
|
readonly pageSize?: number;
|
|
4849
3015
|
/**
|
|
4850
3016
|
* Search term to filter results
|
|
4851
|
-
* @type {string}
|
|
4852
|
-
* @memberof PixelsApiListPixels
|
|
4853
3017
|
*/
|
|
4854
3018
|
readonly search?: string;
|
|
4855
3019
|
}
|
|
4856
3020
|
/**
|
|
4857
3021
|
* Request parameters for updatePixel operation in PixelsApi.
|
|
4858
|
-
* @export
|
|
4859
|
-
* @interface PixelsApiUpdatePixelRequest
|
|
4860
3022
|
*/
|
|
4861
3023
|
export interface PixelsApiUpdatePixelRequest {
|
|
4862
3024
|
/**
|
|
4863
3025
|
* Project unique identifier
|
|
4864
|
-
* @type {string}
|
|
4865
|
-
* @memberof PixelsApiUpdatePixel
|
|
4866
3026
|
*/
|
|
4867
3027
|
readonly project: string;
|
|
4868
3028
|
/**
|
|
4869
3029
|
* The platform identifier
|
|
4870
|
-
* @type {string}
|
|
4871
|
-
* @memberof PixelsApiUpdatePixel
|
|
4872
3030
|
*/
|
|
4873
3031
|
readonly platformId: string;
|
|
4874
3032
|
/**
|
|
4875
3033
|
* The pixel identifier
|
|
4876
|
-
* @type {string}
|
|
4877
|
-
* @memberof PixelsApiUpdatePixel
|
|
4878
3034
|
*/
|
|
4879
3035
|
readonly pixelId: string;
|
|
4880
|
-
/**
|
|
4881
|
-
*
|
|
4882
|
-
* @type {CreatePixelRequest}
|
|
4883
|
-
* @memberof PixelsApiUpdatePixel
|
|
4884
|
-
*/
|
|
4885
3036
|
readonly createPixelRequest?: CreatePixelRequest;
|
|
4886
3037
|
}
|
|
4887
3038
|
/**
|
|
4888
3039
|
* PixelsApi - object-oriented interface
|
|
4889
|
-
* @export
|
|
4890
|
-
* @class PixelsApi
|
|
4891
|
-
* @extends {BaseAPI}
|
|
4892
3040
|
*/
|
|
4893
3041
|
export declare class PixelsApi extends BaseAPI {
|
|
4894
3042
|
/**
|
|
@@ -4897,7 +3045,6 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
4897
3045
|
* @param {PixelsApiCreatePixelRequest} requestParameters Request parameters.
|
|
4898
3046
|
* @param {*} [options] Override http request option.
|
|
4899
3047
|
* @throws {RequiredError}
|
|
4900
|
-
* @memberof PixelsApi
|
|
4901
3048
|
*/
|
|
4902
3049
|
createPixel(requestParameters: PixelsApiCreatePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
4903
3050
|
/**
|
|
@@ -4906,7 +3053,6 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
4906
3053
|
* @param {PixelsApiDeletePixelRequest} requestParameters Request parameters.
|
|
4907
3054
|
* @param {*} [options] Override http request option.
|
|
4908
3055
|
* @throws {RequiredError}
|
|
4909
|
-
* @memberof PixelsApi
|
|
4910
3056
|
*/
|
|
4911
3057
|
deletePixel(requestParameters: PixelsApiDeletePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4912
3058
|
/**
|
|
@@ -4915,7 +3061,6 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
4915
3061
|
* @param {PixelsApiGetPixelRequest} requestParameters Request parameters.
|
|
4916
3062
|
* @param {*} [options] Override http request option.
|
|
4917
3063
|
* @throws {RequiredError}
|
|
4918
|
-
* @memberof PixelsApi
|
|
4919
3064
|
*/
|
|
4920
3065
|
getPixel(requestParameters: PixelsApiGetPixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
4921
3066
|
/**
|
|
@@ -4924,7 +3069,6 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
4924
3069
|
* @param {PixelsApiListPixelsRequest} requestParameters Request parameters.
|
|
4925
3070
|
* @param {*} [options] Override http request option.
|
|
4926
3071
|
* @throws {RequiredError}
|
|
4927
|
-
* @memberof PixelsApi
|
|
4928
3072
|
*/
|
|
4929
3073
|
listPixels(requestParameters: PixelsApiListPixelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PixelsResponse, any>>;
|
|
4930
3074
|
/**
|
|
@@ -4933,13 +3077,11 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
4933
3077
|
* @param {PixelsApiUpdatePixelRequest} requestParameters Request parameters.
|
|
4934
3078
|
* @param {*} [options] Override http request option.
|
|
4935
3079
|
* @throws {RequiredError}
|
|
4936
|
-
* @memberof PixelsApi
|
|
4937
3080
|
*/
|
|
4938
3081
|
updatePixel(requestParameters: PixelsApiUpdatePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
4939
3082
|
}
|
|
4940
3083
|
/**
|
|
4941
3084
|
* PlatformApi - axios parameter creator
|
|
4942
|
-
* @export
|
|
4943
3085
|
*/
|
|
4944
3086
|
export declare const PlatformApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4945
3087
|
/**
|
|
@@ -5014,7 +3156,6 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5014
3156
|
};
|
|
5015
3157
|
/**
|
|
5016
3158
|
* PlatformApi - functional programming interface
|
|
5017
|
-
* @export
|
|
5018
3159
|
*/
|
|
5019
3160
|
export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
5020
3161
|
/**
|
|
@@ -5068,7 +3209,7 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
5068
3209
|
* @param {*} [options] Override http request option.
|
|
5069
3210
|
* @throws {RequiredError}
|
|
5070
3211
|
*/
|
|
5071
|
-
listClientDomains(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3212
|
+
listClientDomains(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDomains200Response>>;
|
|
5072
3213
|
/**
|
|
5073
3214
|
* List the domains attached to a platform
|
|
5074
3215
|
* @summary List platform domains
|
|
@@ -5076,7 +3217,7 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
5076
3217
|
* @param {*} [options] Override http request option.
|
|
5077
3218
|
* @throws {RequiredError}
|
|
5078
3219
|
*/
|
|
5079
|
-
listDomains(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3220
|
+
listDomains(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDomains200Response>>;
|
|
5080
3221
|
/**
|
|
5081
3222
|
*
|
|
5082
3223
|
* @summary Update platform
|
|
@@ -5089,7 +3230,6 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
5089
3230
|
};
|
|
5090
3231
|
/**
|
|
5091
3232
|
* PlatformApi - factory interface
|
|
5092
|
-
* @export
|
|
5093
3233
|
*/
|
|
5094
3234
|
export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5095
3235
|
/**
|
|
@@ -5139,7 +3279,7 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
5139
3279
|
* @param {*} [options] Override http request option.
|
|
5140
3280
|
* @throws {RequiredError}
|
|
5141
3281
|
*/
|
|
5142
|
-
listClientDomains(requestParameters: PlatformApiListClientDomainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3282
|
+
listClientDomains(requestParameters: PlatformApiListClientDomainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDomains200Response>;
|
|
5143
3283
|
/**
|
|
5144
3284
|
* List the domains attached to a platform
|
|
5145
3285
|
* @summary List platform domains
|
|
@@ -5147,7 +3287,7 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
5147
3287
|
* @param {*} [options] Override http request option.
|
|
5148
3288
|
* @throws {RequiredError}
|
|
5149
3289
|
*/
|
|
5150
|
-
listDomains(requestParameters: PlatformApiListDomainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3290
|
+
listDomains(requestParameters: PlatformApiListDomainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDomains200Response>;
|
|
5151
3291
|
/**
|
|
5152
3292
|
*
|
|
5153
3293
|
* @summary Update platform
|
|
@@ -5159,143 +3299,89 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
5159
3299
|
};
|
|
5160
3300
|
/**
|
|
5161
3301
|
* Request parameters for createClientDomain operation in PlatformApi.
|
|
5162
|
-
* @export
|
|
5163
|
-
* @interface PlatformApiCreateClientDomainRequest
|
|
5164
3302
|
*/
|
|
5165
3303
|
export interface PlatformApiCreateClientDomainRequest {
|
|
5166
3304
|
/**
|
|
5167
3305
|
* Project unique identifier
|
|
5168
|
-
* @type {string}
|
|
5169
|
-
* @memberof PlatformApiCreateClientDomain
|
|
5170
3306
|
*/
|
|
5171
3307
|
readonly project: string;
|
|
5172
|
-
/**
|
|
5173
|
-
*
|
|
5174
|
-
* @type {CreateDomainRequest}
|
|
5175
|
-
* @memberof PlatformApiCreateClientDomain
|
|
5176
|
-
*/
|
|
5177
3308
|
readonly createDomainRequest?: CreateDomainRequest;
|
|
5178
3309
|
}
|
|
5179
3310
|
/**
|
|
5180
3311
|
* Request parameters for createDomain operation in PlatformApi.
|
|
5181
|
-
* @export
|
|
5182
|
-
* @interface PlatformApiCreateDomainRequest
|
|
5183
3312
|
*/
|
|
5184
3313
|
export interface PlatformApiCreateDomainRequest {
|
|
5185
3314
|
/**
|
|
5186
3315
|
* Project unique identifier
|
|
5187
|
-
* @type {string}
|
|
5188
|
-
* @memberof PlatformApiCreateDomain
|
|
5189
3316
|
*/
|
|
5190
3317
|
readonly project: string;
|
|
5191
|
-
/**
|
|
5192
|
-
*
|
|
5193
|
-
* @type {CreateDomainRequest}
|
|
5194
|
-
* @memberof PlatformApiCreateDomain
|
|
5195
|
-
*/
|
|
5196
3318
|
readonly createDomainRequest?: CreateDomainRequest;
|
|
5197
3319
|
}
|
|
5198
3320
|
/**
|
|
5199
3321
|
* Request parameters for deleteClientDomain operation in PlatformApi.
|
|
5200
|
-
* @export
|
|
5201
|
-
* @interface PlatformApiDeleteClientDomainRequest
|
|
5202
3322
|
*/
|
|
5203
3323
|
export interface PlatformApiDeleteClientDomainRequest {
|
|
5204
3324
|
/**
|
|
5205
3325
|
* Project unique identifier
|
|
5206
|
-
* @type {string}
|
|
5207
|
-
* @memberof PlatformApiDeleteClientDomain
|
|
5208
3326
|
*/
|
|
5209
3327
|
readonly project: string;
|
|
5210
3328
|
/**
|
|
5211
3329
|
* The domain identifier
|
|
5212
|
-
* @type {string}
|
|
5213
|
-
* @memberof PlatformApiDeleteClientDomain
|
|
5214
3330
|
*/
|
|
5215
3331
|
readonly domain: string;
|
|
5216
3332
|
}
|
|
5217
3333
|
/**
|
|
5218
3334
|
* Request parameters for deleteDomain operation in PlatformApi.
|
|
5219
|
-
* @export
|
|
5220
|
-
* @interface PlatformApiDeleteDomainRequest
|
|
5221
3335
|
*/
|
|
5222
3336
|
export interface PlatformApiDeleteDomainRequest {
|
|
5223
3337
|
/**
|
|
5224
3338
|
* Project unique identifier
|
|
5225
|
-
* @type {string}
|
|
5226
|
-
* @memberof PlatformApiDeleteDomain
|
|
5227
3339
|
*/
|
|
5228
3340
|
readonly project: string;
|
|
5229
3341
|
/**
|
|
5230
3342
|
* The domain identifier
|
|
5231
|
-
* @type {string}
|
|
5232
|
-
* @memberof PlatformApiDeleteDomain
|
|
5233
3343
|
*/
|
|
5234
3344
|
readonly domain: string;
|
|
5235
3345
|
}
|
|
5236
3346
|
/**
|
|
5237
3347
|
* Request parameters for getPlatform operation in PlatformApi.
|
|
5238
|
-
* @export
|
|
5239
|
-
* @interface PlatformApiGetPlatformRequest
|
|
5240
3348
|
*/
|
|
5241
3349
|
export interface PlatformApiGetPlatformRequest {
|
|
5242
3350
|
/**
|
|
5243
3351
|
* Project unique identifier
|
|
5244
|
-
* @type {string}
|
|
5245
|
-
* @memberof PlatformApiGetPlatform
|
|
5246
3352
|
*/
|
|
5247
3353
|
readonly project: string;
|
|
5248
3354
|
}
|
|
5249
3355
|
/**
|
|
5250
3356
|
* Request parameters for listClientDomains operation in PlatformApi.
|
|
5251
|
-
* @export
|
|
5252
|
-
* @interface PlatformApiListClientDomainsRequest
|
|
5253
3357
|
*/
|
|
5254
3358
|
export interface PlatformApiListClientDomainsRequest {
|
|
5255
3359
|
/**
|
|
5256
3360
|
* Project unique identifier
|
|
5257
|
-
* @type {string}
|
|
5258
|
-
* @memberof PlatformApiListClientDomains
|
|
5259
3361
|
*/
|
|
5260
3362
|
readonly project: string;
|
|
5261
3363
|
}
|
|
5262
3364
|
/**
|
|
5263
3365
|
* Request parameters for listDomains operation in PlatformApi.
|
|
5264
|
-
* @export
|
|
5265
|
-
* @interface PlatformApiListDomainsRequest
|
|
5266
3366
|
*/
|
|
5267
3367
|
export interface PlatformApiListDomainsRequest {
|
|
5268
3368
|
/**
|
|
5269
3369
|
* Project unique identifier
|
|
5270
|
-
* @type {string}
|
|
5271
|
-
* @memberof PlatformApiListDomains
|
|
5272
3370
|
*/
|
|
5273
3371
|
readonly project: string;
|
|
5274
3372
|
}
|
|
5275
3373
|
/**
|
|
5276
3374
|
* Request parameters for updatePlatform operation in PlatformApi.
|
|
5277
|
-
* @export
|
|
5278
|
-
* @interface PlatformApiUpdatePlatformRequest
|
|
5279
3375
|
*/
|
|
5280
3376
|
export interface PlatformApiUpdatePlatformRequest {
|
|
5281
3377
|
/**
|
|
5282
3378
|
* Project unique identifier
|
|
5283
|
-
* @type {string}
|
|
5284
|
-
* @memberof PlatformApiUpdatePlatform
|
|
5285
3379
|
*/
|
|
5286
3380
|
readonly project: string;
|
|
5287
|
-
/**
|
|
5288
|
-
*
|
|
5289
|
-
* @type {UpdatePlatformRequest}
|
|
5290
|
-
* @memberof PlatformApiUpdatePlatform
|
|
5291
|
-
*/
|
|
5292
3381
|
readonly updatePlatformRequest: UpdatePlatformRequest;
|
|
5293
3382
|
}
|
|
5294
3383
|
/**
|
|
5295
3384
|
* PlatformApi - object-oriented interface
|
|
5296
|
-
* @export
|
|
5297
|
-
* @class PlatformApi
|
|
5298
|
-
* @extends {BaseAPI}
|
|
5299
3385
|
*/
|
|
5300
3386
|
export declare class PlatformApi extends BaseAPI {
|
|
5301
3387
|
/**
|
|
@@ -5304,7 +3390,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5304
3390
|
* @param {PlatformApiCreateClientDomainRequest} requestParameters Request parameters.
|
|
5305
3391
|
* @param {*} [options] Override http request option.
|
|
5306
3392
|
* @throws {RequiredError}
|
|
5307
|
-
* @memberof PlatformApi
|
|
5308
3393
|
*/
|
|
5309
3394
|
createClientDomain(requestParameters: PlatformApiCreateClientDomainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Domain, any>>;
|
|
5310
3395
|
/**
|
|
@@ -5313,7 +3398,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5313
3398
|
* @param {PlatformApiCreateDomainRequest} requestParameters Request parameters.
|
|
5314
3399
|
* @param {*} [options] Override http request option.
|
|
5315
3400
|
* @throws {RequiredError}
|
|
5316
|
-
* @memberof PlatformApi
|
|
5317
3401
|
*/
|
|
5318
3402
|
createDomain(requestParameters: PlatformApiCreateDomainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Domain, any>>;
|
|
5319
3403
|
/**
|
|
@@ -5322,7 +3406,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5322
3406
|
* @param {PlatformApiDeleteClientDomainRequest} requestParameters Request parameters.
|
|
5323
3407
|
* @param {*} [options] Override http request option.
|
|
5324
3408
|
* @throws {RequiredError}
|
|
5325
|
-
* @memberof PlatformApi
|
|
5326
3409
|
*/
|
|
5327
3410
|
deleteClientDomain(requestParameters: PlatformApiDeleteClientDomainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5328
3411
|
/**
|
|
@@ -5331,7 +3414,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5331
3414
|
* @param {PlatformApiDeleteDomainRequest} requestParameters Request parameters.
|
|
5332
3415
|
* @param {*} [options] Override http request option.
|
|
5333
3416
|
* @throws {RequiredError}
|
|
5334
|
-
* @memberof PlatformApi
|
|
5335
3417
|
*/
|
|
5336
3418
|
deleteDomain(requestParameters: PlatformApiDeleteDomainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5337
3419
|
/**
|
|
@@ -5340,7 +3422,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5340
3422
|
* @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
|
|
5341
3423
|
* @param {*} [options] Override http request option.
|
|
5342
3424
|
* @throws {RequiredError}
|
|
5343
|
-
* @memberof PlatformApi
|
|
5344
3425
|
*/
|
|
5345
3426
|
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
5346
3427
|
/**
|
|
@@ -5349,31 +3430,27 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5349
3430
|
* @param {PlatformApiListClientDomainsRequest} requestParameters Request parameters.
|
|
5350
3431
|
* @param {*} [options] Override http request option.
|
|
5351
3432
|
* @throws {RequiredError}
|
|
5352
|
-
* @memberof PlatformApi
|
|
5353
3433
|
*/
|
|
5354
|
-
listClientDomains(requestParameters: PlatformApiListClientDomainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
3434
|
+
listClientDomains(requestParameters: PlatformApiListClientDomainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDomains200Response, any>>;
|
|
5355
3435
|
/**
|
|
5356
3436
|
* List the domains attached to a platform
|
|
5357
3437
|
* @summary List platform domains
|
|
5358
3438
|
* @param {PlatformApiListDomainsRequest} requestParameters Request parameters.
|
|
5359
3439
|
* @param {*} [options] Override http request option.
|
|
5360
3440
|
* @throws {RequiredError}
|
|
5361
|
-
* @memberof PlatformApi
|
|
5362
3441
|
*/
|
|
5363
|
-
listDomains(requestParameters: PlatformApiListDomainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
3442
|
+
listDomains(requestParameters: PlatformApiListDomainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDomains200Response, any>>;
|
|
5364
3443
|
/**
|
|
5365
3444
|
*
|
|
5366
3445
|
* @summary Update platform
|
|
5367
3446
|
* @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
|
|
5368
3447
|
* @param {*} [options] Override http request option.
|
|
5369
3448
|
* @throws {RequiredError}
|
|
5370
|
-
* @memberof PlatformApi
|
|
5371
3449
|
*/
|
|
5372
3450
|
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
5373
3451
|
}
|
|
5374
3452
|
/**
|
|
5375
3453
|
* ReviewsApi - axios parameter creator
|
|
5376
|
-
* @export
|
|
5377
3454
|
*/
|
|
5378
3455
|
export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5379
3456
|
/**
|
|
@@ -5442,7 +3519,6 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5442
3519
|
};
|
|
5443
3520
|
/**
|
|
5444
3521
|
* ReviewsApi - functional programming interface
|
|
5445
|
-
* @export
|
|
5446
3522
|
*/
|
|
5447
3523
|
export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
5448
3524
|
/**
|
|
@@ -5511,7 +3587,6 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
5511
3587
|
};
|
|
5512
3588
|
/**
|
|
5513
3589
|
* ReviewsApi - factory interface
|
|
5514
|
-
* @export
|
|
5515
3590
|
*/
|
|
5516
3591
|
export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5517
3592
|
/**
|
|
@@ -5557,212 +3632,137 @@ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath
|
|
|
5557
3632
|
};
|
|
5558
3633
|
/**
|
|
5559
3634
|
* Request parameters for createReview operation in ReviewsApi.
|
|
5560
|
-
* @export
|
|
5561
|
-
* @interface ReviewsApiCreateReviewRequest
|
|
5562
3635
|
*/
|
|
5563
3636
|
export interface ReviewsApiCreateReviewRequest {
|
|
5564
3637
|
/**
|
|
5565
3638
|
* Project unique identifier
|
|
5566
|
-
* @type {string}
|
|
5567
|
-
* @memberof ReviewsApiCreateReview
|
|
5568
3639
|
*/
|
|
5569
3640
|
readonly project: string;
|
|
5570
3641
|
/**
|
|
5571
3642
|
* The platform identifier
|
|
5572
|
-
* @type {string}
|
|
5573
|
-
* @memberof ReviewsApiCreateReview
|
|
5574
3643
|
*/
|
|
5575
3644
|
readonly platformId: string;
|
|
5576
|
-
/**
|
|
5577
|
-
*
|
|
5578
|
-
* @type {CreateReviewRequest}
|
|
5579
|
-
* @memberof ReviewsApiCreateReview
|
|
5580
|
-
*/
|
|
5581
3645
|
readonly createReviewRequest: CreateReviewRequest;
|
|
5582
3646
|
/**
|
|
5583
3647
|
* Page reference token
|
|
5584
|
-
* @type {number}
|
|
5585
|
-
* @memberof ReviewsApiCreateReview
|
|
5586
3648
|
*/
|
|
5587
3649
|
readonly pageToken?: number;
|
|
5588
3650
|
/**
|
|
5589
3651
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
5590
|
-
* @type {number}
|
|
5591
|
-
* @memberof ReviewsApiCreateReview
|
|
5592
3652
|
*/
|
|
5593
3653
|
readonly pageSize?: number;
|
|
5594
3654
|
/**
|
|
5595
3655
|
* Search term to filter results
|
|
5596
|
-
* @type {string}
|
|
5597
|
-
* @memberof ReviewsApiCreateReview
|
|
5598
3656
|
*/
|
|
5599
3657
|
readonly search?: string;
|
|
5600
3658
|
/**
|
|
5601
3659
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
5602
|
-
* @type {Array<string>}
|
|
5603
|
-
* @memberof ReviewsApiCreateReview
|
|
5604
3660
|
*/
|
|
5605
3661
|
readonly sortBy?: Array<string>;
|
|
5606
3662
|
/**
|
|
5607
3663
|
* Start of date range to filter by
|
|
5608
|
-
* @type {string}
|
|
5609
|
-
* @memberof ReviewsApiCreateReview
|
|
5610
3664
|
*/
|
|
5611
3665
|
readonly start?: string;
|
|
5612
3666
|
/**
|
|
5613
3667
|
* End of date range to filter by
|
|
5614
|
-
* @type {string}
|
|
5615
|
-
* @memberof ReviewsApiCreateReview
|
|
5616
3668
|
*/
|
|
5617
3669
|
readonly end?: string;
|
|
5618
3670
|
}
|
|
5619
3671
|
/**
|
|
5620
3672
|
* Request parameters for exportReviews operation in ReviewsApi.
|
|
5621
|
-
* @export
|
|
5622
|
-
* @interface ReviewsApiExportReviewsRequest
|
|
5623
3673
|
*/
|
|
5624
3674
|
export interface ReviewsApiExportReviewsRequest {
|
|
5625
3675
|
/**
|
|
5626
3676
|
* Project unique identifier
|
|
5627
|
-
* @type {string}
|
|
5628
|
-
* @memberof ReviewsApiExportReviews
|
|
5629
3677
|
*/
|
|
5630
3678
|
readonly project: string;
|
|
5631
3679
|
/**
|
|
5632
3680
|
* The platform identifier
|
|
5633
|
-
* @type {string}
|
|
5634
|
-
* @memberof ReviewsApiExportReviews
|
|
5635
3681
|
*/
|
|
5636
3682
|
readonly platformId: string;
|
|
5637
3683
|
/**
|
|
5638
3684
|
* Start of date range to filter by
|
|
5639
|
-
* @type {string}
|
|
5640
|
-
* @memberof ReviewsApiExportReviews
|
|
5641
3685
|
*/
|
|
5642
3686
|
readonly start: string;
|
|
5643
3687
|
/**
|
|
5644
3688
|
* End of date range to filter by
|
|
5645
|
-
* @type {string}
|
|
5646
|
-
* @memberof ReviewsApiExportReviews
|
|
5647
3689
|
*/
|
|
5648
3690
|
readonly end?: string;
|
|
5649
3691
|
}
|
|
5650
3692
|
/**
|
|
5651
3693
|
* Request parameters for getReview operation in ReviewsApi.
|
|
5652
|
-
* @export
|
|
5653
|
-
* @interface ReviewsApiGetReviewRequest
|
|
5654
3694
|
*/
|
|
5655
3695
|
export interface ReviewsApiGetReviewRequest {
|
|
5656
3696
|
/**
|
|
5657
3697
|
* Project unique identifier
|
|
5658
|
-
* @type {string}
|
|
5659
|
-
* @memberof ReviewsApiGetReview
|
|
5660
3698
|
*/
|
|
5661
3699
|
readonly project: string;
|
|
5662
3700
|
/**
|
|
5663
3701
|
* The platform identifier
|
|
5664
|
-
* @type {string}
|
|
5665
|
-
* @memberof ReviewsApiGetReview
|
|
5666
3702
|
*/
|
|
5667
3703
|
readonly platformId: string;
|
|
5668
3704
|
/**
|
|
5669
3705
|
* The review identifier
|
|
5670
|
-
* @type {string}
|
|
5671
|
-
* @memberof ReviewsApiGetReview
|
|
5672
3706
|
*/
|
|
5673
3707
|
readonly reviewId: string;
|
|
5674
3708
|
}
|
|
5675
3709
|
/**
|
|
5676
3710
|
* Request parameters for listReviews operation in ReviewsApi.
|
|
5677
|
-
* @export
|
|
5678
|
-
* @interface ReviewsApiListReviewsRequest
|
|
5679
3711
|
*/
|
|
5680
3712
|
export interface ReviewsApiListReviewsRequest {
|
|
5681
3713
|
/**
|
|
5682
3714
|
* Project unique identifier
|
|
5683
|
-
* @type {string}
|
|
5684
|
-
* @memberof ReviewsApiListReviews
|
|
5685
3715
|
*/
|
|
5686
3716
|
readonly project: string;
|
|
5687
3717
|
/**
|
|
5688
3718
|
* The platform identifier
|
|
5689
|
-
* @type {string}
|
|
5690
|
-
* @memberof ReviewsApiListReviews
|
|
5691
3719
|
*/
|
|
5692
3720
|
readonly platformId: string;
|
|
5693
3721
|
/**
|
|
5694
3722
|
* Page reference token
|
|
5695
|
-
* @type {number}
|
|
5696
|
-
* @memberof ReviewsApiListReviews
|
|
5697
3723
|
*/
|
|
5698
3724
|
readonly pageToken?: number;
|
|
5699
3725
|
/**
|
|
5700
3726
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
5701
|
-
* @type {number}
|
|
5702
|
-
* @memberof ReviewsApiListReviews
|
|
5703
3727
|
*/
|
|
5704
3728
|
readonly pageSize?: number;
|
|
5705
3729
|
/**
|
|
5706
3730
|
* Search term to filter results
|
|
5707
|
-
* @type {string}
|
|
5708
|
-
* @memberof ReviewsApiListReviews
|
|
5709
3731
|
*/
|
|
5710
3732
|
readonly search?: string;
|
|
5711
3733
|
/**
|
|
5712
3734
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
5713
|
-
* @type {Array<string>}
|
|
5714
|
-
* @memberof ReviewsApiListReviews
|
|
5715
3735
|
*/
|
|
5716
3736
|
readonly sortBy?: Array<string>;
|
|
5717
3737
|
/**
|
|
5718
3738
|
* Start of date range to filter by
|
|
5719
|
-
* @type {string}
|
|
5720
|
-
* @memberof ReviewsApiListReviews
|
|
5721
3739
|
*/
|
|
5722
3740
|
readonly start?: string;
|
|
5723
3741
|
/**
|
|
5724
3742
|
* End of date range to filter by
|
|
5725
|
-
* @type {string}
|
|
5726
|
-
* @memberof ReviewsApiListReviews
|
|
5727
3743
|
*/
|
|
5728
3744
|
readonly end?: string;
|
|
5729
3745
|
}
|
|
5730
3746
|
/**
|
|
5731
3747
|
* Request parameters for moderateReview operation in ReviewsApi.
|
|
5732
|
-
* @export
|
|
5733
|
-
* @interface ReviewsApiModerateReviewRequest
|
|
5734
3748
|
*/
|
|
5735
3749
|
export interface ReviewsApiModerateReviewRequest {
|
|
5736
3750
|
/**
|
|
5737
3751
|
* Project unique identifier
|
|
5738
|
-
* @type {string}
|
|
5739
|
-
* @memberof ReviewsApiModerateReview
|
|
5740
3752
|
*/
|
|
5741
3753
|
readonly project: string;
|
|
5742
3754
|
/**
|
|
5743
3755
|
* The platform identifier
|
|
5744
|
-
* @type {string}
|
|
5745
|
-
* @memberof ReviewsApiModerateReview
|
|
5746
3756
|
*/
|
|
5747
3757
|
readonly platformId: string;
|
|
5748
3758
|
/**
|
|
5749
3759
|
* The review identifier
|
|
5750
|
-
* @type {string}
|
|
5751
|
-
* @memberof ReviewsApiModerateReview
|
|
5752
3760
|
*/
|
|
5753
3761
|
readonly reviewId: string;
|
|
5754
|
-
/**
|
|
5755
|
-
*
|
|
5756
|
-
* @type {ModerateReviewRequest}
|
|
5757
|
-
* @memberof ReviewsApiModerateReview
|
|
5758
|
-
*/
|
|
5759
3762
|
readonly moderateReviewRequest?: ModerateReviewRequest;
|
|
5760
3763
|
}
|
|
5761
3764
|
/**
|
|
5762
3765
|
* ReviewsApi - object-oriented interface
|
|
5763
|
-
* @export
|
|
5764
|
-
* @class ReviewsApi
|
|
5765
|
-
* @extends {BaseAPI}
|
|
5766
3766
|
*/
|
|
5767
3767
|
export declare class ReviewsApi extends BaseAPI {
|
|
5768
3768
|
/**
|
|
@@ -5771,7 +3771,6 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5771
3771
|
* @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
|
|
5772
3772
|
* @param {*} [options] Override http request option.
|
|
5773
3773
|
* @throws {RequiredError}
|
|
5774
|
-
* @memberof ReviewsApi
|
|
5775
3774
|
*/
|
|
5776
3775
|
createReview(requestParameters: ReviewsApiCreateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReview201Response, any>>;
|
|
5777
3776
|
/**
|
|
@@ -5780,7 +3779,6 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5780
3779
|
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
5781
3780
|
* @param {*} [options] Override http request option.
|
|
5782
3781
|
* @throws {RequiredError}
|
|
5783
|
-
* @memberof ReviewsApi
|
|
5784
3782
|
*/
|
|
5785
3783
|
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
5786
3784
|
/**
|
|
@@ -5789,7 +3787,6 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5789
3787
|
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
5790
3788
|
* @param {*} [options] Override http request option.
|
|
5791
3789
|
* @throws {RequiredError}
|
|
5792
|
-
* @memberof ReviewsApi
|
|
5793
3790
|
*/
|
|
5794
3791
|
getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
|
|
5795
3792
|
/**
|
|
@@ -5798,7 +3795,6 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5798
3795
|
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
5799
3796
|
* @param {*} [options] Override http request option.
|
|
5800
3797
|
* @throws {RequiredError}
|
|
5801
|
-
* @memberof ReviewsApi
|
|
5802
3798
|
*/
|
|
5803
3799
|
listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReviewsResponse, any>>;
|
|
5804
3800
|
/**
|
|
@@ -5807,13 +3803,11 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5807
3803
|
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
5808
3804
|
* @param {*} [options] Override http request option.
|
|
5809
3805
|
* @throws {RequiredError}
|
|
5810
|
-
* @memberof ReviewsApi
|
|
5811
3806
|
*/
|
|
5812
3807
|
moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
|
|
5813
3808
|
}
|
|
5814
3809
|
/**
|
|
5815
3810
|
* TermsApi - axios parameter creator
|
|
5816
|
-
* @export
|
|
5817
3811
|
*/
|
|
5818
3812
|
export declare const TermsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5819
3813
|
/**
|
|
@@ -5838,7 +3832,6 @@ export declare const TermsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5838
3832
|
};
|
|
5839
3833
|
/**
|
|
5840
3834
|
* TermsApi - functional programming interface
|
|
5841
|
-
* @export
|
|
5842
3835
|
*/
|
|
5843
3836
|
export declare const TermsApiFp: (configuration?: Configuration) => {
|
|
5844
3837
|
/**
|
|
@@ -5863,7 +3856,6 @@ export declare const TermsApiFp: (configuration?: Configuration) => {
|
|
|
5863
3856
|
};
|
|
5864
3857
|
/**
|
|
5865
3858
|
* TermsApi - factory interface
|
|
5866
|
-
* @export
|
|
5867
3859
|
*/
|
|
5868
3860
|
export declare const TermsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5869
3861
|
/**
|
|
@@ -5885,53 +3877,36 @@ export declare const TermsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
5885
3877
|
};
|
|
5886
3878
|
/**
|
|
5887
3879
|
* Request parameters for getTerms operation in TermsApi.
|
|
5888
|
-
* @export
|
|
5889
|
-
* @interface TermsApiGetTermsRequest
|
|
5890
3880
|
*/
|
|
5891
3881
|
export interface TermsApiGetTermsRequest {
|
|
5892
3882
|
/**
|
|
5893
3883
|
* Project unique identifier
|
|
5894
|
-
* @type {string}
|
|
5895
|
-
* @memberof TermsApiGetTerms
|
|
5896
3884
|
*/
|
|
5897
3885
|
readonly project: string;
|
|
5898
3886
|
/**
|
|
5899
3887
|
* The platform identifier
|
|
5900
|
-
* @type {string}
|
|
5901
|
-
* @memberof TermsApiGetTerms
|
|
5902
3888
|
*/
|
|
5903
3889
|
readonly platformId: string;
|
|
5904
3890
|
}
|
|
5905
3891
|
/**
|
|
5906
3892
|
* Request parameters for saveTerms operation in TermsApi.
|
|
5907
|
-
* @export
|
|
5908
|
-
* @interface TermsApiSaveTermsRequest
|
|
5909
3893
|
*/
|
|
5910
3894
|
export interface TermsApiSaveTermsRequest {
|
|
5911
3895
|
/**
|
|
5912
3896
|
* Project unique identifier
|
|
5913
|
-
* @type {string}
|
|
5914
|
-
* @memberof TermsApiSaveTerms
|
|
5915
3897
|
*/
|
|
5916
3898
|
readonly project: string;
|
|
5917
3899
|
/**
|
|
5918
3900
|
* The platform identifier
|
|
5919
|
-
* @type {string}
|
|
5920
|
-
* @memberof TermsApiSaveTerms
|
|
5921
3901
|
*/
|
|
5922
3902
|
readonly platformId: string;
|
|
5923
3903
|
/**
|
|
5924
3904
|
* Save terms
|
|
5925
|
-
* @type {SaveTermsRequest}
|
|
5926
|
-
* @memberof TermsApiSaveTerms
|
|
5927
3905
|
*/
|
|
5928
3906
|
readonly saveTermsRequest: SaveTermsRequest;
|
|
5929
3907
|
}
|
|
5930
3908
|
/**
|
|
5931
3909
|
* TermsApi - object-oriented interface
|
|
5932
|
-
* @export
|
|
5933
|
-
* @class TermsApi
|
|
5934
|
-
* @extends {BaseAPI}
|
|
5935
3910
|
*/
|
|
5936
3911
|
export declare class TermsApi extends BaseAPI {
|
|
5937
3912
|
/**
|
|
@@ -5940,7 +3915,6 @@ export declare class TermsApi extends BaseAPI {
|
|
|
5940
3915
|
* @param {TermsApiGetTermsRequest} requestParameters Request parameters.
|
|
5941
3916
|
* @param {*} [options] Override http request option.
|
|
5942
3917
|
* @throws {RequiredError}
|
|
5943
|
-
* @memberof TermsApi
|
|
5944
3918
|
*/
|
|
5945
3919
|
getTerms(requestParameters: TermsApiGetTermsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Terms, any>>;
|
|
5946
3920
|
/**
|
|
@@ -5949,7 +3923,6 @@ export declare class TermsApi extends BaseAPI {
|
|
|
5949
3923
|
* @param {TermsApiSaveTermsRequest} requestParameters Request parameters.
|
|
5950
3924
|
* @param {*} [options] Override http request option.
|
|
5951
3925
|
* @throws {RequiredError}
|
|
5952
|
-
* @memberof TermsApi
|
|
5953
3926
|
*/
|
|
5954
3927
|
saveTerms(requestParameters: TermsApiSaveTermsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Terms, any>>;
|
|
5955
3928
|
}
|