@teemill/platform 0.34.1 → 0.36.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 +5 -5
- package/api.ts +35 -2185
- package/base.ts +1 -25
- package/common.ts +1 -2
- package/configuration.ts +1 -18
- package/dist/api.d.ts +39 -2189
- package/dist/api.js +1 -122
- 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 +39 -2189
- package/dist/esm/api.js +1 -122
- 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/CreateOrder.md +4 -0
- package/docs/CustomersApi.md +2 -2
- package/docs/ListCustomerTags200Response.md +22 -0
- package/docs/ListDomains200Response.md +22 -0
- package/docs/Order.md +2 -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.36.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,202 @@ 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
|
-
*/
|
|
186
|
+
'billingAddress'?: Address;
|
|
407
187
|
'customsInformation'?: CustomsInformation;
|
|
408
188
|
/**
|
|
409
189
|
* Items to be ordered
|
|
410
|
-
* @type {Array<OrderItem1>}
|
|
411
|
-
* @memberof CreateOrder
|
|
412
190
|
*/
|
|
413
191
|
'items': Array<OrderItem1>;
|
|
414
|
-
/**
|
|
415
|
-
*
|
|
416
|
-
* @type {Array<string>}
|
|
417
|
-
* @memberof CreateOrder
|
|
418
|
-
*/
|
|
419
192
|
'preferredFulfillers'?: Array<string>;
|
|
420
193
|
/**
|
|
421
194
|
* A reference to the resource location
|
|
422
|
-
* @type {string}
|
|
423
|
-
* @memberof CreateOrder
|
|
424
195
|
*/
|
|
425
196
|
'originalOrderRef'?: string;
|
|
197
|
+
/**
|
|
198
|
+
* The project code of a client you want to order on the behalf of. If provided, the order will be created for the client\'s project.
|
|
199
|
+
*/
|
|
200
|
+
'client'?: string;
|
|
426
201
|
}
|
|
427
202
|
/**
|
|
428
203
|
* Contact information for the order
|
|
429
|
-
* @export
|
|
430
|
-
* @interface CreateOrderContactInformation
|
|
431
204
|
*/
|
|
432
205
|
export interface CreateOrderContactInformation {
|
|
433
|
-
/**
|
|
434
|
-
*
|
|
435
|
-
* @type {string}
|
|
436
|
-
* @memberof CreateOrderContactInformation
|
|
437
|
-
*/
|
|
438
206
|
'email': string;
|
|
439
|
-
/**
|
|
440
|
-
*
|
|
441
|
-
* @type {string}
|
|
442
|
-
* @memberof CreateOrderContactInformation
|
|
443
|
-
*/
|
|
444
207
|
'phone'?: string | null;
|
|
445
208
|
}
|
|
446
|
-
/**
|
|
447
|
-
*
|
|
448
|
-
* @export
|
|
449
|
-
* @interface CreatePixelRequest
|
|
450
|
-
*/
|
|
451
209
|
export interface CreatePixelRequest {
|
|
452
|
-
/**
|
|
453
|
-
*
|
|
454
|
-
* @type {string}
|
|
455
|
-
* @memberof CreatePixelRequest
|
|
456
|
-
*/
|
|
457
210
|
'name': string;
|
|
458
|
-
/**
|
|
459
|
-
*
|
|
460
|
-
* @type {Array<string>}
|
|
461
|
-
* @memberof CreatePixelRequest
|
|
462
|
-
*/
|
|
463
211
|
'sourceProjects': Array<string>;
|
|
464
|
-
/**
|
|
465
|
-
*
|
|
466
|
-
* @type {CreatePixelRequestFilters}
|
|
467
|
-
* @memberof CreatePixelRequest
|
|
468
|
-
*/
|
|
469
212
|
'filters': CreatePixelRequestFilters;
|
|
470
213
|
}
|
|
471
|
-
/**
|
|
472
|
-
*
|
|
473
|
-
* @export
|
|
474
|
-
* @interface CreatePixelRequestFilters
|
|
475
|
-
*/
|
|
476
214
|
export interface CreatePixelRequestFilters {
|
|
477
|
-
/**
|
|
478
|
-
*
|
|
479
|
-
* @type {Array<string>}
|
|
480
|
-
* @memberof CreatePixelRequestFilters
|
|
481
|
-
*/
|
|
482
215
|
'projects': Array<string> | null;
|
|
483
|
-
/**
|
|
484
|
-
*
|
|
485
|
-
* @type {Array<string>}
|
|
486
|
-
* @memberof CreatePixelRequestFilters
|
|
487
|
-
*/
|
|
488
216
|
'demographics': Array<string> | null;
|
|
489
|
-
/**
|
|
490
|
-
*
|
|
491
|
-
* @type {Array<string>}
|
|
492
|
-
* @memberof CreatePixelRequestFilters
|
|
493
|
-
*/
|
|
494
217
|
'tags': Array<string> | null;
|
|
495
218
|
}
|
|
496
219
|
/**
|
|
497
220
|
* @type CreateReview201Response
|
|
498
|
-
* @export
|
|
499
221
|
*/
|
|
500
222
|
export type CreateReview201Response = BulkCreatedReviews | Review;
|
|
501
|
-
/**
|
|
502
|
-
*
|
|
503
|
-
* @export
|
|
504
|
-
* @interface CreateReviewPayload
|
|
505
|
-
*/
|
|
506
223
|
export interface CreateReviewPayload {
|
|
507
|
-
/**
|
|
508
|
-
*
|
|
509
|
-
* @type {CreateReviewPayloadAuthor}
|
|
510
|
-
* @memberof CreateReviewPayload
|
|
511
|
-
*/
|
|
512
224
|
'author': CreateReviewPayloadAuthor;
|
|
513
225
|
/**
|
|
514
226
|
* The title of the review
|
|
515
|
-
* @type {string}
|
|
516
|
-
* @memberof CreateReviewPayload
|
|
517
227
|
*/
|
|
518
228
|
'title'?: string;
|
|
519
229
|
/**
|
|
520
230
|
* The text of the review
|
|
521
|
-
* @type {string}
|
|
522
|
-
* @memberof CreateReviewPayload
|
|
523
231
|
*/
|
|
524
232
|
'text': string;
|
|
525
233
|
/**
|
|
526
234
|
* A reference to the product being ordered
|
|
527
|
-
* @type {string}
|
|
528
|
-
* @memberof CreateReviewPayload
|
|
529
235
|
*/
|
|
530
236
|
'productRef': string;
|
|
531
237
|
/**
|
|
532
238
|
* The rating of the review
|
|
533
|
-
* @type {number}
|
|
534
|
-
* @memberof CreateReviewPayload
|
|
535
239
|
*/
|
|
536
240
|
'rating': number;
|
|
537
|
-
/**
|
|
538
|
-
*
|
|
539
|
-
* @type {Array<Image>}
|
|
540
|
-
* @memberof CreateReviewPayload
|
|
541
|
-
*/
|
|
542
241
|
'images'?: Array<Image>;
|
|
543
242
|
/**
|
|
544
243
|
* 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
244
|
*/
|
|
548
245
|
'enabled': boolean;
|
|
549
246
|
/**
|
|
550
247
|
* A reference to the project being ordered
|
|
551
|
-
* @type {string}
|
|
552
|
-
* @memberof CreateReviewPayload
|
|
553
248
|
*/
|
|
554
249
|
'projectRef': string;
|
|
555
250
|
}
|
|
556
|
-
/**
|
|
557
|
-
*
|
|
558
|
-
* @export
|
|
559
|
-
* @interface CreateReviewPayloadAuthor
|
|
560
|
-
*/
|
|
561
251
|
export interface CreateReviewPayloadAuthor {
|
|
562
252
|
/**
|
|
563
253
|
* The name of the author
|
|
564
|
-
* @type {string}
|
|
565
|
-
* @memberof CreateReviewPayloadAuthor
|
|
566
254
|
*/
|
|
567
255
|
'name'?: string;
|
|
568
256
|
/**
|
|
569
257
|
* The email of the author
|
|
570
|
-
* @type {string}
|
|
571
|
-
* @memberof CreateReviewPayloadAuthor
|
|
572
258
|
*/
|
|
573
259
|
'email'?: string;
|
|
574
260
|
}
|
|
575
261
|
/**
|
|
576
262
|
* @type CreateReviewRequest
|
|
577
|
-
* @export
|
|
578
263
|
*/
|
|
579
264
|
export type CreateReviewRequest = BulkCreateReviewPayload | CreateReviewPayload;
|
|
580
265
|
/**
|
|
581
266
|
* The customer that has placed an order on your platform
|
|
582
|
-
* @export
|
|
583
|
-
* @interface Customer
|
|
584
267
|
*/
|
|
585
268
|
export interface Customer {
|
|
586
269
|
/**
|
|
587
270
|
* Unique object identifier
|
|
588
|
-
* @type {string}
|
|
589
|
-
* @memberof Customer
|
|
590
271
|
*/
|
|
591
272
|
'id': string;
|
|
592
|
-
/**
|
|
593
|
-
*
|
|
594
|
-
* @type {string}
|
|
595
|
-
* @memberof Customer
|
|
596
|
-
*/
|
|
597
273
|
'email': string;
|
|
598
|
-
/**
|
|
599
|
-
*
|
|
600
|
-
* @type {string}
|
|
601
|
-
* @memberof Customer
|
|
602
|
-
*/
|
|
603
274
|
'firstName': string;
|
|
604
|
-
/**
|
|
605
|
-
*
|
|
606
|
-
* @type {string}
|
|
607
|
-
* @memberof Customer
|
|
608
|
-
*/
|
|
609
275
|
'lastName': string;
|
|
610
|
-
/**
|
|
611
|
-
*
|
|
612
|
-
* @type {string}
|
|
613
|
-
* @memberof Customer
|
|
614
|
-
*/
|
|
615
276
|
'gender': string | null;
|
|
616
|
-
/**
|
|
617
|
-
*
|
|
618
|
-
* @type {string}
|
|
619
|
-
* @memberof Customer
|
|
620
|
-
*/
|
|
621
277
|
'country': string | null;
|
|
622
|
-
/**
|
|
623
|
-
*
|
|
624
|
-
* @type {Statistics}
|
|
625
|
-
* @memberof Customer
|
|
626
|
-
*/
|
|
627
278
|
'statistics': Statistics;
|
|
628
279
|
}
|
|
629
|
-
/**
|
|
630
|
-
*
|
|
631
|
-
* @export
|
|
632
|
-
* @interface CustomersResponse
|
|
633
|
-
*/
|
|
634
280
|
export interface CustomersResponse {
|
|
635
|
-
/**
|
|
636
|
-
*
|
|
637
|
-
* @type {Array<Customer>}
|
|
638
|
-
* @memberof CustomersResponse
|
|
639
|
-
*/
|
|
640
281
|
'customers': Array<Customer>;
|
|
641
|
-
/**
|
|
642
|
-
*
|
|
643
|
-
* @type {number}
|
|
644
|
-
* @memberof CustomersResponse
|
|
645
|
-
*/
|
|
646
282
|
'nextPageToken'?: number | null;
|
|
647
283
|
}
|
|
648
284
|
/**
|
|
649
285
|
* 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
286
|
*/
|
|
653
287
|
export interface CustomsInformation {
|
|
654
288
|
/**
|
|
655
289
|
* Pre-registration type
|
|
656
|
-
* @type {string}
|
|
657
|
-
* @memberof CustomsInformation
|
|
658
290
|
*/
|
|
659
291
|
'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
|
|
660
292
|
/**
|
|
661
293
|
* Pre-registration number
|
|
662
|
-
* @type {string}
|
|
663
|
-
* @memberof CustomsInformation
|
|
664
294
|
*/
|
|
665
295
|
'preRegistrationNumber'?: string;
|
|
666
296
|
/**
|
|
667
297
|
* VAT number
|
|
668
|
-
* @type {string}
|
|
669
|
-
* @memberof CustomsInformation
|
|
670
298
|
*/
|
|
671
299
|
'vatNumber'?: string;
|
|
672
300
|
/**
|
|
673
301
|
* EORI number
|
|
674
|
-
* @type {string}
|
|
675
|
-
* @memberof CustomsInformation
|
|
676
302
|
*/
|
|
677
303
|
'eoriNumber'?: string;
|
|
678
304
|
}
|
|
@@ -680,189 +306,54 @@ export declare const CustomsInformationPreRegistrationTypeEnum: {
|
|
|
680
306
|
readonly Ioss: "IOSS";
|
|
681
307
|
};
|
|
682
308
|
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
683
|
-
/**
|
|
684
|
-
*
|
|
685
|
-
* @export
|
|
686
|
-
* @interface DashboardItem
|
|
687
|
-
*/
|
|
688
309
|
export interface DashboardItem {
|
|
689
|
-
/**
|
|
690
|
-
*
|
|
691
|
-
* @type {string}
|
|
692
|
-
* @memberof DashboardItem
|
|
693
|
-
*/
|
|
694
310
|
'id': string;
|
|
695
|
-
/**
|
|
696
|
-
*
|
|
697
|
-
* @type {string}
|
|
698
|
-
* @memberof DashboardItem
|
|
699
|
-
*/
|
|
700
311
|
'type': string;
|
|
701
|
-
/**
|
|
702
|
-
*
|
|
703
|
-
* @type {{ [key: string]: any; }}
|
|
704
|
-
* @memberof DashboardItem
|
|
705
|
-
*/
|
|
706
312
|
'properties': {
|
|
707
313
|
[key: string]: any;
|
|
708
314
|
} | null;
|
|
709
|
-
/**
|
|
710
|
-
*
|
|
711
|
-
* @type {boolean}
|
|
712
|
-
* @memberof DashboardItem
|
|
713
|
-
*/
|
|
714
315
|
'published': boolean;
|
|
715
|
-
/**
|
|
716
|
-
*
|
|
717
|
-
* @type {number}
|
|
718
|
-
* @memberof DashboardItem
|
|
719
|
-
*/
|
|
720
316
|
'sortOrder': number;
|
|
721
|
-
/**
|
|
722
|
-
*
|
|
723
|
-
* @type {Array<DashboardItem>}
|
|
724
|
-
* @memberof DashboardItem
|
|
725
|
-
*/
|
|
726
317
|
'items'?: Array<DashboardItem> | null;
|
|
727
318
|
}
|
|
728
|
-
/**
|
|
729
|
-
*
|
|
730
|
-
* @export
|
|
731
|
-
* @interface DeliveryEstimates
|
|
732
|
-
*/
|
|
733
319
|
export interface DeliveryEstimates {
|
|
734
320
|
/**
|
|
735
321
|
* ISO 8601 Timestamp
|
|
736
|
-
* @type {string}
|
|
737
|
-
* @memberof DeliveryEstimates
|
|
738
322
|
*/
|
|
739
323
|
'min'?: string;
|
|
740
324
|
/**
|
|
741
325
|
* ISO 8601 Timestamp
|
|
742
|
-
* @type {string}
|
|
743
|
-
* @memberof DeliveryEstimates
|
|
744
326
|
*/
|
|
745
327
|
'max'?: string;
|
|
746
328
|
}
|
|
747
|
-
/**
|
|
748
|
-
*
|
|
749
|
-
* @export
|
|
750
|
-
* @interface Domain
|
|
751
|
-
*/
|
|
752
329
|
export interface Domain {
|
|
753
|
-
/**
|
|
754
|
-
*
|
|
755
|
-
* @type {number}
|
|
756
|
-
* @memberof Domain
|
|
757
|
-
*/
|
|
758
330
|
'id': number;
|
|
759
|
-
/**
|
|
760
|
-
*
|
|
761
|
-
* @type {string}
|
|
762
|
-
* @memberof Domain
|
|
763
|
-
*/
|
|
764
331
|
'name': string;
|
|
765
|
-
/**
|
|
766
|
-
*
|
|
767
|
-
* @type {number}
|
|
768
|
-
* @memberof Domain
|
|
769
|
-
*/
|
|
770
332
|
'priority': number;
|
|
771
|
-
/**
|
|
772
|
-
*
|
|
773
|
-
* @type {string}
|
|
774
|
-
* @memberof Domain
|
|
775
|
-
*/
|
|
776
333
|
'enabledAt': string | null;
|
|
777
334
|
}
|
|
778
|
-
/**
|
|
779
|
-
*
|
|
780
|
-
* @export
|
|
781
|
-
* @interface Enquiry
|
|
782
|
-
*/
|
|
783
335
|
export interface Enquiry {
|
|
784
|
-
/**
|
|
785
|
-
*
|
|
786
|
-
* @type {string}
|
|
787
|
-
* @memberof Enquiry
|
|
788
|
-
*/
|
|
789
336
|
'id': string;
|
|
790
337
|
/**
|
|
791
338
|
* API reference for the enquiry
|
|
792
|
-
* @type {string}
|
|
793
|
-
* @memberof Enquiry
|
|
794
339
|
*/
|
|
795
340
|
'ref': string;
|
|
796
|
-
/**
|
|
797
|
-
*
|
|
798
|
-
* @type {ListCustomerEnquiryLogs200ResponseLogsInnerCustomer}
|
|
799
|
-
* @memberof Enquiry
|
|
800
|
-
*/
|
|
801
341
|
'customer': ListCustomerEnquiryLogs200ResponseLogsInnerCustomer;
|
|
802
|
-
/**
|
|
803
|
-
*
|
|
804
|
-
* @type {Client}
|
|
805
|
-
* @memberof Enquiry
|
|
806
|
-
*/
|
|
807
342
|
'client': Client;
|
|
808
|
-
/**
|
|
809
|
-
*
|
|
810
|
-
* @type {string}
|
|
811
|
-
* @memberof Enquiry
|
|
812
|
-
*/
|
|
813
343
|
'subject': string;
|
|
814
|
-
/**
|
|
815
|
-
*
|
|
816
|
-
* @type {string}
|
|
817
|
-
* @memberof Enquiry
|
|
818
|
-
*/
|
|
819
344
|
'body': string;
|
|
820
|
-
/**
|
|
821
|
-
*
|
|
822
|
-
* @type {string}
|
|
823
|
-
* @memberof Enquiry
|
|
824
|
-
*/
|
|
825
345
|
'createdAt': string;
|
|
826
|
-
/**
|
|
827
|
-
*
|
|
828
|
-
* @type {string}
|
|
829
|
-
* @memberof Enquiry
|
|
830
|
-
*/
|
|
831
346
|
'updatedAt': string;
|
|
832
|
-
/**
|
|
833
|
-
*
|
|
834
|
-
* @type {Array<string>}
|
|
835
|
-
* @memberof Enquiry
|
|
836
|
-
*/
|
|
837
347
|
'tags': Array<string>;
|
|
838
|
-
/**
|
|
839
|
-
*
|
|
840
|
-
* @type {string}
|
|
841
|
-
* @memberof Enquiry
|
|
842
|
-
*/
|
|
843
348
|
'status': EnquiryStatusEnum;
|
|
844
|
-
/**
|
|
845
|
-
*
|
|
846
|
-
* @type {boolean}
|
|
847
|
-
* @memberof Enquiry
|
|
848
|
-
*/
|
|
849
349
|
'read': boolean;
|
|
850
|
-
|
|
851
|
-
*
|
|
852
|
-
* @type {Array<EnquiryExtraInputsInner>}
|
|
853
|
-
* @memberof Enquiry
|
|
854
|
-
*/
|
|
855
|
-
'extraInputs': Array<EnquiryExtraInputsInner> | null;
|
|
350
|
+
'extraInputs': Array<EnquiryExtraInputsInner> | null;
|
|
856
351
|
/**
|
|
857
352
|
* Reference to the chat channel resource
|
|
858
|
-
* @type {string}
|
|
859
|
-
* @memberof Enquiry
|
|
860
353
|
*/
|
|
861
354
|
'chatChannelRef'?: string | null;
|
|
862
355
|
/**
|
|
863
356
|
* The unique id of the user who owns the enquiry
|
|
864
|
-
* @type {string}
|
|
865
|
-
* @memberof Enquiry
|
|
866
357
|
*/
|
|
867
358
|
'owner': string | null;
|
|
868
359
|
}
|
|
@@ -872,669 +363,226 @@ export declare const EnquiryStatusEnum: {
|
|
|
872
363
|
readonly Priority: "Priority";
|
|
873
364
|
};
|
|
874
365
|
export type EnquiryStatusEnum = typeof EnquiryStatusEnum[keyof typeof EnquiryStatusEnum];
|
|
875
|
-
/**
|
|
876
|
-
*
|
|
877
|
-
* @export
|
|
878
|
-
* @interface EnquiryExtraInputsInner
|
|
879
|
-
*/
|
|
880
366
|
export interface EnquiryExtraInputsInner {
|
|
881
|
-
/**
|
|
882
|
-
*
|
|
883
|
-
* @type {string}
|
|
884
|
-
* @memberof EnquiryExtraInputsInner
|
|
885
|
-
*/
|
|
886
367
|
'name': string;
|
|
887
|
-
/**
|
|
888
|
-
*
|
|
889
|
-
* @type {string}
|
|
890
|
-
* @memberof EnquiryExtraInputsInner
|
|
891
|
-
*/
|
|
892
368
|
'type': string;
|
|
893
|
-
/**
|
|
894
|
-
*
|
|
895
|
-
* @type {EnquiryExtraInputsInnerValue}
|
|
896
|
-
* @memberof EnquiryExtraInputsInner
|
|
897
|
-
*/
|
|
898
369
|
'value': EnquiryExtraInputsInnerValue;
|
|
899
370
|
}
|
|
900
371
|
/**
|
|
901
372
|
* @type EnquiryExtraInputsInnerValue
|
|
902
|
-
* @export
|
|
903
373
|
*/
|
|
904
374
|
export type EnquiryExtraInputsInnerValue = Array<string | null> | string;
|
|
905
|
-
/**
|
|
906
|
-
*
|
|
907
|
-
* @export
|
|
908
|
-
* @interface ExportOrders202Response
|
|
909
|
-
*/
|
|
910
375
|
export interface ExportOrders202Response {
|
|
911
376
|
/**
|
|
912
377
|
* A message describing the export status
|
|
913
|
-
* @type {string}
|
|
914
|
-
* @memberof ExportOrders202Response
|
|
915
378
|
*/
|
|
916
379
|
'message'?: string;
|
|
917
380
|
}
|
|
918
381
|
/**
|
|
919
382
|
* The fulfiller that will be processing this order.
|
|
920
|
-
* @export
|
|
921
|
-
* @interface Fulfiller
|
|
922
383
|
*/
|
|
923
384
|
export interface Fulfiller {
|
|
924
385
|
/**
|
|
925
386
|
* Unique object identifier
|
|
926
|
-
* @type {string}
|
|
927
|
-
* @memberof Fulfiller
|
|
928
387
|
*/
|
|
929
388
|
'id'?: string;
|
|
930
|
-
/**
|
|
931
|
-
*
|
|
932
|
-
* @type {FulfillerLocation}
|
|
933
|
-
* @memberof Fulfiller
|
|
934
|
-
*/
|
|
935
389
|
'location'?: FulfillerLocation;
|
|
936
390
|
}
|
|
937
|
-
/**
|
|
938
|
-
*
|
|
939
|
-
* @export
|
|
940
|
-
* @interface FulfillerLocation
|
|
941
|
-
*/
|
|
942
391
|
export interface FulfillerLocation {
|
|
943
|
-
/**
|
|
944
|
-
*
|
|
945
|
-
* @type {string}
|
|
946
|
-
* @memberof FulfillerLocation
|
|
947
|
-
*/
|
|
948
392
|
'city'?: string | null;
|
|
949
|
-
/**
|
|
950
|
-
*
|
|
951
|
-
* @type {string}
|
|
952
|
-
* @memberof FulfillerLocation
|
|
953
|
-
*/
|
|
954
393
|
'country'?: string | null;
|
|
955
394
|
}
|
|
956
|
-
/**
|
|
957
|
-
*
|
|
958
|
-
* @export
|
|
959
|
-
* @interface FulfillersResponse
|
|
960
|
-
*/
|
|
961
395
|
export interface FulfillersResponse {
|
|
962
|
-
/**
|
|
963
|
-
*
|
|
964
|
-
* @type {Array<Fulfiller>}
|
|
965
|
-
* @memberof FulfillersResponse
|
|
966
|
-
*/
|
|
967
396
|
'fulfillers'?: Array<Fulfiller>;
|
|
968
|
-
/**
|
|
969
|
-
*
|
|
970
|
-
* @type {number}
|
|
971
|
-
* @memberof FulfillersResponse
|
|
972
|
-
*/
|
|
973
397
|
'nextPageToken'?: number;
|
|
974
398
|
}
|
|
975
|
-
/**
|
|
976
|
-
*
|
|
977
|
-
* @export
|
|
978
|
-
* @interface Fulfillment
|
|
979
|
-
*/
|
|
980
399
|
export interface Fulfillment {
|
|
981
400
|
/**
|
|
982
401
|
* Unique fulfillment id
|
|
983
|
-
* @type {string}
|
|
984
|
-
* @memberof Fulfillment
|
|
985
402
|
*/
|
|
986
403
|
'id'?: string;
|
|
987
|
-
/**
|
|
988
|
-
*
|
|
989
|
-
* @type {OrderStatus}
|
|
990
|
-
* @memberof Fulfillment
|
|
991
|
-
*/
|
|
992
404
|
'status'?: OrderStatus;
|
|
993
|
-
/**
|
|
994
|
-
*
|
|
995
|
-
* @type {Fulfiller}
|
|
996
|
-
* @memberof Fulfillment
|
|
997
|
-
*/
|
|
998
405
|
'fulfiller'?: Fulfiller;
|
|
999
|
-
/**
|
|
1000
|
-
*
|
|
1001
|
-
* @type {Array<FulfillmentItem>}
|
|
1002
|
-
* @memberof Fulfillment
|
|
1003
|
-
*/
|
|
1004
406
|
'items'?: Array<FulfillmentItem>;
|
|
1005
|
-
/**
|
|
1006
|
-
*
|
|
1007
|
-
* @type {OrderTracking}
|
|
1008
|
-
* @memberof Fulfillment
|
|
1009
|
-
*/
|
|
1010
407
|
'tracking'?: OrderTracking | null;
|
|
1011
408
|
/**
|
|
1012
409
|
* Shipping method currently set
|
|
1013
|
-
* @type {ShippingMethod}
|
|
1014
|
-
* @memberof Fulfillment
|
|
1015
410
|
*/
|
|
1016
411
|
'shippingMethod'?: ShippingMethod;
|
|
1017
412
|
/**
|
|
1018
413
|
* Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment.
|
|
1019
|
-
* @type {Array<ShippingMethod>}
|
|
1020
|
-
* @memberof Fulfillment
|
|
1021
414
|
*/
|
|
1022
415
|
'availableShippingMethods'?: Array<ShippingMethod>;
|
|
1023
416
|
/**
|
|
1024
417
|
* Weight of the package being shipped in grams
|
|
1025
|
-
* @type {number}
|
|
1026
|
-
* @memberof Fulfillment
|
|
1027
418
|
*/
|
|
1028
419
|
'packageWeight'?: number;
|
|
1029
420
|
}
|
|
1030
|
-
/**
|
|
1031
|
-
*
|
|
1032
|
-
* @export
|
|
1033
|
-
* @interface FulfillmentItem
|
|
1034
|
-
*/
|
|
1035
421
|
export interface FulfillmentItem {
|
|
1036
422
|
/**
|
|
1037
423
|
* Unique fulfillment item id
|
|
1038
|
-
* @type {string}
|
|
1039
|
-
* @memberof FulfillmentItem
|
|
1040
424
|
*/
|
|
1041
425
|
'id'?: string;
|
|
1042
426
|
/**
|
|
1043
427
|
* Id of the order item being fulfilled
|
|
1044
|
-
* @type {string}
|
|
1045
|
-
* @memberof FulfillmentItem
|
|
1046
428
|
*/
|
|
1047
429
|
'itemId'?: string;
|
|
1048
430
|
/**
|
|
1049
431
|
* Number of this item being fulfilled
|
|
1050
|
-
* @type {number}
|
|
1051
|
-
* @memberof FulfillmentItem
|
|
1052
432
|
*/
|
|
1053
433
|
'quantity'?: number;
|
|
1054
434
|
}
|
|
1055
|
-
/**
|
|
1056
|
-
*
|
|
1057
|
-
* @export
|
|
1058
|
-
* @interface GetDashboardResponse
|
|
1059
|
-
*/
|
|
1060
435
|
export interface GetDashboardResponse {
|
|
1061
|
-
/**
|
|
1062
|
-
*
|
|
1063
|
-
* @type {Array<DashboardItem>}
|
|
1064
|
-
* @memberof GetDashboardResponse
|
|
1065
|
-
*/
|
|
1066
436
|
'items'?: Array<DashboardItem>;
|
|
1067
437
|
}
|
|
1068
438
|
/**
|
|
1069
439
|
* Image description
|
|
1070
|
-
* @export
|
|
1071
|
-
* @interface Image
|
|
1072
440
|
*/
|
|
1073
441
|
export interface Image {
|
|
1074
442
|
/**
|
|
1075
443
|
* Unique object identifier
|
|
1076
|
-
* @type {string}
|
|
1077
|
-
* @memberof Image
|
|
1078
444
|
*/
|
|
1079
445
|
'id'?: string;
|
|
1080
|
-
/**
|
|
1081
|
-
*
|
|
1082
|
-
* @type {string}
|
|
1083
|
-
* @memberof Image
|
|
1084
|
-
*/
|
|
1085
446
|
'src'?: string;
|
|
1086
|
-
/**
|
|
1087
|
-
*
|
|
1088
|
-
* @type {string}
|
|
1089
|
-
* @memberof Image
|
|
1090
|
-
*/
|
|
1091
447
|
'alt'?: string;
|
|
1092
|
-
/**
|
|
1093
|
-
*
|
|
1094
|
-
* @type {number}
|
|
1095
|
-
* @memberof Image
|
|
1096
|
-
*/
|
|
1097
448
|
'sortOrder'?: number;
|
|
1098
449
|
}
|
|
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
|
-
*
|
|
1126
|
-
* @type {Array<string>}
|
|
1127
|
-
* @memberof InlineObject1
|
|
1128
|
-
*/
|
|
1129
|
-
'tags': Array<string>;
|
|
1130
|
-
/**
|
|
1131
|
-
*
|
|
1132
|
-
* @type {number}
|
|
1133
|
-
* @memberof InlineObject1
|
|
1134
|
-
*/
|
|
1135
|
-
'nextPageToken'?: number | null;
|
|
1136
|
-
}
|
|
1137
|
-
/**
|
|
1138
|
-
*
|
|
1139
|
-
* @export
|
|
1140
|
-
* @interface InlineObject2
|
|
1141
|
-
*/
|
|
1142
|
-
export interface InlineObject2 {
|
|
1143
|
-
/**
|
|
1144
|
-
* The URL to redirect to
|
|
1145
|
-
* @type {string}
|
|
1146
|
-
* @memberof InlineObject2
|
|
1147
|
-
*/
|
|
1148
|
-
'redirect_url': string;
|
|
1149
|
-
}
|
|
1150
|
-
/**
|
|
1151
|
-
*
|
|
1152
|
-
* @export
|
|
1153
|
-
* @interface ListCustomerEnquiries200Response
|
|
1154
|
-
*/
|
|
1155
450
|
export interface ListCustomerEnquiries200Response {
|
|
1156
|
-
/**
|
|
1157
|
-
*
|
|
1158
|
-
* @type {Array<Enquiry>}
|
|
1159
|
-
* @memberof ListCustomerEnquiries200Response
|
|
1160
|
-
*/
|
|
1161
451
|
'enquiries'?: Array<Enquiry>;
|
|
1162
|
-
/**
|
|
1163
|
-
*
|
|
1164
|
-
* @type {number}
|
|
1165
|
-
* @memberof ListCustomerEnquiries200Response
|
|
1166
|
-
*/
|
|
1167
452
|
'nextPageToken'?: number | null;
|
|
1168
453
|
}
|
|
1169
|
-
/**
|
|
1170
|
-
*
|
|
1171
|
-
* @export
|
|
1172
|
-
* @interface ListCustomerEnquiryLogs200Response
|
|
1173
|
-
*/
|
|
1174
454
|
export interface ListCustomerEnquiryLogs200Response {
|
|
1175
|
-
/**
|
|
1176
|
-
*
|
|
1177
|
-
* @type {Array<ListCustomerEnquiryLogs200ResponseLogsInner>}
|
|
1178
|
-
* @memberof ListCustomerEnquiryLogs200Response
|
|
1179
|
-
*/
|
|
1180
455
|
'logs': Array<ListCustomerEnquiryLogs200ResponseLogsInner>;
|
|
1181
456
|
}
|
|
1182
|
-
/**
|
|
1183
|
-
*
|
|
1184
|
-
* @export
|
|
1185
|
-
* @interface ListCustomerEnquiryLogs200ResponseLogsInner
|
|
1186
|
-
*/
|
|
1187
457
|
export interface ListCustomerEnquiryLogs200ResponseLogsInner {
|
|
1188
|
-
/**
|
|
1189
|
-
*
|
|
1190
|
-
* @type {ListCustomerEnquiryLogs200ResponseLogsInnerCustomer}
|
|
1191
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInner
|
|
1192
|
-
*/
|
|
1193
458
|
'customer': ListCustomerEnquiryLogs200ResponseLogsInnerCustomer;
|
|
1194
|
-
/**
|
|
1195
|
-
*
|
|
1196
|
-
* @type {string}
|
|
1197
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInner
|
|
1198
|
-
*/
|
|
1199
459
|
'createdAt': string;
|
|
1200
460
|
}
|
|
1201
|
-
/**
|
|
1202
|
-
*
|
|
1203
|
-
* @export
|
|
1204
|
-
* @interface ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1205
|
-
*/
|
|
1206
461
|
export interface ListCustomerEnquiryLogs200ResponseLogsInnerCustomer {
|
|
1207
|
-
/**
|
|
1208
|
-
*
|
|
1209
|
-
* @type {string}
|
|
1210
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1211
|
-
*/
|
|
1212
462
|
'id'?: string;
|
|
1213
463
|
/**
|
|
1214
464
|
* API reference for the customer
|
|
1215
|
-
* @type {string}
|
|
1216
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1217
465
|
*/
|
|
1218
466
|
'ref'?: string;
|
|
1219
|
-
/**
|
|
1220
|
-
*
|
|
1221
|
-
* @type {string}
|
|
1222
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1223
|
-
*/
|
|
1224
467
|
'firstName'?: string;
|
|
1225
|
-
/**
|
|
1226
|
-
*
|
|
1227
|
-
* @type {string}
|
|
1228
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1229
|
-
*/
|
|
1230
468
|
'lastName'?: string;
|
|
1231
|
-
/**
|
|
1232
|
-
*
|
|
1233
|
-
* @type {string}
|
|
1234
|
-
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
1235
|
-
*/
|
|
1236
469
|
'email'?: string;
|
|
1237
470
|
}
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
471
|
+
export interface ListCustomerTags200Response {
|
|
472
|
+
'tags': Array<string>;
|
|
473
|
+
'nextPageToken'?: number | null;
|
|
474
|
+
}
|
|
475
|
+
export interface ListDomains200Response {
|
|
476
|
+
'domains': Array<Domain>;
|
|
477
|
+
'nextPageToken': number;
|
|
478
|
+
}
|
|
1243
479
|
export interface ModerateReviewRequest {
|
|
1244
480
|
/**
|
|
1245
481
|
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
1246
|
-
* @type {boolean}
|
|
1247
|
-
* @memberof ModerateReviewRequest
|
|
1248
482
|
*/
|
|
1249
483
|
'enabled'?: boolean;
|
|
1250
484
|
}
|
|
1251
|
-
/**
|
|
1252
|
-
*
|
|
1253
|
-
* @export
|
|
1254
|
-
* @interface Option
|
|
1255
|
-
*/
|
|
1256
485
|
export interface Option {
|
|
1257
486
|
/**
|
|
1258
487
|
* Option name
|
|
1259
|
-
* @type {string}
|
|
1260
|
-
* @memberof Option
|
|
1261
488
|
*/
|
|
1262
489
|
'name': string;
|
|
1263
490
|
/**
|
|
1264
491
|
* Option value
|
|
1265
|
-
* @type {string}
|
|
1266
|
-
* @memberof Option
|
|
1267
492
|
*/
|
|
1268
493
|
'value': string;
|
|
1269
494
|
}
|
|
1270
|
-
/**
|
|
1271
|
-
*
|
|
1272
|
-
* @export
|
|
1273
|
-
* @interface Order
|
|
1274
|
-
*/
|
|
1275
495
|
export interface Order {
|
|
1276
496
|
/**
|
|
1277
497
|
* Unique object identifier
|
|
1278
|
-
* @type {string}
|
|
1279
|
-
* @memberof Order
|
|
1280
498
|
*/
|
|
1281
499
|
'id'?: string;
|
|
1282
500
|
/**
|
|
1283
501
|
* A reference to the resource location
|
|
1284
|
-
* @type {string}
|
|
1285
|
-
* @memberof Order
|
|
1286
502
|
*/
|
|
1287
503
|
'ref'?: string;
|
|
1288
|
-
/**
|
|
1289
|
-
*
|
|
1290
|
-
* @type {OrderStatus}
|
|
1291
|
-
* @memberof Order
|
|
1292
|
-
*/
|
|
1293
504
|
'status'?: OrderStatus;
|
|
1294
|
-
/**
|
|
1295
|
-
*
|
|
1296
|
-
* @type {ContactInformation}
|
|
1297
|
-
* @memberof Order
|
|
1298
|
-
*/
|
|
1299
505
|
'contactInformation': ContactInformation;
|
|
1300
|
-
/**
|
|
1301
|
-
*
|
|
1302
|
-
* @type {Address}
|
|
1303
|
-
* @memberof Order
|
|
1304
|
-
*/
|
|
1305
506
|
'shippingAddress': Address;
|
|
507
|
+
'billingAddress'?: Address;
|
|
1306
508
|
/**
|
|
1307
509
|
* ISO 8601 Timestamp
|
|
1308
|
-
* @type {string}
|
|
1309
|
-
* @memberof Order
|
|
1310
510
|
*/
|
|
1311
511
|
'createdAt'?: string;
|
|
1312
512
|
/**
|
|
1313
513
|
* ISO 8601 Timestamp
|
|
1314
|
-
* @type {string}
|
|
1315
|
-
* @memberof Order
|
|
1316
514
|
*/
|
|
1317
515
|
'updatedAt'?: string;
|
|
1318
516
|
/**
|
|
1319
517
|
* A custom reference to the merchant\'s order that will be displayed on the shipping label.
|
|
1320
|
-
* @type {string}
|
|
1321
|
-
* @memberof Order
|
|
1322
518
|
*/
|
|
1323
519
|
'merchantReference'?: string | null;
|
|
1324
|
-
/**
|
|
1325
|
-
*
|
|
1326
|
-
* @type {Array<Fulfillment>}
|
|
1327
|
-
* @memberof Order
|
|
1328
|
-
*/
|
|
1329
520
|
'fulfillments'?: Array<Fulfillment>;
|
|
1330
|
-
/**
|
|
1331
|
-
*
|
|
1332
|
-
* @type {Array<OrderItem>}
|
|
1333
|
-
* @memberof Order
|
|
1334
|
-
*/
|
|
1335
521
|
'items': Array<OrderItem>;
|
|
1336
|
-
/**
|
|
1337
|
-
*
|
|
1338
|
-
* @type {Price}
|
|
1339
|
-
* @memberof Order
|
|
1340
|
-
*/
|
|
1341
522
|
'totalPrice'?: Price;
|
|
1342
|
-
/**
|
|
1343
|
-
*
|
|
1344
|
-
* @type {Price}
|
|
1345
|
-
* @memberof Order
|
|
1346
|
-
*/
|
|
1347
523
|
'taxPrice'?: Price;
|
|
1348
|
-
/**
|
|
1349
|
-
*
|
|
1350
|
-
* @type {Price}
|
|
1351
|
-
* @memberof Order
|
|
1352
|
-
*/
|
|
1353
524
|
'subtotalPrice'?: Price;
|
|
1354
|
-
/**
|
|
1355
|
-
*
|
|
1356
|
-
* @type {Price}
|
|
1357
|
-
* @memberof Order
|
|
1358
|
-
*/
|
|
1359
525
|
'discountPrice'?: Price;
|
|
1360
|
-
/**
|
|
1361
|
-
*
|
|
1362
|
-
* @type {Coupon}
|
|
1363
|
-
* @memberof Order
|
|
1364
|
-
*/
|
|
1365
526
|
'coupon'?: Coupon | null;
|
|
1366
|
-
/**
|
|
1367
|
-
*
|
|
1368
|
-
* @type {Price}
|
|
1369
|
-
* @memberof Order
|
|
1370
|
-
*/
|
|
1371
527
|
'shippingPrice'?: Price;
|
|
1372
|
-
/**
|
|
1373
|
-
*
|
|
1374
|
-
* @type {Origin}
|
|
1375
|
-
* @memberof Order
|
|
1376
|
-
*/
|
|
1377
528
|
'origin'?: Origin;
|
|
1378
|
-
/**
|
|
1379
|
-
*
|
|
1380
|
-
* @type {Array<StatusHistoryItem>}
|
|
1381
|
-
* @memberof Order
|
|
1382
|
-
*/
|
|
1383
529
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
1384
|
-
/**
|
|
1385
|
-
*
|
|
1386
|
-
* @type {Project}
|
|
1387
|
-
* @memberof Order
|
|
1388
|
-
*/
|
|
1389
530
|
'project': Project;
|
|
1390
|
-
/**
|
|
1391
|
-
*
|
|
1392
|
-
* @type {Array<PaymentAttempt>}
|
|
1393
|
-
* @memberof Order
|
|
1394
|
-
*/
|
|
1395
531
|
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
1396
532
|
/**
|
|
1397
533
|
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
1398
|
-
* @type {string}
|
|
1399
|
-
* @memberof Order
|
|
1400
534
|
*/
|
|
1401
535
|
'integrationType'?: string;
|
|
1402
536
|
}
|
|
1403
|
-
/**
|
|
1404
|
-
*
|
|
1405
|
-
* @export
|
|
1406
|
-
* @interface OrderItem
|
|
1407
|
-
*/
|
|
1408
537
|
export interface OrderItem {
|
|
1409
538
|
/**
|
|
1410
539
|
* Unique object identifier
|
|
1411
|
-
* @type {string}
|
|
1412
|
-
* @memberof OrderItem
|
|
1413
540
|
*/
|
|
1414
541
|
'id'?: string;
|
|
1415
542
|
/**
|
|
1416
543
|
* Reference URL to the order item variant
|
|
1417
|
-
* @type {string}
|
|
1418
|
-
* @memberof OrderItem
|
|
1419
544
|
* @deprecated
|
|
1420
545
|
*/
|
|
1421
546
|
'variantRef': string;
|
|
1422
|
-
/**
|
|
1423
|
-
*
|
|
1424
|
-
* @type {Variant}
|
|
1425
|
-
* @memberof OrderItem
|
|
1426
|
-
*/
|
|
1427
547
|
'variant': Variant;
|
|
1428
548
|
/**
|
|
1429
549
|
* Options associated to an order item\'s variant, such as color and size.
|
|
1430
|
-
* @type {Array<Option>}
|
|
1431
|
-
* @memberof OrderItem
|
|
1432
550
|
*/
|
|
1433
551
|
'options'?: Array<Option>;
|
|
1434
|
-
/**
|
|
1435
|
-
*
|
|
1436
|
-
* @type {number}
|
|
1437
|
-
* @memberof OrderItem
|
|
1438
|
-
*/
|
|
1439
552
|
'quantity': number;
|
|
1440
553
|
/**
|
|
1441
554
|
* The name of the product
|
|
1442
|
-
* @type {string}
|
|
1443
|
-
* @memberof OrderItem
|
|
1444
555
|
*/
|
|
1445
556
|
'name'?: string;
|
|
1446
557
|
/**
|
|
1447
558
|
* Images
|
|
1448
|
-
* @type {Array<Image>}
|
|
1449
|
-
* @memberof OrderItem
|
|
1450
559
|
*/
|
|
1451
560
|
'images'?: Array<Image>;
|
|
1452
|
-
/**
|
|
1453
|
-
*
|
|
1454
|
-
* @type {Price}
|
|
1455
|
-
* @memberof OrderItem
|
|
1456
|
-
*/
|
|
1457
561
|
'totalPrice'?: Price;
|
|
1458
562
|
/**
|
|
1459
563
|
* This is an estimate until the order has been confirmed
|
|
1460
|
-
* @type {Price}
|
|
1461
|
-
* @memberof OrderItem
|
|
1462
564
|
*/
|
|
1463
565
|
'taxPrice'?: Price;
|
|
1464
|
-
/**
|
|
1465
|
-
*
|
|
1466
|
-
* @type {Price}
|
|
1467
|
-
* @memberof OrderItem
|
|
1468
|
-
*/
|
|
1469
566
|
'subtotalPrice'?: Price;
|
|
1470
|
-
/**
|
|
1471
|
-
*
|
|
1472
|
-
* @type {Price}
|
|
1473
|
-
* @memberof OrderItem
|
|
1474
|
-
*/
|
|
1475
567
|
'discountPrice'?: Price;
|
|
1476
568
|
/**
|
|
1477
569
|
* The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
|
|
1478
|
-
* @type {Price}
|
|
1479
|
-
* @memberof OrderItem
|
|
1480
570
|
*/
|
|
1481
571
|
'recipientCost'?: Price;
|
|
1482
|
-
/**
|
|
1483
|
-
*
|
|
1484
|
-
* @type {Array<AmendmentLog>}
|
|
1485
|
-
* @memberof OrderItem
|
|
1486
|
-
*/
|
|
1487
572
|
'amendmentLogs'?: Array<AmendmentLog>;
|
|
1488
573
|
}
|
|
1489
|
-
/**
|
|
1490
|
-
*
|
|
1491
|
-
* @export
|
|
1492
|
-
* @interface OrderItem1
|
|
1493
|
-
*/
|
|
1494
574
|
export interface OrderItem1 {
|
|
1495
575
|
/**
|
|
1496
576
|
* A reference to the variant being ordered
|
|
1497
|
-
* @type {string}
|
|
1498
|
-
* @memberof OrderItem1
|
|
1499
577
|
*/
|
|
1500
578
|
'variantRef': string;
|
|
1501
|
-
/**
|
|
1502
|
-
*
|
|
1503
|
-
* @type {number}
|
|
1504
|
-
* @memberof OrderItem1
|
|
1505
|
-
*/
|
|
1506
579
|
'quantity': number;
|
|
1507
|
-
/**
|
|
1508
|
-
*
|
|
1509
|
-
* @type {OrderItem1RecipientCost}
|
|
1510
|
-
* @memberof OrderItem1
|
|
1511
|
-
*/
|
|
1512
580
|
'recipientCost'?: OrderItem1RecipientCost;
|
|
1513
581
|
}
|
|
1514
|
-
/**
|
|
1515
|
-
*
|
|
1516
|
-
* @export
|
|
1517
|
-
* @interface OrderItem1RecipientCost
|
|
1518
|
-
*/
|
|
1519
582
|
export interface OrderItem1RecipientCost {
|
|
1520
|
-
/**
|
|
1521
|
-
*
|
|
1522
|
-
* @type {string}
|
|
1523
|
-
* @memberof OrderItem1RecipientCost
|
|
1524
|
-
*/
|
|
1525
583
|
'amount': string;
|
|
1526
|
-
/**
|
|
1527
|
-
*
|
|
1528
|
-
* @type {string}
|
|
1529
|
-
* @memberof OrderItem1RecipientCost
|
|
1530
|
-
*/
|
|
1531
584
|
'currencyCode': string;
|
|
1532
585
|
}
|
|
1533
|
-
/**
|
|
1534
|
-
*
|
|
1535
|
-
* @export
|
|
1536
|
-
* @enum {string}
|
|
1537
|
-
*/
|
|
1538
586
|
export declare const OrderStatus: {
|
|
1539
587
|
readonly New: "new";
|
|
1540
588
|
readonly Paid: "paid";
|
|
@@ -1543,91 +591,30 @@ export declare const OrderStatus: {
|
|
|
1543
591
|
readonly Refunded: "refunded";
|
|
1544
592
|
};
|
|
1545
593
|
export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
|
|
1546
|
-
/**
|
|
1547
|
-
*
|
|
1548
|
-
* @export
|
|
1549
|
-
* @interface OrderTracking
|
|
1550
|
-
*/
|
|
1551
594
|
export interface OrderTracking {
|
|
1552
|
-
/**
|
|
1553
|
-
*
|
|
1554
|
-
* @type {string}
|
|
1555
|
-
* @memberof OrderTracking
|
|
1556
|
-
*/
|
|
1557
595
|
'courier'?: string;
|
|
1558
|
-
/**
|
|
1559
|
-
*
|
|
1560
|
-
* @type {string}
|
|
1561
|
-
* @memberof OrderTracking
|
|
1562
|
-
*/
|
|
1563
596
|
'code'?: string;
|
|
1564
|
-
/**
|
|
1565
|
-
*
|
|
1566
|
-
* @type {string}
|
|
1567
|
-
* @memberof OrderTracking
|
|
1568
|
-
*/
|
|
1569
597
|
'url'?: string;
|
|
1570
598
|
}
|
|
1571
|
-
/**
|
|
1572
|
-
*
|
|
1573
|
-
* @export
|
|
1574
|
-
* @interface OrdersResponse
|
|
1575
|
-
*/
|
|
1576
599
|
export interface OrdersResponse {
|
|
1577
|
-
/**
|
|
1578
|
-
*
|
|
1579
|
-
* @type {Array<Order>}
|
|
1580
|
-
* @memberof OrdersResponse
|
|
1581
|
-
*/
|
|
1582
600
|
'orders'?: Array<Order>;
|
|
1583
|
-
/**
|
|
1584
|
-
*
|
|
1585
|
-
* @type {number}
|
|
1586
|
-
* @memberof OrdersResponse
|
|
1587
|
-
*/
|
|
1588
601
|
'nextPageToken'?: number;
|
|
1589
602
|
}
|
|
1590
|
-
/**
|
|
1591
|
-
*
|
|
1592
|
-
* @export
|
|
1593
|
-
* @interface Origin
|
|
1594
|
-
*/
|
|
1595
603
|
export interface Origin {
|
|
1596
|
-
/**
|
|
1597
|
-
*
|
|
1598
|
-
* @type {string}
|
|
1599
|
-
* @memberof Origin
|
|
1600
|
-
*/
|
|
1601
604
|
'code'?: string;
|
|
1602
|
-
/**
|
|
1603
|
-
*
|
|
1604
|
-
* @type {boolean}
|
|
1605
|
-
* @memberof Origin
|
|
1606
|
-
*/
|
|
1607
605
|
'isPaid'?: boolean;
|
|
1608
606
|
}
|
|
1609
|
-
/**
|
|
1610
|
-
*
|
|
1611
|
-
* @export
|
|
1612
|
-
* @interface PaymentAccount
|
|
1613
|
-
*/
|
|
1614
607
|
export interface PaymentAccount {
|
|
1615
608
|
/**
|
|
1616
609
|
* The name of the payment account
|
|
1617
|
-
* @type {string}
|
|
1618
|
-
* @memberof PaymentAccount
|
|
1619
610
|
*/
|
|
1620
611
|
'name': string;
|
|
1621
612
|
/**
|
|
1622
613
|
* The payment method
|
|
1623
|
-
* @type {string}
|
|
1624
|
-
* @memberof PaymentAccount
|
|
1625
614
|
*/
|
|
1626
615
|
'method': PaymentAccountMethodEnum;
|
|
1627
616
|
/**
|
|
1628
617
|
* The configuration for the payment account
|
|
1629
|
-
* @type {{ [key: string]: string; }}
|
|
1630
|
-
* @memberof PaymentAccount
|
|
1631
618
|
*/
|
|
1632
619
|
'config': {
|
|
1633
620
|
[key: string]: string;
|
|
@@ -1639,38 +626,14 @@ export declare const PaymentAccountMethodEnum: {
|
|
|
1639
626
|
export type PaymentAccountMethodEnum = typeof PaymentAccountMethodEnum[keyof typeof PaymentAccountMethodEnum];
|
|
1640
627
|
/**
|
|
1641
628
|
* List of payment attempts for this order
|
|
1642
|
-
* @export
|
|
1643
|
-
* @interface PaymentAttempt
|
|
1644
629
|
*/
|
|
1645
630
|
export interface PaymentAttempt {
|
|
1646
|
-
/**
|
|
1647
|
-
*
|
|
1648
|
-
* @type {string}
|
|
1649
|
-
* @memberof PaymentAttempt
|
|
1650
|
-
*/
|
|
1651
631
|
'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
|
|
1652
|
-
/**
|
|
1653
|
-
*
|
|
1654
|
-
* @type {string}
|
|
1655
|
-
* @memberof PaymentAttempt
|
|
1656
|
-
*/
|
|
1657
632
|
'status'?: PaymentAttemptStatusEnum;
|
|
1658
|
-
/**
|
|
1659
|
-
*
|
|
1660
|
-
* @type {string}
|
|
1661
|
-
* @memberof PaymentAttempt
|
|
1662
|
-
*/
|
|
1663
633
|
'transactionId'?: string | null;
|
|
1664
|
-
/**
|
|
1665
|
-
*
|
|
1666
|
-
* @type {string}
|
|
1667
|
-
* @memberof PaymentAttempt
|
|
1668
|
-
*/
|
|
1669
634
|
'message'?: string;
|
|
1670
635
|
/**
|
|
1671
636
|
* ISO 8601 Timestamp
|
|
1672
|
-
* @type {string}
|
|
1673
|
-
* @memberof PaymentAttempt
|
|
1674
637
|
*/
|
|
1675
638
|
'createdAt'?: string;
|
|
1676
639
|
}
|
|
@@ -1687,230 +650,90 @@ export declare const PaymentAttemptStatusEnum: {
|
|
|
1687
650
|
readonly Cancelled: "cancelled";
|
|
1688
651
|
};
|
|
1689
652
|
export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
|
|
1690
|
-
/**
|
|
1691
|
-
*
|
|
1692
|
-
* @export
|
|
1693
|
-
* @interface Pixel
|
|
1694
|
-
*/
|
|
1695
653
|
export interface Pixel {
|
|
1696
654
|
/**
|
|
1697
655
|
* Unique object identifier
|
|
1698
|
-
* @type {string}
|
|
1699
|
-
* @memberof Pixel
|
|
1700
656
|
*/
|
|
1701
657
|
'id': string;
|
|
1702
|
-
/**
|
|
1703
|
-
*
|
|
1704
|
-
* @type {string}
|
|
1705
|
-
* @memberof Pixel
|
|
1706
|
-
*/
|
|
1707
658
|
'name': string;
|
|
1708
|
-
/**
|
|
1709
|
-
*
|
|
1710
|
-
* @type {Array<string>}
|
|
1711
|
-
* @memberof Pixel
|
|
1712
|
-
*/
|
|
1713
659
|
'sourceProjects': Array<string>;
|
|
1714
|
-
/**
|
|
1715
|
-
*
|
|
1716
|
-
* @type {CreatePixelRequestFilters}
|
|
1717
|
-
* @memberof Pixel
|
|
1718
|
-
*/
|
|
1719
660
|
'filters': CreatePixelRequestFilters;
|
|
1720
661
|
}
|
|
1721
|
-
/**
|
|
1722
|
-
*
|
|
1723
|
-
* @export
|
|
1724
|
-
* @interface PixelsResponse
|
|
1725
|
-
*/
|
|
1726
662
|
export interface PixelsResponse {
|
|
1727
|
-
/**
|
|
1728
|
-
*
|
|
1729
|
-
* @type {Array<Pixel>}
|
|
1730
|
-
* @memberof PixelsResponse
|
|
1731
|
-
*/
|
|
1732
663
|
'pixels': Array<Pixel>;
|
|
1733
|
-
/**
|
|
1734
|
-
*
|
|
1735
|
-
* @type {number}
|
|
1736
|
-
* @memberof PixelsResponse
|
|
1737
|
-
*/
|
|
1738
664
|
'nextPageToken'?: number | null;
|
|
1739
665
|
}
|
|
1740
|
-
/**
|
|
1741
|
-
*
|
|
1742
|
-
* @export
|
|
1743
|
-
* @interface Platform
|
|
1744
|
-
*/
|
|
1745
666
|
export interface Platform {
|
|
1746
|
-
/**
|
|
1747
|
-
*
|
|
1748
|
-
* @type {string}
|
|
1749
|
-
* @memberof Platform
|
|
1750
|
-
*/
|
|
1751
667
|
'id': string;
|
|
1752
|
-
|
|
1753
|
-
*
|
|
1754
|
-
* @type {string}
|
|
1755
|
-
* @memberof Platform
|
|
1756
|
-
*/
|
|
1757
|
-
'name': string;
|
|
1758
|
-
/**
|
|
1759
|
-
*
|
|
1760
|
-
* @type {Array<string>}
|
|
1761
|
-
* @memberof Platform
|
|
1762
|
-
*/
|
|
668
|
+
'name': string;
|
|
1763
669
|
'domains': Array<string>;
|
|
1764
|
-
/**
|
|
1765
|
-
*
|
|
1766
|
-
* @type {Array<PlatformLogo>}
|
|
1767
|
-
* @memberof Platform
|
|
1768
|
-
*/
|
|
1769
670
|
'logos': Array<PlatformLogo>;
|
|
1770
|
-
/**
|
|
1771
|
-
*
|
|
1772
|
-
* @type {string}
|
|
1773
|
-
* @memberof Platform
|
|
1774
|
-
*/
|
|
1775
671
|
'favicon': string | null;
|
|
1776
|
-
/**
|
|
1777
|
-
*
|
|
1778
|
-
* @type {boolean}
|
|
1779
|
-
* @memberof Platform
|
|
1780
|
-
*/
|
|
1781
672
|
'clientGiftWrapAvailable': boolean;
|
|
1782
673
|
/**
|
|
1783
674
|
* The subscription fee for the platform
|
|
1784
|
-
* @type {number}
|
|
1785
|
-
* @memberof Platform
|
|
1786
675
|
*/
|
|
1787
676
|
'storeSubscriptionFee': number;
|
|
1788
677
|
/**
|
|
1789
678
|
* The order handling fee for the platform
|
|
1790
|
-
* @type {number}
|
|
1791
|
-
* @memberof Platform
|
|
1792
679
|
*/
|
|
1793
680
|
'orderHandlingFee': number;
|
|
1794
681
|
/**
|
|
1795
682
|
* The item handling fee for the platform
|
|
1796
|
-
* @type {number}
|
|
1797
|
-
* @memberof Platform
|
|
1798
683
|
*/
|
|
1799
684
|
'itemHandlingFee': number;
|
|
685
|
+
/**
|
|
686
|
+
* The neck print fee for the platform
|
|
687
|
+
*/
|
|
688
|
+
'neckPrintFee': number;
|
|
1800
689
|
/**
|
|
1801
690
|
* Whether the platform can charge clients for orders
|
|
1802
|
-
* @type {boolean}
|
|
1803
|
-
* @memberof Platform
|
|
1804
691
|
*/
|
|
1805
692
|
'chargeClients': boolean;
|
|
1806
693
|
}
|
|
1807
|
-
/**
|
|
1808
|
-
*
|
|
1809
|
-
* @export
|
|
1810
|
-
* @interface PlatformLogo
|
|
1811
|
-
*/
|
|
1812
694
|
export interface PlatformLogo {
|
|
1813
|
-
/**
|
|
1814
|
-
*
|
|
1815
|
-
* @type {string}
|
|
1816
|
-
* @memberof PlatformLogo
|
|
1817
|
-
*/
|
|
1818
695
|
'url': string;
|
|
1819
|
-
/**
|
|
1820
|
-
*
|
|
1821
|
-
* @type {{ [key: string]: string; }}
|
|
1822
|
-
* @memberof PlatformLogo
|
|
1823
|
-
*/
|
|
1824
696
|
'meta': {
|
|
1825
697
|
[key: string]: string;
|
|
1826
698
|
};
|
|
1827
699
|
}
|
|
1828
700
|
/**
|
|
1829
701
|
* Standard price definition that defines the amount and currency.
|
|
1830
|
-
* @export
|
|
1831
|
-
* @interface Price
|
|
1832
702
|
*/
|
|
1833
703
|
export interface Price {
|
|
1834
704
|
/**
|
|
1835
705
|
* Price including tax in the specified currency.
|
|
1836
|
-
* @type {string}
|
|
1837
|
-
* @memberof Price
|
|
1838
706
|
*/
|
|
1839
707
|
'amount'?: string;
|
|
1840
708
|
/**
|
|
1841
709
|
* Currency code for the currency the price is valued in.
|
|
1842
|
-
* @type {string}
|
|
1843
|
-
* @memberof Price
|
|
1844
710
|
*/
|
|
1845
711
|
'currencyCode'?: string;
|
|
1846
712
|
}
|
|
1847
|
-
/**
|
|
1848
|
-
*
|
|
1849
|
-
* @export
|
|
1850
|
-
* @interface Project
|
|
1851
|
-
*/
|
|
1852
713
|
export interface Project {
|
|
1853
|
-
/**
|
|
1854
|
-
*
|
|
1855
|
-
* @type {string}
|
|
1856
|
-
* @memberof Project
|
|
1857
|
-
*/
|
|
1858
714
|
'id': string;
|
|
1859
715
|
/**
|
|
1860
716
|
* The name of the project
|
|
1861
|
-
* @type {string}
|
|
1862
|
-
* @memberof Project
|
|
1863
717
|
*/
|
|
1864
718
|
'name': string;
|
|
1865
719
|
}
|
|
1866
|
-
/**
|
|
1867
|
-
*
|
|
1868
|
-
* @export
|
|
1869
|
-
* @interface ReturnOrderRequest
|
|
1870
|
-
*/
|
|
1871
720
|
export interface ReturnOrderRequest {
|
|
1872
|
-
/**
|
|
1873
|
-
*
|
|
1874
|
-
* @type {Array<ReturnOrderRequestReturnsInner>}
|
|
1875
|
-
* @memberof ReturnOrderRequest
|
|
1876
|
-
*/
|
|
1877
721
|
'returns': Array<ReturnOrderRequestReturnsInner>;
|
|
1878
722
|
}
|
|
1879
|
-
/**
|
|
1880
|
-
*
|
|
1881
|
-
* @export
|
|
1882
|
-
* @interface ReturnOrderRequestReturnsInner
|
|
1883
|
-
*/
|
|
1884
723
|
export interface ReturnOrderRequestReturnsInner {
|
|
1885
724
|
/**
|
|
1886
725
|
* Unique order item identifier
|
|
1887
|
-
* @type {string}
|
|
1888
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1889
726
|
*/
|
|
1890
727
|
'id': string;
|
|
1891
|
-
/**
|
|
1892
|
-
*
|
|
1893
|
-
* @type {string}
|
|
1894
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1895
|
-
*/
|
|
1896
728
|
'action': ReturnOrderRequestReturnsInnerActionEnum;
|
|
1897
729
|
/**
|
|
1898
730
|
* 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.
|
|
1899
|
-
* @type {number}
|
|
1900
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1901
731
|
*/
|
|
1902
732
|
'quantity': number;
|
|
1903
733
|
/**
|
|
1904
734
|
* A reference to the variant being ordered
|
|
1905
|
-
* @type {string}
|
|
1906
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1907
735
|
*/
|
|
1908
736
|
'newVariantRef'?: string;
|
|
1909
|
-
/**
|
|
1910
|
-
*
|
|
1911
|
-
* @type {ReturnOrderRequestReturnsInnerReason}
|
|
1912
|
-
* @memberof ReturnOrderRequestReturnsInner
|
|
1913
|
-
*/
|
|
1914
737
|
'reason': ReturnOrderRequestReturnsInnerReason;
|
|
1915
738
|
}
|
|
1916
739
|
export declare const ReturnOrderRequestReturnsInnerActionEnum: {
|
|
@@ -1918,544 +741,192 @@ export declare const ReturnOrderRequestReturnsInnerActionEnum: {
|
|
|
1918
741
|
readonly Exchange: "exchange";
|
|
1919
742
|
};
|
|
1920
743
|
export type ReturnOrderRequestReturnsInnerActionEnum = typeof ReturnOrderRequestReturnsInnerActionEnum[keyof typeof ReturnOrderRequestReturnsInnerActionEnum];
|
|
1921
|
-
/**
|
|
1922
|
-
*
|
|
1923
|
-
* @export
|
|
1924
|
-
* @interface ReturnOrderRequestReturnsInnerReason
|
|
1925
|
-
*/
|
|
1926
744
|
export interface ReturnOrderRequestReturnsInnerReason {
|
|
1927
745
|
/**
|
|
1928
746
|
* A reference to the reason for the return or exchange.
|
|
1929
|
-
* @type {string}
|
|
1930
|
-
* @memberof ReturnOrderRequestReturnsInnerReason
|
|
1931
747
|
*/
|
|
1932
748
|
'reasonRef': string;
|
|
1933
749
|
/**
|
|
1934
750
|
* Additional comments as to why the item is being returned or exchanged.
|
|
1935
|
-
* @type {string}
|
|
1936
|
-
* @memberof ReturnOrderRequestReturnsInnerReason
|
|
1937
751
|
*/
|
|
1938
752
|
'additionalComments'?: string | null;
|
|
1939
753
|
}
|
|
1940
|
-
/**
|
|
1941
|
-
*
|
|
1942
|
-
* @export
|
|
1943
|
-
* @interface Review
|
|
1944
|
-
*/
|
|
1945
754
|
export interface Review {
|
|
1946
755
|
/**
|
|
1947
756
|
* Unique object identifier
|
|
1948
|
-
* @type {string}
|
|
1949
|
-
* @memberof Review
|
|
1950
757
|
*/
|
|
1951
758
|
'id': string;
|
|
1952
759
|
/**
|
|
1953
760
|
* Text content of the review
|
|
1954
|
-
* @type {string}
|
|
1955
|
-
* @memberof Review
|
|
1956
761
|
*/
|
|
1957
762
|
'text': string;
|
|
1958
|
-
/**
|
|
1959
|
-
*
|
|
1960
|
-
* @type {ReviewProduct}
|
|
1961
|
-
* @memberof Review
|
|
1962
|
-
*/
|
|
1963
763
|
'product'?: ReviewProduct;
|
|
1964
|
-
/**
|
|
1965
|
-
*
|
|
1966
|
-
* @type {ReviewAuthor}
|
|
1967
|
-
* @memberof Review
|
|
1968
|
-
*/
|
|
1969
764
|
'author'?: ReviewAuthor;
|
|
1970
765
|
/**
|
|
1971
766
|
* Rating of the review
|
|
1972
|
-
* @type {number}
|
|
1973
|
-
* @memberof Review
|
|
1974
767
|
*/
|
|
1975
768
|
'rating'?: number;
|
|
1976
769
|
/**
|
|
1977
770
|
* Google\'s sentiment analysis score
|
|
1978
|
-
* @type {number}
|
|
1979
|
-
* @memberof Review
|
|
1980
771
|
*/
|
|
1981
772
|
'sentiment'?: number;
|
|
1982
773
|
/**
|
|
1983
774
|
* Whether the review has been approved or not. If the review is not enabled, it will not be visible to the public.
|
|
1984
|
-
* @type {boolean}
|
|
1985
|
-
* @memberof Review
|
|
1986
775
|
*/
|
|
1987
776
|
'enabled': boolean;
|
|
1988
|
-
/**
|
|
1989
|
-
*
|
|
1990
|
-
* @type {string}
|
|
1991
|
-
* @memberof Review
|
|
1992
|
-
*/
|
|
1993
777
|
'createdAt'?: string;
|
|
1994
|
-
/**
|
|
1995
|
-
*
|
|
1996
|
-
* @type {Project}
|
|
1997
|
-
* @memberof Review
|
|
1998
|
-
*/
|
|
1999
778
|
'project': Project;
|
|
2000
|
-
/**
|
|
2001
|
-
*
|
|
2002
|
-
* @type {Array<ReviewImagesInner>}
|
|
2003
|
-
* @memberof Review
|
|
2004
|
-
*/
|
|
2005
779
|
'images'?: Array<ReviewImagesInner>;
|
|
2006
|
-
/**
|
|
2007
|
-
*
|
|
2008
|
-
* @type {Array<ReviewReply>}
|
|
2009
|
-
* @memberof Review
|
|
2010
|
-
*/
|
|
2011
780
|
'replies'?: Array<ReviewReply> | null;
|
|
2012
781
|
}
|
|
2013
|
-
/**
|
|
2014
|
-
*
|
|
2015
|
-
* @export
|
|
2016
|
-
* @interface ReviewAuthor
|
|
2017
|
-
*/
|
|
2018
782
|
export interface ReviewAuthor {
|
|
2019
783
|
/**
|
|
2020
784
|
* Name of the review\'s author
|
|
2021
|
-
* @type {string}
|
|
2022
|
-
* @memberof ReviewAuthor
|
|
2023
785
|
*/
|
|
2024
786
|
'name'?: string;
|
|
2025
787
|
/**
|
|
2026
788
|
* Email of the review\'s author
|
|
2027
|
-
* @type {string}
|
|
2028
|
-
* @memberof ReviewAuthor
|
|
2029
789
|
*/
|
|
2030
790
|
'email'?: string;
|
|
2031
791
|
}
|
|
2032
|
-
/**
|
|
2033
|
-
*
|
|
2034
|
-
* @export
|
|
2035
|
-
* @interface ReviewImagesInner
|
|
2036
|
-
*/
|
|
2037
792
|
export interface ReviewImagesInner {
|
|
2038
793
|
/**
|
|
2039
794
|
* URL of the image
|
|
2040
|
-
* @type {string}
|
|
2041
|
-
* @memberof ReviewImagesInner
|
|
2042
795
|
*/
|
|
2043
796
|
'src'?: string;
|
|
2044
797
|
/**
|
|
2045
798
|
* Alternative text for the image
|
|
2046
|
-
* @type {string}
|
|
2047
|
-
* @memberof ReviewImagesInner
|
|
2048
799
|
*/
|
|
2049
800
|
'alt'?: string;
|
|
2050
801
|
}
|
|
2051
802
|
/**
|
|
2052
803
|
* The product that the review is for
|
|
2053
|
-
* @export
|
|
2054
|
-
* @interface ReviewProduct
|
|
2055
804
|
*/
|
|
2056
805
|
export interface ReviewProduct {
|
|
2057
806
|
/**
|
|
2058
807
|
* Unique object identifier
|
|
2059
|
-
* @type {string}
|
|
2060
|
-
* @memberof ReviewProduct
|
|
2061
808
|
*/
|
|
2062
809
|
'id'?: string;
|
|
2063
810
|
/**
|
|
2064
811
|
* The title of the product
|
|
2065
|
-
* @type {string}
|
|
2066
|
-
* @memberof ReviewProduct
|
|
2067
812
|
*/
|
|
2068
813
|
'title'?: string;
|
|
2069
814
|
}
|
|
2070
|
-
/**
|
|
2071
|
-
*
|
|
2072
|
-
* @export
|
|
2073
|
-
* @interface ReviewReply
|
|
2074
|
-
*/
|
|
2075
815
|
export interface ReviewReply {
|
|
2076
816
|
/**
|
|
2077
817
|
* Unique object identifier
|
|
2078
|
-
* @type {string}
|
|
2079
|
-
* @memberof ReviewReply
|
|
2080
818
|
*/
|
|
2081
819
|
'id': string;
|
|
2082
820
|
/**
|
|
2083
821
|
* Text content of the reply
|
|
2084
|
-
* @type {string}
|
|
2085
|
-
* @memberof ReviewReply
|
|
2086
822
|
*/
|
|
2087
823
|
'text': string;
|
|
2088
|
-
/**
|
|
2089
|
-
*
|
|
2090
|
-
* @type {ReviewReplyAuthor}
|
|
2091
|
-
* @memberof ReviewReply
|
|
2092
|
-
*/
|
|
2093
824
|
'author'?: ReviewReplyAuthor;
|
|
2094
|
-
/**
|
|
2095
|
-
*
|
|
2096
|
-
* @type {string}
|
|
2097
|
-
* @memberof ReviewReply
|
|
2098
|
-
*/
|
|
2099
825
|
'createdAt'?: string;
|
|
2100
826
|
}
|
|
2101
|
-
/**
|
|
2102
|
-
*
|
|
2103
|
-
* @export
|
|
2104
|
-
* @interface ReviewReplyAuthor
|
|
2105
|
-
*/
|
|
2106
827
|
export interface ReviewReplyAuthor {
|
|
2107
828
|
/**
|
|
2108
829
|
* Name of the reply\'s author
|
|
2109
|
-
* @type {string}
|
|
2110
|
-
* @memberof ReviewReplyAuthor
|
|
2111
830
|
*/
|
|
2112
831
|
'name'?: string;
|
|
2113
832
|
}
|
|
2114
|
-
/**
|
|
2115
|
-
*
|
|
2116
|
-
* @export
|
|
2117
|
-
* @interface ReviewsResponse
|
|
2118
|
-
*/
|
|
2119
833
|
export interface ReviewsResponse {
|
|
2120
|
-
/**
|
|
2121
|
-
*
|
|
2122
|
-
* @type {Array<Review>}
|
|
2123
|
-
* @memberof ReviewsResponse
|
|
2124
|
-
*/
|
|
2125
834
|
'reviews'?: Array<Review>;
|
|
2126
835
|
/**
|
|
2127
836
|
* The token referencing the next page number
|
|
2128
|
-
* @type {number}
|
|
2129
|
-
* @memberof ReviewsResponse
|
|
2130
837
|
*/
|
|
2131
838
|
'nextPageToken'?: number | null;
|
|
2132
839
|
}
|
|
2133
|
-
/**
|
|
2134
|
-
*
|
|
2135
|
-
* @export
|
|
2136
|
-
* @interface SaveDashboardRequest
|
|
2137
|
-
*/
|
|
2138
840
|
export interface SaveDashboardRequest {
|
|
2139
|
-
/**
|
|
2140
|
-
*
|
|
2141
|
-
* @type {Array<DashboardItem>}
|
|
2142
|
-
* @memberof SaveDashboardRequest
|
|
2143
|
-
*/
|
|
2144
841
|
'items'?: Array<DashboardItem>;
|
|
2145
842
|
}
|
|
2146
|
-
/**
|
|
2147
|
-
*
|
|
2148
|
-
* @export
|
|
2149
|
-
* @interface SaveTermsRequest
|
|
2150
|
-
*/
|
|
2151
843
|
export interface SaveTermsRequest {
|
|
2152
|
-
/**
|
|
2153
|
-
*
|
|
2154
|
-
* @type {string}
|
|
2155
|
-
* @memberof SaveTermsRequest
|
|
2156
|
-
*/
|
|
2157
844
|
'title': string;
|
|
2158
|
-
/**
|
|
2159
|
-
*
|
|
2160
|
-
* @type {string}
|
|
2161
|
-
* @memberof SaveTermsRequest
|
|
2162
|
-
*/
|
|
2163
845
|
'content': string;
|
|
2164
|
-
/**
|
|
2165
|
-
*
|
|
2166
|
-
* @type {boolean}
|
|
2167
|
-
* @memberof SaveTermsRequest
|
|
2168
|
-
*/
|
|
2169
846
|
'enabled': boolean;
|
|
2170
|
-
/**
|
|
2171
|
-
*
|
|
2172
|
-
* @type {boolean}
|
|
2173
|
-
* @memberof SaveTermsRequest
|
|
2174
|
-
*/
|
|
2175
847
|
'updateVersion': boolean;
|
|
2176
848
|
}
|
|
2177
|
-
/**
|
|
2178
|
-
*
|
|
2179
|
-
* @export
|
|
2180
|
-
* @interface ShippingMethod
|
|
2181
|
-
*/
|
|
2182
849
|
export interface ShippingMethod {
|
|
2183
850
|
/**
|
|
2184
851
|
* Unique object identifier
|
|
2185
|
-
* @type {string}
|
|
2186
|
-
* @memberof ShippingMethod
|
|
2187
852
|
*/
|
|
2188
853
|
'id'?: string;
|
|
2189
|
-
/**
|
|
2190
|
-
*
|
|
2191
|
-
* @type {string}
|
|
2192
|
-
* @memberof ShippingMethod
|
|
2193
|
-
*/
|
|
2194
854
|
'name'?: string;
|
|
2195
|
-
/**
|
|
2196
|
-
*
|
|
2197
|
-
* @type {string}
|
|
2198
|
-
* @memberof ShippingMethod
|
|
2199
|
-
*/
|
|
2200
855
|
'description'?: string;
|
|
2201
|
-
/**
|
|
2202
|
-
*
|
|
2203
|
-
* @type {DeliveryEstimates}
|
|
2204
|
-
* @memberof ShippingMethod
|
|
2205
|
-
*/
|
|
2206
856
|
'deliveryEstimates'?: DeliveryEstimates;
|
|
2207
|
-
/**
|
|
2208
|
-
*
|
|
2209
|
-
* @type {Price}
|
|
2210
|
-
* @memberof ShippingMethod
|
|
2211
|
-
*/
|
|
2212
857
|
'totalPrice'?: Price;
|
|
2213
|
-
/**
|
|
2214
|
-
*
|
|
2215
|
-
* @type {Price}
|
|
2216
|
-
* @memberof ShippingMethod
|
|
2217
|
-
*/
|
|
2218
858
|
'taxPrice'?: Price;
|
|
2219
|
-
/**
|
|
2220
|
-
*
|
|
2221
|
-
* @type {Price}
|
|
2222
|
-
* @memberof ShippingMethod
|
|
2223
|
-
*/
|
|
2224
859
|
'subtotalPrice'?: Price;
|
|
2225
|
-
/**
|
|
2226
|
-
*
|
|
2227
|
-
* @type {Price}
|
|
2228
|
-
* @memberof ShippingMethod
|
|
2229
|
-
*/
|
|
2230
860
|
'discountPrice'?: Price;
|
|
2231
861
|
}
|
|
2232
|
-
/**
|
|
2233
|
-
*
|
|
2234
|
-
* @export
|
|
2235
|
-
* @interface Statistics
|
|
2236
|
-
*/
|
|
2237
862
|
export interface Statistics {
|
|
2238
|
-
/**
|
|
2239
|
-
*
|
|
2240
|
-
* @type {number}
|
|
2241
|
-
* @memberof Statistics
|
|
2242
|
-
*/
|
|
2243
863
|
'lifetimeValue': number;
|
|
2244
|
-
/**
|
|
2245
|
-
*
|
|
2246
|
-
* @type {number}
|
|
2247
|
-
* @memberof Statistics
|
|
2248
|
-
*/
|
|
2249
864
|
'totalOrderCount': number;
|
|
2250
|
-
/**
|
|
2251
|
-
*
|
|
2252
|
-
* @type {number}
|
|
2253
|
-
* @memberof Statistics
|
|
2254
|
-
*/
|
|
2255
865
|
'refundedOrderCount': number;
|
|
2256
|
-
/**
|
|
2257
|
-
*
|
|
2258
|
-
* @type {string}
|
|
2259
|
-
* @memberof Statistics
|
|
2260
|
-
*/
|
|
2261
866
|
'lastPurchased': string | null;
|
|
2262
|
-
/**
|
|
2263
|
-
*
|
|
2264
|
-
* @type {boolean}
|
|
2265
|
-
* @memberof Statistics
|
|
2266
|
-
*/
|
|
2267
867
|
'usedDiscount': boolean;
|
|
2268
868
|
}
|
|
2269
|
-
/**
|
|
2270
|
-
*
|
|
2271
|
-
* @export
|
|
2272
|
-
* @interface StatusHistoryItem
|
|
2273
|
-
*/
|
|
2274
869
|
export interface StatusHistoryItem {
|
|
2275
|
-
/**
|
|
2276
|
-
*
|
|
2277
|
-
* @type {OrderStatus}
|
|
2278
|
-
* @memberof StatusHistoryItem
|
|
2279
|
-
*/
|
|
2280
870
|
'status'?: OrderStatus;
|
|
2281
871
|
/**
|
|
2282
872
|
* ISO 8601 Timestamp
|
|
2283
|
-
* @type {string}
|
|
2284
|
-
* @memberof StatusHistoryItem
|
|
2285
873
|
*/
|
|
2286
874
|
'createdAt'?: string;
|
|
2287
875
|
}
|
|
2288
|
-
/**
|
|
2289
|
-
*
|
|
2290
|
-
* @export
|
|
2291
|
-
* @interface Terms
|
|
2292
|
-
*/
|
|
2293
876
|
export interface Terms {
|
|
2294
|
-
/**
|
|
2295
|
-
*
|
|
2296
|
-
* @type {string}
|
|
2297
|
-
* @memberof Terms
|
|
2298
|
-
*/
|
|
2299
877
|
'id': string;
|
|
2300
|
-
/**
|
|
2301
|
-
*
|
|
2302
|
-
* @type {string}
|
|
2303
|
-
* @memberof Terms
|
|
2304
|
-
*/
|
|
2305
878
|
'title': string;
|
|
2306
|
-
/**
|
|
2307
|
-
*
|
|
2308
|
-
* @type {string}
|
|
2309
|
-
* @memberof Terms
|
|
2310
|
-
*/
|
|
2311
879
|
'content': string;
|
|
2312
|
-
/**
|
|
2313
|
-
*
|
|
2314
|
-
* @type {number}
|
|
2315
|
-
* @memberof Terms
|
|
2316
|
-
*/
|
|
2317
880
|
'version': number;
|
|
2318
|
-
/**
|
|
2319
|
-
*
|
|
2320
|
-
* @type {boolean}
|
|
2321
|
-
* @memberof Terms
|
|
2322
|
-
*/
|
|
2323
881
|
'enabled': boolean;
|
|
2324
|
-
/**
|
|
2325
|
-
*
|
|
2326
|
-
* @type {string}
|
|
2327
|
-
* @memberof Terms
|
|
2328
|
-
*/
|
|
2329
882
|
'createdAt': string;
|
|
2330
|
-
/**
|
|
2331
|
-
*
|
|
2332
|
-
* @type {string}
|
|
2333
|
-
* @memberof Terms
|
|
2334
|
-
*/
|
|
2335
883
|
'updatedAt': string;
|
|
2336
884
|
}
|
|
2337
|
-
/**
|
|
2338
|
-
*
|
|
2339
|
-
* @export
|
|
2340
|
-
* @interface UpdateCustomerEnquiryRequest
|
|
2341
|
-
*/
|
|
2342
885
|
export interface UpdateCustomerEnquiryRequest {
|
|
2343
886
|
/**
|
|
2344
887
|
* The unique id of the user who owns the enquiry
|
|
2345
|
-
* @type {string}
|
|
2346
|
-
* @memberof UpdateCustomerEnquiryRequest
|
|
2347
888
|
*/
|
|
2348
889
|
'owner'?: string | null;
|
|
2349
890
|
}
|
|
2350
|
-
/**
|
|
2351
|
-
*
|
|
2352
|
-
* @export
|
|
2353
|
-
* @interface UpdateFulfillmentRequest
|
|
2354
|
-
*/
|
|
2355
891
|
export interface UpdateFulfillmentRequest {
|
|
2356
892
|
/**
|
|
2357
893
|
* Unique object identifier
|
|
2358
|
-
* @type {string}
|
|
2359
|
-
* @memberof UpdateFulfillmentRequest
|
|
2360
894
|
*/
|
|
2361
895
|
'fulfillerId'?: string;
|
|
2362
896
|
}
|
|
2363
|
-
/**
|
|
2364
|
-
*
|
|
2365
|
-
* @export
|
|
2366
|
-
* @interface UpdatePlatformRequest
|
|
2367
|
-
*/
|
|
2368
897
|
export interface UpdatePlatformRequest {
|
|
2369
|
-
/**
|
|
2370
|
-
*
|
|
2371
|
-
* @type {Array<PlatformLogo>}
|
|
2372
|
-
* @memberof UpdatePlatformRequest
|
|
2373
|
-
*/
|
|
2374
898
|
'logos'?: Array<PlatformLogo>;
|
|
2375
|
-
/**
|
|
2376
|
-
*
|
|
2377
|
-
* @type {string}
|
|
2378
|
-
* @memberof UpdatePlatformRequest
|
|
2379
|
-
*/
|
|
2380
899
|
'favicon'?: string;
|
|
2381
|
-
/**
|
|
2382
|
-
*
|
|
2383
|
-
* @type {boolean}
|
|
2384
|
-
* @memberof UpdatePlatformRequest
|
|
2385
|
-
*/
|
|
2386
900
|
'clientGiftWrapAvailable'?: boolean;
|
|
2387
|
-
/**
|
|
2388
|
-
*
|
|
2389
|
-
* @type {number}
|
|
2390
|
-
* @memberof UpdatePlatformRequest
|
|
2391
|
-
*/
|
|
2392
901
|
'storeSubscriptionFee'?: number;
|
|
2393
|
-
/**
|
|
2394
|
-
*
|
|
2395
|
-
* @type {number}
|
|
2396
|
-
* @memberof UpdatePlatformRequest
|
|
2397
|
-
*/
|
|
2398
902
|
'orderHandlingFee'?: number;
|
|
2399
|
-
/**
|
|
2400
|
-
*
|
|
2401
|
-
* @type {number}
|
|
2402
|
-
* @memberof UpdatePlatformRequest
|
|
2403
|
-
*/
|
|
2404
903
|
'itemHandlingFee'?: number;
|
|
2405
|
-
|
|
2406
|
-
*
|
|
2407
|
-
* @type {boolean}
|
|
2408
|
-
* @memberof UpdatePlatformRequest
|
|
2409
|
-
*/
|
|
904
|
+
'neckPrintFee'?: number;
|
|
2410
905
|
'chargeClients'?: boolean;
|
|
2411
906
|
}
|
|
2412
|
-
/**
|
|
2413
|
-
*
|
|
2414
|
-
* @export
|
|
2415
|
-
* @interface ValidationError
|
|
2416
|
-
*/
|
|
2417
907
|
export interface ValidationError {
|
|
2418
|
-
/**
|
|
2419
|
-
*
|
|
2420
|
-
* @type {string}
|
|
2421
|
-
* @memberof ValidationError
|
|
2422
|
-
*/
|
|
2423
908
|
'message': string;
|
|
2424
909
|
}
|
|
2425
|
-
/**
|
|
2426
|
-
*
|
|
2427
|
-
* @export
|
|
2428
|
-
* @interface Variant
|
|
2429
|
-
*/
|
|
2430
910
|
export interface Variant {
|
|
2431
911
|
/**
|
|
2432
912
|
* Unique object identifier
|
|
2433
|
-
* @type {string}
|
|
2434
|
-
* @memberof Variant
|
|
2435
913
|
*/
|
|
2436
914
|
'id': string;
|
|
2437
915
|
/**
|
|
2438
916
|
* A reference to the resource location
|
|
2439
|
-
* @type {string}
|
|
2440
|
-
* @memberof Variant
|
|
2441
917
|
*/
|
|
2442
918
|
'ref': string;
|
|
2443
919
|
/**
|
|
2444
920
|
* A reference to the resource location
|
|
2445
|
-
* @type {string}
|
|
2446
|
-
* @memberof Variant
|
|
2447
921
|
*/
|
|
2448
922
|
'productRef': string;
|
|
2449
923
|
/**
|
|
2450
924
|
* A reference to the resource location
|
|
2451
|
-
* @type {string}
|
|
2452
|
-
* @memberof Variant
|
|
2453
925
|
*/
|
|
2454
926
|
'warehouseVariantRef': string;
|
|
2455
927
|
}
|
|
2456
928
|
/**
|
|
2457
929
|
* CustomersApi - axios parameter creator
|
|
2458
|
-
* @export
|
|
2459
930
|
*/
|
|
2460
931
|
export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2461
932
|
/**
|
|
@@ -2536,7 +1007,6 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2536
1007
|
};
|
|
2537
1008
|
/**
|
|
2538
1009
|
* CustomersApi - functional programming interface
|
|
2539
|
-
* @export
|
|
2540
1010
|
*/
|
|
2541
1011
|
export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
2542
1012
|
/**
|
|
@@ -2585,7 +1055,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
2585
1055
|
* @param {*} [options] Override http request option.
|
|
2586
1056
|
* @throws {RequiredError}
|
|
2587
1057
|
*/
|
|
2588
|
-
listCustomerTags(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1058
|
+
listCustomerTags(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerTags200Response>>;
|
|
2589
1059
|
/**
|
|
2590
1060
|
* List customers for a platform
|
|
2591
1061
|
* @summary List customers
|
|
@@ -2617,7 +1087,6 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
2617
1087
|
};
|
|
2618
1088
|
/**
|
|
2619
1089
|
* CustomersApi - factory interface
|
|
2620
|
-
* @export
|
|
2621
1090
|
*/
|
|
2622
1091
|
export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2623
1092
|
/**
|
|
@@ -2643,7 +1112,7 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
2643
1112
|
* @param {*} [options] Override http request option.
|
|
2644
1113
|
* @throws {RequiredError}
|
|
2645
1114
|
*/
|
|
2646
|
-
listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1115
|
+
listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerTags200Response>;
|
|
2647
1116
|
/**
|
|
2648
1117
|
* List customers for a platform
|
|
2649
1118
|
* @summary List customers
|
|
@@ -2655,319 +1124,214 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
2655
1124
|
};
|
|
2656
1125
|
/**
|
|
2657
1126
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
2658
|
-
* @export
|
|
2659
|
-
* @interface CustomersApiExportCustomersRequest
|
|
2660
1127
|
*/
|
|
2661
1128
|
export interface CustomersApiExportCustomersRequest {
|
|
2662
1129
|
/**
|
|
2663
1130
|
* Project unique identifier
|
|
2664
|
-
* @type {string}
|
|
2665
|
-
* @memberof CustomersApiExportCustomers
|
|
2666
1131
|
*/
|
|
2667
1132
|
readonly project: string;
|
|
2668
1133
|
/**
|
|
2669
1134
|
* The platform identifier
|
|
2670
|
-
* @type {string}
|
|
2671
|
-
* @memberof CustomersApiExportCustomers
|
|
2672
1135
|
*/
|
|
2673
1136
|
readonly platformId: string;
|
|
2674
1137
|
/**
|
|
2675
1138
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2676
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
|
|
2677
|
-
* @memberof CustomersApiExportCustomers
|
|
2678
1139
|
*/
|
|
2679
1140
|
readonly sortBy?: Array<ExportCustomersSortByEnum>;
|
|
2680
1141
|
/**
|
|
2681
1142
|
* Filter customers by country code
|
|
2682
|
-
* @type {Array<string>}
|
|
2683
|
-
* @memberof CustomersApiExportCustomers
|
|
2684
1143
|
*/
|
|
2685
1144
|
readonly countries?: Array<string>;
|
|
2686
1145
|
/**
|
|
2687
1146
|
* Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2688
|
-
* @type {Array<string>}
|
|
2689
|
-
* @memberof CustomersApiExportCustomers
|
|
2690
1147
|
*/
|
|
2691
1148
|
readonly projects?: Array<string>;
|
|
2692
1149
|
/**
|
|
2693
1150
|
* Filter customers by gender equal to the value provided
|
|
2694
|
-
* @type {'male' | 'female'}
|
|
2695
|
-
* @memberof CustomersApiExportCustomers
|
|
2696
1151
|
*/
|
|
2697
1152
|
readonly gender?: ExportCustomersGenderEnum;
|
|
2698
1153
|
/**
|
|
2699
1154
|
* Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2700
|
-
* @type {Array<number>}
|
|
2701
|
-
* @memberof CustomersApiExportCustomers
|
|
2702
1155
|
*/
|
|
2703
1156
|
readonly productTypes?: Array<number>;
|
|
2704
1157
|
/**
|
|
2705
1158
|
* Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
2706
|
-
* @type {Array<string>}
|
|
2707
|
-
* @memberof CustomersApiExportCustomers
|
|
2708
1159
|
*/
|
|
2709
1160
|
readonly demographics?: Array<string>;
|
|
2710
1161
|
/**
|
|
2711
1162
|
* Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2712
|
-
* @type {Array<string>}
|
|
2713
|
-
* @memberof CustomersApiExportCustomers
|
|
2714
1163
|
*/
|
|
2715
1164
|
readonly tags?: Array<string>;
|
|
2716
1165
|
/**
|
|
2717
1166
|
* Filter customers by whether they have used a discount
|
|
2718
|
-
* @type {boolean}
|
|
2719
|
-
* @memberof CustomersApiExportCustomers
|
|
2720
1167
|
*/
|
|
2721
1168
|
readonly usedDiscount?: boolean;
|
|
2722
1169
|
/**
|
|
2723
1170
|
* Filter customers by total order count greater than or equal to the value provided
|
|
2724
|
-
* @type {number}
|
|
2725
|
-
* @memberof CustomersApiExportCustomers
|
|
2726
1171
|
*/
|
|
2727
1172
|
readonly minimumTotalOrderCount?: number;
|
|
2728
1173
|
/**
|
|
2729
1174
|
* Filter customers by total order count less than or equal to the value provided
|
|
2730
|
-
* @type {number}
|
|
2731
|
-
* @memberof CustomersApiExportCustomers
|
|
2732
1175
|
*/
|
|
2733
1176
|
readonly maximumTotalOrderCount?: number;
|
|
2734
1177
|
/**
|
|
2735
1178
|
* Filter customers by refunded order count greater than or equal to the value provided
|
|
2736
|
-
* @type {number}
|
|
2737
|
-
* @memberof CustomersApiExportCustomers
|
|
2738
1179
|
*/
|
|
2739
1180
|
readonly minimumRefundedOrderCount?: number;
|
|
2740
1181
|
/**
|
|
2741
1182
|
* Filter customers by refunded order count less than or equal to the value provided
|
|
2742
|
-
* @type {number}
|
|
2743
|
-
* @memberof CustomersApiExportCustomers
|
|
2744
1183
|
*/
|
|
2745
1184
|
readonly maximumRefundedOrderCount?: number;
|
|
2746
1185
|
/**
|
|
2747
1186
|
* Filter customers by lifetime value greater than or equal to the value provided
|
|
2748
|
-
* @type {number}
|
|
2749
|
-
* @memberof CustomersApiExportCustomers
|
|
2750
1187
|
*/
|
|
2751
1188
|
readonly minimumLifetimeValue?: number;
|
|
2752
1189
|
/**
|
|
2753
1190
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2754
|
-
* @type {number}
|
|
2755
|
-
* @memberof CustomersApiExportCustomers
|
|
2756
1191
|
*/
|
|
2757
1192
|
readonly maximumLifetimeValue?: number;
|
|
2758
1193
|
/**
|
|
2759
1194
|
* Start of date range to filter customers by last purchase date
|
|
2760
|
-
* @type {string}
|
|
2761
|
-
* @memberof CustomersApiExportCustomers
|
|
2762
1195
|
*/
|
|
2763
1196
|
readonly lastPurchasedStart?: string;
|
|
2764
1197
|
/**
|
|
2765
1198
|
* End of date range to filter customers by last purchase date
|
|
2766
|
-
* @type {string}
|
|
2767
|
-
* @memberof CustomersApiExportCustomers
|
|
2768
1199
|
*/
|
|
2769
1200
|
readonly lastPurchasedEnd?: string;
|
|
2770
1201
|
}
|
|
2771
1202
|
/**
|
|
2772
1203
|
* Request parameters for getCustomer operation in CustomersApi.
|
|
2773
|
-
* @export
|
|
2774
|
-
* @interface CustomersApiGetCustomerRequest
|
|
2775
1204
|
*/
|
|
2776
1205
|
export interface CustomersApiGetCustomerRequest {
|
|
2777
1206
|
/**
|
|
2778
1207
|
* Project unique identifier
|
|
2779
|
-
* @type {string}
|
|
2780
|
-
* @memberof CustomersApiGetCustomer
|
|
2781
1208
|
*/
|
|
2782
1209
|
readonly project: string;
|
|
2783
1210
|
/**
|
|
2784
1211
|
* The platform identifier
|
|
2785
|
-
* @type {string}
|
|
2786
|
-
* @memberof CustomersApiGetCustomer
|
|
2787
1212
|
*/
|
|
2788
1213
|
readonly platformId: string;
|
|
2789
1214
|
/**
|
|
2790
1215
|
* The customer identifier
|
|
2791
|
-
* @type {string}
|
|
2792
|
-
* @memberof CustomersApiGetCustomer
|
|
2793
1216
|
*/
|
|
2794
1217
|
readonly customerId: string;
|
|
2795
1218
|
}
|
|
2796
1219
|
/**
|
|
2797
1220
|
* Request parameters for listCustomerTags operation in CustomersApi.
|
|
2798
|
-
* @export
|
|
2799
|
-
* @interface CustomersApiListCustomerTagsRequest
|
|
2800
1221
|
*/
|
|
2801
1222
|
export interface CustomersApiListCustomerTagsRequest {
|
|
2802
1223
|
/**
|
|
2803
1224
|
* Project unique identifier
|
|
2804
|
-
* @type {string}
|
|
2805
|
-
* @memberof CustomersApiListCustomerTags
|
|
2806
1225
|
*/
|
|
2807
1226
|
readonly project: string;
|
|
2808
1227
|
/**
|
|
2809
1228
|
* The platform identifier
|
|
2810
|
-
* @type {string}
|
|
2811
|
-
* @memberof CustomersApiListCustomerTags
|
|
2812
1229
|
*/
|
|
2813
1230
|
readonly platformId: string;
|
|
2814
1231
|
/**
|
|
2815
1232
|
* Page reference token
|
|
2816
|
-
* @type {number}
|
|
2817
|
-
* @memberof CustomersApiListCustomerTags
|
|
2818
1233
|
*/
|
|
2819
1234
|
readonly pageToken?: number;
|
|
2820
1235
|
/**
|
|
2821
1236
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2822
|
-
* @type {number}
|
|
2823
|
-
* @memberof CustomersApiListCustomerTags
|
|
2824
1237
|
*/
|
|
2825
1238
|
readonly pageSize?: number;
|
|
2826
1239
|
/**
|
|
2827
1240
|
* Search term to filter results
|
|
2828
|
-
* @type {string}
|
|
2829
|
-
* @memberof CustomersApiListCustomerTags
|
|
2830
1241
|
*/
|
|
2831
1242
|
readonly search?: string;
|
|
2832
1243
|
}
|
|
2833
1244
|
/**
|
|
2834
1245
|
* Request parameters for listCustomers operation in CustomersApi.
|
|
2835
|
-
* @export
|
|
2836
|
-
* @interface CustomersApiListCustomersRequest
|
|
2837
1246
|
*/
|
|
2838
1247
|
export interface CustomersApiListCustomersRequest {
|
|
2839
1248
|
/**
|
|
2840
1249
|
* Project unique identifier
|
|
2841
|
-
* @type {string}
|
|
2842
|
-
* @memberof CustomersApiListCustomers
|
|
2843
1250
|
*/
|
|
2844
1251
|
readonly project: string;
|
|
2845
1252
|
/**
|
|
2846
1253
|
* The platform identifier
|
|
2847
|
-
* @type {string}
|
|
2848
|
-
* @memberof CustomersApiListCustomers
|
|
2849
1254
|
*/
|
|
2850
1255
|
readonly platformId: string;
|
|
2851
1256
|
/**
|
|
2852
1257
|
* Page reference token
|
|
2853
|
-
* @type {number}
|
|
2854
|
-
* @memberof CustomersApiListCustomers
|
|
2855
1258
|
*/
|
|
2856
1259
|
readonly pageToken?: number;
|
|
2857
1260
|
/**
|
|
2858
1261
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2859
|
-
* @type {number}
|
|
2860
|
-
* @memberof CustomersApiListCustomers
|
|
2861
1262
|
*/
|
|
2862
1263
|
readonly pageSize?: number;
|
|
2863
1264
|
/**
|
|
2864
1265
|
* Search term to filter results
|
|
2865
|
-
* @type {string}
|
|
2866
|
-
* @memberof CustomersApiListCustomers
|
|
2867
1266
|
*/
|
|
2868
1267
|
readonly search?: string;
|
|
2869
1268
|
/**
|
|
2870
1269
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2871
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
|
|
2872
|
-
* @memberof CustomersApiListCustomers
|
|
2873
1270
|
*/
|
|
2874
1271
|
readonly sortBy?: Array<ListCustomersSortByEnum>;
|
|
2875
1272
|
/**
|
|
2876
1273
|
* Filter customers by country code
|
|
2877
|
-
* @type {Array<string>}
|
|
2878
|
-
* @memberof CustomersApiListCustomers
|
|
2879
1274
|
*/
|
|
2880
1275
|
readonly countries?: Array<string>;
|
|
2881
1276
|
/**
|
|
2882
1277
|
* Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2883
|
-
* @type {Array<string>}
|
|
2884
|
-
* @memberof CustomersApiListCustomers
|
|
2885
1278
|
*/
|
|
2886
1279
|
readonly projects?: Array<string>;
|
|
2887
1280
|
/**
|
|
2888
1281
|
* Filter customers by gender equal to the value provided
|
|
2889
|
-
* @type {'male' | 'female'}
|
|
2890
|
-
* @memberof CustomersApiListCustomers
|
|
2891
1282
|
*/
|
|
2892
1283
|
readonly gender?: ListCustomersGenderEnum;
|
|
2893
1284
|
/**
|
|
2894
1285
|
* Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2895
|
-
* @type {Array<number>}
|
|
2896
|
-
* @memberof CustomersApiListCustomers
|
|
2897
1286
|
*/
|
|
2898
1287
|
readonly productTypes?: Array<number>;
|
|
2899
1288
|
/**
|
|
2900
1289
|
* Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
2901
|
-
* @type {Array<string>}
|
|
2902
|
-
* @memberof CustomersApiListCustomers
|
|
2903
1290
|
*/
|
|
2904
1291
|
readonly demographics?: Array<string>;
|
|
2905
1292
|
/**
|
|
2906
1293
|
* Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2907
|
-
* @type {Array<string>}
|
|
2908
|
-
* @memberof CustomersApiListCustomers
|
|
2909
1294
|
*/
|
|
2910
1295
|
readonly tags?: Array<string>;
|
|
2911
1296
|
/**
|
|
2912
1297
|
* Filter customers by whether they have used a discount
|
|
2913
|
-
* @type {boolean}
|
|
2914
|
-
* @memberof CustomersApiListCustomers
|
|
2915
1298
|
*/
|
|
2916
1299
|
readonly usedDiscount?: boolean;
|
|
2917
1300
|
/**
|
|
2918
1301
|
* Filter customers by total order count greater than or equal to the value provided
|
|
2919
|
-
* @type {number}
|
|
2920
|
-
* @memberof CustomersApiListCustomers
|
|
2921
1302
|
*/
|
|
2922
1303
|
readonly minimumTotalOrderCount?: number;
|
|
2923
1304
|
/**
|
|
2924
1305
|
* Filter customers by total order count less than or equal to the value provided
|
|
2925
|
-
* @type {number}
|
|
2926
|
-
* @memberof CustomersApiListCustomers
|
|
2927
1306
|
*/
|
|
2928
1307
|
readonly maximumTotalOrderCount?: number;
|
|
2929
1308
|
/**
|
|
2930
1309
|
* Filter customers by refunded order count greater than or equal to the value provided
|
|
2931
|
-
* @type {number}
|
|
2932
|
-
* @memberof CustomersApiListCustomers
|
|
2933
1310
|
*/
|
|
2934
1311
|
readonly minimumRefundedOrderCount?: number;
|
|
2935
1312
|
/**
|
|
2936
1313
|
* Filter customers by refunded order count less than or equal to the value provided
|
|
2937
|
-
* @type {number}
|
|
2938
|
-
* @memberof CustomersApiListCustomers
|
|
2939
1314
|
*/
|
|
2940
1315
|
readonly maximumRefundedOrderCount?: number;
|
|
2941
1316
|
/**
|
|
2942
1317
|
* Filter customers by lifetime value greater than or equal to the value provided
|
|
2943
|
-
* @type {number}
|
|
2944
|
-
* @memberof CustomersApiListCustomers
|
|
2945
1318
|
*/
|
|
2946
1319
|
readonly minimumLifetimeValue?: number;
|
|
2947
1320
|
/**
|
|
2948
1321
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2949
|
-
* @type {number}
|
|
2950
|
-
* @memberof CustomersApiListCustomers
|
|
2951
1322
|
*/
|
|
2952
1323
|
readonly maximumLifetimeValue?: number;
|
|
2953
1324
|
/**
|
|
2954
1325
|
* Start of date range to filter customers by last purchase date
|
|
2955
|
-
* @type {string}
|
|
2956
|
-
* @memberof CustomersApiListCustomers
|
|
2957
1326
|
*/
|
|
2958
1327
|
readonly lastPurchasedStart?: string;
|
|
2959
1328
|
/**
|
|
2960
1329
|
* End of date range to filter customers by last purchase date
|
|
2961
|
-
* @type {string}
|
|
2962
|
-
* @memberof CustomersApiListCustomers
|
|
2963
1330
|
*/
|
|
2964
1331
|
readonly lastPurchasedEnd?: string;
|
|
2965
1332
|
}
|
|
2966
1333
|
/**
|
|
2967
1334
|
* CustomersApi - object-oriented interface
|
|
2968
|
-
* @export
|
|
2969
|
-
* @class CustomersApi
|
|
2970
|
-
* @extends {BaseAPI}
|
|
2971
1335
|
*/
|
|
2972
1336
|
export declare class CustomersApi extends BaseAPI {
|
|
2973
1337
|
/**
|
|
@@ -2976,7 +1340,6 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
2976
1340
|
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
2977
1341
|
* @param {*} [options] Override http request option.
|
|
2978
1342
|
* @throws {RequiredError}
|
|
2979
|
-
* @memberof CustomersApi
|
|
2980
1343
|
*/
|
|
2981
1344
|
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
2982
1345
|
/**
|
|
@@ -2985,7 +1348,6 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
2985
1348
|
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
2986
1349
|
* @param {*} [options] Override http request option.
|
|
2987
1350
|
* @throws {RequiredError}
|
|
2988
|
-
* @memberof CustomersApi
|
|
2989
1351
|
*/
|
|
2990
1352
|
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
|
|
2991
1353
|
/**
|
|
@@ -2994,22 +1356,17 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
2994
1356
|
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
2995
1357
|
* @param {*} [options] Override http request option.
|
|
2996
1358
|
* @throws {RequiredError}
|
|
2997
|
-
* @memberof CustomersApi
|
|
2998
1359
|
*/
|
|
2999
|
-
listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
1360
|
+
listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerTags200Response, any>>;
|
|
3000
1361
|
/**
|
|
3001
1362
|
* List customers for a platform
|
|
3002
1363
|
* @summary List customers
|
|
3003
1364
|
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
3004
1365
|
* @param {*} [options] Override http request option.
|
|
3005
1366
|
* @throws {RequiredError}
|
|
3006
|
-
* @memberof CustomersApi
|
|
3007
1367
|
*/
|
|
3008
1368
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
|
|
3009
1369
|
}
|
|
3010
|
-
/**
|
|
3011
|
-
* @export
|
|
3012
|
-
*/
|
|
3013
1370
|
export declare const ExportCustomersSortByEnum: {
|
|
3014
1371
|
readonly LifetimeValue: "+lifetimeValue";
|
|
3015
1372
|
readonly LifetimeValue2: "-lifetimeValue";
|
|
@@ -3023,17 +1380,11 @@ export declare const ExportCustomersSortByEnum: {
|
|
|
3023
1380
|
readonly UsedDiscount2: "-usedDiscount";
|
|
3024
1381
|
};
|
|
3025
1382
|
export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
|
|
3026
|
-
/**
|
|
3027
|
-
* @export
|
|
3028
|
-
*/
|
|
3029
1383
|
export declare const ExportCustomersGenderEnum: {
|
|
3030
1384
|
readonly Male: "male";
|
|
3031
1385
|
readonly Female: "female";
|
|
3032
1386
|
};
|
|
3033
1387
|
export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
|
|
3034
|
-
/**
|
|
3035
|
-
* @export
|
|
3036
|
-
*/
|
|
3037
1388
|
export declare const ListCustomersSortByEnum: {
|
|
3038
1389
|
readonly LifetimeValue: "+lifetimeValue";
|
|
3039
1390
|
readonly LifetimeValue2: "-lifetimeValue";
|
|
@@ -3047,9 +1398,6 @@ export declare const ListCustomersSortByEnum: {
|
|
|
3047
1398
|
readonly UsedDiscount2: "-usedDiscount";
|
|
3048
1399
|
};
|
|
3049
1400
|
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
3050
|
-
/**
|
|
3051
|
-
* @export
|
|
3052
|
-
*/
|
|
3053
1401
|
export declare const ListCustomersGenderEnum: {
|
|
3054
1402
|
readonly Male: "male";
|
|
3055
1403
|
readonly Female: "female";
|
|
@@ -3057,7 +1405,6 @@ export declare const ListCustomersGenderEnum: {
|
|
|
3057
1405
|
export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
|
|
3058
1406
|
/**
|
|
3059
1407
|
* DashboardApi - axios parameter creator
|
|
3060
|
-
* @export
|
|
3061
1408
|
*/
|
|
3062
1409
|
export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3063
1410
|
/**
|
|
@@ -3082,7 +1429,6 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3082
1429
|
};
|
|
3083
1430
|
/**
|
|
3084
1431
|
* DashboardApi - functional programming interface
|
|
3085
|
-
* @export
|
|
3086
1432
|
*/
|
|
3087
1433
|
export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
3088
1434
|
/**
|
|
@@ -3107,7 +1453,6 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
3107
1453
|
};
|
|
3108
1454
|
/**
|
|
3109
1455
|
* DashboardApi - factory interface
|
|
3110
|
-
* @export
|
|
3111
1456
|
*/
|
|
3112
1457
|
export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3113
1458
|
/**
|
|
@@ -3129,53 +1474,36 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
3129
1474
|
};
|
|
3130
1475
|
/**
|
|
3131
1476
|
* Request parameters for getDashboard operation in DashboardApi.
|
|
3132
|
-
* @export
|
|
3133
|
-
* @interface DashboardApiGetDashboardRequest
|
|
3134
1477
|
*/
|
|
3135
1478
|
export interface DashboardApiGetDashboardRequest {
|
|
3136
1479
|
/**
|
|
3137
1480
|
* Project unique identifier
|
|
3138
|
-
* @type {string}
|
|
3139
|
-
* @memberof DashboardApiGetDashboard
|
|
3140
1481
|
*/
|
|
3141
1482
|
readonly project: string;
|
|
3142
1483
|
/**
|
|
3143
1484
|
* The platform identifier
|
|
3144
|
-
* @type {string}
|
|
3145
|
-
* @memberof DashboardApiGetDashboard
|
|
3146
1485
|
*/
|
|
3147
1486
|
readonly platformId: string;
|
|
3148
1487
|
}
|
|
3149
1488
|
/**
|
|
3150
1489
|
* Request parameters for saveDashboard operation in DashboardApi.
|
|
3151
|
-
* @export
|
|
3152
|
-
* @interface DashboardApiSaveDashboardRequest
|
|
3153
1490
|
*/
|
|
3154
1491
|
export interface DashboardApiSaveDashboardRequest {
|
|
3155
1492
|
/**
|
|
3156
1493
|
* Project unique identifier
|
|
3157
|
-
* @type {string}
|
|
3158
|
-
* @memberof DashboardApiSaveDashboard
|
|
3159
1494
|
*/
|
|
3160
1495
|
readonly project: string;
|
|
3161
1496
|
/**
|
|
3162
1497
|
* The platform identifier
|
|
3163
|
-
* @type {string}
|
|
3164
|
-
* @memberof DashboardApiSaveDashboard
|
|
3165
1498
|
*/
|
|
3166
1499
|
readonly platformId: string;
|
|
3167
1500
|
/**
|
|
3168
1501
|
* Save dashboard
|
|
3169
|
-
* @type {SaveDashboardRequest}
|
|
3170
|
-
* @memberof DashboardApiSaveDashboard
|
|
3171
1502
|
*/
|
|
3172
1503
|
readonly saveDashboardRequest: SaveDashboardRequest;
|
|
3173
1504
|
}
|
|
3174
1505
|
/**
|
|
3175
1506
|
* DashboardApi - object-oriented interface
|
|
3176
|
-
* @export
|
|
3177
|
-
* @class DashboardApi
|
|
3178
|
-
* @extends {BaseAPI}
|
|
3179
1507
|
*/
|
|
3180
1508
|
export declare class DashboardApi extends BaseAPI {
|
|
3181
1509
|
/**
|
|
@@ -3184,7 +1512,6 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
3184
1512
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
3185
1513
|
* @param {*} [options] Override http request option.
|
|
3186
1514
|
* @throws {RequiredError}
|
|
3187
|
-
* @memberof DashboardApi
|
|
3188
1515
|
*/
|
|
3189
1516
|
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
|
|
3190
1517
|
/**
|
|
@@ -3193,13 +1520,11 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
3193
1520
|
* @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
|
|
3194
1521
|
* @param {*} [options] Override http request option.
|
|
3195
1522
|
* @throws {RequiredError}
|
|
3196
|
-
* @memberof DashboardApi
|
|
3197
1523
|
*/
|
|
3198
1524
|
saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
|
|
3199
1525
|
}
|
|
3200
1526
|
/**
|
|
3201
1527
|
* EnquiriesApi - axios parameter creator
|
|
3202
|
-
* @export
|
|
3203
1528
|
*/
|
|
3204
1529
|
export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3205
1530
|
/**
|
|
@@ -3260,7 +1585,6 @@ export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3260
1585
|
};
|
|
3261
1586
|
/**
|
|
3262
1587
|
* EnquiriesApi - functional programming interface
|
|
3263
|
-
* @export
|
|
3264
1588
|
*/
|
|
3265
1589
|
export declare const EnquiriesApiFp: (configuration?: Configuration) => {
|
|
3266
1590
|
/**
|
|
@@ -3321,7 +1645,6 @@ export declare const EnquiriesApiFp: (configuration?: Configuration) => {
|
|
|
3321
1645
|
};
|
|
3322
1646
|
/**
|
|
3323
1647
|
* EnquiriesApi - factory interface
|
|
3324
|
-
* @export
|
|
3325
1648
|
*/
|
|
3326
1649
|
export declare const EnquiriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3327
1650
|
/**
|
|
@@ -3367,164 +1690,111 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
|
|
|
3367
1690
|
};
|
|
3368
1691
|
/**
|
|
3369
1692
|
* Request parameters for createChatChannel operation in EnquiriesApi.
|
|
3370
|
-
* @export
|
|
3371
|
-
* @interface EnquiriesApiCreateChatChannelRequest
|
|
3372
1693
|
*/
|
|
3373
1694
|
export interface EnquiriesApiCreateChatChannelRequest {
|
|
3374
1695
|
/**
|
|
3375
1696
|
* Project unique identifier
|
|
3376
|
-
* @type {string}
|
|
3377
|
-
* @memberof EnquiriesApiCreateChatChannel
|
|
3378
1697
|
*/
|
|
3379
1698
|
readonly project: string;
|
|
3380
1699
|
/**
|
|
3381
1700
|
* The platform identifier
|
|
3382
|
-
* @type {string}
|
|
3383
|
-
* @memberof EnquiriesApiCreateChatChannel
|
|
3384
1701
|
*/
|
|
3385
1702
|
readonly platformId: string;
|
|
3386
1703
|
/**
|
|
3387
1704
|
* The enquiry identifier
|
|
3388
|
-
* @type {string}
|
|
3389
|
-
* @memberof EnquiriesApiCreateChatChannel
|
|
3390
1705
|
*/
|
|
3391
1706
|
readonly enquiryId: string;
|
|
3392
1707
|
}
|
|
3393
1708
|
/**
|
|
3394
1709
|
* Request parameters for getCustomerEnquiry operation in EnquiriesApi.
|
|
3395
|
-
* @export
|
|
3396
|
-
* @interface EnquiriesApiGetCustomerEnquiryRequest
|
|
3397
1710
|
*/
|
|
3398
1711
|
export interface EnquiriesApiGetCustomerEnquiryRequest {
|
|
3399
1712
|
/**
|
|
3400
1713
|
* Project unique identifier
|
|
3401
|
-
* @type {string}
|
|
3402
|
-
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
3403
1714
|
*/
|
|
3404
1715
|
readonly project: string;
|
|
3405
1716
|
/**
|
|
3406
1717
|
* The platform identifier
|
|
3407
|
-
* @type {string}
|
|
3408
|
-
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
3409
1718
|
*/
|
|
3410
1719
|
readonly platformId: string;
|
|
3411
1720
|
/**
|
|
3412
1721
|
* The enquiry identifier
|
|
3413
|
-
* @type {string}
|
|
3414
|
-
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
3415
1722
|
*/
|
|
3416
1723
|
readonly enquiryId: string;
|
|
3417
1724
|
}
|
|
3418
1725
|
/**
|
|
3419
1726
|
* Request parameters for listCustomerEnquiries operation in EnquiriesApi.
|
|
3420
|
-
* @export
|
|
3421
|
-
* @interface EnquiriesApiListCustomerEnquiriesRequest
|
|
3422
1727
|
*/
|
|
3423
1728
|
export interface EnquiriesApiListCustomerEnquiriesRequest {
|
|
3424
1729
|
/**
|
|
3425
1730
|
* Project unique identifier
|
|
3426
|
-
* @type {string}
|
|
3427
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3428
1731
|
*/
|
|
3429
1732
|
readonly project: string;
|
|
3430
1733
|
/**
|
|
3431
1734
|
* The platform identifier
|
|
3432
|
-
* @type {string}
|
|
3433
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3434
1735
|
*/
|
|
3435
1736
|
readonly platformId: string;
|
|
3436
1737
|
/**
|
|
3437
1738
|
* Page reference token
|
|
3438
|
-
* @type {number}
|
|
3439
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3440
1739
|
*/
|
|
3441
1740
|
readonly pageToken?: number;
|
|
3442
1741
|
/**
|
|
3443
1742
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3444
|
-
* @type {number}
|
|
3445
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3446
1743
|
*/
|
|
3447
1744
|
readonly pageSize?: number;
|
|
3448
1745
|
/**
|
|
3449
1746
|
* Search term to filter based on enquiry title, content, customer name and customer email.
|
|
3450
|
-
* @type {string}
|
|
3451
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3452
1747
|
*/
|
|
3453
1748
|
readonly search?: string;
|
|
3454
1749
|
/**
|
|
3455
1750
|
* Start of date range to filter by
|
|
3456
|
-
* @type {string}
|
|
3457
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3458
1751
|
*/
|
|
3459
1752
|
readonly start?: string;
|
|
3460
1753
|
/**
|
|
3461
1754
|
* End of date range to filter by
|
|
3462
|
-
* @type {string}
|
|
3463
|
-
* @memberof EnquiriesApiListCustomerEnquiries
|
|
3464
1755
|
*/
|
|
3465
1756
|
readonly end?: string;
|
|
3466
1757
|
}
|
|
3467
1758
|
/**
|
|
3468
1759
|
* Request parameters for listCustomerEnquiryLogs operation in EnquiriesApi.
|
|
3469
|
-
* @export
|
|
3470
|
-
* @interface EnquiriesApiListCustomerEnquiryLogsRequest
|
|
3471
1760
|
*/
|
|
3472
1761
|
export interface EnquiriesApiListCustomerEnquiryLogsRequest {
|
|
3473
1762
|
/**
|
|
3474
1763
|
* Project unique identifier
|
|
3475
|
-
* @type {string}
|
|
3476
|
-
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
3477
1764
|
*/
|
|
3478
1765
|
readonly project: string;
|
|
3479
1766
|
/**
|
|
3480
1767
|
* The platform identifier
|
|
3481
|
-
* @type {string}
|
|
3482
|
-
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
3483
1768
|
*/
|
|
3484
1769
|
readonly platformId: string;
|
|
3485
1770
|
/**
|
|
3486
1771
|
* The enquiry identifier
|
|
3487
|
-
* @type {string}
|
|
3488
|
-
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
3489
1772
|
*/
|
|
3490
1773
|
readonly enquiryId: string;
|
|
3491
1774
|
}
|
|
3492
1775
|
/**
|
|
3493
1776
|
* Request parameters for updateCustomerEnquiry operation in EnquiriesApi.
|
|
3494
|
-
* @export
|
|
3495
|
-
* @interface EnquiriesApiUpdateCustomerEnquiryRequest
|
|
3496
1777
|
*/
|
|
3497
1778
|
export interface EnquiriesApiUpdateCustomerEnquiryRequest {
|
|
3498
1779
|
/**
|
|
3499
1780
|
* Project unique identifier
|
|
3500
|
-
* @type {string}
|
|
3501
|
-
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3502
1781
|
*/
|
|
3503
1782
|
readonly project: string;
|
|
3504
1783
|
/**
|
|
3505
1784
|
* The platform identifier
|
|
3506
|
-
* @type {string}
|
|
3507
|
-
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3508
1785
|
*/
|
|
3509
1786
|
readonly platformId: string;
|
|
3510
1787
|
/**
|
|
3511
1788
|
* The enquiry identifier
|
|
3512
|
-
* @type {string}
|
|
3513
|
-
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3514
1789
|
*/
|
|
3515
1790
|
readonly enquiryId: string;
|
|
3516
1791
|
/**
|
|
3517
1792
|
* Enquiry update
|
|
3518
|
-
* @type {UpdateCustomerEnquiryRequest}
|
|
3519
|
-
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3520
1793
|
*/
|
|
3521
1794
|
readonly updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest;
|
|
3522
1795
|
}
|
|
3523
1796
|
/**
|
|
3524
1797
|
* EnquiriesApi - object-oriented interface
|
|
3525
|
-
* @export
|
|
3526
|
-
* @class EnquiriesApi
|
|
3527
|
-
* @extends {BaseAPI}
|
|
3528
1798
|
*/
|
|
3529
1799
|
export declare class EnquiriesApi extends BaseAPI {
|
|
3530
1800
|
/**
|
|
@@ -3533,7 +1803,6 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3533
1803
|
* @param {EnquiriesApiCreateChatChannelRequest} requestParameters Request parameters.
|
|
3534
1804
|
* @param {*} [options] Override http request option.
|
|
3535
1805
|
* @throws {RequiredError}
|
|
3536
|
-
* @memberof EnquiriesApi
|
|
3537
1806
|
*/
|
|
3538
1807
|
createChatChannel(requestParameters: EnquiriesApiCreateChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateChatChannel200Response, any>>;
|
|
3539
1808
|
/**
|
|
@@ -3542,7 +1811,6 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3542
1811
|
* @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
|
|
3543
1812
|
* @param {*} [options] Override http request option.
|
|
3544
1813
|
* @throws {RequiredError}
|
|
3545
|
-
* @memberof EnquiriesApi
|
|
3546
1814
|
*/
|
|
3547
1815
|
getCustomerEnquiry(requestParameters: EnquiriesApiGetCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Enquiry, any>>;
|
|
3548
1816
|
/**
|
|
@@ -3551,7 +1819,6 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3551
1819
|
* @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
|
|
3552
1820
|
* @param {*} [options] Override http request option.
|
|
3553
1821
|
* @throws {RequiredError}
|
|
3554
|
-
* @memberof EnquiriesApi
|
|
3555
1822
|
*/
|
|
3556
1823
|
listCustomerEnquiries(requestParameters: EnquiriesApiListCustomerEnquiriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerEnquiries200Response, any>>;
|
|
3557
1824
|
/**
|
|
@@ -3560,7 +1827,6 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3560
1827
|
* @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
|
|
3561
1828
|
* @param {*} [options] Override http request option.
|
|
3562
1829
|
* @throws {RequiredError}
|
|
3563
|
-
* @memberof EnquiriesApi
|
|
3564
1830
|
*/
|
|
3565
1831
|
listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerEnquiryLogs200Response, any>>;
|
|
3566
1832
|
/**
|
|
@@ -3569,13 +1835,11 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
3569
1835
|
* @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
|
|
3570
1836
|
* @param {*} [options] Override http request option.
|
|
3571
1837
|
* @throws {RequiredError}
|
|
3572
|
-
* @memberof EnquiriesApi
|
|
3573
1838
|
*/
|
|
3574
1839
|
updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Enquiry, any>>;
|
|
3575
1840
|
}
|
|
3576
1841
|
/**
|
|
3577
1842
|
* OrdersApi - axios parameter creator
|
|
3578
|
-
* @export
|
|
3579
1843
|
*/
|
|
3580
1844
|
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3581
1845
|
/**
|
|
@@ -3724,7 +1988,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3724
1988
|
};
|
|
3725
1989
|
/**
|
|
3726
1990
|
* OrdersApi - functional programming interface
|
|
3727
|
-
* @export
|
|
3728
1991
|
*/
|
|
3729
1992
|
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
3730
1993
|
/**
|
|
@@ -3873,7 +2136,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
3873
2136
|
};
|
|
3874
2137
|
/**
|
|
3875
2138
|
* OrdersApi - factory interface
|
|
3876
|
-
* @export
|
|
3877
2139
|
*/
|
|
3878
2140
|
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3879
2141
|
/**
|
|
@@ -3983,412 +2245,276 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
3983
2245
|
};
|
|
3984
2246
|
/**
|
|
3985
2247
|
* Request parameters for amendOrder operation in OrdersApi.
|
|
3986
|
-
* @export
|
|
3987
|
-
* @interface OrdersApiAmendOrderRequest
|
|
3988
2248
|
*/
|
|
3989
2249
|
export interface OrdersApiAmendOrderRequest {
|
|
3990
2250
|
/**
|
|
3991
2251
|
* Project unique identifier
|
|
3992
|
-
* @type {string}
|
|
3993
|
-
* @memberof OrdersApiAmendOrder
|
|
3994
2252
|
*/
|
|
3995
2253
|
readonly project: string;
|
|
3996
2254
|
/**
|
|
3997
2255
|
* The platform identifier
|
|
3998
|
-
* @type {string}
|
|
3999
|
-
* @memberof OrdersApiAmendOrder
|
|
4000
2256
|
*/
|
|
4001
2257
|
readonly platformId: string;
|
|
4002
2258
|
/**
|
|
4003
2259
|
* The order identifier
|
|
4004
|
-
* @type {string}
|
|
4005
|
-
* @memberof OrdersApiAmendOrder
|
|
4006
2260
|
*/
|
|
4007
2261
|
readonly orderId: string;
|
|
4008
2262
|
/**
|
|
4009
2263
|
* AmendOrder schema
|
|
4010
|
-
* @type {AmendOrderRequest}
|
|
4011
|
-
* @memberof OrdersApiAmendOrder
|
|
4012
2264
|
*/
|
|
4013
2265
|
readonly amendOrderRequest: AmendOrderRequest;
|
|
4014
2266
|
}
|
|
4015
2267
|
/**
|
|
4016
2268
|
* Request parameters for confirmOrder operation in OrdersApi.
|
|
4017
|
-
* @export
|
|
4018
|
-
* @interface OrdersApiConfirmOrderRequest
|
|
4019
2269
|
*/
|
|
4020
2270
|
export interface OrdersApiConfirmOrderRequest {
|
|
4021
2271
|
/**
|
|
4022
2272
|
* Project unique identifier
|
|
4023
|
-
* @type {string}
|
|
4024
|
-
* @memberof OrdersApiConfirmOrder
|
|
4025
2273
|
*/
|
|
4026
2274
|
readonly project: string;
|
|
4027
2275
|
/**
|
|
4028
2276
|
* The platform identifier
|
|
4029
|
-
* @type {string}
|
|
4030
|
-
* @memberof OrdersApiConfirmOrder
|
|
4031
2277
|
*/
|
|
4032
2278
|
readonly platformId: string;
|
|
4033
2279
|
/**
|
|
4034
2280
|
* The order identifier
|
|
4035
|
-
* @type {string}
|
|
4036
|
-
* @memberof OrdersApiConfirmOrder
|
|
4037
2281
|
*/
|
|
4038
2282
|
readonly orderId: string;
|
|
4039
2283
|
/**
|
|
4040
2284
|
* ConfirmFulfillment schema
|
|
4041
|
-
* @type {ConfirmOrderRequest}
|
|
4042
|
-
* @memberof OrdersApiConfirmOrder
|
|
4043
2285
|
*/
|
|
4044
2286
|
readonly confirmOrderRequest: ConfirmOrderRequest;
|
|
4045
2287
|
}
|
|
4046
2288
|
/**
|
|
4047
2289
|
* Request parameters for createOrder operation in OrdersApi.
|
|
4048
|
-
* @export
|
|
4049
|
-
* @interface OrdersApiCreateOrderRequest
|
|
4050
2290
|
*/
|
|
4051
2291
|
export interface OrdersApiCreateOrderRequest {
|
|
4052
2292
|
/**
|
|
4053
2293
|
* Project unique identifier
|
|
4054
|
-
* @type {string}
|
|
4055
|
-
* @memberof OrdersApiCreateOrder
|
|
4056
2294
|
*/
|
|
4057
2295
|
readonly project: string;
|
|
4058
2296
|
/**
|
|
4059
2297
|
* The platform identifier
|
|
4060
|
-
* @type {string}
|
|
4061
|
-
* @memberof OrdersApiCreateOrder
|
|
4062
2298
|
*/
|
|
4063
2299
|
readonly platformId: string;
|
|
4064
2300
|
/**
|
|
4065
2301
|
* Create Order schema
|
|
4066
|
-
* @type {CreateOrder}
|
|
4067
|
-
* @memberof OrdersApiCreateOrder
|
|
4068
2302
|
*/
|
|
4069
2303
|
readonly createOrder: CreateOrder;
|
|
4070
2304
|
}
|
|
4071
2305
|
/**
|
|
4072
2306
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
4073
|
-
* @export
|
|
4074
|
-
* @interface OrdersApiExportOrdersRequest
|
|
4075
2307
|
*/
|
|
4076
2308
|
export interface OrdersApiExportOrdersRequest {
|
|
4077
2309
|
/**
|
|
4078
2310
|
* Project unique identifier
|
|
4079
|
-
* @type {string}
|
|
4080
|
-
* @memberof OrdersApiExportOrders
|
|
4081
2311
|
*/
|
|
4082
2312
|
readonly project: string;
|
|
4083
2313
|
/**
|
|
4084
2314
|
* The platform identifier
|
|
4085
|
-
* @type {string}
|
|
4086
|
-
* @memberof OrdersApiExportOrders
|
|
4087
2315
|
*/
|
|
4088
2316
|
readonly platformId: string;
|
|
4089
2317
|
/**
|
|
4090
2318
|
* Start of date range to filter by when orders were placed
|
|
4091
|
-
* @type {string}
|
|
4092
|
-
* @memberof OrdersApiExportOrders
|
|
4093
2319
|
*/
|
|
4094
2320
|
readonly start: string;
|
|
4095
2321
|
/**
|
|
4096
2322
|
* End of date range to filter when orders were placed
|
|
4097
|
-
* @type {string}
|
|
4098
|
-
* @memberof OrdersApiExportOrders
|
|
4099
2323
|
*/
|
|
4100
2324
|
readonly end?: string;
|
|
4101
2325
|
/**
|
|
4102
2326
|
* Search term to filter based on order reference, customer name and email
|
|
4103
|
-
* @type {string}
|
|
4104
|
-
* @memberof OrdersApiExportOrders
|
|
4105
2327
|
*/
|
|
4106
2328
|
readonly search?: string;
|
|
4107
2329
|
}
|
|
4108
2330
|
/**
|
|
4109
2331
|
* Request parameters for getFulfillment operation in OrdersApi.
|
|
4110
|
-
* @export
|
|
4111
|
-
* @interface OrdersApiGetFulfillmentRequest
|
|
4112
2332
|
*/
|
|
4113
2333
|
export interface OrdersApiGetFulfillmentRequest {
|
|
4114
2334
|
/**
|
|
4115
2335
|
* Project unique identifier
|
|
4116
|
-
* @type {string}
|
|
4117
|
-
* @memberof OrdersApiGetFulfillment
|
|
4118
2336
|
*/
|
|
4119
2337
|
readonly project: string;
|
|
4120
2338
|
/**
|
|
4121
2339
|
* The platform identifier
|
|
4122
|
-
* @type {string}
|
|
4123
|
-
* @memberof OrdersApiGetFulfillment
|
|
4124
2340
|
*/
|
|
4125
2341
|
readonly platformId: string;
|
|
4126
2342
|
/**
|
|
4127
2343
|
* The fulfillment identifier
|
|
4128
|
-
* @type {string}
|
|
4129
|
-
* @memberof OrdersApiGetFulfillment
|
|
4130
2344
|
*/
|
|
4131
2345
|
readonly fulfillmentId: string;
|
|
4132
2346
|
}
|
|
4133
2347
|
/**
|
|
4134
2348
|
* Request parameters for getOrder operation in OrdersApi.
|
|
4135
|
-
* @export
|
|
4136
|
-
* @interface OrdersApiGetOrderRequest
|
|
4137
2349
|
*/
|
|
4138
2350
|
export interface OrdersApiGetOrderRequest {
|
|
4139
2351
|
/**
|
|
4140
2352
|
* Project unique identifier
|
|
4141
|
-
* @type {string}
|
|
4142
|
-
* @memberof OrdersApiGetOrder
|
|
4143
2353
|
*/
|
|
4144
2354
|
readonly project: string;
|
|
4145
2355
|
/**
|
|
4146
2356
|
* The platform identifier
|
|
4147
|
-
* @type {string}
|
|
4148
|
-
* @memberof OrdersApiGetOrder
|
|
4149
2357
|
*/
|
|
4150
2358
|
readonly platformId: string;
|
|
4151
2359
|
/**
|
|
4152
2360
|
* The order identifier
|
|
4153
|
-
* @type {string}
|
|
4154
|
-
* @memberof OrdersApiGetOrder
|
|
4155
2361
|
*/
|
|
4156
2362
|
readonly orderId: string;
|
|
4157
2363
|
}
|
|
4158
2364
|
/**
|
|
4159
2365
|
* Request parameters for getOrderReceipt operation in OrdersApi.
|
|
4160
|
-
* @export
|
|
4161
|
-
* @interface OrdersApiGetOrderReceiptRequest
|
|
4162
2366
|
*/
|
|
4163
2367
|
export interface OrdersApiGetOrderReceiptRequest {
|
|
4164
2368
|
/**
|
|
4165
2369
|
* Project unique identifier
|
|
4166
|
-
* @type {string}
|
|
4167
|
-
* @memberof OrdersApiGetOrderReceipt
|
|
4168
2370
|
*/
|
|
4169
2371
|
readonly project: string;
|
|
4170
2372
|
/**
|
|
4171
2373
|
* The platform identifier
|
|
4172
|
-
* @type {string}
|
|
4173
|
-
* @memberof OrdersApiGetOrderReceipt
|
|
4174
2374
|
*/
|
|
4175
2375
|
readonly platformId: string;
|
|
4176
2376
|
/**
|
|
4177
2377
|
* The order identifier
|
|
4178
|
-
* @type {string}
|
|
4179
|
-
* @memberof OrdersApiGetOrderReceipt
|
|
4180
2378
|
*/
|
|
4181
2379
|
readonly orderId: string;
|
|
4182
2380
|
}
|
|
4183
2381
|
/**
|
|
4184
2382
|
* Request parameters for listAvailableFulfillers operation in OrdersApi.
|
|
4185
|
-
* @export
|
|
4186
|
-
* @interface OrdersApiListAvailableFulfillersRequest
|
|
4187
2383
|
*/
|
|
4188
2384
|
export interface OrdersApiListAvailableFulfillersRequest {
|
|
4189
2385
|
/**
|
|
4190
2386
|
* Project unique identifier
|
|
4191
|
-
* @type {string}
|
|
4192
|
-
* @memberof OrdersApiListAvailableFulfillers
|
|
4193
2387
|
*/
|
|
4194
2388
|
readonly project: string;
|
|
4195
2389
|
/**
|
|
4196
2390
|
* The platform identifier
|
|
4197
|
-
* @type {string}
|
|
4198
|
-
* @memberof OrdersApiListAvailableFulfillers
|
|
4199
2391
|
*/
|
|
4200
2392
|
readonly platformId: string;
|
|
4201
2393
|
/**
|
|
4202
2394
|
* The fulfillment identifier
|
|
4203
|
-
* @type {string}
|
|
4204
|
-
* @memberof OrdersApiListAvailableFulfillers
|
|
4205
2395
|
*/
|
|
4206
2396
|
readonly fulfillmentId: string;
|
|
4207
2397
|
}
|
|
4208
2398
|
/**
|
|
4209
2399
|
* Request parameters for listOrders operation in OrdersApi.
|
|
4210
|
-
* @export
|
|
4211
|
-
* @interface OrdersApiListOrdersRequest
|
|
4212
2400
|
*/
|
|
4213
2401
|
export interface OrdersApiListOrdersRequest {
|
|
4214
2402
|
/**
|
|
4215
2403
|
* Project unique identifier
|
|
4216
|
-
* @type {string}
|
|
4217
|
-
* @memberof OrdersApiListOrders
|
|
4218
2404
|
*/
|
|
4219
2405
|
readonly project: string;
|
|
4220
2406
|
/**
|
|
4221
2407
|
* The platform identifier
|
|
4222
|
-
* @type {string}
|
|
4223
|
-
* @memberof OrdersApiListOrders
|
|
4224
2408
|
*/
|
|
4225
2409
|
readonly platformId: string;
|
|
4226
2410
|
/**
|
|
4227
2411
|
* Page reference token
|
|
4228
|
-
* @type {number}
|
|
4229
|
-
* @memberof OrdersApiListOrders
|
|
4230
2412
|
*/
|
|
4231
2413
|
readonly pageToken?: number;
|
|
4232
2414
|
/**
|
|
4233
2415
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4234
|
-
* @type {number}
|
|
4235
|
-
* @memberof OrdersApiListOrders
|
|
4236
2416
|
*/
|
|
4237
2417
|
readonly pageSize?: number;
|
|
4238
2418
|
/**
|
|
4239
2419
|
* Search term to filter based on order reference, customer name and email
|
|
4240
|
-
* @type {string}
|
|
4241
|
-
* @memberof OrdersApiListOrders
|
|
4242
2420
|
*/
|
|
4243
2421
|
readonly search?: string;
|
|
4244
2422
|
/**
|
|
4245
2423
|
* Start of date range to filter when orders were placed
|
|
4246
|
-
* @type {string}
|
|
4247
|
-
* @memberof OrdersApiListOrders
|
|
4248
2424
|
*/
|
|
4249
2425
|
readonly start?: string;
|
|
4250
2426
|
/**
|
|
4251
2427
|
* End of date range to filter when orders were placed
|
|
4252
|
-
* @type {string}
|
|
4253
|
-
* @memberof OrdersApiListOrders
|
|
4254
2428
|
*/
|
|
4255
2429
|
readonly end?: string;
|
|
4256
2430
|
/**
|
|
4257
2431
|
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4258
|
-
* @type {'createdAt' | 'updatedAt' | 'statusChangedAt'}
|
|
4259
|
-
* @memberof OrdersApiListOrders
|
|
4260
2432
|
*/
|
|
4261
2433
|
readonly dateFilterType?: ListOrdersDateFilterTypeEnum;
|
|
4262
2434
|
/**
|
|
4263
2435
|
* The maximum value of the order
|
|
4264
|
-
* @type {number}
|
|
4265
|
-
* @memberof OrdersApiListOrders
|
|
4266
2436
|
*/
|
|
4267
2437
|
readonly maxOrderTotal?: number;
|
|
4268
2438
|
/**
|
|
4269
2439
|
* The minimum value of the order
|
|
4270
|
-
* @type {number}
|
|
4271
|
-
* @memberof OrdersApiListOrders
|
|
4272
2440
|
*/
|
|
4273
2441
|
readonly minOrderTotal?: number;
|
|
4274
2442
|
}
|
|
4275
2443
|
/**
|
|
4276
2444
|
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
4277
|
-
* @export
|
|
4278
|
-
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
4279
2445
|
*/
|
|
4280
2446
|
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
4281
2447
|
/**
|
|
4282
2448
|
* Project unique identifier
|
|
4283
|
-
* @type {string}
|
|
4284
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
4285
2449
|
*/
|
|
4286
2450
|
readonly project: string;
|
|
4287
2451
|
/**
|
|
4288
2452
|
* The platform identifier
|
|
4289
|
-
* @type {string}
|
|
4290
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
4291
2453
|
*/
|
|
4292
2454
|
readonly platformId: string;
|
|
4293
2455
|
/**
|
|
4294
2456
|
* The order identifier
|
|
4295
|
-
* @type {string}
|
|
4296
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
4297
2457
|
*/
|
|
4298
2458
|
readonly orderId: string;
|
|
4299
2459
|
}
|
|
4300
2460
|
/**
|
|
4301
2461
|
* Request parameters for returnOrder operation in OrdersApi.
|
|
4302
|
-
* @export
|
|
4303
|
-
* @interface OrdersApiReturnOrderRequest
|
|
4304
2462
|
*/
|
|
4305
2463
|
export interface OrdersApiReturnOrderRequest {
|
|
4306
2464
|
/**
|
|
4307
2465
|
* Project unique identifier
|
|
4308
|
-
* @type {string}
|
|
4309
|
-
* @memberof OrdersApiReturnOrder
|
|
4310
2466
|
*/
|
|
4311
2467
|
readonly project: string;
|
|
4312
2468
|
/**
|
|
4313
2469
|
* The platform identifier
|
|
4314
|
-
* @type {string}
|
|
4315
|
-
* @memberof OrdersApiReturnOrder
|
|
4316
2470
|
*/
|
|
4317
2471
|
readonly platformId: string;
|
|
4318
2472
|
/**
|
|
4319
2473
|
* The order identifier
|
|
4320
|
-
* @type {string}
|
|
4321
|
-
* @memberof OrdersApiReturnOrder
|
|
4322
2474
|
*/
|
|
4323
2475
|
readonly orderId: string;
|
|
4324
2476
|
/**
|
|
4325
2477
|
* ReturnOrder schema
|
|
4326
|
-
* @type {ReturnOrderRequest}
|
|
4327
|
-
* @memberof OrdersApiReturnOrder
|
|
4328
2478
|
*/
|
|
4329
2479
|
readonly returnOrderRequest: ReturnOrderRequest;
|
|
4330
2480
|
}
|
|
4331
2481
|
/**
|
|
4332
2482
|
* Request parameters for sendOrderReceipt operation in OrdersApi.
|
|
4333
|
-
* @export
|
|
4334
|
-
* @interface OrdersApiSendOrderReceiptRequest
|
|
4335
2483
|
*/
|
|
4336
2484
|
export interface OrdersApiSendOrderReceiptRequest {
|
|
4337
2485
|
/**
|
|
4338
2486
|
* Project unique identifier
|
|
4339
|
-
* @type {string}
|
|
4340
|
-
* @memberof OrdersApiSendOrderReceipt
|
|
4341
2487
|
*/
|
|
4342
2488
|
readonly project: string;
|
|
4343
2489
|
/**
|
|
4344
2490
|
* The platform identifier
|
|
4345
|
-
* @type {string}
|
|
4346
|
-
* @memberof OrdersApiSendOrderReceipt
|
|
4347
2491
|
*/
|
|
4348
2492
|
readonly platformId: string;
|
|
4349
2493
|
/**
|
|
4350
2494
|
* The order identifier
|
|
4351
|
-
* @type {string}
|
|
4352
|
-
* @memberof OrdersApiSendOrderReceipt
|
|
4353
2495
|
*/
|
|
4354
2496
|
readonly orderId: string;
|
|
4355
2497
|
}
|
|
4356
2498
|
/**
|
|
4357
2499
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
4358
|
-
* @export
|
|
4359
|
-
* @interface OrdersApiUpdateFulfillmentRequest
|
|
4360
2500
|
*/
|
|
4361
2501
|
export interface OrdersApiUpdateFulfillmentRequest {
|
|
4362
2502
|
/**
|
|
4363
2503
|
* Project unique identifier
|
|
4364
|
-
* @type {string}
|
|
4365
|
-
* @memberof OrdersApiUpdateFulfillment
|
|
4366
2504
|
*/
|
|
4367
2505
|
readonly project: string;
|
|
4368
2506
|
/**
|
|
4369
2507
|
* The platform identifier
|
|
4370
|
-
* @type {string}
|
|
4371
|
-
* @memberof OrdersApiUpdateFulfillment
|
|
4372
2508
|
*/
|
|
4373
2509
|
readonly platformId: string;
|
|
4374
2510
|
/**
|
|
4375
2511
|
* The fulfillment identifier
|
|
4376
|
-
* @type {string}
|
|
4377
|
-
* @memberof OrdersApiUpdateFulfillment
|
|
4378
2512
|
*/
|
|
4379
2513
|
readonly fulfillmentId: string;
|
|
4380
|
-
/**
|
|
4381
|
-
*
|
|
4382
|
-
* @type {UpdateFulfillmentRequest}
|
|
4383
|
-
* @memberof OrdersApiUpdateFulfillment
|
|
4384
|
-
*/
|
|
4385
2514
|
readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
|
|
4386
2515
|
}
|
|
4387
2516
|
/**
|
|
4388
2517
|
* OrdersApi - object-oriented interface
|
|
4389
|
-
* @export
|
|
4390
|
-
* @class OrdersApi
|
|
4391
|
-
* @extends {BaseAPI}
|
|
4392
2518
|
*/
|
|
4393
2519
|
export declare class OrdersApi extends BaseAPI {
|
|
4394
2520
|
/**
|
|
@@ -4397,7 +2523,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4397
2523
|
* @param {OrdersApiAmendOrderRequest} requestParameters Request parameters.
|
|
4398
2524
|
* @param {*} [options] Override http request option.
|
|
4399
2525
|
* @throws {RequiredError}
|
|
4400
|
-
* @memberof OrdersApi
|
|
4401
2526
|
*/
|
|
4402
2527
|
amendOrder(requestParameters: OrdersApiAmendOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4403
2528
|
/**
|
|
@@ -4406,7 +2531,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4406
2531
|
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
4407
2532
|
* @param {*} [options] Override http request option.
|
|
4408
2533
|
* @throws {RequiredError}
|
|
4409
|
-
* @memberof OrdersApi
|
|
4410
2534
|
*/
|
|
4411
2535
|
confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4412
2536
|
/**
|
|
@@ -4415,7 +2539,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4415
2539
|
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
4416
2540
|
* @param {*} [options] Override http request option.
|
|
4417
2541
|
* @throws {RequiredError}
|
|
4418
|
-
* @memberof OrdersApi
|
|
4419
2542
|
*/
|
|
4420
2543
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4421
2544
|
/**
|
|
@@ -4424,7 +2547,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4424
2547
|
* @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
|
|
4425
2548
|
* @param {*} [options] Override http request option.
|
|
4426
2549
|
* @throws {RequiredError}
|
|
4427
|
-
* @memberof OrdersApi
|
|
4428
2550
|
*/
|
|
4429
2551
|
exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
4430
2552
|
/**
|
|
@@ -4433,7 +2555,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4433
2555
|
* @param {OrdersApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
4434
2556
|
* @param {*} [options] Override http request option.
|
|
4435
2557
|
* @throws {RequiredError}
|
|
4436
|
-
* @memberof OrdersApi
|
|
4437
2558
|
*/
|
|
4438
2559
|
getFulfillment(requestParameters: OrdersApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
4439
2560
|
/**
|
|
@@ -4442,7 +2563,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4442
2563
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
4443
2564
|
* @param {*} [options] Override http request option.
|
|
4444
2565
|
* @throws {RequiredError}
|
|
4445
|
-
* @memberof OrdersApi
|
|
4446
2566
|
*/
|
|
4447
2567
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4448
2568
|
/**
|
|
@@ -4451,7 +2571,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4451
2571
|
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
4452
2572
|
* @param {*} [options] Override http request option.
|
|
4453
2573
|
* @throws {RequiredError}
|
|
4454
|
-
* @memberof OrdersApi
|
|
4455
2574
|
*/
|
|
4456
2575
|
getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
4457
2576
|
/**
|
|
@@ -4460,7 +2579,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4460
2579
|
* @param {OrdersApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
4461
2580
|
* @param {*} [options] Override http request option.
|
|
4462
2581
|
* @throws {RequiredError}
|
|
4463
|
-
* @memberof OrdersApi
|
|
4464
2582
|
*/
|
|
4465
2583
|
listAvailableFulfillers(requestParameters: OrdersApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
|
|
4466
2584
|
/**
|
|
@@ -4469,7 +2587,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4469
2587
|
* @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
|
|
4470
2588
|
* @param {*} [options] Override http request option.
|
|
4471
2589
|
* @throws {RequiredError}
|
|
4472
|
-
* @memberof OrdersApi
|
|
4473
2590
|
*/
|
|
4474
2591
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
4475
2592
|
/**
|
|
@@ -4478,7 +2595,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4478
2595
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
4479
2596
|
* @param {*} [options] Override http request option.
|
|
4480
2597
|
* @throws {RequiredError}
|
|
4481
|
-
* @memberof OrdersApi
|
|
4482
2598
|
*/
|
|
4483
2599
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4484
2600
|
/**
|
|
@@ -4487,7 +2603,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4487
2603
|
* @param {OrdersApiReturnOrderRequest} requestParameters Request parameters.
|
|
4488
2604
|
* @param {*} [options] Override http request option.
|
|
4489
2605
|
* @throws {RequiredError}
|
|
4490
|
-
* @memberof OrdersApi
|
|
4491
2606
|
*/
|
|
4492
2607
|
returnOrder(requestParameters: OrdersApiReturnOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
4493
2608
|
/**
|
|
@@ -4496,7 +2611,6 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4496
2611
|
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
4497
2612
|
* @param {*} [options] Override http request option.
|
|
4498
2613
|
* @throws {RequiredError}
|
|
4499
|
-
* @memberof OrdersApi
|
|
4500
2614
|
*/
|
|
4501
2615
|
sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4502
2616
|
/**
|
|
@@ -4505,13 +2619,9 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
4505
2619
|
* @param {OrdersApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
4506
2620
|
* @param {*} [options] Override http request option.
|
|
4507
2621
|
* @throws {RequiredError}
|
|
4508
|
-
* @memberof OrdersApi
|
|
4509
2622
|
*/
|
|
4510
2623
|
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
4511
2624
|
}
|
|
4512
|
-
/**
|
|
4513
|
-
* @export
|
|
4514
|
-
*/
|
|
4515
2625
|
export declare const ListOrdersDateFilterTypeEnum: {
|
|
4516
2626
|
readonly CreatedAt: "createdAt";
|
|
4517
2627
|
readonly UpdatedAt: "updatedAt";
|
|
@@ -4520,7 +2630,6 @@ export declare const ListOrdersDateFilterTypeEnum: {
|
|
|
4520
2630
|
export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
|
|
4521
2631
|
/**
|
|
4522
2632
|
* PaymentApi - axios parameter creator
|
|
4523
|
-
* @export
|
|
4524
2633
|
*/
|
|
4525
2634
|
export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4526
2635
|
/**
|
|
@@ -4550,7 +2659,6 @@ export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4550
2659
|
};
|
|
4551
2660
|
/**
|
|
4552
2661
|
* PaymentApi - functional programming interface
|
|
4553
|
-
* @export
|
|
4554
2662
|
*/
|
|
4555
2663
|
export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
4556
2664
|
/**
|
|
@@ -4560,7 +2668,7 @@ export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
|
4560
2668
|
* @param {*} [options] Override http request option.
|
|
4561
2669
|
* @throws {RequiredError}
|
|
4562
2670
|
*/
|
|
4563
|
-
authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2671
|
+
authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizeStripe200Response>>;
|
|
4564
2672
|
/**
|
|
4565
2673
|
* Deauthorize a Stripe payment account
|
|
4566
2674
|
* @summary Deauthorize Stripe
|
|
@@ -4580,7 +2688,6 @@ export declare const PaymentApiFp: (configuration?: Configuration) => {
|
|
|
4580
2688
|
};
|
|
4581
2689
|
/**
|
|
4582
2690
|
* PaymentApi - factory interface
|
|
4583
|
-
* @export
|
|
4584
2691
|
*/
|
|
4585
2692
|
export declare const PaymentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4586
2693
|
/**
|
|
@@ -4590,7 +2697,7 @@ export declare const PaymentApiFactory: (configuration?: Configuration, basePath
|
|
|
4590
2697
|
* @param {*} [options] Override http request option.
|
|
4591
2698
|
* @throws {RequiredError}
|
|
4592
2699
|
*/
|
|
4593
|
-
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2700
|
+
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizeStripe200Response>;
|
|
4594
2701
|
/**
|
|
4595
2702
|
* Deauthorize a Stripe payment account
|
|
4596
2703
|
* @summary Deauthorize Stripe
|
|
@@ -4610,48 +2717,33 @@ export declare const PaymentApiFactory: (configuration?: Configuration, basePath
|
|
|
4610
2717
|
};
|
|
4611
2718
|
/**
|
|
4612
2719
|
* Request parameters for authorizeStripe operation in PaymentApi.
|
|
4613
|
-
* @export
|
|
4614
|
-
* @interface PaymentApiAuthorizeStripeRequest
|
|
4615
2720
|
*/
|
|
4616
2721
|
export interface PaymentApiAuthorizeStripeRequest {
|
|
4617
2722
|
/**
|
|
4618
2723
|
* Project unique identifier
|
|
4619
|
-
* @type {string}
|
|
4620
|
-
* @memberof PaymentApiAuthorizeStripe
|
|
4621
2724
|
*/
|
|
4622
2725
|
readonly project: string;
|
|
4623
2726
|
}
|
|
4624
2727
|
/**
|
|
4625
2728
|
* Request parameters for deauthorizeStripe operation in PaymentApi.
|
|
4626
|
-
* @export
|
|
4627
|
-
* @interface PaymentApiDeauthorizeStripeRequest
|
|
4628
2729
|
*/
|
|
4629
2730
|
export interface PaymentApiDeauthorizeStripeRequest {
|
|
4630
2731
|
/**
|
|
4631
2732
|
* Project unique identifier
|
|
4632
|
-
* @type {string}
|
|
4633
|
-
* @memberof PaymentApiDeauthorizeStripe
|
|
4634
2733
|
*/
|
|
4635
2734
|
readonly project: string;
|
|
4636
2735
|
}
|
|
4637
2736
|
/**
|
|
4638
2737
|
* Request parameters for getStripePaymentAccount operation in PaymentApi.
|
|
4639
|
-
* @export
|
|
4640
|
-
* @interface PaymentApiGetStripePaymentAccountRequest
|
|
4641
2738
|
*/
|
|
4642
2739
|
export interface PaymentApiGetStripePaymentAccountRequest {
|
|
4643
2740
|
/**
|
|
4644
2741
|
* Project unique identifier
|
|
4645
|
-
* @type {string}
|
|
4646
|
-
* @memberof PaymentApiGetStripePaymentAccount
|
|
4647
2742
|
*/
|
|
4648
2743
|
readonly project: string;
|
|
4649
2744
|
}
|
|
4650
2745
|
/**
|
|
4651
2746
|
* PaymentApi - object-oriented interface
|
|
4652
|
-
* @export
|
|
4653
|
-
* @class PaymentApi
|
|
4654
|
-
* @extends {BaseAPI}
|
|
4655
2747
|
*/
|
|
4656
2748
|
export declare class PaymentApi extends BaseAPI {
|
|
4657
2749
|
/**
|
|
@@ -4660,16 +2752,14 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
4660
2752
|
* @param {PaymentApiAuthorizeStripeRequest} requestParameters Request parameters.
|
|
4661
2753
|
* @param {*} [options] Override http request option.
|
|
4662
2754
|
* @throws {RequiredError}
|
|
4663
|
-
* @memberof PaymentApi
|
|
4664
2755
|
*/
|
|
4665
|
-
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2756
|
+
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizeStripe200Response, any>>;
|
|
4666
2757
|
/**
|
|
4667
2758
|
* Deauthorize a Stripe payment account
|
|
4668
2759
|
* @summary Deauthorize Stripe
|
|
4669
2760
|
* @param {PaymentApiDeauthorizeStripeRequest} requestParameters Request parameters.
|
|
4670
2761
|
* @param {*} [options] Override http request option.
|
|
4671
2762
|
* @throws {RequiredError}
|
|
4672
|
-
* @memberof PaymentApi
|
|
4673
2763
|
*/
|
|
4674
2764
|
deauthorizeStripe(requestParameters: PaymentApiDeauthorizeStripeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4675
2765
|
/**
|
|
@@ -4678,13 +2768,11 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
4678
2768
|
* @param {PaymentApiGetStripePaymentAccountRequest} requestParameters Request parameters.
|
|
4679
2769
|
* @param {*} [options] Override http request option.
|
|
4680
2770
|
* @throws {RequiredError}
|
|
4681
|
-
* @memberof PaymentApi
|
|
4682
2771
|
*/
|
|
4683
2772
|
getStripePaymentAccount(requestParameters: PaymentApiGetStripePaymentAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentAccount, any>>;
|
|
4684
2773
|
}
|
|
4685
2774
|
/**
|
|
4686
2775
|
* PixelsApi - axios parameter creator
|
|
4687
|
-
* @export
|
|
4688
2776
|
*/
|
|
4689
2777
|
export declare const PixelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4690
2778
|
/**
|
|
@@ -4746,7 +2834,6 @@ export declare const PixelsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
4746
2834
|
};
|
|
4747
2835
|
/**
|
|
4748
2836
|
* PixelsApi - functional programming interface
|
|
4749
|
-
* @export
|
|
4750
2837
|
*/
|
|
4751
2838
|
export declare const PixelsApiFp: (configuration?: Configuration) => {
|
|
4752
2839
|
/**
|
|
@@ -4808,7 +2895,6 @@ export declare const PixelsApiFp: (configuration?: Configuration) => {
|
|
|
4808
2895
|
};
|
|
4809
2896
|
/**
|
|
4810
2897
|
* PixelsApi - factory interface
|
|
4811
|
-
* @export
|
|
4812
2898
|
*/
|
|
4813
2899
|
export declare const PixelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4814
2900
|
/**
|
|
@@ -4854,170 +2940,109 @@ export declare const PixelsApiFactory: (configuration?: Configuration, basePath?
|
|
|
4854
2940
|
};
|
|
4855
2941
|
/**
|
|
4856
2942
|
* Request parameters for createPixel operation in PixelsApi.
|
|
4857
|
-
* @export
|
|
4858
|
-
* @interface PixelsApiCreatePixelRequest
|
|
4859
2943
|
*/
|
|
4860
2944
|
export interface PixelsApiCreatePixelRequest {
|
|
4861
2945
|
/**
|
|
4862
2946
|
* Project unique identifier
|
|
4863
|
-
* @type {string}
|
|
4864
|
-
* @memberof PixelsApiCreatePixel
|
|
4865
2947
|
*/
|
|
4866
2948
|
readonly project: string;
|
|
4867
2949
|
/**
|
|
4868
2950
|
* The platform identifier
|
|
4869
|
-
* @type {string}
|
|
4870
|
-
* @memberof PixelsApiCreatePixel
|
|
4871
2951
|
*/
|
|
4872
2952
|
readonly platformId: string;
|
|
4873
2953
|
/**
|
|
4874
2954
|
* Page reference token
|
|
4875
|
-
* @type {number}
|
|
4876
|
-
* @memberof PixelsApiCreatePixel
|
|
4877
2955
|
*/
|
|
4878
2956
|
readonly pageToken?: number;
|
|
4879
2957
|
/**
|
|
4880
2958
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4881
|
-
* @type {number}
|
|
4882
|
-
* @memberof PixelsApiCreatePixel
|
|
4883
2959
|
*/
|
|
4884
2960
|
readonly pageSize?: number;
|
|
4885
2961
|
/**
|
|
4886
2962
|
* Search term to filter results
|
|
4887
|
-
* @type {string}
|
|
4888
|
-
* @memberof PixelsApiCreatePixel
|
|
4889
2963
|
*/
|
|
4890
2964
|
readonly search?: string;
|
|
4891
|
-
/**
|
|
4892
|
-
*
|
|
4893
|
-
* @type {CreatePixelRequest}
|
|
4894
|
-
* @memberof PixelsApiCreatePixel
|
|
4895
|
-
*/
|
|
4896
2965
|
readonly createPixelRequest?: CreatePixelRequest;
|
|
4897
2966
|
}
|
|
4898
2967
|
/**
|
|
4899
2968
|
* Request parameters for deletePixel operation in PixelsApi.
|
|
4900
|
-
* @export
|
|
4901
|
-
* @interface PixelsApiDeletePixelRequest
|
|
4902
2969
|
*/
|
|
4903
2970
|
export interface PixelsApiDeletePixelRequest {
|
|
4904
2971
|
/**
|
|
4905
2972
|
* Project unique identifier
|
|
4906
|
-
* @type {string}
|
|
4907
|
-
* @memberof PixelsApiDeletePixel
|
|
4908
2973
|
*/
|
|
4909
2974
|
readonly project: string;
|
|
4910
2975
|
/**
|
|
4911
2976
|
* The platform identifier
|
|
4912
|
-
* @type {string}
|
|
4913
|
-
* @memberof PixelsApiDeletePixel
|
|
4914
2977
|
*/
|
|
4915
2978
|
readonly platformId: string;
|
|
4916
2979
|
/**
|
|
4917
2980
|
* The pixel identifier
|
|
4918
|
-
* @type {string}
|
|
4919
|
-
* @memberof PixelsApiDeletePixel
|
|
4920
2981
|
*/
|
|
4921
2982
|
readonly pixelId: string;
|
|
4922
2983
|
}
|
|
4923
2984
|
/**
|
|
4924
2985
|
* Request parameters for getPixel operation in PixelsApi.
|
|
4925
|
-
* @export
|
|
4926
|
-
* @interface PixelsApiGetPixelRequest
|
|
4927
2986
|
*/
|
|
4928
2987
|
export interface PixelsApiGetPixelRequest {
|
|
4929
2988
|
/**
|
|
4930
2989
|
* Project unique identifier
|
|
4931
|
-
* @type {string}
|
|
4932
|
-
* @memberof PixelsApiGetPixel
|
|
4933
2990
|
*/
|
|
4934
2991
|
readonly project: string;
|
|
4935
2992
|
/**
|
|
4936
2993
|
* The platform identifier
|
|
4937
|
-
* @type {string}
|
|
4938
|
-
* @memberof PixelsApiGetPixel
|
|
4939
2994
|
*/
|
|
4940
2995
|
readonly platformId: string;
|
|
4941
2996
|
/**
|
|
4942
2997
|
* The pixel identifier
|
|
4943
|
-
* @type {string}
|
|
4944
|
-
* @memberof PixelsApiGetPixel
|
|
4945
2998
|
*/
|
|
4946
2999
|
readonly pixelId: string;
|
|
4947
3000
|
}
|
|
4948
3001
|
/**
|
|
4949
3002
|
* Request parameters for listPixels operation in PixelsApi.
|
|
4950
|
-
* @export
|
|
4951
|
-
* @interface PixelsApiListPixelsRequest
|
|
4952
3003
|
*/
|
|
4953
3004
|
export interface PixelsApiListPixelsRequest {
|
|
4954
3005
|
/**
|
|
4955
3006
|
* Project unique identifier
|
|
4956
|
-
* @type {string}
|
|
4957
|
-
* @memberof PixelsApiListPixels
|
|
4958
3007
|
*/
|
|
4959
3008
|
readonly project: string;
|
|
4960
3009
|
/**
|
|
4961
3010
|
* The platform identifier
|
|
4962
|
-
* @type {string}
|
|
4963
|
-
* @memberof PixelsApiListPixels
|
|
4964
3011
|
*/
|
|
4965
3012
|
readonly platformId: string;
|
|
4966
3013
|
/**
|
|
4967
3014
|
* Page reference token
|
|
4968
|
-
* @type {number}
|
|
4969
|
-
* @memberof PixelsApiListPixels
|
|
4970
3015
|
*/
|
|
4971
3016
|
readonly pageToken?: number;
|
|
4972
3017
|
/**
|
|
4973
3018
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4974
|
-
* @type {number}
|
|
4975
|
-
* @memberof PixelsApiListPixels
|
|
4976
3019
|
*/
|
|
4977
3020
|
readonly pageSize?: number;
|
|
4978
3021
|
/**
|
|
4979
3022
|
* Search term to filter results
|
|
4980
|
-
* @type {string}
|
|
4981
|
-
* @memberof PixelsApiListPixels
|
|
4982
3023
|
*/
|
|
4983
3024
|
readonly search?: string;
|
|
4984
3025
|
}
|
|
4985
3026
|
/**
|
|
4986
3027
|
* Request parameters for updatePixel operation in PixelsApi.
|
|
4987
|
-
* @export
|
|
4988
|
-
* @interface PixelsApiUpdatePixelRequest
|
|
4989
3028
|
*/
|
|
4990
3029
|
export interface PixelsApiUpdatePixelRequest {
|
|
4991
3030
|
/**
|
|
4992
3031
|
* Project unique identifier
|
|
4993
|
-
* @type {string}
|
|
4994
|
-
* @memberof PixelsApiUpdatePixel
|
|
4995
3032
|
*/
|
|
4996
3033
|
readonly project: string;
|
|
4997
3034
|
/**
|
|
4998
3035
|
* The platform identifier
|
|
4999
|
-
* @type {string}
|
|
5000
|
-
* @memberof PixelsApiUpdatePixel
|
|
5001
3036
|
*/
|
|
5002
3037
|
readonly platformId: string;
|
|
5003
3038
|
/**
|
|
5004
3039
|
* The pixel identifier
|
|
5005
|
-
* @type {string}
|
|
5006
|
-
* @memberof PixelsApiUpdatePixel
|
|
5007
3040
|
*/
|
|
5008
3041
|
readonly pixelId: string;
|
|
5009
|
-
/**
|
|
5010
|
-
*
|
|
5011
|
-
* @type {CreatePixelRequest}
|
|
5012
|
-
* @memberof PixelsApiUpdatePixel
|
|
5013
|
-
*/
|
|
5014
3042
|
readonly createPixelRequest?: CreatePixelRequest;
|
|
5015
3043
|
}
|
|
5016
3044
|
/**
|
|
5017
3045
|
* PixelsApi - object-oriented interface
|
|
5018
|
-
* @export
|
|
5019
|
-
* @class PixelsApi
|
|
5020
|
-
* @extends {BaseAPI}
|
|
5021
3046
|
*/
|
|
5022
3047
|
export declare class PixelsApi extends BaseAPI {
|
|
5023
3048
|
/**
|
|
@@ -5026,7 +3051,6 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
5026
3051
|
* @param {PixelsApiCreatePixelRequest} requestParameters Request parameters.
|
|
5027
3052
|
* @param {*} [options] Override http request option.
|
|
5028
3053
|
* @throws {RequiredError}
|
|
5029
|
-
* @memberof PixelsApi
|
|
5030
3054
|
*/
|
|
5031
3055
|
createPixel(requestParameters: PixelsApiCreatePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
5032
3056
|
/**
|
|
@@ -5035,7 +3059,6 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
5035
3059
|
* @param {PixelsApiDeletePixelRequest} requestParameters Request parameters.
|
|
5036
3060
|
* @param {*} [options] Override http request option.
|
|
5037
3061
|
* @throws {RequiredError}
|
|
5038
|
-
* @memberof PixelsApi
|
|
5039
3062
|
*/
|
|
5040
3063
|
deletePixel(requestParameters: PixelsApiDeletePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5041
3064
|
/**
|
|
@@ -5044,7 +3067,6 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
5044
3067
|
* @param {PixelsApiGetPixelRequest} requestParameters Request parameters.
|
|
5045
3068
|
* @param {*} [options] Override http request option.
|
|
5046
3069
|
* @throws {RequiredError}
|
|
5047
|
-
* @memberof PixelsApi
|
|
5048
3070
|
*/
|
|
5049
3071
|
getPixel(requestParameters: PixelsApiGetPixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
5050
3072
|
/**
|
|
@@ -5053,7 +3075,6 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
5053
3075
|
* @param {PixelsApiListPixelsRequest} requestParameters Request parameters.
|
|
5054
3076
|
* @param {*} [options] Override http request option.
|
|
5055
3077
|
* @throws {RequiredError}
|
|
5056
|
-
* @memberof PixelsApi
|
|
5057
3078
|
*/
|
|
5058
3079
|
listPixels(requestParameters: PixelsApiListPixelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PixelsResponse, any>>;
|
|
5059
3080
|
/**
|
|
@@ -5062,13 +3083,11 @@ export declare class PixelsApi extends BaseAPI {
|
|
|
5062
3083
|
* @param {PixelsApiUpdatePixelRequest} requestParameters Request parameters.
|
|
5063
3084
|
* @param {*} [options] Override http request option.
|
|
5064
3085
|
* @throws {RequiredError}
|
|
5065
|
-
* @memberof PixelsApi
|
|
5066
3086
|
*/
|
|
5067
3087
|
updatePixel(requestParameters: PixelsApiUpdatePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
5068
3088
|
}
|
|
5069
3089
|
/**
|
|
5070
3090
|
* PlatformApi - axios parameter creator
|
|
5071
|
-
* @export
|
|
5072
3091
|
*/
|
|
5073
3092
|
export declare const PlatformApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5074
3093
|
/**
|
|
@@ -5143,7 +3162,6 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5143
3162
|
};
|
|
5144
3163
|
/**
|
|
5145
3164
|
* PlatformApi - functional programming interface
|
|
5146
|
-
* @export
|
|
5147
3165
|
*/
|
|
5148
3166
|
export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
5149
3167
|
/**
|
|
@@ -5197,7 +3215,7 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
5197
3215
|
* @param {*} [options] Override http request option.
|
|
5198
3216
|
* @throws {RequiredError}
|
|
5199
3217
|
*/
|
|
5200
|
-
listClientDomains(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3218
|
+
listClientDomains(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDomains200Response>>;
|
|
5201
3219
|
/**
|
|
5202
3220
|
* List the domains attached to a platform
|
|
5203
3221
|
* @summary List platform domains
|
|
@@ -5205,7 +3223,7 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
5205
3223
|
* @param {*} [options] Override http request option.
|
|
5206
3224
|
* @throws {RequiredError}
|
|
5207
3225
|
*/
|
|
5208
|
-
listDomains(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3226
|
+
listDomains(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDomains200Response>>;
|
|
5209
3227
|
/**
|
|
5210
3228
|
*
|
|
5211
3229
|
* @summary Update platform
|
|
@@ -5218,7 +3236,6 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
5218
3236
|
};
|
|
5219
3237
|
/**
|
|
5220
3238
|
* PlatformApi - factory interface
|
|
5221
|
-
* @export
|
|
5222
3239
|
*/
|
|
5223
3240
|
export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5224
3241
|
/**
|
|
@@ -5268,7 +3285,7 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
5268
3285
|
* @param {*} [options] Override http request option.
|
|
5269
3286
|
* @throws {RequiredError}
|
|
5270
3287
|
*/
|
|
5271
|
-
listClientDomains(requestParameters: PlatformApiListClientDomainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3288
|
+
listClientDomains(requestParameters: PlatformApiListClientDomainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDomains200Response>;
|
|
5272
3289
|
/**
|
|
5273
3290
|
* List the domains attached to a platform
|
|
5274
3291
|
* @summary List platform domains
|
|
@@ -5276,7 +3293,7 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
5276
3293
|
* @param {*} [options] Override http request option.
|
|
5277
3294
|
* @throws {RequiredError}
|
|
5278
3295
|
*/
|
|
5279
|
-
listDomains(requestParameters: PlatformApiListDomainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3296
|
+
listDomains(requestParameters: PlatformApiListDomainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDomains200Response>;
|
|
5280
3297
|
/**
|
|
5281
3298
|
*
|
|
5282
3299
|
* @summary Update platform
|
|
@@ -5288,143 +3305,89 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
5288
3305
|
};
|
|
5289
3306
|
/**
|
|
5290
3307
|
* Request parameters for createClientDomain operation in PlatformApi.
|
|
5291
|
-
* @export
|
|
5292
|
-
* @interface PlatformApiCreateClientDomainRequest
|
|
5293
3308
|
*/
|
|
5294
3309
|
export interface PlatformApiCreateClientDomainRequest {
|
|
5295
3310
|
/**
|
|
5296
3311
|
* Project unique identifier
|
|
5297
|
-
* @type {string}
|
|
5298
|
-
* @memberof PlatformApiCreateClientDomain
|
|
5299
3312
|
*/
|
|
5300
3313
|
readonly project: string;
|
|
5301
|
-
/**
|
|
5302
|
-
*
|
|
5303
|
-
* @type {CreateDomainRequest}
|
|
5304
|
-
* @memberof PlatformApiCreateClientDomain
|
|
5305
|
-
*/
|
|
5306
3314
|
readonly createDomainRequest?: CreateDomainRequest;
|
|
5307
3315
|
}
|
|
5308
3316
|
/**
|
|
5309
3317
|
* Request parameters for createDomain operation in PlatformApi.
|
|
5310
|
-
* @export
|
|
5311
|
-
* @interface PlatformApiCreateDomainRequest
|
|
5312
3318
|
*/
|
|
5313
3319
|
export interface PlatformApiCreateDomainRequest {
|
|
5314
3320
|
/**
|
|
5315
3321
|
* Project unique identifier
|
|
5316
|
-
* @type {string}
|
|
5317
|
-
* @memberof PlatformApiCreateDomain
|
|
5318
3322
|
*/
|
|
5319
3323
|
readonly project: string;
|
|
5320
|
-
/**
|
|
5321
|
-
*
|
|
5322
|
-
* @type {CreateDomainRequest}
|
|
5323
|
-
* @memberof PlatformApiCreateDomain
|
|
5324
|
-
*/
|
|
5325
3324
|
readonly createDomainRequest?: CreateDomainRequest;
|
|
5326
3325
|
}
|
|
5327
3326
|
/**
|
|
5328
3327
|
* Request parameters for deleteClientDomain operation in PlatformApi.
|
|
5329
|
-
* @export
|
|
5330
|
-
* @interface PlatformApiDeleteClientDomainRequest
|
|
5331
3328
|
*/
|
|
5332
3329
|
export interface PlatformApiDeleteClientDomainRequest {
|
|
5333
3330
|
/**
|
|
5334
3331
|
* Project unique identifier
|
|
5335
|
-
* @type {string}
|
|
5336
|
-
* @memberof PlatformApiDeleteClientDomain
|
|
5337
3332
|
*/
|
|
5338
3333
|
readonly project: string;
|
|
5339
3334
|
/**
|
|
5340
3335
|
* The domain identifier
|
|
5341
|
-
* @type {string}
|
|
5342
|
-
* @memberof PlatformApiDeleteClientDomain
|
|
5343
3336
|
*/
|
|
5344
3337
|
readonly domain: string;
|
|
5345
3338
|
}
|
|
5346
3339
|
/**
|
|
5347
3340
|
* Request parameters for deleteDomain operation in PlatformApi.
|
|
5348
|
-
* @export
|
|
5349
|
-
* @interface PlatformApiDeleteDomainRequest
|
|
5350
3341
|
*/
|
|
5351
3342
|
export interface PlatformApiDeleteDomainRequest {
|
|
5352
3343
|
/**
|
|
5353
3344
|
* Project unique identifier
|
|
5354
|
-
* @type {string}
|
|
5355
|
-
* @memberof PlatformApiDeleteDomain
|
|
5356
3345
|
*/
|
|
5357
3346
|
readonly project: string;
|
|
5358
3347
|
/**
|
|
5359
3348
|
* The domain identifier
|
|
5360
|
-
* @type {string}
|
|
5361
|
-
* @memberof PlatformApiDeleteDomain
|
|
5362
3349
|
*/
|
|
5363
3350
|
readonly domain: string;
|
|
5364
3351
|
}
|
|
5365
3352
|
/**
|
|
5366
3353
|
* Request parameters for getPlatform operation in PlatformApi.
|
|
5367
|
-
* @export
|
|
5368
|
-
* @interface PlatformApiGetPlatformRequest
|
|
5369
3354
|
*/
|
|
5370
3355
|
export interface PlatformApiGetPlatformRequest {
|
|
5371
3356
|
/**
|
|
5372
3357
|
* Project unique identifier
|
|
5373
|
-
* @type {string}
|
|
5374
|
-
* @memberof PlatformApiGetPlatform
|
|
5375
3358
|
*/
|
|
5376
3359
|
readonly project: string;
|
|
5377
3360
|
}
|
|
5378
3361
|
/**
|
|
5379
3362
|
* Request parameters for listClientDomains operation in PlatformApi.
|
|
5380
|
-
* @export
|
|
5381
|
-
* @interface PlatformApiListClientDomainsRequest
|
|
5382
3363
|
*/
|
|
5383
3364
|
export interface PlatformApiListClientDomainsRequest {
|
|
5384
3365
|
/**
|
|
5385
3366
|
* Project unique identifier
|
|
5386
|
-
* @type {string}
|
|
5387
|
-
* @memberof PlatformApiListClientDomains
|
|
5388
3367
|
*/
|
|
5389
3368
|
readonly project: string;
|
|
5390
3369
|
}
|
|
5391
3370
|
/**
|
|
5392
3371
|
* Request parameters for listDomains operation in PlatformApi.
|
|
5393
|
-
* @export
|
|
5394
|
-
* @interface PlatformApiListDomainsRequest
|
|
5395
3372
|
*/
|
|
5396
3373
|
export interface PlatformApiListDomainsRequest {
|
|
5397
3374
|
/**
|
|
5398
3375
|
* Project unique identifier
|
|
5399
|
-
* @type {string}
|
|
5400
|
-
* @memberof PlatformApiListDomains
|
|
5401
3376
|
*/
|
|
5402
3377
|
readonly project: string;
|
|
5403
3378
|
}
|
|
5404
3379
|
/**
|
|
5405
3380
|
* Request parameters for updatePlatform operation in PlatformApi.
|
|
5406
|
-
* @export
|
|
5407
|
-
* @interface PlatformApiUpdatePlatformRequest
|
|
5408
3381
|
*/
|
|
5409
3382
|
export interface PlatformApiUpdatePlatformRequest {
|
|
5410
3383
|
/**
|
|
5411
3384
|
* Project unique identifier
|
|
5412
|
-
* @type {string}
|
|
5413
|
-
* @memberof PlatformApiUpdatePlatform
|
|
5414
3385
|
*/
|
|
5415
3386
|
readonly project: string;
|
|
5416
|
-
/**
|
|
5417
|
-
*
|
|
5418
|
-
* @type {UpdatePlatformRequest}
|
|
5419
|
-
* @memberof PlatformApiUpdatePlatform
|
|
5420
|
-
*/
|
|
5421
3387
|
readonly updatePlatformRequest: UpdatePlatformRequest;
|
|
5422
3388
|
}
|
|
5423
3389
|
/**
|
|
5424
3390
|
* PlatformApi - object-oriented interface
|
|
5425
|
-
* @export
|
|
5426
|
-
* @class PlatformApi
|
|
5427
|
-
* @extends {BaseAPI}
|
|
5428
3391
|
*/
|
|
5429
3392
|
export declare class PlatformApi extends BaseAPI {
|
|
5430
3393
|
/**
|
|
@@ -5433,7 +3396,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5433
3396
|
* @param {PlatformApiCreateClientDomainRequest} requestParameters Request parameters.
|
|
5434
3397
|
* @param {*} [options] Override http request option.
|
|
5435
3398
|
* @throws {RequiredError}
|
|
5436
|
-
* @memberof PlatformApi
|
|
5437
3399
|
*/
|
|
5438
3400
|
createClientDomain(requestParameters: PlatformApiCreateClientDomainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Domain, any>>;
|
|
5439
3401
|
/**
|
|
@@ -5442,7 +3404,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5442
3404
|
* @param {PlatformApiCreateDomainRequest} requestParameters Request parameters.
|
|
5443
3405
|
* @param {*} [options] Override http request option.
|
|
5444
3406
|
* @throws {RequiredError}
|
|
5445
|
-
* @memberof PlatformApi
|
|
5446
3407
|
*/
|
|
5447
3408
|
createDomain(requestParameters: PlatformApiCreateDomainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Domain, any>>;
|
|
5448
3409
|
/**
|
|
@@ -5451,7 +3412,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5451
3412
|
* @param {PlatformApiDeleteClientDomainRequest} requestParameters Request parameters.
|
|
5452
3413
|
* @param {*} [options] Override http request option.
|
|
5453
3414
|
* @throws {RequiredError}
|
|
5454
|
-
* @memberof PlatformApi
|
|
5455
3415
|
*/
|
|
5456
3416
|
deleteClientDomain(requestParameters: PlatformApiDeleteClientDomainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5457
3417
|
/**
|
|
@@ -5460,7 +3420,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5460
3420
|
* @param {PlatformApiDeleteDomainRequest} requestParameters Request parameters.
|
|
5461
3421
|
* @param {*} [options] Override http request option.
|
|
5462
3422
|
* @throws {RequiredError}
|
|
5463
|
-
* @memberof PlatformApi
|
|
5464
3423
|
*/
|
|
5465
3424
|
deleteDomain(requestParameters: PlatformApiDeleteDomainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5466
3425
|
/**
|
|
@@ -5469,7 +3428,6 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5469
3428
|
* @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
|
|
5470
3429
|
* @param {*} [options] Override http request option.
|
|
5471
3430
|
* @throws {RequiredError}
|
|
5472
|
-
* @memberof PlatformApi
|
|
5473
3431
|
*/
|
|
5474
3432
|
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
5475
3433
|
/**
|
|
@@ -5478,31 +3436,27 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
5478
3436
|
* @param {PlatformApiListClientDomainsRequest} requestParameters Request parameters.
|
|
5479
3437
|
* @param {*} [options] Override http request option.
|
|
5480
3438
|
* @throws {RequiredError}
|
|
5481
|
-
* @memberof PlatformApi
|
|
5482
3439
|
*/
|
|
5483
|
-
listClientDomains(requestParameters: PlatformApiListClientDomainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
3440
|
+
listClientDomains(requestParameters: PlatformApiListClientDomainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDomains200Response, any>>;
|
|
5484
3441
|
/**
|
|
5485
3442
|
* List the domains attached to a platform
|
|
5486
3443
|
* @summary List platform domains
|
|
5487
3444
|
* @param {PlatformApiListDomainsRequest} requestParameters Request parameters.
|
|
5488
3445
|
* @param {*} [options] Override http request option.
|
|
5489
3446
|
* @throws {RequiredError}
|
|
5490
|
-
* @memberof PlatformApi
|
|
5491
3447
|
*/
|
|
5492
|
-
listDomains(requestParameters: PlatformApiListDomainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
3448
|
+
listDomains(requestParameters: PlatformApiListDomainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDomains200Response, any>>;
|
|
5493
3449
|
/**
|
|
5494
3450
|
*
|
|
5495
3451
|
* @summary Update platform
|
|
5496
3452
|
* @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
|
|
5497
3453
|
* @param {*} [options] Override http request option.
|
|
5498
3454
|
* @throws {RequiredError}
|
|
5499
|
-
* @memberof PlatformApi
|
|
5500
3455
|
*/
|
|
5501
3456
|
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
5502
3457
|
}
|
|
5503
3458
|
/**
|
|
5504
3459
|
* ReviewsApi - axios parameter creator
|
|
5505
|
-
* @export
|
|
5506
3460
|
*/
|
|
5507
3461
|
export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5508
3462
|
/**
|
|
@@ -5571,7 +3525,6 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5571
3525
|
};
|
|
5572
3526
|
/**
|
|
5573
3527
|
* ReviewsApi - functional programming interface
|
|
5574
|
-
* @export
|
|
5575
3528
|
*/
|
|
5576
3529
|
export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
5577
3530
|
/**
|
|
@@ -5640,7 +3593,6 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
|
|
|
5640
3593
|
};
|
|
5641
3594
|
/**
|
|
5642
3595
|
* ReviewsApi - factory interface
|
|
5643
|
-
* @export
|
|
5644
3596
|
*/
|
|
5645
3597
|
export declare const ReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5646
3598
|
/**
|
|
@@ -5686,212 +3638,137 @@ export declare const ReviewsApiFactory: (configuration?: Configuration, basePath
|
|
|
5686
3638
|
};
|
|
5687
3639
|
/**
|
|
5688
3640
|
* Request parameters for createReview operation in ReviewsApi.
|
|
5689
|
-
* @export
|
|
5690
|
-
* @interface ReviewsApiCreateReviewRequest
|
|
5691
3641
|
*/
|
|
5692
3642
|
export interface ReviewsApiCreateReviewRequest {
|
|
5693
3643
|
/**
|
|
5694
3644
|
* Project unique identifier
|
|
5695
|
-
* @type {string}
|
|
5696
|
-
* @memberof ReviewsApiCreateReview
|
|
5697
3645
|
*/
|
|
5698
3646
|
readonly project: string;
|
|
5699
3647
|
/**
|
|
5700
3648
|
* The platform identifier
|
|
5701
|
-
* @type {string}
|
|
5702
|
-
* @memberof ReviewsApiCreateReview
|
|
5703
3649
|
*/
|
|
5704
3650
|
readonly platformId: string;
|
|
5705
|
-
/**
|
|
5706
|
-
*
|
|
5707
|
-
* @type {CreateReviewRequest}
|
|
5708
|
-
* @memberof ReviewsApiCreateReview
|
|
5709
|
-
*/
|
|
5710
3651
|
readonly createReviewRequest: CreateReviewRequest;
|
|
5711
3652
|
/**
|
|
5712
3653
|
* Page reference token
|
|
5713
|
-
* @type {number}
|
|
5714
|
-
* @memberof ReviewsApiCreateReview
|
|
5715
3654
|
*/
|
|
5716
3655
|
readonly pageToken?: number;
|
|
5717
3656
|
/**
|
|
5718
3657
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
5719
|
-
* @type {number}
|
|
5720
|
-
* @memberof ReviewsApiCreateReview
|
|
5721
3658
|
*/
|
|
5722
3659
|
readonly pageSize?: number;
|
|
5723
3660
|
/**
|
|
5724
3661
|
* Search term to filter results
|
|
5725
|
-
* @type {string}
|
|
5726
|
-
* @memberof ReviewsApiCreateReview
|
|
5727
3662
|
*/
|
|
5728
3663
|
readonly search?: string;
|
|
5729
3664
|
/**
|
|
5730
3665
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
5731
|
-
* @type {Array<string>}
|
|
5732
|
-
* @memberof ReviewsApiCreateReview
|
|
5733
3666
|
*/
|
|
5734
3667
|
readonly sortBy?: Array<string>;
|
|
5735
3668
|
/**
|
|
5736
3669
|
* Start of date range to filter by
|
|
5737
|
-
* @type {string}
|
|
5738
|
-
* @memberof ReviewsApiCreateReview
|
|
5739
3670
|
*/
|
|
5740
3671
|
readonly start?: string;
|
|
5741
3672
|
/**
|
|
5742
3673
|
* End of date range to filter by
|
|
5743
|
-
* @type {string}
|
|
5744
|
-
* @memberof ReviewsApiCreateReview
|
|
5745
3674
|
*/
|
|
5746
3675
|
readonly end?: string;
|
|
5747
3676
|
}
|
|
5748
3677
|
/**
|
|
5749
3678
|
* Request parameters for exportReviews operation in ReviewsApi.
|
|
5750
|
-
* @export
|
|
5751
|
-
* @interface ReviewsApiExportReviewsRequest
|
|
5752
3679
|
*/
|
|
5753
3680
|
export interface ReviewsApiExportReviewsRequest {
|
|
5754
3681
|
/**
|
|
5755
3682
|
* Project unique identifier
|
|
5756
|
-
* @type {string}
|
|
5757
|
-
* @memberof ReviewsApiExportReviews
|
|
5758
3683
|
*/
|
|
5759
3684
|
readonly project: string;
|
|
5760
3685
|
/**
|
|
5761
3686
|
* The platform identifier
|
|
5762
|
-
* @type {string}
|
|
5763
|
-
* @memberof ReviewsApiExportReviews
|
|
5764
3687
|
*/
|
|
5765
3688
|
readonly platformId: string;
|
|
5766
3689
|
/**
|
|
5767
3690
|
* Start of date range to filter by
|
|
5768
|
-
* @type {string}
|
|
5769
|
-
* @memberof ReviewsApiExportReviews
|
|
5770
3691
|
*/
|
|
5771
3692
|
readonly start: string;
|
|
5772
3693
|
/**
|
|
5773
3694
|
* End of date range to filter by
|
|
5774
|
-
* @type {string}
|
|
5775
|
-
* @memberof ReviewsApiExportReviews
|
|
5776
3695
|
*/
|
|
5777
3696
|
readonly end?: string;
|
|
5778
3697
|
}
|
|
5779
3698
|
/**
|
|
5780
3699
|
* Request parameters for getReview operation in ReviewsApi.
|
|
5781
|
-
* @export
|
|
5782
|
-
* @interface ReviewsApiGetReviewRequest
|
|
5783
3700
|
*/
|
|
5784
3701
|
export interface ReviewsApiGetReviewRequest {
|
|
5785
3702
|
/**
|
|
5786
3703
|
* Project unique identifier
|
|
5787
|
-
* @type {string}
|
|
5788
|
-
* @memberof ReviewsApiGetReview
|
|
5789
3704
|
*/
|
|
5790
3705
|
readonly project: string;
|
|
5791
3706
|
/**
|
|
5792
3707
|
* The platform identifier
|
|
5793
|
-
* @type {string}
|
|
5794
|
-
* @memberof ReviewsApiGetReview
|
|
5795
3708
|
*/
|
|
5796
3709
|
readonly platformId: string;
|
|
5797
3710
|
/**
|
|
5798
3711
|
* The review identifier
|
|
5799
|
-
* @type {string}
|
|
5800
|
-
* @memberof ReviewsApiGetReview
|
|
5801
3712
|
*/
|
|
5802
3713
|
readonly reviewId: string;
|
|
5803
3714
|
}
|
|
5804
3715
|
/**
|
|
5805
3716
|
* Request parameters for listReviews operation in ReviewsApi.
|
|
5806
|
-
* @export
|
|
5807
|
-
* @interface ReviewsApiListReviewsRequest
|
|
5808
3717
|
*/
|
|
5809
3718
|
export interface ReviewsApiListReviewsRequest {
|
|
5810
3719
|
/**
|
|
5811
3720
|
* Project unique identifier
|
|
5812
|
-
* @type {string}
|
|
5813
|
-
* @memberof ReviewsApiListReviews
|
|
5814
3721
|
*/
|
|
5815
3722
|
readonly project: string;
|
|
5816
3723
|
/**
|
|
5817
3724
|
* The platform identifier
|
|
5818
|
-
* @type {string}
|
|
5819
|
-
* @memberof ReviewsApiListReviews
|
|
5820
3725
|
*/
|
|
5821
3726
|
readonly platformId: string;
|
|
5822
3727
|
/**
|
|
5823
3728
|
* Page reference token
|
|
5824
|
-
* @type {number}
|
|
5825
|
-
* @memberof ReviewsApiListReviews
|
|
5826
3729
|
*/
|
|
5827
3730
|
readonly pageToken?: number;
|
|
5828
3731
|
/**
|
|
5829
3732
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
5830
|
-
* @type {number}
|
|
5831
|
-
* @memberof ReviewsApiListReviews
|
|
5832
3733
|
*/
|
|
5833
3734
|
readonly pageSize?: number;
|
|
5834
3735
|
/**
|
|
5835
3736
|
* Search term to filter results
|
|
5836
|
-
* @type {string}
|
|
5837
|
-
* @memberof ReviewsApiListReviews
|
|
5838
3737
|
*/
|
|
5839
3738
|
readonly search?: string;
|
|
5840
3739
|
/**
|
|
5841
3740
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
5842
|
-
* @type {Array<string>}
|
|
5843
|
-
* @memberof ReviewsApiListReviews
|
|
5844
3741
|
*/
|
|
5845
3742
|
readonly sortBy?: Array<string>;
|
|
5846
3743
|
/**
|
|
5847
3744
|
* Start of date range to filter by
|
|
5848
|
-
* @type {string}
|
|
5849
|
-
* @memberof ReviewsApiListReviews
|
|
5850
3745
|
*/
|
|
5851
3746
|
readonly start?: string;
|
|
5852
3747
|
/**
|
|
5853
3748
|
* End of date range to filter by
|
|
5854
|
-
* @type {string}
|
|
5855
|
-
* @memberof ReviewsApiListReviews
|
|
5856
3749
|
*/
|
|
5857
3750
|
readonly end?: string;
|
|
5858
3751
|
}
|
|
5859
3752
|
/**
|
|
5860
3753
|
* Request parameters for moderateReview operation in ReviewsApi.
|
|
5861
|
-
* @export
|
|
5862
|
-
* @interface ReviewsApiModerateReviewRequest
|
|
5863
3754
|
*/
|
|
5864
3755
|
export interface ReviewsApiModerateReviewRequest {
|
|
5865
3756
|
/**
|
|
5866
3757
|
* Project unique identifier
|
|
5867
|
-
* @type {string}
|
|
5868
|
-
* @memberof ReviewsApiModerateReview
|
|
5869
3758
|
*/
|
|
5870
3759
|
readonly project: string;
|
|
5871
3760
|
/**
|
|
5872
3761
|
* The platform identifier
|
|
5873
|
-
* @type {string}
|
|
5874
|
-
* @memberof ReviewsApiModerateReview
|
|
5875
3762
|
*/
|
|
5876
3763
|
readonly platformId: string;
|
|
5877
3764
|
/**
|
|
5878
3765
|
* The review identifier
|
|
5879
|
-
* @type {string}
|
|
5880
|
-
* @memberof ReviewsApiModerateReview
|
|
5881
3766
|
*/
|
|
5882
3767
|
readonly reviewId: string;
|
|
5883
|
-
/**
|
|
5884
|
-
*
|
|
5885
|
-
* @type {ModerateReviewRequest}
|
|
5886
|
-
* @memberof ReviewsApiModerateReview
|
|
5887
|
-
*/
|
|
5888
3768
|
readonly moderateReviewRequest?: ModerateReviewRequest;
|
|
5889
3769
|
}
|
|
5890
3770
|
/**
|
|
5891
3771
|
* ReviewsApi - object-oriented interface
|
|
5892
|
-
* @export
|
|
5893
|
-
* @class ReviewsApi
|
|
5894
|
-
* @extends {BaseAPI}
|
|
5895
3772
|
*/
|
|
5896
3773
|
export declare class ReviewsApi extends BaseAPI {
|
|
5897
3774
|
/**
|
|
@@ -5900,7 +3777,6 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5900
3777
|
* @param {ReviewsApiCreateReviewRequest} requestParameters Request parameters.
|
|
5901
3778
|
* @param {*} [options] Override http request option.
|
|
5902
3779
|
* @throws {RequiredError}
|
|
5903
|
-
* @memberof ReviewsApi
|
|
5904
3780
|
*/
|
|
5905
3781
|
createReview(requestParameters: ReviewsApiCreateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReview201Response, any>>;
|
|
5906
3782
|
/**
|
|
@@ -5909,7 +3785,6 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5909
3785
|
* @param {ReviewsApiExportReviewsRequest} requestParameters Request parameters.
|
|
5910
3786
|
* @param {*} [options] Override http request option.
|
|
5911
3787
|
* @throws {RequiredError}
|
|
5912
|
-
* @memberof ReviewsApi
|
|
5913
3788
|
*/
|
|
5914
3789
|
exportReviews(requestParameters: ReviewsApiExportReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
5915
3790
|
/**
|
|
@@ -5918,7 +3793,6 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5918
3793
|
* @param {ReviewsApiGetReviewRequest} requestParameters Request parameters.
|
|
5919
3794
|
* @param {*} [options] Override http request option.
|
|
5920
3795
|
* @throws {RequiredError}
|
|
5921
|
-
* @memberof ReviewsApi
|
|
5922
3796
|
*/
|
|
5923
3797
|
getReview(requestParameters: ReviewsApiGetReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
|
|
5924
3798
|
/**
|
|
@@ -5927,7 +3801,6 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5927
3801
|
* @param {ReviewsApiListReviewsRequest} requestParameters Request parameters.
|
|
5928
3802
|
* @param {*} [options] Override http request option.
|
|
5929
3803
|
* @throws {RequiredError}
|
|
5930
|
-
* @memberof ReviewsApi
|
|
5931
3804
|
*/
|
|
5932
3805
|
listReviews(requestParameters: ReviewsApiListReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReviewsResponse, any>>;
|
|
5933
3806
|
/**
|
|
@@ -5936,13 +3809,11 @@ export declare class ReviewsApi extends BaseAPI {
|
|
|
5936
3809
|
* @param {ReviewsApiModerateReviewRequest} requestParameters Request parameters.
|
|
5937
3810
|
* @param {*} [options] Override http request option.
|
|
5938
3811
|
* @throws {RequiredError}
|
|
5939
|
-
* @memberof ReviewsApi
|
|
5940
3812
|
*/
|
|
5941
3813
|
moderateReview(requestParameters: ReviewsApiModerateReviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Review, any>>;
|
|
5942
3814
|
}
|
|
5943
3815
|
/**
|
|
5944
3816
|
* TermsApi - axios parameter creator
|
|
5945
|
-
* @export
|
|
5946
3817
|
*/
|
|
5947
3818
|
export declare const TermsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5948
3819
|
/**
|
|
@@ -5967,7 +3838,6 @@ export declare const TermsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5967
3838
|
};
|
|
5968
3839
|
/**
|
|
5969
3840
|
* TermsApi - functional programming interface
|
|
5970
|
-
* @export
|
|
5971
3841
|
*/
|
|
5972
3842
|
export declare const TermsApiFp: (configuration?: Configuration) => {
|
|
5973
3843
|
/**
|
|
@@ -5992,7 +3862,6 @@ export declare const TermsApiFp: (configuration?: Configuration) => {
|
|
|
5992
3862
|
};
|
|
5993
3863
|
/**
|
|
5994
3864
|
* TermsApi - factory interface
|
|
5995
|
-
* @export
|
|
5996
3865
|
*/
|
|
5997
3866
|
export declare const TermsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5998
3867
|
/**
|
|
@@ -6014,53 +3883,36 @@ export declare const TermsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
6014
3883
|
};
|
|
6015
3884
|
/**
|
|
6016
3885
|
* Request parameters for getTerms operation in TermsApi.
|
|
6017
|
-
* @export
|
|
6018
|
-
* @interface TermsApiGetTermsRequest
|
|
6019
3886
|
*/
|
|
6020
3887
|
export interface TermsApiGetTermsRequest {
|
|
6021
3888
|
/**
|
|
6022
3889
|
* Project unique identifier
|
|
6023
|
-
* @type {string}
|
|
6024
|
-
* @memberof TermsApiGetTerms
|
|
6025
3890
|
*/
|
|
6026
3891
|
readonly project: string;
|
|
6027
3892
|
/**
|
|
6028
3893
|
* The platform identifier
|
|
6029
|
-
* @type {string}
|
|
6030
|
-
* @memberof TermsApiGetTerms
|
|
6031
3894
|
*/
|
|
6032
3895
|
readonly platformId: string;
|
|
6033
3896
|
}
|
|
6034
3897
|
/**
|
|
6035
3898
|
* Request parameters for saveTerms operation in TermsApi.
|
|
6036
|
-
* @export
|
|
6037
|
-
* @interface TermsApiSaveTermsRequest
|
|
6038
3899
|
*/
|
|
6039
3900
|
export interface TermsApiSaveTermsRequest {
|
|
6040
3901
|
/**
|
|
6041
3902
|
* Project unique identifier
|
|
6042
|
-
* @type {string}
|
|
6043
|
-
* @memberof TermsApiSaveTerms
|
|
6044
3903
|
*/
|
|
6045
3904
|
readonly project: string;
|
|
6046
3905
|
/**
|
|
6047
3906
|
* The platform identifier
|
|
6048
|
-
* @type {string}
|
|
6049
|
-
* @memberof TermsApiSaveTerms
|
|
6050
3907
|
*/
|
|
6051
3908
|
readonly platformId: string;
|
|
6052
3909
|
/**
|
|
6053
3910
|
* Save terms
|
|
6054
|
-
* @type {SaveTermsRequest}
|
|
6055
|
-
* @memberof TermsApiSaveTerms
|
|
6056
3911
|
*/
|
|
6057
3912
|
readonly saveTermsRequest: SaveTermsRequest;
|
|
6058
3913
|
}
|
|
6059
3914
|
/**
|
|
6060
3915
|
* TermsApi - object-oriented interface
|
|
6061
|
-
* @export
|
|
6062
|
-
* @class TermsApi
|
|
6063
|
-
* @extends {BaseAPI}
|
|
6064
3916
|
*/
|
|
6065
3917
|
export declare class TermsApi extends BaseAPI {
|
|
6066
3918
|
/**
|
|
@@ -6069,7 +3921,6 @@ export declare class TermsApi extends BaseAPI {
|
|
|
6069
3921
|
* @param {TermsApiGetTermsRequest} requestParameters Request parameters.
|
|
6070
3922
|
* @param {*} [options] Override http request option.
|
|
6071
3923
|
* @throws {RequiredError}
|
|
6072
|
-
* @memberof TermsApi
|
|
6073
3924
|
*/
|
|
6074
3925
|
getTerms(requestParameters: TermsApiGetTermsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Terms, any>>;
|
|
6075
3926
|
/**
|
|
@@ -6078,7 +3929,6 @@ export declare class TermsApi extends BaseAPI {
|
|
|
6078
3929
|
* @param {TermsApiSaveTermsRequest} requestParameters Request parameters.
|
|
6079
3930
|
* @param {*} [options] Override http request option.
|
|
6080
3931
|
* @throws {RequiredError}
|
|
6081
|
-
* @memberof TermsApi
|
|
6082
3932
|
*/
|
|
6083
3933
|
saveTerms(requestParameters: TermsApiSaveTermsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Terms, any>>;
|
|
6084
3934
|
}
|