flexinet-api 0.0.255-prerelease0
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/.openapi-generator/FILES +13 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +45 -0
- package/api.ts +6791 -0
- package/base.ts +72 -0
- package/common.ts +150 -0
- package/configuration.ts +101 -0
- package/dist/api.d.ts +4532 -0
- package/dist/api.js +4177 -0
- package/dist/base.d.ts +54 -0
- package/dist/base.js +59 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +160 -0
- package/dist/configuration.d.ts +83 -0
- package/dist/configuration.js +42 -0
- package/dist/esm/api.d.ts +4532 -0
- package/dist/esm/api.js +4113 -0
- package/dist/esm/base.d.ts +54 -0
- package/dist/esm/base.js +54 -0
- package/dist/esm/common.d.ts +65 -0
- package/dist/esm/common.js +148 -0
- package/dist/esm/configuration.d.ts +83 -0
- package/dist/esm/configuration.js +38 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,4532 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Flexinet API
|
|
3
|
+
* This is Flexinet API documentation
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@binhatch.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ApiKey
|
|
20
|
+
*/
|
|
21
|
+
export interface ApiKey {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof ApiKey
|
|
26
|
+
*/
|
|
27
|
+
'key': string;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @export
|
|
32
|
+
* @interface AuditLog
|
|
33
|
+
*/
|
|
34
|
+
export interface AuditLog {
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof AuditLog
|
|
39
|
+
*/
|
|
40
|
+
'timestamp': string;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof AuditLog
|
|
45
|
+
*/
|
|
46
|
+
'action': AuditLogActionEnum;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {User}
|
|
50
|
+
* @memberof AuditLog
|
|
51
|
+
*/
|
|
52
|
+
'user': User;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {AuditLogObjectType}
|
|
56
|
+
* @memberof AuditLog
|
|
57
|
+
*/
|
|
58
|
+
'objectType': AuditLogObjectType;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof AuditLog
|
|
63
|
+
*/
|
|
64
|
+
'objectId'?: string;
|
|
65
|
+
}
|
|
66
|
+
export declare const AuditLogActionEnum: {
|
|
67
|
+
readonly Create: "create";
|
|
68
|
+
readonly Update: "update";
|
|
69
|
+
};
|
|
70
|
+
export type AuditLogActionEnum = typeof AuditLogActionEnum[keyof typeof AuditLogActionEnum];
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @export
|
|
74
|
+
* @interface AuditLogListResponse
|
|
75
|
+
*/
|
|
76
|
+
export interface AuditLogListResponse {
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
* @type {Array<AuditLog>}
|
|
80
|
+
* @memberof AuditLogListResponse
|
|
81
|
+
*/
|
|
82
|
+
'auditLogs': Array<AuditLog>;
|
|
83
|
+
/**
|
|
84
|
+
* This is the pagination token
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof AuditLogListResponse
|
|
87
|
+
*/
|
|
88
|
+
'nextToken'?: string;
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
* @type {boolean}
|
|
92
|
+
* @memberof AuditLogListResponse
|
|
93
|
+
*/
|
|
94
|
+
'hasMore': boolean;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @export
|
|
99
|
+
* @enum {string}
|
|
100
|
+
*/
|
|
101
|
+
export declare const AuditLogObjectType: {
|
|
102
|
+
readonly Promotion: "promotion";
|
|
103
|
+
};
|
|
104
|
+
export type AuditLogObjectType = typeof AuditLogObjectType[keyof typeof AuditLogObjectType];
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @export
|
|
108
|
+
* @interface BackofficeConfig
|
|
109
|
+
*/
|
|
110
|
+
export interface BackofficeConfig {
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @type {NotificationEmailAddress}
|
|
114
|
+
* @memberof BackofficeConfig
|
|
115
|
+
*/
|
|
116
|
+
'notificationEmailConfig'?: NotificationEmailAddress;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @export
|
|
121
|
+
* @interface Balance
|
|
122
|
+
*/
|
|
123
|
+
export interface Balance {
|
|
124
|
+
/**
|
|
125
|
+
*
|
|
126
|
+
* @type {string}
|
|
127
|
+
* @memberof Balance
|
|
128
|
+
*/
|
|
129
|
+
'id': string;
|
|
130
|
+
/**
|
|
131
|
+
*
|
|
132
|
+
* @type {string}
|
|
133
|
+
* @memberof Balance
|
|
134
|
+
*/
|
|
135
|
+
'kind': string;
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
* @type {number}
|
|
139
|
+
* @memberof Balance
|
|
140
|
+
*/
|
|
141
|
+
'amount': number;
|
|
142
|
+
/**
|
|
143
|
+
*
|
|
144
|
+
* @type {string}
|
|
145
|
+
* @memberof Balance
|
|
146
|
+
*/
|
|
147
|
+
'receiver': string;
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
*
|
|
151
|
+
* @export
|
|
152
|
+
* @interface BalanceUpdateRequest
|
|
153
|
+
*/
|
|
154
|
+
export interface BalanceUpdateRequest {
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @type {number}
|
|
158
|
+
* @memberof BalanceUpdateRequest
|
|
159
|
+
*/
|
|
160
|
+
'amount': number;
|
|
161
|
+
/**
|
|
162
|
+
*
|
|
163
|
+
* @type {ReceiverKind}
|
|
164
|
+
* @memberof BalanceUpdateRequest
|
|
165
|
+
*/
|
|
166
|
+
'receiverKind': ReceiverKind;
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
*
|
|
170
|
+
* @export
|
|
171
|
+
* @enum {string}
|
|
172
|
+
*/
|
|
173
|
+
export declare const Beneficiary: {
|
|
174
|
+
readonly User: "user";
|
|
175
|
+
readonly Client: "client";
|
|
176
|
+
};
|
|
177
|
+
export type Beneficiary = typeof Beneficiary[keyof typeof Beneficiary];
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @export
|
|
181
|
+
* @enum {string}
|
|
182
|
+
*/
|
|
183
|
+
export declare const BonusMu: {
|
|
184
|
+
readonly Points: "points";
|
|
185
|
+
readonly Product: "product";
|
|
186
|
+
};
|
|
187
|
+
export type BonusMu = typeof BonusMu[keyof typeof BonusMu];
|
|
188
|
+
/**
|
|
189
|
+
*
|
|
190
|
+
* @export
|
|
191
|
+
* @interface BonusValue
|
|
192
|
+
*/
|
|
193
|
+
export interface BonusValue {
|
|
194
|
+
/**
|
|
195
|
+
*
|
|
196
|
+
* @type {number}
|
|
197
|
+
* @memberof BonusValue
|
|
198
|
+
*/
|
|
199
|
+
'value': number;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @type {BonusMu}
|
|
203
|
+
* @memberof BonusValue
|
|
204
|
+
*/
|
|
205
|
+
'mu': BonusMu;
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @type {string}
|
|
209
|
+
* @memberof BonusValue
|
|
210
|
+
*/
|
|
211
|
+
'ref'?: string;
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @export
|
|
216
|
+
* @interface BulkNotificationsReadRequest
|
|
217
|
+
*/
|
|
218
|
+
export interface BulkNotificationsReadRequest {
|
|
219
|
+
/**
|
|
220
|
+
*
|
|
221
|
+
* @type {Array<string>}
|
|
222
|
+
* @memberof BulkNotificationsReadRequest
|
|
223
|
+
*/
|
|
224
|
+
'notificationIds': Array<string>;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
*
|
|
228
|
+
* @export
|
|
229
|
+
* @interface Client
|
|
230
|
+
*/
|
|
231
|
+
export interface Client {
|
|
232
|
+
/**
|
|
233
|
+
*
|
|
234
|
+
* @type {string}
|
|
235
|
+
* @memberof Client
|
|
236
|
+
*/
|
|
237
|
+
'id': string;
|
|
238
|
+
/**
|
|
239
|
+
*
|
|
240
|
+
* @type {string}
|
|
241
|
+
* @memberof Client
|
|
242
|
+
*/
|
|
243
|
+
'referenceId': string;
|
|
244
|
+
/**
|
|
245
|
+
*
|
|
246
|
+
* @type {string}
|
|
247
|
+
* @memberof Client
|
|
248
|
+
*/
|
|
249
|
+
'name': string;
|
|
250
|
+
/**
|
|
251
|
+
*
|
|
252
|
+
* @type {string}
|
|
253
|
+
* @memberof Client
|
|
254
|
+
*/
|
|
255
|
+
'createdAt': string;
|
|
256
|
+
/**
|
|
257
|
+
*
|
|
258
|
+
* @type {{ [key: string]: string; }}
|
|
259
|
+
* @memberof Client
|
|
260
|
+
*/
|
|
261
|
+
'additionalProperties': {
|
|
262
|
+
[key: string]: string;
|
|
263
|
+
};
|
|
264
|
+
/**
|
|
265
|
+
*
|
|
266
|
+
* @type {string}
|
|
267
|
+
* @memberof Client
|
|
268
|
+
*/
|
|
269
|
+
'updatedAt': string;
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
*
|
|
273
|
+
* @export
|
|
274
|
+
* @interface ClientCreationRequest
|
|
275
|
+
*/
|
|
276
|
+
export interface ClientCreationRequest {
|
|
277
|
+
/**
|
|
278
|
+
*
|
|
279
|
+
* @type {string}
|
|
280
|
+
* @memberof ClientCreationRequest
|
|
281
|
+
*/
|
|
282
|
+
'referenceId': string;
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof ClientCreationRequest
|
|
287
|
+
*/
|
|
288
|
+
'name': string;
|
|
289
|
+
/**
|
|
290
|
+
*
|
|
291
|
+
* @type {{ [key: string]: string; }}
|
|
292
|
+
* @memberof ClientCreationRequest
|
|
293
|
+
*/
|
|
294
|
+
'additionalProperties': {
|
|
295
|
+
[key: string]: string;
|
|
296
|
+
};
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
*
|
|
300
|
+
* @export
|
|
301
|
+
* @interface ClientListResponse
|
|
302
|
+
*/
|
|
303
|
+
export interface ClientListResponse {
|
|
304
|
+
/**
|
|
305
|
+
*
|
|
306
|
+
* @type {Array<Client>}
|
|
307
|
+
* @memberof ClientListResponse
|
|
308
|
+
*/
|
|
309
|
+
'clients': Array<Client>;
|
|
310
|
+
/**
|
|
311
|
+
* This is the pagination token
|
|
312
|
+
* @type {string}
|
|
313
|
+
* @memberof ClientListResponse
|
|
314
|
+
*/
|
|
315
|
+
'nextToken'?: string;
|
|
316
|
+
/**
|
|
317
|
+
*
|
|
318
|
+
* @type {boolean}
|
|
319
|
+
* @memberof ClientListResponse
|
|
320
|
+
*/
|
|
321
|
+
'hasMore': boolean;
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
*
|
|
325
|
+
* @export
|
|
326
|
+
* @enum {string}
|
|
327
|
+
*/
|
|
328
|
+
export declare const Condition: {
|
|
329
|
+
readonly Exists: "exists";
|
|
330
|
+
readonly Equals: "equals";
|
|
331
|
+
readonly Contains: "contains";
|
|
332
|
+
};
|
|
333
|
+
export type Condition = typeof Condition[keyof typeof Condition];
|
|
334
|
+
/**
|
|
335
|
+
*
|
|
336
|
+
* @export
|
|
337
|
+
* @interface CreateSegmentRequest
|
|
338
|
+
*/
|
|
339
|
+
export interface CreateSegmentRequest {
|
|
340
|
+
/**
|
|
341
|
+
*
|
|
342
|
+
* @type {SegmentCreationRequest}
|
|
343
|
+
* @memberof CreateSegmentRequest
|
|
344
|
+
*/
|
|
345
|
+
'segment'?: SegmentCreationRequest;
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
*
|
|
349
|
+
* @export
|
|
350
|
+
* @interface CreateTagRequest
|
|
351
|
+
*/
|
|
352
|
+
export interface CreateTagRequest {
|
|
353
|
+
/**
|
|
354
|
+
*
|
|
355
|
+
* @type {TagCreationRequest}
|
|
356
|
+
* @memberof CreateTagRequest
|
|
357
|
+
*/
|
|
358
|
+
'tag'?: TagCreationRequest;
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
*
|
|
362
|
+
* @export
|
|
363
|
+
* @interface CustomDealRestriction
|
|
364
|
+
*/
|
|
365
|
+
export interface CustomDealRestriction {
|
|
366
|
+
/**
|
|
367
|
+
*
|
|
368
|
+
* @type {string}
|
|
369
|
+
* @memberof CustomDealRestriction
|
|
370
|
+
*/
|
|
371
|
+
'tagKey': string;
|
|
372
|
+
/**
|
|
373
|
+
*
|
|
374
|
+
* @type {string}
|
|
375
|
+
* @memberof CustomDealRestriction
|
|
376
|
+
*/
|
|
377
|
+
'tagValue': string;
|
|
378
|
+
/**
|
|
379
|
+
*
|
|
380
|
+
* @type {number}
|
|
381
|
+
* @memberof CustomDealRestriction
|
|
382
|
+
*/
|
|
383
|
+
'minTurnoverPercent': number;
|
|
384
|
+
/**
|
|
385
|
+
*
|
|
386
|
+
* @type {CustomDealRestrictionPriority}
|
|
387
|
+
* @memberof CustomDealRestriction
|
|
388
|
+
*/
|
|
389
|
+
'priority': CustomDealRestrictionPriority;
|
|
390
|
+
/**
|
|
391
|
+
*
|
|
392
|
+
* @type {number}
|
|
393
|
+
* @memberof CustomDealRestriction
|
|
394
|
+
*/
|
|
395
|
+
'points': number;
|
|
396
|
+
/**
|
|
397
|
+
*
|
|
398
|
+
* @type {string}
|
|
399
|
+
* @memberof CustomDealRestriction
|
|
400
|
+
*/
|
|
401
|
+
'createdAt': string;
|
|
402
|
+
/**
|
|
403
|
+
*
|
|
404
|
+
* @type {string}
|
|
405
|
+
* @memberof CustomDealRestriction
|
|
406
|
+
*/
|
|
407
|
+
'updatedAt': string;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @export
|
|
412
|
+
* @enum {string}
|
|
413
|
+
*/
|
|
414
|
+
export declare const CustomDealRestrictionPriority: {
|
|
415
|
+
readonly Low: "low";
|
|
416
|
+
readonly Medium: "medium";
|
|
417
|
+
readonly High: "high";
|
|
418
|
+
};
|
|
419
|
+
export type CustomDealRestrictionPriority = typeof CustomDealRestrictionPriority[keyof typeof CustomDealRestrictionPriority];
|
|
420
|
+
/**
|
|
421
|
+
*
|
|
422
|
+
* @export
|
|
423
|
+
* @interface CustomDealRestrictionRequest
|
|
424
|
+
*/
|
|
425
|
+
export interface CustomDealRestrictionRequest {
|
|
426
|
+
/**
|
|
427
|
+
*
|
|
428
|
+
* @type {string}
|
|
429
|
+
* @memberof CustomDealRestrictionRequest
|
|
430
|
+
*/
|
|
431
|
+
'tagKey': string;
|
|
432
|
+
/**
|
|
433
|
+
*
|
|
434
|
+
* @type {string}
|
|
435
|
+
* @memberof CustomDealRestrictionRequest
|
|
436
|
+
*/
|
|
437
|
+
'tagValue': string;
|
|
438
|
+
/**
|
|
439
|
+
*
|
|
440
|
+
* @type {number}
|
|
441
|
+
* @memberof CustomDealRestrictionRequest
|
|
442
|
+
*/
|
|
443
|
+
'minTurnoverPercent': number;
|
|
444
|
+
/**
|
|
445
|
+
*
|
|
446
|
+
* @type {CustomDealRestrictionPriority}
|
|
447
|
+
* @memberof CustomDealRestrictionRequest
|
|
448
|
+
*/
|
|
449
|
+
'priority': CustomDealRestrictionPriority;
|
|
450
|
+
/**
|
|
451
|
+
*
|
|
452
|
+
* @type {number}
|
|
453
|
+
* @memberof CustomDealRestrictionRequest
|
|
454
|
+
*/
|
|
455
|
+
'points': number;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
*
|
|
459
|
+
* @export
|
|
460
|
+
* @interface CustomDealRestrictionsResponse
|
|
461
|
+
*/
|
|
462
|
+
export interface CustomDealRestrictionsResponse {
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
* @type {Array<CustomDealRestriction>}
|
|
466
|
+
* @memberof CustomDealRestrictionsResponse
|
|
467
|
+
*/
|
|
468
|
+
'restrictions': Array<CustomDealRestriction>;
|
|
469
|
+
}
|
|
470
|
+
/**
|
|
471
|
+
*
|
|
472
|
+
* @export
|
|
473
|
+
* @interface CustomeruserDetails
|
|
474
|
+
*/
|
|
475
|
+
export interface CustomeruserDetails {
|
|
476
|
+
/**
|
|
477
|
+
*
|
|
478
|
+
* @type {string}
|
|
479
|
+
* @memberof CustomeruserDetails
|
|
480
|
+
*/
|
|
481
|
+
'email': string;
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
*
|
|
485
|
+
* @export
|
|
486
|
+
* @interface EventCreationRequest
|
|
487
|
+
*/
|
|
488
|
+
export interface EventCreationRequest {
|
|
489
|
+
/**
|
|
490
|
+
*
|
|
491
|
+
* @type {EventCreationRequestDetails}
|
|
492
|
+
* @memberof EventCreationRequest
|
|
493
|
+
*/
|
|
494
|
+
'details': EventCreationRequestDetails;
|
|
495
|
+
/**
|
|
496
|
+
*
|
|
497
|
+
* @type {string}
|
|
498
|
+
* @memberof EventCreationRequest
|
|
499
|
+
*/
|
|
500
|
+
'kind': EventCreationRequestKindEnum;
|
|
501
|
+
/**
|
|
502
|
+
*
|
|
503
|
+
* @type {string}
|
|
504
|
+
* @memberof EventCreationRequest
|
|
505
|
+
*/
|
|
506
|
+
'timestamp': string;
|
|
507
|
+
/**
|
|
508
|
+
*
|
|
509
|
+
* @type {string}
|
|
510
|
+
* @memberof EventCreationRequest
|
|
511
|
+
*/
|
|
512
|
+
'id': string;
|
|
513
|
+
}
|
|
514
|
+
export declare const EventCreationRequestKindEnum: {
|
|
515
|
+
readonly Transaction: "transaction";
|
|
516
|
+
};
|
|
517
|
+
export type EventCreationRequestKindEnum = typeof EventCreationRequestKindEnum[keyof typeof EventCreationRequestKindEnum];
|
|
518
|
+
/**
|
|
519
|
+
* @type EventCreationRequestDetails
|
|
520
|
+
* @export
|
|
521
|
+
*/
|
|
522
|
+
export type EventCreationRequestDetails = object;
|
|
523
|
+
/**
|
|
524
|
+
*
|
|
525
|
+
* @export
|
|
526
|
+
* @interface Metrics
|
|
527
|
+
*/
|
|
528
|
+
export interface Metrics {
|
|
529
|
+
/**
|
|
530
|
+
*
|
|
531
|
+
* @type {number}
|
|
532
|
+
* @memberof Metrics
|
|
533
|
+
*/
|
|
534
|
+
'clientCount'?: number;
|
|
535
|
+
/**
|
|
536
|
+
*
|
|
537
|
+
* @type {number}
|
|
538
|
+
* @memberof Metrics
|
|
539
|
+
*/
|
|
540
|
+
'participationCount'?: number;
|
|
541
|
+
/**
|
|
542
|
+
*
|
|
543
|
+
* @type {{ [key: string]: number; }}
|
|
544
|
+
* @memberof Metrics
|
|
545
|
+
*/
|
|
546
|
+
'participationCountPerProgress'?: {
|
|
547
|
+
[key: string]: number;
|
|
548
|
+
};
|
|
549
|
+
/**
|
|
550
|
+
*
|
|
551
|
+
* @type {number}
|
|
552
|
+
* @memberof Metrics
|
|
553
|
+
*/
|
|
554
|
+
'salesValue'?: number;
|
|
555
|
+
}
|
|
556
|
+
/**
|
|
557
|
+
*
|
|
558
|
+
* @export
|
|
559
|
+
* @interface MetricsAggregation
|
|
560
|
+
*/
|
|
561
|
+
export interface MetricsAggregation {
|
|
562
|
+
/**
|
|
563
|
+
*
|
|
564
|
+
* @type {{ [key: string]: MetricsCollection; }}
|
|
565
|
+
* @memberof MetricsAggregation
|
|
566
|
+
*/
|
|
567
|
+
'perPeriod': {
|
|
568
|
+
[key: string]: MetricsCollection;
|
|
569
|
+
};
|
|
570
|
+
}
|
|
571
|
+
/**
|
|
572
|
+
*
|
|
573
|
+
* @export
|
|
574
|
+
* @interface MetricsCollection
|
|
575
|
+
*/
|
|
576
|
+
export interface MetricsCollection {
|
|
577
|
+
/**
|
|
578
|
+
*
|
|
579
|
+
* @type {Metrics}
|
|
580
|
+
* @memberof MetricsCollection
|
|
581
|
+
*/
|
|
582
|
+
'active': Metrics;
|
|
583
|
+
/**
|
|
584
|
+
*
|
|
585
|
+
* @type {Metrics}
|
|
586
|
+
* @memberof MetricsCollection
|
|
587
|
+
*/
|
|
588
|
+
'pending': Metrics;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
*
|
|
592
|
+
* @export
|
|
593
|
+
* @interface ModelError
|
|
594
|
+
*/
|
|
595
|
+
export interface ModelError {
|
|
596
|
+
/**
|
|
597
|
+
*
|
|
598
|
+
* @type {number}
|
|
599
|
+
* @memberof ModelError
|
|
600
|
+
*/
|
|
601
|
+
'code': number;
|
|
602
|
+
/**
|
|
603
|
+
*
|
|
604
|
+
* @type {string}
|
|
605
|
+
* @memberof ModelError
|
|
606
|
+
*/
|
|
607
|
+
'key'?: string;
|
|
608
|
+
/**
|
|
609
|
+
*
|
|
610
|
+
* @type {string}
|
|
611
|
+
* @memberof ModelError
|
|
612
|
+
*/
|
|
613
|
+
'message': string;
|
|
614
|
+
}
|
|
615
|
+
/**
|
|
616
|
+
*
|
|
617
|
+
* @export
|
|
618
|
+
* @interface Notification
|
|
619
|
+
*/
|
|
620
|
+
export interface Notification {
|
|
621
|
+
/**
|
|
622
|
+
*
|
|
623
|
+
* @type {string}
|
|
624
|
+
* @memberof Notification
|
|
625
|
+
*/
|
|
626
|
+
'id': string;
|
|
627
|
+
/**
|
|
628
|
+
*
|
|
629
|
+
* @type {string}
|
|
630
|
+
* @memberof Notification
|
|
631
|
+
*/
|
|
632
|
+
'title': string;
|
|
633
|
+
/**
|
|
634
|
+
*
|
|
635
|
+
* @type {string}
|
|
636
|
+
* @memberof Notification
|
|
637
|
+
*/
|
|
638
|
+
'body': string;
|
|
639
|
+
/**
|
|
640
|
+
*
|
|
641
|
+
* @type {NotificationStatus}
|
|
642
|
+
* @memberof Notification
|
|
643
|
+
*/
|
|
644
|
+
'status': NotificationStatus;
|
|
645
|
+
/**
|
|
646
|
+
*
|
|
647
|
+
* @type {string}
|
|
648
|
+
* @memberof Notification
|
|
649
|
+
*/
|
|
650
|
+
'createdAt': string;
|
|
651
|
+
/**
|
|
652
|
+
*
|
|
653
|
+
* @type {string}
|
|
654
|
+
* @memberof Notification
|
|
655
|
+
*/
|
|
656
|
+
'updatedAt': string;
|
|
657
|
+
/**
|
|
658
|
+
*
|
|
659
|
+
* @type {NotificationKind}
|
|
660
|
+
* @memberof Notification
|
|
661
|
+
*/
|
|
662
|
+
'kind': NotificationKind;
|
|
663
|
+
/**
|
|
664
|
+
*
|
|
665
|
+
* @type {string}
|
|
666
|
+
* @memberof Notification
|
|
667
|
+
*/
|
|
668
|
+
'referenceId'?: string;
|
|
669
|
+
}
|
|
670
|
+
/**
|
|
671
|
+
*
|
|
672
|
+
* @export
|
|
673
|
+
* @interface NotificationEmailAddress
|
|
674
|
+
*/
|
|
675
|
+
export interface NotificationEmailAddress {
|
|
676
|
+
/**
|
|
677
|
+
*
|
|
678
|
+
* @type {Array<string>}
|
|
679
|
+
* @memberof NotificationEmailAddress
|
|
680
|
+
*/
|
|
681
|
+
'emails': Array<string>;
|
|
682
|
+
}
|
|
683
|
+
/**
|
|
684
|
+
*
|
|
685
|
+
* @export
|
|
686
|
+
* @enum {string}
|
|
687
|
+
*/
|
|
688
|
+
export declare const NotificationKind: {
|
|
689
|
+
readonly Promotion: "promotion";
|
|
690
|
+
};
|
|
691
|
+
export type NotificationKind = typeof NotificationKind[keyof typeof NotificationKind];
|
|
692
|
+
/**
|
|
693
|
+
*
|
|
694
|
+
* @export
|
|
695
|
+
* @interface NotificationListResponse
|
|
696
|
+
*/
|
|
697
|
+
export interface NotificationListResponse {
|
|
698
|
+
/**
|
|
699
|
+
*
|
|
700
|
+
* @type {Array<Notification>}
|
|
701
|
+
* @memberof NotificationListResponse
|
|
702
|
+
*/
|
|
703
|
+
'notifications': Array<Notification>;
|
|
704
|
+
/**
|
|
705
|
+
* This is the pagination token
|
|
706
|
+
* @type {string}
|
|
707
|
+
* @memberof NotificationListResponse
|
|
708
|
+
*/
|
|
709
|
+
'nextToken'?: string;
|
|
710
|
+
/**
|
|
711
|
+
*
|
|
712
|
+
* @type {boolean}
|
|
713
|
+
* @memberof NotificationListResponse
|
|
714
|
+
*/
|
|
715
|
+
'hasMore': boolean;
|
|
716
|
+
/**
|
|
717
|
+
*
|
|
718
|
+
* @type {number}
|
|
719
|
+
* @memberof NotificationListResponse
|
|
720
|
+
*/
|
|
721
|
+
'unreadCount': number;
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
*
|
|
725
|
+
* @export
|
|
726
|
+
* @enum {string}
|
|
727
|
+
*/
|
|
728
|
+
export declare const NotificationStatus: {
|
|
729
|
+
readonly Unread: "unread";
|
|
730
|
+
readonly Read: "read";
|
|
731
|
+
};
|
|
732
|
+
export type NotificationStatus = typeof NotificationStatus[keyof typeof NotificationStatus];
|
|
733
|
+
/**
|
|
734
|
+
*
|
|
735
|
+
* @export
|
|
736
|
+
* @interface Period
|
|
737
|
+
*/
|
|
738
|
+
export interface Period {
|
|
739
|
+
/**
|
|
740
|
+
*
|
|
741
|
+
* @type {string}
|
|
742
|
+
* @memberof Period
|
|
743
|
+
*/
|
|
744
|
+
'startAt': string;
|
|
745
|
+
/**
|
|
746
|
+
*
|
|
747
|
+
* @type {string}
|
|
748
|
+
* @memberof Period
|
|
749
|
+
*/
|
|
750
|
+
'endAt': string;
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
*
|
|
754
|
+
* @export
|
|
755
|
+
* @interface Product
|
|
756
|
+
*/
|
|
757
|
+
export interface Product {
|
|
758
|
+
/**
|
|
759
|
+
*
|
|
760
|
+
* @type {string}
|
|
761
|
+
* @memberof Product
|
|
762
|
+
*/
|
|
763
|
+
'id': string;
|
|
764
|
+
/**
|
|
765
|
+
*
|
|
766
|
+
* @type {string}
|
|
767
|
+
* @memberof Product
|
|
768
|
+
*/
|
|
769
|
+
'name': string;
|
|
770
|
+
/**
|
|
771
|
+
*
|
|
772
|
+
* @type {string}
|
|
773
|
+
* @memberof Product
|
|
774
|
+
*/
|
|
775
|
+
'description': string;
|
|
776
|
+
/**
|
|
777
|
+
*
|
|
778
|
+
* @type {number}
|
|
779
|
+
* @memberof Product
|
|
780
|
+
*/
|
|
781
|
+
'value': number;
|
|
782
|
+
/**
|
|
783
|
+
*
|
|
784
|
+
* @type {ProductAvailability}
|
|
785
|
+
* @memberof Product
|
|
786
|
+
*/
|
|
787
|
+
'availability': ProductAvailability;
|
|
788
|
+
/**
|
|
789
|
+
*
|
|
790
|
+
* @type {ProductStatus}
|
|
791
|
+
* @memberof Product
|
|
792
|
+
*/
|
|
793
|
+
'status': ProductStatus;
|
|
794
|
+
/**
|
|
795
|
+
*
|
|
796
|
+
* @type {Array<ProductUsage>}
|
|
797
|
+
* @memberof Product
|
|
798
|
+
*/
|
|
799
|
+
'usage'?: Array<ProductUsage>;
|
|
800
|
+
/**
|
|
801
|
+
*
|
|
802
|
+
* @type {Array<string>}
|
|
803
|
+
* @memberof Product
|
|
804
|
+
*/
|
|
805
|
+
'media': Array<string>;
|
|
806
|
+
/**
|
|
807
|
+
*
|
|
808
|
+
* @type {string}
|
|
809
|
+
* @memberof Product
|
|
810
|
+
*/
|
|
811
|
+
'productCode': string;
|
|
812
|
+
/**
|
|
813
|
+
*
|
|
814
|
+
* @type {string}
|
|
815
|
+
* @memberof Product
|
|
816
|
+
*/
|
|
817
|
+
'source': string;
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @type {Array<string>}
|
|
821
|
+
* @memberof Product
|
|
822
|
+
*/
|
|
823
|
+
'segments': Array<string>;
|
|
824
|
+
/**
|
|
825
|
+
*
|
|
826
|
+
* @type {ProductKind}
|
|
827
|
+
* @memberof Product
|
|
828
|
+
*/
|
|
829
|
+
'kind': ProductKind;
|
|
830
|
+
/**
|
|
831
|
+
*
|
|
832
|
+
* @type {string}
|
|
833
|
+
* @memberof Product
|
|
834
|
+
*/
|
|
835
|
+
'createdAt': string;
|
|
836
|
+
/**
|
|
837
|
+
*
|
|
838
|
+
* @type {string}
|
|
839
|
+
* @memberof Product
|
|
840
|
+
*/
|
|
841
|
+
'updatedAt': string;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
* The details necessary to transform a Product request into a Product in case it is accepted.
|
|
845
|
+
* @export
|
|
846
|
+
* @interface ProductApprovalDetails
|
|
847
|
+
*/
|
|
848
|
+
export interface ProductApprovalDetails {
|
|
849
|
+
/**
|
|
850
|
+
*
|
|
851
|
+
* @type {number}
|
|
852
|
+
* @memberof ProductApprovalDetails
|
|
853
|
+
*/
|
|
854
|
+
'value': number;
|
|
855
|
+
/**
|
|
856
|
+
*
|
|
857
|
+
* @type {string}
|
|
858
|
+
* @memberof ProductApprovalDetails
|
|
859
|
+
*/
|
|
860
|
+
'productCode': string;
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @type {string}
|
|
864
|
+
* @memberof ProductApprovalDetails
|
|
865
|
+
*/
|
|
866
|
+
'source': string;
|
|
867
|
+
/**
|
|
868
|
+
*
|
|
869
|
+
* @type {Array<string>}
|
|
870
|
+
* @memberof ProductApprovalDetails
|
|
871
|
+
*/
|
|
872
|
+
'segments': Array<string>;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
*
|
|
876
|
+
* @export
|
|
877
|
+
* @enum {string}
|
|
878
|
+
*/
|
|
879
|
+
export declare const ProductAvailability: {
|
|
880
|
+
readonly Available: "available";
|
|
881
|
+
readonly Unavailable: "unavailable";
|
|
882
|
+
};
|
|
883
|
+
export type ProductAvailability = typeof ProductAvailability[keyof typeof ProductAvailability];
|
|
884
|
+
/**
|
|
885
|
+
*
|
|
886
|
+
* @export
|
|
887
|
+
* @interface ProductCreationRequest
|
|
888
|
+
*/
|
|
889
|
+
export interface ProductCreationRequest {
|
|
890
|
+
/**
|
|
891
|
+
*
|
|
892
|
+
* @type {string}
|
|
893
|
+
* @memberof ProductCreationRequest
|
|
894
|
+
*/
|
|
895
|
+
'name': string;
|
|
896
|
+
/**
|
|
897
|
+
*
|
|
898
|
+
* @type {string}
|
|
899
|
+
* @memberof ProductCreationRequest
|
|
900
|
+
*/
|
|
901
|
+
'description': string;
|
|
902
|
+
/**
|
|
903
|
+
*
|
|
904
|
+
* @type {number}
|
|
905
|
+
* @memberof ProductCreationRequest
|
|
906
|
+
*/
|
|
907
|
+
'value': number;
|
|
908
|
+
/**
|
|
909
|
+
*
|
|
910
|
+
* @type {ProductAvailability}
|
|
911
|
+
* @memberof ProductCreationRequest
|
|
912
|
+
*/
|
|
913
|
+
'availability'?: ProductAvailability;
|
|
914
|
+
/**
|
|
915
|
+
*
|
|
916
|
+
* @type {ProductStatus}
|
|
917
|
+
* @memberof ProductCreationRequest
|
|
918
|
+
*/
|
|
919
|
+
'status'?: ProductStatus;
|
|
920
|
+
/**
|
|
921
|
+
*
|
|
922
|
+
* @type {Array<ProductUsage>}
|
|
923
|
+
* @memberof ProductCreationRequest
|
|
924
|
+
*/
|
|
925
|
+
'usage'?: Array<ProductUsage>;
|
|
926
|
+
/**
|
|
927
|
+
*
|
|
928
|
+
* @type {Array<string>}
|
|
929
|
+
* @memberof ProductCreationRequest
|
|
930
|
+
*/
|
|
931
|
+
'media': Array<string>;
|
|
932
|
+
/**
|
|
933
|
+
*
|
|
934
|
+
* @type {string}
|
|
935
|
+
* @memberof ProductCreationRequest
|
|
936
|
+
*/
|
|
937
|
+
'productCode': string;
|
|
938
|
+
/**
|
|
939
|
+
*
|
|
940
|
+
* @type {string}
|
|
941
|
+
* @memberof ProductCreationRequest
|
|
942
|
+
*/
|
|
943
|
+
'source': string;
|
|
944
|
+
/**
|
|
945
|
+
*
|
|
946
|
+
* @type {Array<string>}
|
|
947
|
+
* @memberof ProductCreationRequest
|
|
948
|
+
*/
|
|
949
|
+
'segments': Array<string>;
|
|
950
|
+
/**
|
|
951
|
+
*
|
|
952
|
+
* @type {ProductKind}
|
|
953
|
+
* @memberof ProductCreationRequest
|
|
954
|
+
*/
|
|
955
|
+
'kind': ProductKind;
|
|
956
|
+
}
|
|
957
|
+
/**
|
|
958
|
+
*
|
|
959
|
+
* @export
|
|
960
|
+
* @enum {string}
|
|
961
|
+
*/
|
|
962
|
+
export declare const ProductKind: {
|
|
963
|
+
readonly Item: "item";
|
|
964
|
+
};
|
|
965
|
+
export type ProductKind = typeof ProductKind[keyof typeof ProductKind];
|
|
966
|
+
/**
|
|
967
|
+
*
|
|
968
|
+
* @export
|
|
969
|
+
* @interface ProductRequest
|
|
970
|
+
*/
|
|
971
|
+
export interface ProductRequest {
|
|
972
|
+
/**
|
|
973
|
+
*
|
|
974
|
+
* @type {string}
|
|
975
|
+
* @memberof ProductRequest
|
|
976
|
+
*/
|
|
977
|
+
'id': string;
|
|
978
|
+
/**
|
|
979
|
+
*
|
|
980
|
+
* @type {string}
|
|
981
|
+
* @memberof ProductRequest
|
|
982
|
+
*/
|
|
983
|
+
'name': string;
|
|
984
|
+
/**
|
|
985
|
+
*
|
|
986
|
+
* @type {string}
|
|
987
|
+
* @memberof ProductRequest
|
|
988
|
+
*/
|
|
989
|
+
'description': string;
|
|
990
|
+
/**
|
|
991
|
+
*
|
|
992
|
+
* @type {Array<string>}
|
|
993
|
+
* @memberof ProductRequest
|
|
994
|
+
*/
|
|
995
|
+
'media': Array<string>;
|
|
996
|
+
/**
|
|
997
|
+
*
|
|
998
|
+
* @type {ProductKind}
|
|
999
|
+
* @memberof ProductRequest
|
|
1000
|
+
*/
|
|
1001
|
+
'kind': ProductKind;
|
|
1002
|
+
/**
|
|
1003
|
+
*
|
|
1004
|
+
* @type {ProductRequestStatus}
|
|
1005
|
+
* @memberof ProductRequest
|
|
1006
|
+
*/
|
|
1007
|
+
'status': ProductRequestStatus;
|
|
1008
|
+
/**
|
|
1009
|
+
*
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof ProductRequest
|
|
1012
|
+
*/
|
|
1013
|
+
'createdAt': string;
|
|
1014
|
+
/**
|
|
1015
|
+
*
|
|
1016
|
+
* @type {string}
|
|
1017
|
+
* @memberof ProductRequest
|
|
1018
|
+
*/
|
|
1019
|
+
'updatedAt': string;
|
|
1020
|
+
}
|
|
1021
|
+
/**
|
|
1022
|
+
*
|
|
1023
|
+
* @export
|
|
1024
|
+
* @interface ProductRequestApprovalRequest
|
|
1025
|
+
*/
|
|
1026
|
+
export interface ProductRequestApprovalRequest {
|
|
1027
|
+
/**
|
|
1028
|
+
*
|
|
1029
|
+
* @type {string}
|
|
1030
|
+
* @memberof ProductRequestApprovalRequest
|
|
1031
|
+
*/
|
|
1032
|
+
'status': ProductRequestApprovalRequestStatusEnum;
|
|
1033
|
+
/**
|
|
1034
|
+
*
|
|
1035
|
+
* @type {ProductApprovalDetails}
|
|
1036
|
+
* @memberof ProductRequestApprovalRequest
|
|
1037
|
+
*/
|
|
1038
|
+
'details'?: ProductApprovalDetails;
|
|
1039
|
+
}
|
|
1040
|
+
export declare const ProductRequestApprovalRequestStatusEnum: {
|
|
1041
|
+
readonly Accepted: "accepted";
|
|
1042
|
+
readonly Rejected: "rejected";
|
|
1043
|
+
};
|
|
1044
|
+
export type ProductRequestApprovalRequestStatusEnum = typeof ProductRequestApprovalRequestStatusEnum[keyof typeof ProductRequestApprovalRequestStatusEnum];
|
|
1045
|
+
/**
|
|
1046
|
+
*
|
|
1047
|
+
* @export
|
|
1048
|
+
* @interface ProductRequestApprovalResponse
|
|
1049
|
+
*/
|
|
1050
|
+
export interface ProductRequestApprovalResponse {
|
|
1051
|
+
/**
|
|
1052
|
+
*
|
|
1053
|
+
* @type {string}
|
|
1054
|
+
* @memberof ProductRequestApprovalResponse
|
|
1055
|
+
*/
|
|
1056
|
+
'ProductId'?: string;
|
|
1057
|
+
}
|
|
1058
|
+
/**
|
|
1059
|
+
*
|
|
1060
|
+
* @export
|
|
1061
|
+
* @interface ProductRequestCreationRequest
|
|
1062
|
+
*/
|
|
1063
|
+
export interface ProductRequestCreationRequest {
|
|
1064
|
+
/**
|
|
1065
|
+
*
|
|
1066
|
+
* @type {string}
|
|
1067
|
+
* @memberof ProductRequestCreationRequest
|
|
1068
|
+
*/
|
|
1069
|
+
'name': string;
|
|
1070
|
+
/**
|
|
1071
|
+
*
|
|
1072
|
+
* @type {string}
|
|
1073
|
+
* @memberof ProductRequestCreationRequest
|
|
1074
|
+
*/
|
|
1075
|
+
'description': string;
|
|
1076
|
+
/**
|
|
1077
|
+
*
|
|
1078
|
+
* @type {Array<string>}
|
|
1079
|
+
* @memberof ProductRequestCreationRequest
|
|
1080
|
+
*/
|
|
1081
|
+
'media': Array<string>;
|
|
1082
|
+
/**
|
|
1083
|
+
*
|
|
1084
|
+
* @type {ProductKind}
|
|
1085
|
+
* @memberof ProductRequestCreationRequest
|
|
1086
|
+
*/
|
|
1087
|
+
'kind': ProductKind;
|
|
1088
|
+
}
|
|
1089
|
+
/**
|
|
1090
|
+
*
|
|
1091
|
+
* @export
|
|
1092
|
+
* @enum {string}
|
|
1093
|
+
*/
|
|
1094
|
+
export declare const ProductRequestStatus: {
|
|
1095
|
+
readonly Accepted: "accepted";
|
|
1096
|
+
readonly Rejected: "rejected";
|
|
1097
|
+
readonly Pending: "pending";
|
|
1098
|
+
};
|
|
1099
|
+
export type ProductRequestStatus = typeof ProductRequestStatus[keyof typeof ProductRequestStatus];
|
|
1100
|
+
/**
|
|
1101
|
+
*
|
|
1102
|
+
* @export
|
|
1103
|
+
* @interface ProductRequestsResponse
|
|
1104
|
+
*/
|
|
1105
|
+
export interface ProductRequestsResponse {
|
|
1106
|
+
/**
|
|
1107
|
+
*
|
|
1108
|
+
* @type {Array<ProductRequest>}
|
|
1109
|
+
* @memberof ProductRequestsResponse
|
|
1110
|
+
*/
|
|
1111
|
+
'data': Array<ProductRequest>;
|
|
1112
|
+
/**
|
|
1113
|
+
* There are additional results that could be fetched or not.
|
|
1114
|
+
* @type {boolean}
|
|
1115
|
+
* @memberof ProductRequestsResponse
|
|
1116
|
+
*/
|
|
1117
|
+
'hasMore': boolean;
|
|
1118
|
+
/**
|
|
1119
|
+
* This is the pagination token
|
|
1120
|
+
* @type {string}
|
|
1121
|
+
* @memberof ProductRequestsResponse
|
|
1122
|
+
*/
|
|
1123
|
+
'nextToken'?: string;
|
|
1124
|
+
}
|
|
1125
|
+
/**
|
|
1126
|
+
*
|
|
1127
|
+
* @export
|
|
1128
|
+
* @enum {string}
|
|
1129
|
+
*/
|
|
1130
|
+
export declare const ProductStatus: {
|
|
1131
|
+
readonly Active: "active";
|
|
1132
|
+
readonly Inactive: "inactive";
|
|
1133
|
+
readonly Pending: "pending";
|
|
1134
|
+
};
|
|
1135
|
+
export type ProductStatus = typeof ProductStatus[keyof typeof ProductStatus];
|
|
1136
|
+
/**
|
|
1137
|
+
*
|
|
1138
|
+
* @export
|
|
1139
|
+
* @enum {string}
|
|
1140
|
+
*/
|
|
1141
|
+
export declare const ProductUsage: {
|
|
1142
|
+
readonly Webshop: "webshop";
|
|
1143
|
+
readonly Promotion: "promotion";
|
|
1144
|
+
};
|
|
1145
|
+
export type ProductUsage = typeof ProductUsage[keyof typeof ProductUsage];
|
|
1146
|
+
/**
|
|
1147
|
+
*
|
|
1148
|
+
* @export
|
|
1149
|
+
* @interface ProductsResponse
|
|
1150
|
+
*/
|
|
1151
|
+
export interface ProductsResponse {
|
|
1152
|
+
/**
|
|
1153
|
+
*
|
|
1154
|
+
* @type {Array<Product>}
|
|
1155
|
+
* @memberof ProductsResponse
|
|
1156
|
+
*/
|
|
1157
|
+
'data': Array<Product>;
|
|
1158
|
+
/**
|
|
1159
|
+
* There are additional results that could be fetched or not.
|
|
1160
|
+
* @type {boolean}
|
|
1161
|
+
* @memberof ProductsResponse
|
|
1162
|
+
*/
|
|
1163
|
+
'hasMore': boolean;
|
|
1164
|
+
/**
|
|
1165
|
+
* This is the pagination token
|
|
1166
|
+
* @type {string}
|
|
1167
|
+
* @memberof ProductsResponse
|
|
1168
|
+
*/
|
|
1169
|
+
'nextToken'?: string;
|
|
1170
|
+
}
|
|
1171
|
+
/**
|
|
1172
|
+
*
|
|
1173
|
+
* @export
|
|
1174
|
+
* @interface Progress
|
|
1175
|
+
*/
|
|
1176
|
+
export interface Progress {
|
|
1177
|
+
/**
|
|
1178
|
+
*
|
|
1179
|
+
* @type {string}
|
|
1180
|
+
* @memberof Progress
|
|
1181
|
+
*/
|
|
1182
|
+
'id': string;
|
|
1183
|
+
/**
|
|
1184
|
+
*
|
|
1185
|
+
* @type {number}
|
|
1186
|
+
* @memberof Progress
|
|
1187
|
+
*/
|
|
1188
|
+
'value': number;
|
|
1189
|
+
/**
|
|
1190
|
+
*
|
|
1191
|
+
* @type {string}
|
|
1192
|
+
* @memberof Progress
|
|
1193
|
+
*/
|
|
1194
|
+
'value_mu': string;
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @type {{ [key: string]: number; }}
|
|
1198
|
+
* @memberof Progress
|
|
1199
|
+
*/
|
|
1200
|
+
'value_detailed'?: {
|
|
1201
|
+
[key: string]: number;
|
|
1202
|
+
};
|
|
1203
|
+
/**
|
|
1204
|
+
*
|
|
1205
|
+
* @type {ProgressState}
|
|
1206
|
+
* @memberof Progress
|
|
1207
|
+
*/
|
|
1208
|
+
'state': ProgressState;
|
|
1209
|
+
/**
|
|
1210
|
+
*
|
|
1211
|
+
* @type {string}
|
|
1212
|
+
* @memberof Progress
|
|
1213
|
+
*/
|
|
1214
|
+
'beneficiary': string;
|
|
1215
|
+
/**
|
|
1216
|
+
*
|
|
1217
|
+
* @type {number}
|
|
1218
|
+
* @memberof Progress
|
|
1219
|
+
*/
|
|
1220
|
+
'periodID'?: number;
|
|
1221
|
+
}
|
|
1222
|
+
/**
|
|
1223
|
+
*
|
|
1224
|
+
* @export
|
|
1225
|
+
* @interface ProgressResponse
|
|
1226
|
+
*/
|
|
1227
|
+
export interface ProgressResponse {
|
|
1228
|
+
/**
|
|
1229
|
+
*
|
|
1230
|
+
* @type {Array<Progress>}
|
|
1231
|
+
* @memberof ProgressResponse
|
|
1232
|
+
*/
|
|
1233
|
+
'data': Array<Progress>;
|
|
1234
|
+
/**
|
|
1235
|
+
* This is the pagination token
|
|
1236
|
+
* @type {string}
|
|
1237
|
+
* @memberof ProgressResponse
|
|
1238
|
+
*/
|
|
1239
|
+
'nextToken'?: string;
|
|
1240
|
+
}
|
|
1241
|
+
/**
|
|
1242
|
+
*
|
|
1243
|
+
* @export
|
|
1244
|
+
* @enum {string}
|
|
1245
|
+
*/
|
|
1246
|
+
export declare const ProgressState: {
|
|
1247
|
+
readonly Active: "active";
|
|
1248
|
+
readonly Pending: "pending";
|
|
1249
|
+
};
|
|
1250
|
+
export type ProgressState = typeof ProgressState[keyof typeof ProgressState];
|
|
1251
|
+
/**
|
|
1252
|
+
*
|
|
1253
|
+
* @export
|
|
1254
|
+
* @interface Promotion
|
|
1255
|
+
*/
|
|
1256
|
+
export interface Promotion {
|
|
1257
|
+
/**
|
|
1258
|
+
*
|
|
1259
|
+
* @type {string}
|
|
1260
|
+
* @memberof Promotion
|
|
1261
|
+
*/
|
|
1262
|
+
'id': string;
|
|
1263
|
+
/**
|
|
1264
|
+
*
|
|
1265
|
+
* @type {string}
|
|
1266
|
+
* @memberof Promotion
|
|
1267
|
+
*/
|
|
1268
|
+
'name': string;
|
|
1269
|
+
/**
|
|
1270
|
+
*
|
|
1271
|
+
* @type {string}
|
|
1272
|
+
* @memberof Promotion
|
|
1273
|
+
*/
|
|
1274
|
+
'description': string;
|
|
1275
|
+
/**
|
|
1276
|
+
*
|
|
1277
|
+
* @type {Beneficiary}
|
|
1278
|
+
* @memberof Promotion
|
|
1279
|
+
*/
|
|
1280
|
+
'beneficiary': Beneficiary;
|
|
1281
|
+
/**
|
|
1282
|
+
*
|
|
1283
|
+
* @type {Array<string>}
|
|
1284
|
+
* @memberof Promotion
|
|
1285
|
+
*/
|
|
1286
|
+
'beneficiaryIds': Array<string>;
|
|
1287
|
+
/**
|
|
1288
|
+
*
|
|
1289
|
+
* @type {Target}
|
|
1290
|
+
* @memberof Promotion
|
|
1291
|
+
*/
|
|
1292
|
+
'target': Target;
|
|
1293
|
+
/**
|
|
1294
|
+
*
|
|
1295
|
+
* @type {boolean}
|
|
1296
|
+
* @memberof Promotion
|
|
1297
|
+
*/
|
|
1298
|
+
'repeatable': boolean;
|
|
1299
|
+
/**
|
|
1300
|
+
*
|
|
1301
|
+
* @type {number}
|
|
1302
|
+
* @memberof Promotion
|
|
1303
|
+
*/
|
|
1304
|
+
'repeatCount'?: number;
|
|
1305
|
+
/**
|
|
1306
|
+
*
|
|
1307
|
+
* @type {Array<Segment>}
|
|
1308
|
+
* @memberof Promotion
|
|
1309
|
+
*/
|
|
1310
|
+
'segments': Array<Segment>;
|
|
1311
|
+
/**
|
|
1312
|
+
*
|
|
1313
|
+
* @type {Array<RuleGroup>}
|
|
1314
|
+
* @memberof Promotion
|
|
1315
|
+
*/
|
|
1316
|
+
'ruleGroups': Array<RuleGroup>;
|
|
1317
|
+
/**
|
|
1318
|
+
*
|
|
1319
|
+
* @type {RuleGroupState}
|
|
1320
|
+
* @memberof Promotion
|
|
1321
|
+
*/
|
|
1322
|
+
'ruleGroupsState'?: RuleGroupState;
|
|
1323
|
+
/**
|
|
1324
|
+
*
|
|
1325
|
+
* @type {string}
|
|
1326
|
+
* @memberof Promotion
|
|
1327
|
+
*/
|
|
1328
|
+
'brandLogoURL': string;
|
|
1329
|
+
/**
|
|
1330
|
+
*
|
|
1331
|
+
* @type {string}
|
|
1332
|
+
* @memberof Promotion
|
|
1333
|
+
*/
|
|
1334
|
+
'imageURL': string;
|
|
1335
|
+
/**
|
|
1336
|
+
*
|
|
1337
|
+
* @type {string}
|
|
1338
|
+
* @memberof Promotion
|
|
1339
|
+
*/
|
|
1340
|
+
'startAt': string;
|
|
1341
|
+
/**
|
|
1342
|
+
*
|
|
1343
|
+
* @type {string}
|
|
1344
|
+
* @memberof Promotion
|
|
1345
|
+
*/
|
|
1346
|
+
'endAt': string;
|
|
1347
|
+
/**
|
|
1348
|
+
*
|
|
1349
|
+
* @type {{ [key: string]: string; }}
|
|
1350
|
+
* @memberof Promotion
|
|
1351
|
+
*/
|
|
1352
|
+
'tags': {
|
|
1353
|
+
[key: string]: string;
|
|
1354
|
+
};
|
|
1355
|
+
/**
|
|
1356
|
+
*
|
|
1357
|
+
* @type {Repetition}
|
|
1358
|
+
* @memberof Promotion
|
|
1359
|
+
*/
|
|
1360
|
+
'repetition'?: Repetition;
|
|
1361
|
+
/**
|
|
1362
|
+
*
|
|
1363
|
+
* @type {string}
|
|
1364
|
+
* @memberof Promotion
|
|
1365
|
+
*/
|
|
1366
|
+
'createdAt': string;
|
|
1367
|
+
/**
|
|
1368
|
+
*
|
|
1369
|
+
* @type {string}
|
|
1370
|
+
* @memberof Promotion
|
|
1371
|
+
*/
|
|
1372
|
+
'updatedAt'?: string;
|
|
1373
|
+
/**
|
|
1374
|
+
*
|
|
1375
|
+
* @type {string}
|
|
1376
|
+
* @memberof Promotion
|
|
1377
|
+
*/
|
|
1378
|
+
'ownerID': string;
|
|
1379
|
+
/**
|
|
1380
|
+
*
|
|
1381
|
+
* @type {Array<Period>}
|
|
1382
|
+
* @memberof Promotion
|
|
1383
|
+
*/
|
|
1384
|
+
'periods'?: Array<Period>;
|
|
1385
|
+
/**
|
|
1386
|
+
*
|
|
1387
|
+
* @type {MetricsAggregation}
|
|
1388
|
+
* @memberof Promotion
|
|
1389
|
+
*/
|
|
1390
|
+
'metrics'?: MetricsAggregation;
|
|
1391
|
+
/**
|
|
1392
|
+
*
|
|
1393
|
+
* @type {PromotionType}
|
|
1394
|
+
* @memberof Promotion
|
|
1395
|
+
*/
|
|
1396
|
+
'type': PromotionType;
|
|
1397
|
+
}
|
|
1398
|
+
/**
|
|
1399
|
+
*
|
|
1400
|
+
* @export
|
|
1401
|
+
* @interface PromotionRequest
|
|
1402
|
+
*/
|
|
1403
|
+
export interface PromotionRequest {
|
|
1404
|
+
/**
|
|
1405
|
+
*
|
|
1406
|
+
* @type {string}
|
|
1407
|
+
* @memberof PromotionRequest
|
|
1408
|
+
*/
|
|
1409
|
+
'name': string;
|
|
1410
|
+
/**
|
|
1411
|
+
*
|
|
1412
|
+
* @type {string}
|
|
1413
|
+
* @memberof PromotionRequest
|
|
1414
|
+
*/
|
|
1415
|
+
'description': string;
|
|
1416
|
+
/**
|
|
1417
|
+
*
|
|
1418
|
+
* @type {Beneficiary}
|
|
1419
|
+
* @memberof PromotionRequest
|
|
1420
|
+
*/
|
|
1421
|
+
'beneficiary': Beneficiary;
|
|
1422
|
+
/**
|
|
1423
|
+
*
|
|
1424
|
+
* @type {Target}
|
|
1425
|
+
* @memberof PromotionRequest
|
|
1426
|
+
*/
|
|
1427
|
+
'target': Target;
|
|
1428
|
+
/**
|
|
1429
|
+
*
|
|
1430
|
+
* @type {boolean}
|
|
1431
|
+
* @memberof PromotionRequest
|
|
1432
|
+
*/
|
|
1433
|
+
'repeatable': boolean;
|
|
1434
|
+
/**
|
|
1435
|
+
*
|
|
1436
|
+
* @type {number}
|
|
1437
|
+
* @memberof PromotionRequest
|
|
1438
|
+
*/
|
|
1439
|
+
'repeatCount'?: number;
|
|
1440
|
+
/**
|
|
1441
|
+
*
|
|
1442
|
+
* @type {Array<Segment>}
|
|
1443
|
+
* @memberof PromotionRequest
|
|
1444
|
+
*/
|
|
1445
|
+
'segments': Array<Segment>;
|
|
1446
|
+
/**
|
|
1447
|
+
*
|
|
1448
|
+
* @type {Array<RuleGroup>}
|
|
1449
|
+
* @memberof PromotionRequest
|
|
1450
|
+
*/
|
|
1451
|
+
'ruleGroups': Array<RuleGroup>;
|
|
1452
|
+
/**
|
|
1453
|
+
*
|
|
1454
|
+
* @type {RuleGroupState}
|
|
1455
|
+
* @memberof PromotionRequest
|
|
1456
|
+
*/
|
|
1457
|
+
'ruleGroupsState': RuleGroupState;
|
|
1458
|
+
/**
|
|
1459
|
+
*
|
|
1460
|
+
* @type {string}
|
|
1461
|
+
* @memberof PromotionRequest
|
|
1462
|
+
*/
|
|
1463
|
+
'brandLogoURL': string;
|
|
1464
|
+
/**
|
|
1465
|
+
*
|
|
1466
|
+
* @type {string}
|
|
1467
|
+
* @memberof PromotionRequest
|
|
1468
|
+
*/
|
|
1469
|
+
'imageURL': string;
|
|
1470
|
+
/**
|
|
1471
|
+
*
|
|
1472
|
+
* @type {{ [key: string]: string; }}
|
|
1473
|
+
* @memberof PromotionRequest
|
|
1474
|
+
*/
|
|
1475
|
+
'tags': {
|
|
1476
|
+
[key: string]: string;
|
|
1477
|
+
};
|
|
1478
|
+
/**
|
|
1479
|
+
*
|
|
1480
|
+
* @type {Repetition}
|
|
1481
|
+
* @memberof PromotionRequest
|
|
1482
|
+
*/
|
|
1483
|
+
'repetition'?: Repetition;
|
|
1484
|
+
/**
|
|
1485
|
+
*
|
|
1486
|
+
* @type {string}
|
|
1487
|
+
* @memberof PromotionRequest
|
|
1488
|
+
*/
|
|
1489
|
+
'startAt': string;
|
|
1490
|
+
/**
|
|
1491
|
+
*
|
|
1492
|
+
* @type {string}
|
|
1493
|
+
* @memberof PromotionRequest
|
|
1494
|
+
*/
|
|
1495
|
+
'endAt': string;
|
|
1496
|
+
}
|
|
1497
|
+
/**
|
|
1498
|
+
*
|
|
1499
|
+
* @export
|
|
1500
|
+
* @enum {string}
|
|
1501
|
+
*/
|
|
1502
|
+
export declare const PromotionType: {
|
|
1503
|
+
readonly Regular: "regular";
|
|
1504
|
+
readonly CustomDeal: "custom_deal";
|
|
1505
|
+
};
|
|
1506
|
+
export type PromotionType = typeof PromotionType[keyof typeof PromotionType];
|
|
1507
|
+
/**
|
|
1508
|
+
*
|
|
1509
|
+
* @export
|
|
1510
|
+
* @interface PromotionsResponse
|
|
1511
|
+
*/
|
|
1512
|
+
export interface PromotionsResponse {
|
|
1513
|
+
/**
|
|
1514
|
+
*
|
|
1515
|
+
* @type {Array<Promotion>}
|
|
1516
|
+
* @memberof PromotionsResponse
|
|
1517
|
+
*/
|
|
1518
|
+
'promotions': Array<Promotion>;
|
|
1519
|
+
/**
|
|
1520
|
+
* This is the pagination token
|
|
1521
|
+
* @type {string}
|
|
1522
|
+
* @memberof PromotionsResponse
|
|
1523
|
+
*/
|
|
1524
|
+
'nextToken'?: string;
|
|
1525
|
+
}
|
|
1526
|
+
/**
|
|
1527
|
+
*
|
|
1528
|
+
* @export
|
|
1529
|
+
* @enum {string}
|
|
1530
|
+
*/
|
|
1531
|
+
export declare const ReceiverKind: {
|
|
1532
|
+
readonly User: "user";
|
|
1533
|
+
readonly Client: "client";
|
|
1534
|
+
};
|
|
1535
|
+
export type ReceiverKind = typeof ReceiverKind[keyof typeof ReceiverKind];
|
|
1536
|
+
/**
|
|
1537
|
+
*
|
|
1538
|
+
* @export
|
|
1539
|
+
* @enum {string}
|
|
1540
|
+
*/
|
|
1541
|
+
export declare const Repetition: {
|
|
1542
|
+
readonly Daily: "daily";
|
|
1543
|
+
readonly Weekly: "weekly";
|
|
1544
|
+
readonly Monthly: "monthly";
|
|
1545
|
+
};
|
|
1546
|
+
export type Repetition = typeof Repetition[keyof typeof Repetition];
|
|
1547
|
+
/**
|
|
1548
|
+
* @type Rule
|
|
1549
|
+
* @export
|
|
1550
|
+
*/
|
|
1551
|
+
export type Rule = {
|
|
1552
|
+
kind: 'tag';
|
|
1553
|
+
} & TagRule;
|
|
1554
|
+
/**
|
|
1555
|
+
*
|
|
1556
|
+
* @export
|
|
1557
|
+
* @interface RuleGroup
|
|
1558
|
+
*/
|
|
1559
|
+
export interface RuleGroup {
|
|
1560
|
+
/**
|
|
1561
|
+
*
|
|
1562
|
+
* @type {Array<Rule>}
|
|
1563
|
+
* @memberof RuleGroup
|
|
1564
|
+
*/
|
|
1565
|
+
'rules': Array<Rule>;
|
|
1566
|
+
/**
|
|
1567
|
+
*
|
|
1568
|
+
* @type {Target}
|
|
1569
|
+
* @memberof RuleGroup
|
|
1570
|
+
*/
|
|
1571
|
+
'target'?: Target;
|
|
1572
|
+
/**
|
|
1573
|
+
*
|
|
1574
|
+
* @type {string}
|
|
1575
|
+
* @memberof RuleGroup
|
|
1576
|
+
*/
|
|
1577
|
+
'id'?: string;
|
|
1578
|
+
}
|
|
1579
|
+
/**
|
|
1580
|
+
*
|
|
1581
|
+
* @export
|
|
1582
|
+
* @enum {string}
|
|
1583
|
+
*/
|
|
1584
|
+
export declare const RuleGroupState: {
|
|
1585
|
+
readonly Visible: "visible";
|
|
1586
|
+
readonly Hidden: "hidden";
|
|
1587
|
+
};
|
|
1588
|
+
export type RuleGroupState = typeof RuleGroupState[keyof typeof RuleGroupState];
|
|
1589
|
+
/**
|
|
1590
|
+
*
|
|
1591
|
+
* @export
|
|
1592
|
+
* @enum {string}
|
|
1593
|
+
*/
|
|
1594
|
+
export declare const RuleKind: {
|
|
1595
|
+
readonly Tag: "tag";
|
|
1596
|
+
};
|
|
1597
|
+
export type RuleKind = typeof RuleKind[keyof typeof RuleKind];
|
|
1598
|
+
/**
|
|
1599
|
+
*
|
|
1600
|
+
* @export
|
|
1601
|
+
* @interface SalesUserDetails
|
|
1602
|
+
*/
|
|
1603
|
+
export interface SalesUserDetails {
|
|
1604
|
+
/**
|
|
1605
|
+
*
|
|
1606
|
+
* @type {string}
|
|
1607
|
+
* @memberof SalesUserDetails
|
|
1608
|
+
*/
|
|
1609
|
+
'name': string;
|
|
1610
|
+
/**
|
|
1611
|
+
*
|
|
1612
|
+
* @type {string}
|
|
1613
|
+
* @memberof SalesUserDetails
|
|
1614
|
+
*/
|
|
1615
|
+
'email': string;
|
|
1616
|
+
/**
|
|
1617
|
+
*
|
|
1618
|
+
* @type {UserRole}
|
|
1619
|
+
* @memberof SalesUserDetails
|
|
1620
|
+
*/
|
|
1621
|
+
'role': UserRole;
|
|
1622
|
+
/**
|
|
1623
|
+
*
|
|
1624
|
+
* @type {string}
|
|
1625
|
+
* @memberof SalesUserDetails
|
|
1626
|
+
*/
|
|
1627
|
+
'departmentId'?: string;
|
|
1628
|
+
}
|
|
1629
|
+
/**
|
|
1630
|
+
*
|
|
1631
|
+
* @export
|
|
1632
|
+
* @interface Segment
|
|
1633
|
+
*/
|
|
1634
|
+
export interface Segment {
|
|
1635
|
+
/**
|
|
1636
|
+
*
|
|
1637
|
+
* @type {string}
|
|
1638
|
+
* @memberof Segment
|
|
1639
|
+
*/
|
|
1640
|
+
'id': string;
|
|
1641
|
+
/**
|
|
1642
|
+
*
|
|
1643
|
+
* @type {string}
|
|
1644
|
+
* @memberof Segment
|
|
1645
|
+
*/
|
|
1646
|
+
'alias': string;
|
|
1647
|
+
/**
|
|
1648
|
+
*
|
|
1649
|
+
* @type {string}
|
|
1650
|
+
* @memberof Segment
|
|
1651
|
+
*/
|
|
1652
|
+
'createdAt': string;
|
|
1653
|
+
/**
|
|
1654
|
+
*
|
|
1655
|
+
* @type {string}
|
|
1656
|
+
* @memberof Segment
|
|
1657
|
+
*/
|
|
1658
|
+
'updatedAt': string;
|
|
1659
|
+
/**
|
|
1660
|
+
*
|
|
1661
|
+
* @type {Array<Client>}
|
|
1662
|
+
* @memberof Segment
|
|
1663
|
+
*/
|
|
1664
|
+
'clients': Array<Client>;
|
|
1665
|
+
}
|
|
1666
|
+
/**
|
|
1667
|
+
*
|
|
1668
|
+
* @export
|
|
1669
|
+
* @interface SegmentCreationRequest
|
|
1670
|
+
*/
|
|
1671
|
+
export interface SegmentCreationRequest {
|
|
1672
|
+
/**
|
|
1673
|
+
*
|
|
1674
|
+
* @type {string}
|
|
1675
|
+
* @memberof SegmentCreationRequest
|
|
1676
|
+
*/
|
|
1677
|
+
'alias': string;
|
|
1678
|
+
/**
|
|
1679
|
+
*
|
|
1680
|
+
* @type {Array<string>}
|
|
1681
|
+
* @memberof SegmentCreationRequest
|
|
1682
|
+
*/
|
|
1683
|
+
'clients': Array<string>;
|
|
1684
|
+
}
|
|
1685
|
+
/**
|
|
1686
|
+
*
|
|
1687
|
+
* @export
|
|
1688
|
+
* @interface SegmentListResponse
|
|
1689
|
+
*/
|
|
1690
|
+
export interface SegmentListResponse {
|
|
1691
|
+
/**
|
|
1692
|
+
*
|
|
1693
|
+
* @type {Array<Segment>}
|
|
1694
|
+
* @memberof SegmentListResponse
|
|
1695
|
+
*/
|
|
1696
|
+
'segments': Array<Segment>;
|
|
1697
|
+
/**
|
|
1698
|
+
* This is the pagination token
|
|
1699
|
+
* @type {string}
|
|
1700
|
+
* @memberof SegmentListResponse
|
|
1701
|
+
*/
|
|
1702
|
+
'nextToken'?: string;
|
|
1703
|
+
/**
|
|
1704
|
+
*
|
|
1705
|
+
* @type {boolean}
|
|
1706
|
+
* @memberof SegmentListResponse
|
|
1707
|
+
*/
|
|
1708
|
+
'hasMore': boolean;
|
|
1709
|
+
}
|
|
1710
|
+
/**
|
|
1711
|
+
*
|
|
1712
|
+
* @export
|
|
1713
|
+
* @interface Tag
|
|
1714
|
+
*/
|
|
1715
|
+
export interface Tag {
|
|
1716
|
+
/**
|
|
1717
|
+
*
|
|
1718
|
+
* @type {string}
|
|
1719
|
+
* @memberof Tag
|
|
1720
|
+
*/
|
|
1721
|
+
'key': string;
|
|
1722
|
+
/**
|
|
1723
|
+
*
|
|
1724
|
+
* @type {TagDataType}
|
|
1725
|
+
* @memberof Tag
|
|
1726
|
+
*/
|
|
1727
|
+
'dataType': TagDataType;
|
|
1728
|
+
/**
|
|
1729
|
+
*
|
|
1730
|
+
* @type {boolean}
|
|
1731
|
+
* @memberof Tag
|
|
1732
|
+
*/
|
|
1733
|
+
'isRequired': boolean;
|
|
1734
|
+
/**
|
|
1735
|
+
*
|
|
1736
|
+
* @type {string}
|
|
1737
|
+
* @memberof Tag
|
|
1738
|
+
*/
|
|
1739
|
+
'createdAt': string;
|
|
1740
|
+
/**
|
|
1741
|
+
*
|
|
1742
|
+
* @type {string}
|
|
1743
|
+
* @memberof Tag
|
|
1744
|
+
*/
|
|
1745
|
+
'updatedAt': string;
|
|
1746
|
+
}
|
|
1747
|
+
/**
|
|
1748
|
+
*
|
|
1749
|
+
* @export
|
|
1750
|
+
* @interface TagCreationRequest
|
|
1751
|
+
*/
|
|
1752
|
+
export interface TagCreationRequest {
|
|
1753
|
+
/**
|
|
1754
|
+
*
|
|
1755
|
+
* @type {string}
|
|
1756
|
+
* @memberof TagCreationRequest
|
|
1757
|
+
*/
|
|
1758
|
+
'key': string;
|
|
1759
|
+
/**
|
|
1760
|
+
*
|
|
1761
|
+
* @type {TagDataType}
|
|
1762
|
+
* @memberof TagCreationRequest
|
|
1763
|
+
*/
|
|
1764
|
+
'dataType': TagDataType;
|
|
1765
|
+
/**
|
|
1766
|
+
*
|
|
1767
|
+
* @type {Array<TagValidator>}
|
|
1768
|
+
* @memberof TagCreationRequest
|
|
1769
|
+
*/
|
|
1770
|
+
'validators': Array<TagValidator>;
|
|
1771
|
+
/**
|
|
1772
|
+
*
|
|
1773
|
+
* @type {boolean}
|
|
1774
|
+
* @memberof TagCreationRequest
|
|
1775
|
+
*/
|
|
1776
|
+
'isRequired': boolean;
|
|
1777
|
+
}
|
|
1778
|
+
/**
|
|
1779
|
+
*
|
|
1780
|
+
* @export
|
|
1781
|
+
* @enum {string}
|
|
1782
|
+
*/
|
|
1783
|
+
export declare const TagDataType: {
|
|
1784
|
+
readonly Text: "text";
|
|
1785
|
+
readonly Number: "number";
|
|
1786
|
+
readonly Boolean: "boolean";
|
|
1787
|
+
readonly Date: "date";
|
|
1788
|
+
};
|
|
1789
|
+
export type TagDataType = typeof TagDataType[keyof typeof TagDataType];
|
|
1790
|
+
/**
|
|
1791
|
+
*
|
|
1792
|
+
* @export
|
|
1793
|
+
* @interface TagDetailed
|
|
1794
|
+
*/
|
|
1795
|
+
export interface TagDetailed {
|
|
1796
|
+
/**
|
|
1797
|
+
*
|
|
1798
|
+
* @type {string}
|
|
1799
|
+
* @memberof TagDetailed
|
|
1800
|
+
*/
|
|
1801
|
+
'key': string;
|
|
1802
|
+
/**
|
|
1803
|
+
*
|
|
1804
|
+
* @type {TagDataType}
|
|
1805
|
+
* @memberof TagDetailed
|
|
1806
|
+
*/
|
|
1807
|
+
'dataType': TagDataType;
|
|
1808
|
+
/**
|
|
1809
|
+
*
|
|
1810
|
+
* @type {boolean}
|
|
1811
|
+
* @memberof TagDetailed
|
|
1812
|
+
*/
|
|
1813
|
+
'isRequired': boolean;
|
|
1814
|
+
/**
|
|
1815
|
+
*
|
|
1816
|
+
* @type {string}
|
|
1817
|
+
* @memberof TagDetailed
|
|
1818
|
+
*/
|
|
1819
|
+
'createdAt': string;
|
|
1820
|
+
/**
|
|
1821
|
+
*
|
|
1822
|
+
* @type {string}
|
|
1823
|
+
* @memberof TagDetailed
|
|
1824
|
+
*/
|
|
1825
|
+
'updatedAt': string;
|
|
1826
|
+
/**
|
|
1827
|
+
*
|
|
1828
|
+
* @type {Array<TagValidator>}
|
|
1829
|
+
* @memberof TagDetailed
|
|
1830
|
+
*/
|
|
1831
|
+
'validators': Array<TagValidator>;
|
|
1832
|
+
}
|
|
1833
|
+
/**
|
|
1834
|
+
*
|
|
1835
|
+
* @export
|
|
1836
|
+
* @interface TagListResponse
|
|
1837
|
+
*/
|
|
1838
|
+
export interface TagListResponse {
|
|
1839
|
+
/**
|
|
1840
|
+
*
|
|
1841
|
+
* @type {Array<Tag>}
|
|
1842
|
+
* @memberof TagListResponse
|
|
1843
|
+
*/
|
|
1844
|
+
'system_tags': Array<Tag>;
|
|
1845
|
+
/**
|
|
1846
|
+
*
|
|
1847
|
+
* @type {Array<Tag>}
|
|
1848
|
+
* @memberof TagListResponse
|
|
1849
|
+
*/
|
|
1850
|
+
'custom_tags': Array<Tag>;
|
|
1851
|
+
}
|
|
1852
|
+
/**
|
|
1853
|
+
*
|
|
1854
|
+
* @export
|
|
1855
|
+
* @interface TagRule
|
|
1856
|
+
*/
|
|
1857
|
+
export interface TagRule {
|
|
1858
|
+
/**
|
|
1859
|
+
*
|
|
1860
|
+
* @type {RuleKind}
|
|
1861
|
+
* @memberof TagRule
|
|
1862
|
+
*/
|
|
1863
|
+
'kind': RuleKind;
|
|
1864
|
+
/**
|
|
1865
|
+
*
|
|
1866
|
+
* @type {string}
|
|
1867
|
+
* @memberof TagRule
|
|
1868
|
+
*/
|
|
1869
|
+
'tagKey': string;
|
|
1870
|
+
/**
|
|
1871
|
+
*
|
|
1872
|
+
* @type {Condition}
|
|
1873
|
+
* @memberof TagRule
|
|
1874
|
+
*/
|
|
1875
|
+
'condition': Condition;
|
|
1876
|
+
/**
|
|
1877
|
+
*
|
|
1878
|
+
* @type {boolean}
|
|
1879
|
+
* @memberof TagRule
|
|
1880
|
+
*/
|
|
1881
|
+
'isNegation'?: boolean;
|
|
1882
|
+
/**
|
|
1883
|
+
*
|
|
1884
|
+
* @type {TagRuleValue}
|
|
1885
|
+
* @memberof TagRule
|
|
1886
|
+
*/
|
|
1887
|
+
'value'?: TagRuleValue;
|
|
1888
|
+
}
|
|
1889
|
+
/**
|
|
1890
|
+
*
|
|
1891
|
+
* @export
|
|
1892
|
+
* @enum {string}
|
|
1893
|
+
*/
|
|
1894
|
+
export declare const TagRuleKind: {
|
|
1895
|
+
readonly String: "string";
|
|
1896
|
+
readonly Integer: "integer";
|
|
1897
|
+
readonly Boolean: "boolean";
|
|
1898
|
+
readonly Number: "number";
|
|
1899
|
+
readonly Array: "array";
|
|
1900
|
+
};
|
|
1901
|
+
export type TagRuleKind = typeof TagRuleKind[keyof typeof TagRuleKind];
|
|
1902
|
+
/**
|
|
1903
|
+
* @type TagRuleValue
|
|
1904
|
+
* @export
|
|
1905
|
+
*/
|
|
1906
|
+
export type TagRuleValue = {
|
|
1907
|
+
kind: 'array';
|
|
1908
|
+
} & TagRuleValueArray | {
|
|
1909
|
+
kind: 'boolean';
|
|
1910
|
+
} & TagRuleValueBoolean | {
|
|
1911
|
+
kind: 'integer';
|
|
1912
|
+
} & TagRuleValueInteger | {
|
|
1913
|
+
kind: 'number';
|
|
1914
|
+
} & TagRuleValueNumber | {
|
|
1915
|
+
kind: 'string';
|
|
1916
|
+
} & TagRuleValueString;
|
|
1917
|
+
/**
|
|
1918
|
+
*
|
|
1919
|
+
* @export
|
|
1920
|
+
* @interface TagRuleValueArray
|
|
1921
|
+
*/
|
|
1922
|
+
export interface TagRuleValueArray {
|
|
1923
|
+
/**
|
|
1924
|
+
*
|
|
1925
|
+
* @type {TagRuleKind}
|
|
1926
|
+
* @memberof TagRuleValueArray
|
|
1927
|
+
*/
|
|
1928
|
+
'kind': TagRuleKind;
|
|
1929
|
+
/**
|
|
1930
|
+
*
|
|
1931
|
+
* @type {Array<any>}
|
|
1932
|
+
* @memberof TagRuleValueArray
|
|
1933
|
+
*/
|
|
1934
|
+
'value': Array<any>;
|
|
1935
|
+
}
|
|
1936
|
+
/**
|
|
1937
|
+
*
|
|
1938
|
+
* @export
|
|
1939
|
+
* @interface TagRuleValueBoolean
|
|
1940
|
+
*/
|
|
1941
|
+
export interface TagRuleValueBoolean {
|
|
1942
|
+
/**
|
|
1943
|
+
*
|
|
1944
|
+
* @type {TagRuleKind}
|
|
1945
|
+
* @memberof TagRuleValueBoolean
|
|
1946
|
+
*/
|
|
1947
|
+
'kind': TagRuleKind;
|
|
1948
|
+
/**
|
|
1949
|
+
*
|
|
1950
|
+
* @type {boolean}
|
|
1951
|
+
* @memberof TagRuleValueBoolean
|
|
1952
|
+
*/
|
|
1953
|
+
'value': boolean;
|
|
1954
|
+
}
|
|
1955
|
+
/**
|
|
1956
|
+
*
|
|
1957
|
+
* @export
|
|
1958
|
+
* @interface TagRuleValueInteger
|
|
1959
|
+
*/
|
|
1960
|
+
export interface TagRuleValueInteger {
|
|
1961
|
+
/**
|
|
1962
|
+
*
|
|
1963
|
+
* @type {TagRuleKind}
|
|
1964
|
+
* @memberof TagRuleValueInteger
|
|
1965
|
+
*/
|
|
1966
|
+
'kind': TagRuleKind;
|
|
1967
|
+
/**
|
|
1968
|
+
*
|
|
1969
|
+
* @type {number}
|
|
1970
|
+
* @memberof TagRuleValueInteger
|
|
1971
|
+
*/
|
|
1972
|
+
'value': number;
|
|
1973
|
+
}
|
|
1974
|
+
/**
|
|
1975
|
+
*
|
|
1976
|
+
* @export
|
|
1977
|
+
* @interface TagRuleValueNumber
|
|
1978
|
+
*/
|
|
1979
|
+
export interface TagRuleValueNumber {
|
|
1980
|
+
/**
|
|
1981
|
+
*
|
|
1982
|
+
* @type {TagRuleKind}
|
|
1983
|
+
* @memberof TagRuleValueNumber
|
|
1984
|
+
*/
|
|
1985
|
+
'kind': TagRuleKind;
|
|
1986
|
+
/**
|
|
1987
|
+
*
|
|
1988
|
+
* @type {number}
|
|
1989
|
+
* @memberof TagRuleValueNumber
|
|
1990
|
+
*/
|
|
1991
|
+
'value': number;
|
|
1992
|
+
}
|
|
1993
|
+
/**
|
|
1994
|
+
*
|
|
1995
|
+
* @export
|
|
1996
|
+
* @interface TagRuleValueString
|
|
1997
|
+
*/
|
|
1998
|
+
export interface TagRuleValueString {
|
|
1999
|
+
/**
|
|
2000
|
+
*
|
|
2001
|
+
* @type {TagRuleKind}
|
|
2002
|
+
* @memberof TagRuleValueString
|
|
2003
|
+
*/
|
|
2004
|
+
'kind': TagRuleKind;
|
|
2005
|
+
/**
|
|
2006
|
+
*
|
|
2007
|
+
* @type {string}
|
|
2008
|
+
* @memberof TagRuleValueString
|
|
2009
|
+
*/
|
|
2010
|
+
'value': string;
|
|
2011
|
+
}
|
|
2012
|
+
/**
|
|
2013
|
+
*
|
|
2014
|
+
* @export
|
|
2015
|
+
* @interface TagValidator
|
|
2016
|
+
*/
|
|
2017
|
+
export interface TagValidator {
|
|
2018
|
+
/**
|
|
2019
|
+
*
|
|
2020
|
+
* @type {TagValidatorType}
|
|
2021
|
+
* @memberof TagValidator
|
|
2022
|
+
*/
|
|
2023
|
+
'type': TagValidatorType;
|
|
2024
|
+
/**
|
|
2025
|
+
*
|
|
2026
|
+
* @type {Array<any>}
|
|
2027
|
+
* @memberof TagValidator
|
|
2028
|
+
*/
|
|
2029
|
+
'params': Array<any>;
|
|
2030
|
+
}
|
|
2031
|
+
/**
|
|
2032
|
+
*
|
|
2033
|
+
* @export
|
|
2034
|
+
* @enum {string}
|
|
2035
|
+
*/
|
|
2036
|
+
export declare const TagValidatorType: {
|
|
2037
|
+
readonly Pattern: "pattern";
|
|
2038
|
+
readonly Range: "range";
|
|
2039
|
+
readonly FixedValues: "fixed_values";
|
|
2040
|
+
};
|
|
2041
|
+
export type TagValidatorType = typeof TagValidatorType[keyof typeof TagValidatorType];
|
|
2042
|
+
/**
|
|
2043
|
+
*
|
|
2044
|
+
* @export
|
|
2045
|
+
* @interface Target
|
|
2046
|
+
*/
|
|
2047
|
+
export interface Target {
|
|
2048
|
+
/**
|
|
2049
|
+
*
|
|
2050
|
+
* @type {TargetMu}
|
|
2051
|
+
* @memberof Target
|
|
2052
|
+
*/
|
|
2053
|
+
'targetMu': TargetMu;
|
|
2054
|
+
/**
|
|
2055
|
+
*
|
|
2056
|
+
* @type {Array<TargetLevel>}
|
|
2057
|
+
* @memberof Target
|
|
2058
|
+
*/
|
|
2059
|
+
'levels': Array<TargetLevel>;
|
|
2060
|
+
}
|
|
2061
|
+
/**
|
|
2062
|
+
*
|
|
2063
|
+
* @export
|
|
2064
|
+
* @interface TargetLevel
|
|
2065
|
+
*/
|
|
2066
|
+
export interface TargetLevel {
|
|
2067
|
+
/**
|
|
2068
|
+
*
|
|
2069
|
+
* @type {TargetValue}
|
|
2070
|
+
* @memberof TargetLevel
|
|
2071
|
+
*/
|
|
2072
|
+
'target': TargetValue;
|
|
2073
|
+
/**
|
|
2074
|
+
*
|
|
2075
|
+
* @type {BonusValue}
|
|
2076
|
+
* @memberof TargetLevel
|
|
2077
|
+
*/
|
|
2078
|
+
'bonus': BonusValue;
|
|
2079
|
+
}
|
|
2080
|
+
/**
|
|
2081
|
+
*
|
|
2082
|
+
* @export
|
|
2083
|
+
* @enum {string}
|
|
2084
|
+
*/
|
|
2085
|
+
export declare const TargetMu: {
|
|
2086
|
+
readonly Currency: "currency";
|
|
2087
|
+
readonly Product: "product";
|
|
2088
|
+
readonly Liter: "liter";
|
|
2089
|
+
};
|
|
2090
|
+
export type TargetMu = typeof TargetMu[keyof typeof TargetMu];
|
|
2091
|
+
/**
|
|
2092
|
+
*
|
|
2093
|
+
* @export
|
|
2094
|
+
* @interface TargetValue
|
|
2095
|
+
*/
|
|
2096
|
+
export interface TargetValue {
|
|
2097
|
+
/**
|
|
2098
|
+
*
|
|
2099
|
+
* @type {number}
|
|
2100
|
+
* @memberof TargetValue
|
|
2101
|
+
*/
|
|
2102
|
+
'value': number;
|
|
2103
|
+
/**
|
|
2104
|
+
*
|
|
2105
|
+
* @type {string}
|
|
2106
|
+
* @memberof TargetValue
|
|
2107
|
+
*/
|
|
2108
|
+
'currency'?: string;
|
|
2109
|
+
}
|
|
2110
|
+
/**
|
|
2111
|
+
*
|
|
2112
|
+
* @export
|
|
2113
|
+
* @interface Transaction
|
|
2114
|
+
*/
|
|
2115
|
+
export interface Transaction {
|
|
2116
|
+
/**
|
|
2117
|
+
*
|
|
2118
|
+
* @type {TransactionKind}
|
|
2119
|
+
* @memberof Transaction
|
|
2120
|
+
*/
|
|
2121
|
+
'kind': TransactionKind;
|
|
2122
|
+
/**
|
|
2123
|
+
*
|
|
2124
|
+
* @type {number}
|
|
2125
|
+
* @memberof Transaction
|
|
2126
|
+
*/
|
|
2127
|
+
'amount': number;
|
|
2128
|
+
/**
|
|
2129
|
+
*
|
|
2130
|
+
* @type {string}
|
|
2131
|
+
* @memberof Transaction
|
|
2132
|
+
*/
|
|
2133
|
+
'receiver': string;
|
|
2134
|
+
/**
|
|
2135
|
+
*
|
|
2136
|
+
* @type {string}
|
|
2137
|
+
* @memberof Transaction
|
|
2138
|
+
*/
|
|
2139
|
+
'createdAt': string;
|
|
2140
|
+
}
|
|
2141
|
+
/**
|
|
2142
|
+
*
|
|
2143
|
+
* @export
|
|
2144
|
+
* @enum {string}
|
|
2145
|
+
*/
|
|
2146
|
+
export declare const TransactionKind: {
|
|
2147
|
+
readonly Credit: "credit";
|
|
2148
|
+
readonly Debit: "debit";
|
|
2149
|
+
};
|
|
2150
|
+
export type TransactionKind = typeof TransactionKind[keyof typeof TransactionKind];
|
|
2151
|
+
/**
|
|
2152
|
+
*
|
|
2153
|
+
* @export
|
|
2154
|
+
* @interface TransactionsResponse
|
|
2155
|
+
*/
|
|
2156
|
+
export interface TransactionsResponse {
|
|
2157
|
+
/**
|
|
2158
|
+
*
|
|
2159
|
+
* @type {Array<Transaction>}
|
|
2160
|
+
* @memberof TransactionsResponse
|
|
2161
|
+
*/
|
|
2162
|
+
'transactions': Array<Transaction>;
|
|
2163
|
+
/**
|
|
2164
|
+
* This is the previous pagination token
|
|
2165
|
+
* @type {string}
|
|
2166
|
+
* @memberof TransactionsResponse
|
|
2167
|
+
*/
|
|
2168
|
+
'previousToken'?: string;
|
|
2169
|
+
/**
|
|
2170
|
+
* This is the pagination token
|
|
2171
|
+
* @type {string}
|
|
2172
|
+
* @memberof TransactionsResponse
|
|
2173
|
+
*/
|
|
2174
|
+
'nextToken'?: string;
|
|
2175
|
+
}
|
|
2176
|
+
/**
|
|
2177
|
+
*
|
|
2178
|
+
* @export
|
|
2179
|
+
* @interface UpdatePromotionRequest
|
|
2180
|
+
*/
|
|
2181
|
+
export interface UpdatePromotionRequest {
|
|
2182
|
+
/**
|
|
2183
|
+
*
|
|
2184
|
+
* @type {string}
|
|
2185
|
+
* @memberof UpdatePromotionRequest
|
|
2186
|
+
*/
|
|
2187
|
+
'name'?: string;
|
|
2188
|
+
/**
|
|
2189
|
+
*
|
|
2190
|
+
* @type {string}
|
|
2191
|
+
* @memberof UpdatePromotionRequest
|
|
2192
|
+
*/
|
|
2193
|
+
'description'?: string;
|
|
2194
|
+
/**
|
|
2195
|
+
*
|
|
2196
|
+
* @type {string}
|
|
2197
|
+
* @memberof UpdatePromotionRequest
|
|
2198
|
+
*/
|
|
2199
|
+
'brandLogoURL'?: string;
|
|
2200
|
+
/**
|
|
2201
|
+
*
|
|
2202
|
+
* @type {string}
|
|
2203
|
+
* @memberof UpdatePromotionRequest
|
|
2204
|
+
*/
|
|
2205
|
+
'imageURL'?: string;
|
|
2206
|
+
/**
|
|
2207
|
+
*
|
|
2208
|
+
* @type {string}
|
|
2209
|
+
* @memberof UpdatePromotionRequest
|
|
2210
|
+
*/
|
|
2211
|
+
'endAt'?: string;
|
|
2212
|
+
/**
|
|
2213
|
+
*
|
|
2214
|
+
* @type {string}
|
|
2215
|
+
* @memberof UpdatePromotionRequest
|
|
2216
|
+
*/
|
|
2217
|
+
'startAt'?: string;
|
|
2218
|
+
/**
|
|
2219
|
+
*
|
|
2220
|
+
* @type {Array<RuleGroup>}
|
|
2221
|
+
* @memberof UpdatePromotionRequest
|
|
2222
|
+
*/
|
|
2223
|
+
'ruleGroups'?: Array<RuleGroup>;
|
|
2224
|
+
/**
|
|
2225
|
+
*
|
|
2226
|
+
* @type {RuleGroupState}
|
|
2227
|
+
* @memberof UpdatePromotionRequest
|
|
2228
|
+
*/
|
|
2229
|
+
'ruleGroupsState'?: RuleGroupState;
|
|
2230
|
+
/**
|
|
2231
|
+
*
|
|
2232
|
+
* @type {Array<Segment>}
|
|
2233
|
+
* @memberof UpdatePromotionRequest
|
|
2234
|
+
*/
|
|
2235
|
+
'segments'?: Array<Segment>;
|
|
2236
|
+
/**
|
|
2237
|
+
*
|
|
2238
|
+
* @type {Target}
|
|
2239
|
+
* @memberof UpdatePromotionRequest
|
|
2240
|
+
*/
|
|
2241
|
+
'target'?: Target;
|
|
2242
|
+
/**
|
|
2243
|
+
*
|
|
2244
|
+
* @type {boolean}
|
|
2245
|
+
* @memberof UpdatePromotionRequest
|
|
2246
|
+
*/
|
|
2247
|
+
'repeatable'?: boolean;
|
|
2248
|
+
/**
|
|
2249
|
+
*
|
|
2250
|
+
* @type {number}
|
|
2251
|
+
* @memberof UpdatePromotionRequest
|
|
2252
|
+
*/
|
|
2253
|
+
'repeatCount'?: number;
|
|
2254
|
+
/**
|
|
2255
|
+
*
|
|
2256
|
+
* @type {Array<string>}
|
|
2257
|
+
* @memberof UpdatePromotionRequest
|
|
2258
|
+
*/
|
|
2259
|
+
'segmentIds'?: Array<string>;
|
|
2260
|
+
/**
|
|
2261
|
+
*
|
|
2262
|
+
* @type {{ [key: string]: string; }}
|
|
2263
|
+
* @memberof UpdatePromotionRequest
|
|
2264
|
+
*/
|
|
2265
|
+
'tags'?: {
|
|
2266
|
+
[key: string]: string;
|
|
2267
|
+
};
|
|
2268
|
+
/**
|
|
2269
|
+
*
|
|
2270
|
+
* @type {Repetition}
|
|
2271
|
+
* @memberof UpdatePromotionRequest
|
|
2272
|
+
*/
|
|
2273
|
+
'repetition'?: Repetition;
|
|
2274
|
+
}
|
|
2275
|
+
/**
|
|
2276
|
+
*
|
|
2277
|
+
* @export
|
|
2278
|
+
* @interface UploadURLResponse
|
|
2279
|
+
*/
|
|
2280
|
+
export interface UploadURLResponse {
|
|
2281
|
+
/**
|
|
2282
|
+
*
|
|
2283
|
+
* @type {string}
|
|
2284
|
+
* @memberof UploadURLResponse
|
|
2285
|
+
*/
|
|
2286
|
+
'uploadURL': string;
|
|
2287
|
+
/**
|
|
2288
|
+
*
|
|
2289
|
+
* @type {string}
|
|
2290
|
+
* @memberof UploadURLResponse
|
|
2291
|
+
*/
|
|
2292
|
+
'getURL': string;
|
|
2293
|
+
/**
|
|
2294
|
+
*
|
|
2295
|
+
* @type {{ [key: string]: string; }}
|
|
2296
|
+
* @memberof UploadURLResponse
|
|
2297
|
+
*/
|
|
2298
|
+
'additionalHeaders': {
|
|
2299
|
+
[key: string]: string;
|
|
2300
|
+
};
|
|
2301
|
+
}
|
|
2302
|
+
/**
|
|
2303
|
+
*
|
|
2304
|
+
* @export
|
|
2305
|
+
* @interface User
|
|
2306
|
+
*/
|
|
2307
|
+
export interface User {
|
|
2308
|
+
/**
|
|
2309
|
+
*
|
|
2310
|
+
* @type {string}
|
|
2311
|
+
* @memberof User
|
|
2312
|
+
*/
|
|
2313
|
+
'id': string;
|
|
2314
|
+
/**
|
|
2315
|
+
*
|
|
2316
|
+
* @type {string}
|
|
2317
|
+
* @memberof User
|
|
2318
|
+
*/
|
|
2319
|
+
'clientId'?: string;
|
|
2320
|
+
/**
|
|
2321
|
+
*
|
|
2322
|
+
* @type {string}
|
|
2323
|
+
* @memberof User
|
|
2324
|
+
*/
|
|
2325
|
+
'externalRef': string;
|
|
2326
|
+
/**
|
|
2327
|
+
*
|
|
2328
|
+
* @type {string}
|
|
2329
|
+
* @memberof User
|
|
2330
|
+
*/
|
|
2331
|
+
'source': string;
|
|
2332
|
+
/**
|
|
2333
|
+
*
|
|
2334
|
+
* @type {string}
|
|
2335
|
+
* @memberof User
|
|
2336
|
+
*/
|
|
2337
|
+
'createdAt': string;
|
|
2338
|
+
/**
|
|
2339
|
+
*
|
|
2340
|
+
* @type {string}
|
|
2341
|
+
* @memberof User
|
|
2342
|
+
*/
|
|
2343
|
+
'updatedAt': string;
|
|
2344
|
+
/**
|
|
2345
|
+
*
|
|
2346
|
+
* @type {UserDetails}
|
|
2347
|
+
* @memberof User
|
|
2348
|
+
*/
|
|
2349
|
+
'details': UserDetails;
|
|
2350
|
+
}
|
|
2351
|
+
/**
|
|
2352
|
+
* @type UserDetails
|
|
2353
|
+
* @export
|
|
2354
|
+
*/
|
|
2355
|
+
export type UserDetails = CustomeruserDetails | SalesUserDetails;
|
|
2356
|
+
/**
|
|
2357
|
+
*
|
|
2358
|
+
* @export
|
|
2359
|
+
* @interface UserListResponse
|
|
2360
|
+
*/
|
|
2361
|
+
export interface UserListResponse {
|
|
2362
|
+
/**
|
|
2363
|
+
*
|
|
2364
|
+
* @type {Array<User>}
|
|
2365
|
+
* @memberof UserListResponse
|
|
2366
|
+
*/
|
|
2367
|
+
'users': Array<User>;
|
|
2368
|
+
/**
|
|
2369
|
+
* This is the pagination token
|
|
2370
|
+
* @type {string}
|
|
2371
|
+
* @memberof UserListResponse
|
|
2372
|
+
*/
|
|
2373
|
+
'nextToken'?: string;
|
|
2374
|
+
/**
|
|
2375
|
+
*
|
|
2376
|
+
* @type {boolean}
|
|
2377
|
+
* @memberof UserListResponse
|
|
2378
|
+
*/
|
|
2379
|
+
'hasMore': boolean;
|
|
2380
|
+
}
|
|
2381
|
+
/**
|
|
2382
|
+
*
|
|
2383
|
+
* @export
|
|
2384
|
+
* @enum {string}
|
|
2385
|
+
*/
|
|
2386
|
+
export declare const UserRole: {
|
|
2387
|
+
readonly SystemAdmin: "systemAdmin";
|
|
2388
|
+
readonly SystemManager: "systemManager";
|
|
2389
|
+
readonly CustomerAdmin: "customerAdmin";
|
|
2390
|
+
readonly CustomerUser: "customerUser";
|
|
2391
|
+
};
|
|
2392
|
+
export type UserRole = typeof UserRole[keyof typeof UserRole];
|
|
2393
|
+
/**
|
|
2394
|
+
*
|
|
2395
|
+
* @export
|
|
2396
|
+
* @enum {string}
|
|
2397
|
+
*/
|
|
2398
|
+
export declare const UserSource: {
|
|
2399
|
+
readonly System: "system";
|
|
2400
|
+
readonly Customer: "customer";
|
|
2401
|
+
};
|
|
2402
|
+
export type UserSource = typeof UserSource[keyof typeof UserSource];
|
|
2403
|
+
/**
|
|
2404
|
+
*
|
|
2405
|
+
* @export
|
|
2406
|
+
* @interface Webhook
|
|
2407
|
+
*/
|
|
2408
|
+
export interface Webhook {
|
|
2409
|
+
/**
|
|
2410
|
+
*
|
|
2411
|
+
* @type {string}
|
|
2412
|
+
* @memberof Webhook
|
|
2413
|
+
*/
|
|
2414
|
+
'url': string;
|
|
2415
|
+
/**
|
|
2416
|
+
*
|
|
2417
|
+
* @type {WebhookKind}
|
|
2418
|
+
* @memberof Webhook
|
|
2419
|
+
*/
|
|
2420
|
+
'kind': WebhookKind;
|
|
2421
|
+
}
|
|
2422
|
+
/**
|
|
2423
|
+
*
|
|
2424
|
+
* @export
|
|
2425
|
+
* @enum {string}
|
|
2426
|
+
*/
|
|
2427
|
+
export declare const WebhookKind: {
|
|
2428
|
+
readonly Product: "product";
|
|
2429
|
+
};
|
|
2430
|
+
export type WebhookKind = typeof WebhookKind[keyof typeof WebhookKind];
|
|
2431
|
+
/**
|
|
2432
|
+
*
|
|
2433
|
+
* @export
|
|
2434
|
+
* @interface WebhooksResponse
|
|
2435
|
+
*/
|
|
2436
|
+
export interface WebhooksResponse {
|
|
2437
|
+
/**
|
|
2438
|
+
*
|
|
2439
|
+
* @type {Array<Webhook>}
|
|
2440
|
+
* @memberof WebhooksResponse
|
|
2441
|
+
*/
|
|
2442
|
+
'webhooks': Array<Webhook>;
|
|
2443
|
+
/**
|
|
2444
|
+
* This is the pagination token
|
|
2445
|
+
* @type {string}
|
|
2446
|
+
* @memberof WebhooksResponse
|
|
2447
|
+
*/
|
|
2448
|
+
'nextToken'?: string;
|
|
2449
|
+
}
|
|
2450
|
+
/**
|
|
2451
|
+
* AuditApi - axios parameter creator
|
|
2452
|
+
* @export
|
|
2453
|
+
*/
|
|
2454
|
+
export declare const AuditApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2455
|
+
/**
|
|
2456
|
+
* List all audit logs
|
|
2457
|
+
* @summary List audit logs for given object type and ID
|
|
2458
|
+
* @param {AuditLogObjectType} objectType object type
|
|
2459
|
+
* @param {string} objectID object ID
|
|
2460
|
+
* @param {*} [options] Override http request option.
|
|
2461
|
+
* @throws {RequiredError}
|
|
2462
|
+
*/
|
|
2463
|
+
listAuditLogs: (objectType: AuditLogObjectType, objectID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2464
|
+
/**
|
|
2465
|
+
* List all audit logs
|
|
2466
|
+
* @summary List audit logs for given object type and ID
|
|
2467
|
+
* @param {string} userID id of the user
|
|
2468
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2469
|
+
* @param {*} [options] Override http request option.
|
|
2470
|
+
* @throws {RequiredError}
|
|
2471
|
+
*/
|
|
2472
|
+
listUserAuditLogs: (userID: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2473
|
+
};
|
|
2474
|
+
/**
|
|
2475
|
+
* AuditApi - functional programming interface
|
|
2476
|
+
* @export
|
|
2477
|
+
*/
|
|
2478
|
+
export declare const AuditApiFp: (configuration?: Configuration) => {
|
|
2479
|
+
/**
|
|
2480
|
+
* List all audit logs
|
|
2481
|
+
* @summary List audit logs for given object type and ID
|
|
2482
|
+
* @param {AuditLogObjectType} objectType object type
|
|
2483
|
+
* @param {string} objectID object ID
|
|
2484
|
+
* @param {*} [options] Override http request option.
|
|
2485
|
+
* @throws {RequiredError}
|
|
2486
|
+
*/
|
|
2487
|
+
listAuditLogs(objectType: AuditLogObjectType, objectID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuditLogListResponse>>;
|
|
2488
|
+
/**
|
|
2489
|
+
* List all audit logs
|
|
2490
|
+
* @summary List audit logs for given object type and ID
|
|
2491
|
+
* @param {string} userID id of the user
|
|
2492
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2493
|
+
* @param {*} [options] Override http request option.
|
|
2494
|
+
* @throws {RequiredError}
|
|
2495
|
+
*/
|
|
2496
|
+
listUserAuditLogs(userID: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuditLogListResponse>>;
|
|
2497
|
+
};
|
|
2498
|
+
/**
|
|
2499
|
+
* AuditApi - factory interface
|
|
2500
|
+
* @export
|
|
2501
|
+
*/
|
|
2502
|
+
export declare const AuditApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2503
|
+
/**
|
|
2504
|
+
* List all audit logs
|
|
2505
|
+
* @summary List audit logs for given object type and ID
|
|
2506
|
+
* @param {AuditLogObjectType} objectType object type
|
|
2507
|
+
* @param {string} objectID object ID
|
|
2508
|
+
* @param {*} [options] Override http request option.
|
|
2509
|
+
* @throws {RequiredError}
|
|
2510
|
+
*/
|
|
2511
|
+
listAuditLogs(objectType: AuditLogObjectType, objectID: string, options?: any): AxiosPromise<AuditLogListResponse>;
|
|
2512
|
+
/**
|
|
2513
|
+
* List all audit logs
|
|
2514
|
+
* @summary List audit logs for given object type and ID
|
|
2515
|
+
* @param {string} userID id of the user
|
|
2516
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2517
|
+
* @param {*} [options] Override http request option.
|
|
2518
|
+
* @throws {RequiredError}
|
|
2519
|
+
*/
|
|
2520
|
+
listUserAuditLogs(userID: string, nextToken?: string, options?: any): AxiosPromise<AuditLogListResponse>;
|
|
2521
|
+
};
|
|
2522
|
+
/**
|
|
2523
|
+
* AuditApi - object-oriented interface
|
|
2524
|
+
* @export
|
|
2525
|
+
* @class AuditApi
|
|
2526
|
+
* @extends {BaseAPI}
|
|
2527
|
+
*/
|
|
2528
|
+
export declare class AuditApi extends BaseAPI {
|
|
2529
|
+
/**
|
|
2530
|
+
* List all audit logs
|
|
2531
|
+
* @summary List audit logs for given object type and ID
|
|
2532
|
+
* @param {AuditLogObjectType} objectType object type
|
|
2533
|
+
* @param {string} objectID object ID
|
|
2534
|
+
* @param {*} [options] Override http request option.
|
|
2535
|
+
* @throws {RequiredError}
|
|
2536
|
+
* @memberof AuditApi
|
|
2537
|
+
*/
|
|
2538
|
+
listAuditLogs(objectType: AuditLogObjectType, objectID: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuditLogListResponse, any>>;
|
|
2539
|
+
/**
|
|
2540
|
+
* List all audit logs
|
|
2541
|
+
* @summary List audit logs for given object type and ID
|
|
2542
|
+
* @param {string} userID id of the user
|
|
2543
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2544
|
+
* @param {*} [options] Override http request option.
|
|
2545
|
+
* @throws {RequiredError}
|
|
2546
|
+
* @memberof AuditApi
|
|
2547
|
+
*/
|
|
2548
|
+
listUserAuditLogs(userID: string, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuditLogListResponse, any>>;
|
|
2549
|
+
}
|
|
2550
|
+
/**
|
|
2551
|
+
* BalanceApi - axios parameter creator
|
|
2552
|
+
* @export
|
|
2553
|
+
*/
|
|
2554
|
+
export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2555
|
+
/**
|
|
2556
|
+
* Get balance
|
|
2557
|
+
* @summary Get balance
|
|
2558
|
+
* @param {string} receiver This is the receiver
|
|
2559
|
+
* @param {*} [options] Override http request option.
|
|
2560
|
+
* @throws {RequiredError}
|
|
2561
|
+
*/
|
|
2562
|
+
getBalance: (receiver: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2563
|
+
/**
|
|
2564
|
+
* Transfer balance
|
|
2565
|
+
* @summary Transfer balance
|
|
2566
|
+
* @param {string} receiverID ID of the receiver where we want to update balance.
|
|
2567
|
+
* @param {BalanceUpdateRequest} [balanceUpdateRequest]
|
|
2568
|
+
* @param {*} [options] Override http request option.
|
|
2569
|
+
* @throws {RequiredError}
|
|
2570
|
+
*/
|
|
2571
|
+
transferBalance: (receiverID: string, balanceUpdateRequest?: BalanceUpdateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2572
|
+
/**
|
|
2573
|
+
* Manually update balance. Used as manual compensation for out of stock products.
|
|
2574
|
+
* @summary Manually update balance
|
|
2575
|
+
* @param {string} receiverID ID of the receiver where we want to update balance.
|
|
2576
|
+
* @param {BalanceUpdateRequest} [balanceUpdateRequest]
|
|
2577
|
+
* @param {*} [options] Override http request option.
|
|
2578
|
+
* @throws {RequiredError}
|
|
2579
|
+
*/
|
|
2580
|
+
updateBalance: (receiverID: string, balanceUpdateRequest?: BalanceUpdateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2581
|
+
};
|
|
2582
|
+
/**
|
|
2583
|
+
* BalanceApi - functional programming interface
|
|
2584
|
+
* @export
|
|
2585
|
+
*/
|
|
2586
|
+
export declare const BalanceApiFp: (configuration?: Configuration) => {
|
|
2587
|
+
/**
|
|
2588
|
+
* Get balance
|
|
2589
|
+
* @summary Get balance
|
|
2590
|
+
* @param {string} receiver This is the receiver
|
|
2591
|
+
* @param {*} [options] Override http request option.
|
|
2592
|
+
* @throws {RequiredError}
|
|
2593
|
+
*/
|
|
2594
|
+
getBalance(receiver: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Balance>>;
|
|
2595
|
+
/**
|
|
2596
|
+
* Transfer balance
|
|
2597
|
+
* @summary Transfer balance
|
|
2598
|
+
* @param {string} receiverID ID of the receiver where we want to update balance.
|
|
2599
|
+
* @param {BalanceUpdateRequest} [balanceUpdateRequest]
|
|
2600
|
+
* @param {*} [options] Override http request option.
|
|
2601
|
+
* @throws {RequiredError}
|
|
2602
|
+
*/
|
|
2603
|
+
transferBalance(receiverID: string, balanceUpdateRequest?: BalanceUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2604
|
+
/**
|
|
2605
|
+
* Manually update balance. Used as manual compensation for out of stock products.
|
|
2606
|
+
* @summary Manually update balance
|
|
2607
|
+
* @param {string} receiverID ID of the receiver where we want to update balance.
|
|
2608
|
+
* @param {BalanceUpdateRequest} [balanceUpdateRequest]
|
|
2609
|
+
* @param {*} [options] Override http request option.
|
|
2610
|
+
* @throws {RequiredError}
|
|
2611
|
+
*/
|
|
2612
|
+
updateBalance(receiverID: string, balanceUpdateRequest?: BalanceUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2613
|
+
};
|
|
2614
|
+
/**
|
|
2615
|
+
* BalanceApi - factory interface
|
|
2616
|
+
* @export
|
|
2617
|
+
*/
|
|
2618
|
+
export declare const BalanceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2619
|
+
/**
|
|
2620
|
+
* Get balance
|
|
2621
|
+
* @summary Get balance
|
|
2622
|
+
* @param {string} receiver This is the receiver
|
|
2623
|
+
* @param {*} [options] Override http request option.
|
|
2624
|
+
* @throws {RequiredError}
|
|
2625
|
+
*/
|
|
2626
|
+
getBalance(receiver: string, options?: any): AxiosPromise<Balance>;
|
|
2627
|
+
/**
|
|
2628
|
+
* Transfer balance
|
|
2629
|
+
* @summary Transfer balance
|
|
2630
|
+
* @param {string} receiverID ID of the receiver where we want to update balance.
|
|
2631
|
+
* @param {BalanceUpdateRequest} [balanceUpdateRequest]
|
|
2632
|
+
* @param {*} [options] Override http request option.
|
|
2633
|
+
* @throws {RequiredError}
|
|
2634
|
+
*/
|
|
2635
|
+
transferBalance(receiverID: string, balanceUpdateRequest?: BalanceUpdateRequest, options?: any): AxiosPromise<void>;
|
|
2636
|
+
/**
|
|
2637
|
+
* Manually update balance. Used as manual compensation for out of stock products.
|
|
2638
|
+
* @summary Manually update balance
|
|
2639
|
+
* @param {string} receiverID ID of the receiver where we want to update balance.
|
|
2640
|
+
* @param {BalanceUpdateRequest} [balanceUpdateRequest]
|
|
2641
|
+
* @param {*} [options] Override http request option.
|
|
2642
|
+
* @throws {RequiredError}
|
|
2643
|
+
*/
|
|
2644
|
+
updateBalance(receiverID: string, balanceUpdateRequest?: BalanceUpdateRequest, options?: any): AxiosPromise<void>;
|
|
2645
|
+
};
|
|
2646
|
+
/**
|
|
2647
|
+
* BalanceApi - object-oriented interface
|
|
2648
|
+
* @export
|
|
2649
|
+
* @class BalanceApi
|
|
2650
|
+
* @extends {BaseAPI}
|
|
2651
|
+
*/
|
|
2652
|
+
export declare class BalanceApi extends BaseAPI {
|
|
2653
|
+
/**
|
|
2654
|
+
* Get balance
|
|
2655
|
+
* @summary Get balance
|
|
2656
|
+
* @param {string} receiver This is the receiver
|
|
2657
|
+
* @param {*} [options] Override http request option.
|
|
2658
|
+
* @throws {RequiredError}
|
|
2659
|
+
* @memberof BalanceApi
|
|
2660
|
+
*/
|
|
2661
|
+
getBalance(receiver: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance, any>>;
|
|
2662
|
+
/**
|
|
2663
|
+
* Transfer balance
|
|
2664
|
+
* @summary Transfer balance
|
|
2665
|
+
* @param {string} receiverID ID of the receiver where we want to update balance.
|
|
2666
|
+
* @param {BalanceUpdateRequest} [balanceUpdateRequest]
|
|
2667
|
+
* @param {*} [options] Override http request option.
|
|
2668
|
+
* @throws {RequiredError}
|
|
2669
|
+
* @memberof BalanceApi
|
|
2670
|
+
*/
|
|
2671
|
+
transferBalance(receiverID: string, balanceUpdateRequest?: BalanceUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2672
|
+
/**
|
|
2673
|
+
* Manually update balance. Used as manual compensation for out of stock products.
|
|
2674
|
+
* @summary Manually update balance
|
|
2675
|
+
* @param {string} receiverID ID of the receiver where we want to update balance.
|
|
2676
|
+
* @param {BalanceUpdateRequest} [balanceUpdateRequest]
|
|
2677
|
+
* @param {*} [options] Override http request option.
|
|
2678
|
+
* @throws {RequiredError}
|
|
2679
|
+
* @memberof BalanceApi
|
|
2680
|
+
*/
|
|
2681
|
+
updateBalance(receiverID: string, balanceUpdateRequest?: BalanceUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2682
|
+
}
|
|
2683
|
+
/**
|
|
2684
|
+
* ClientApi - axios parameter creator
|
|
2685
|
+
* @export
|
|
2686
|
+
*/
|
|
2687
|
+
export declare const ClientApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2688
|
+
/**
|
|
2689
|
+
* Create a new client
|
|
2690
|
+
* @summary Create client
|
|
2691
|
+
* @param {ClientCreationRequest} clientCreationRequest client data
|
|
2692
|
+
* @param {*} [options] Override http request option.
|
|
2693
|
+
* @throws {RequiredError}
|
|
2694
|
+
*/
|
|
2695
|
+
createClient: (clientCreationRequest: ClientCreationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2696
|
+
/**
|
|
2697
|
+
* Get client by ID
|
|
2698
|
+
* @summary Get client
|
|
2699
|
+
* @param {string} clientID client ID
|
|
2700
|
+
* @param {*} [options] Override http request option.
|
|
2701
|
+
* @throws {RequiredError}
|
|
2702
|
+
*/
|
|
2703
|
+
getClient: (clientID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2704
|
+
/**
|
|
2705
|
+
* List all clients
|
|
2706
|
+
* @summary List clients
|
|
2707
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2708
|
+
* @param {string} [search] search string
|
|
2709
|
+
* @param {*} [options] Override http request option.
|
|
2710
|
+
* @throws {RequiredError}
|
|
2711
|
+
*/
|
|
2712
|
+
listClients: (nextToken?: string, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2713
|
+
};
|
|
2714
|
+
/**
|
|
2715
|
+
* ClientApi - functional programming interface
|
|
2716
|
+
* @export
|
|
2717
|
+
*/
|
|
2718
|
+
export declare const ClientApiFp: (configuration?: Configuration) => {
|
|
2719
|
+
/**
|
|
2720
|
+
* Create a new client
|
|
2721
|
+
* @summary Create client
|
|
2722
|
+
* @param {ClientCreationRequest} clientCreationRequest client data
|
|
2723
|
+
* @param {*} [options] Override http request option.
|
|
2724
|
+
* @throws {RequiredError}
|
|
2725
|
+
*/
|
|
2726
|
+
createClient(clientCreationRequest: ClientCreationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Client>>;
|
|
2727
|
+
/**
|
|
2728
|
+
* Get client by ID
|
|
2729
|
+
* @summary Get client
|
|
2730
|
+
* @param {string} clientID client ID
|
|
2731
|
+
* @param {*} [options] Override http request option.
|
|
2732
|
+
* @throws {RequiredError}
|
|
2733
|
+
*/
|
|
2734
|
+
getClient(clientID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Client>>;
|
|
2735
|
+
/**
|
|
2736
|
+
* List all clients
|
|
2737
|
+
* @summary List clients
|
|
2738
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2739
|
+
* @param {string} [search] search string
|
|
2740
|
+
* @param {*} [options] Override http request option.
|
|
2741
|
+
* @throws {RequiredError}
|
|
2742
|
+
*/
|
|
2743
|
+
listClients(nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientListResponse>>;
|
|
2744
|
+
};
|
|
2745
|
+
/**
|
|
2746
|
+
* ClientApi - factory interface
|
|
2747
|
+
* @export
|
|
2748
|
+
*/
|
|
2749
|
+
export declare const ClientApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2750
|
+
/**
|
|
2751
|
+
* Create a new client
|
|
2752
|
+
* @summary Create client
|
|
2753
|
+
* @param {ClientCreationRequest} clientCreationRequest client data
|
|
2754
|
+
* @param {*} [options] Override http request option.
|
|
2755
|
+
* @throws {RequiredError}
|
|
2756
|
+
*/
|
|
2757
|
+
createClient(clientCreationRequest: ClientCreationRequest, options?: any): AxiosPromise<Client>;
|
|
2758
|
+
/**
|
|
2759
|
+
* Get client by ID
|
|
2760
|
+
* @summary Get client
|
|
2761
|
+
* @param {string} clientID client ID
|
|
2762
|
+
* @param {*} [options] Override http request option.
|
|
2763
|
+
* @throws {RequiredError}
|
|
2764
|
+
*/
|
|
2765
|
+
getClient(clientID: string, options?: any): AxiosPromise<Client>;
|
|
2766
|
+
/**
|
|
2767
|
+
* List all clients
|
|
2768
|
+
* @summary List clients
|
|
2769
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2770
|
+
* @param {string} [search] search string
|
|
2771
|
+
* @param {*} [options] Override http request option.
|
|
2772
|
+
* @throws {RequiredError}
|
|
2773
|
+
*/
|
|
2774
|
+
listClients(nextToken?: string, search?: string, options?: any): AxiosPromise<ClientListResponse>;
|
|
2775
|
+
};
|
|
2776
|
+
/**
|
|
2777
|
+
* ClientApi - object-oriented interface
|
|
2778
|
+
* @export
|
|
2779
|
+
* @class ClientApi
|
|
2780
|
+
* @extends {BaseAPI}
|
|
2781
|
+
*/
|
|
2782
|
+
export declare class ClientApi extends BaseAPI {
|
|
2783
|
+
/**
|
|
2784
|
+
* Create a new client
|
|
2785
|
+
* @summary Create client
|
|
2786
|
+
* @param {ClientCreationRequest} clientCreationRequest client data
|
|
2787
|
+
* @param {*} [options] Override http request option.
|
|
2788
|
+
* @throws {RequiredError}
|
|
2789
|
+
* @memberof ClientApi
|
|
2790
|
+
*/
|
|
2791
|
+
createClient(clientCreationRequest: ClientCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Client, any>>;
|
|
2792
|
+
/**
|
|
2793
|
+
* Get client by ID
|
|
2794
|
+
* @summary Get client
|
|
2795
|
+
* @param {string} clientID client ID
|
|
2796
|
+
* @param {*} [options] Override http request option.
|
|
2797
|
+
* @throws {RequiredError}
|
|
2798
|
+
* @memberof ClientApi
|
|
2799
|
+
*/
|
|
2800
|
+
getClient(clientID: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Client, any>>;
|
|
2801
|
+
/**
|
|
2802
|
+
* List all clients
|
|
2803
|
+
* @summary List clients
|
|
2804
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2805
|
+
* @param {string} [search] search string
|
|
2806
|
+
* @param {*} [options] Override http request option.
|
|
2807
|
+
* @throws {RequiredError}
|
|
2808
|
+
* @memberof ClientApi
|
|
2809
|
+
*/
|
|
2810
|
+
listClients(nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientListResponse, any>>;
|
|
2811
|
+
}
|
|
2812
|
+
/**
|
|
2813
|
+
* ConfigurationApi - axios parameter creator
|
|
2814
|
+
* @export
|
|
2815
|
+
*/
|
|
2816
|
+
export declare const ConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2817
|
+
/**
|
|
2818
|
+
* Create a new configuration
|
|
2819
|
+
* @summary Create configuration
|
|
2820
|
+
* @param {BackofficeConfig} backofficeConfig configuration data
|
|
2821
|
+
* @param {*} [options] Override http request option.
|
|
2822
|
+
* @throws {RequiredError}
|
|
2823
|
+
*/
|
|
2824
|
+
createConfiguration: (backofficeConfig: BackofficeConfig, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2825
|
+
/**
|
|
2826
|
+
* List all configurations
|
|
2827
|
+
* @summary List configurations
|
|
2828
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2829
|
+
* @param {string} [search] search string
|
|
2830
|
+
* @param {*} [options] Override http request option.
|
|
2831
|
+
* @throws {RequiredError}
|
|
2832
|
+
*/
|
|
2833
|
+
listConfigurations: (nextToken?: string, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2834
|
+
};
|
|
2835
|
+
/**
|
|
2836
|
+
* ConfigurationApi - functional programming interface
|
|
2837
|
+
* @export
|
|
2838
|
+
*/
|
|
2839
|
+
export declare const ConfigurationApiFp: (configuration?: Configuration) => {
|
|
2840
|
+
/**
|
|
2841
|
+
* Create a new configuration
|
|
2842
|
+
* @summary Create configuration
|
|
2843
|
+
* @param {BackofficeConfig} backofficeConfig configuration data
|
|
2844
|
+
* @param {*} [options] Override http request option.
|
|
2845
|
+
* @throws {RequiredError}
|
|
2846
|
+
*/
|
|
2847
|
+
createConfiguration(backofficeConfig: BackofficeConfig, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2848
|
+
/**
|
|
2849
|
+
* List all configurations
|
|
2850
|
+
* @summary List configurations
|
|
2851
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2852
|
+
* @param {string} [search] search string
|
|
2853
|
+
* @param {*} [options] Override http request option.
|
|
2854
|
+
* @throws {RequiredError}
|
|
2855
|
+
*/
|
|
2856
|
+
listConfigurations(nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BackofficeConfig>>;
|
|
2857
|
+
};
|
|
2858
|
+
/**
|
|
2859
|
+
* ConfigurationApi - factory interface
|
|
2860
|
+
* @export
|
|
2861
|
+
*/
|
|
2862
|
+
export declare const ConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2863
|
+
/**
|
|
2864
|
+
* Create a new configuration
|
|
2865
|
+
* @summary Create configuration
|
|
2866
|
+
* @param {BackofficeConfig} backofficeConfig configuration data
|
|
2867
|
+
* @param {*} [options] Override http request option.
|
|
2868
|
+
* @throws {RequiredError}
|
|
2869
|
+
*/
|
|
2870
|
+
createConfiguration(backofficeConfig: BackofficeConfig, options?: any): AxiosPromise<void>;
|
|
2871
|
+
/**
|
|
2872
|
+
* List all configurations
|
|
2873
|
+
* @summary List configurations
|
|
2874
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2875
|
+
* @param {string} [search] search string
|
|
2876
|
+
* @param {*} [options] Override http request option.
|
|
2877
|
+
* @throws {RequiredError}
|
|
2878
|
+
*/
|
|
2879
|
+
listConfigurations(nextToken?: string, search?: string, options?: any): AxiosPromise<BackofficeConfig>;
|
|
2880
|
+
};
|
|
2881
|
+
/**
|
|
2882
|
+
* ConfigurationApi - object-oriented interface
|
|
2883
|
+
* @export
|
|
2884
|
+
* @class ConfigurationApi
|
|
2885
|
+
* @extends {BaseAPI}
|
|
2886
|
+
*/
|
|
2887
|
+
export declare class ConfigurationApi extends BaseAPI {
|
|
2888
|
+
/**
|
|
2889
|
+
* Create a new configuration
|
|
2890
|
+
* @summary Create configuration
|
|
2891
|
+
* @param {BackofficeConfig} backofficeConfig configuration data
|
|
2892
|
+
* @param {*} [options] Override http request option.
|
|
2893
|
+
* @throws {RequiredError}
|
|
2894
|
+
* @memberof ConfigurationApi
|
|
2895
|
+
*/
|
|
2896
|
+
createConfiguration(backofficeConfig: BackofficeConfig, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2897
|
+
/**
|
|
2898
|
+
* List all configurations
|
|
2899
|
+
* @summary List configurations
|
|
2900
|
+
* @param {string} [nextToken] This is the pagination token
|
|
2901
|
+
* @param {string} [search] search string
|
|
2902
|
+
* @param {*} [options] Override http request option.
|
|
2903
|
+
* @throws {RequiredError}
|
|
2904
|
+
* @memberof ConfigurationApi
|
|
2905
|
+
*/
|
|
2906
|
+
listConfigurations(nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BackofficeConfig, any>>;
|
|
2907
|
+
}
|
|
2908
|
+
/**
|
|
2909
|
+
* CustomDealsApi - axios parameter creator
|
|
2910
|
+
* @export
|
|
2911
|
+
*/
|
|
2912
|
+
export declare const CustomDealsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2913
|
+
/**
|
|
2914
|
+
* Create custom deal restrictions
|
|
2915
|
+
* @summary Create custom deal restrictions
|
|
2916
|
+
* @param {CustomDealRestrictionRequest} customDealRestrictionRequest Custom deal restrictions
|
|
2917
|
+
* @param {*} [options] Override http request option.
|
|
2918
|
+
* @throws {RequiredError}
|
|
2919
|
+
*/
|
|
2920
|
+
createCustomDealRestrictions: (customDealRestrictionRequest: CustomDealRestrictionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2921
|
+
/**
|
|
2922
|
+
* List custom deal restrictions
|
|
2923
|
+
* @summary List custom deal restrictions
|
|
2924
|
+
* @param {*} [options] Override http request option.
|
|
2925
|
+
* @throws {RequiredError}
|
|
2926
|
+
*/
|
|
2927
|
+
listCustomDealRestrictions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2928
|
+
};
|
|
2929
|
+
/**
|
|
2930
|
+
* CustomDealsApi - functional programming interface
|
|
2931
|
+
* @export
|
|
2932
|
+
*/
|
|
2933
|
+
export declare const CustomDealsApiFp: (configuration?: Configuration) => {
|
|
2934
|
+
/**
|
|
2935
|
+
* Create custom deal restrictions
|
|
2936
|
+
* @summary Create custom deal restrictions
|
|
2937
|
+
* @param {CustomDealRestrictionRequest} customDealRestrictionRequest Custom deal restrictions
|
|
2938
|
+
* @param {*} [options] Override http request option.
|
|
2939
|
+
* @throws {RequiredError}
|
|
2940
|
+
*/
|
|
2941
|
+
createCustomDealRestrictions(customDealRestrictionRequest: CustomDealRestrictionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2942
|
+
/**
|
|
2943
|
+
* List custom deal restrictions
|
|
2944
|
+
* @summary List custom deal restrictions
|
|
2945
|
+
* @param {*} [options] Override http request option.
|
|
2946
|
+
* @throws {RequiredError}
|
|
2947
|
+
*/
|
|
2948
|
+
listCustomDealRestrictions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomDealRestrictionsResponse>>;
|
|
2949
|
+
};
|
|
2950
|
+
/**
|
|
2951
|
+
* CustomDealsApi - factory interface
|
|
2952
|
+
* @export
|
|
2953
|
+
*/
|
|
2954
|
+
export declare const CustomDealsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2955
|
+
/**
|
|
2956
|
+
* Create custom deal restrictions
|
|
2957
|
+
* @summary Create custom deal restrictions
|
|
2958
|
+
* @param {CustomDealRestrictionRequest} customDealRestrictionRequest Custom deal restrictions
|
|
2959
|
+
* @param {*} [options] Override http request option.
|
|
2960
|
+
* @throws {RequiredError}
|
|
2961
|
+
*/
|
|
2962
|
+
createCustomDealRestrictions(customDealRestrictionRequest: CustomDealRestrictionRequest, options?: any): AxiosPromise<void>;
|
|
2963
|
+
/**
|
|
2964
|
+
* List custom deal restrictions
|
|
2965
|
+
* @summary List custom deal restrictions
|
|
2966
|
+
* @param {*} [options] Override http request option.
|
|
2967
|
+
* @throws {RequiredError}
|
|
2968
|
+
*/
|
|
2969
|
+
listCustomDealRestrictions(options?: any): AxiosPromise<CustomDealRestrictionsResponse>;
|
|
2970
|
+
};
|
|
2971
|
+
/**
|
|
2972
|
+
* CustomDealsApi - object-oriented interface
|
|
2973
|
+
* @export
|
|
2974
|
+
* @class CustomDealsApi
|
|
2975
|
+
* @extends {BaseAPI}
|
|
2976
|
+
*/
|
|
2977
|
+
export declare class CustomDealsApi extends BaseAPI {
|
|
2978
|
+
/**
|
|
2979
|
+
* Create custom deal restrictions
|
|
2980
|
+
* @summary Create custom deal restrictions
|
|
2981
|
+
* @param {CustomDealRestrictionRequest} customDealRestrictionRequest Custom deal restrictions
|
|
2982
|
+
* @param {*} [options] Override http request option.
|
|
2983
|
+
* @throws {RequiredError}
|
|
2984
|
+
* @memberof CustomDealsApi
|
|
2985
|
+
*/
|
|
2986
|
+
createCustomDealRestrictions(customDealRestrictionRequest: CustomDealRestrictionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2987
|
+
/**
|
|
2988
|
+
* List custom deal restrictions
|
|
2989
|
+
* @summary List custom deal restrictions
|
|
2990
|
+
* @param {*} [options] Override http request option.
|
|
2991
|
+
* @throws {RequiredError}
|
|
2992
|
+
* @memberof CustomDealsApi
|
|
2993
|
+
*/
|
|
2994
|
+
listCustomDealRestrictions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomDealRestrictionsResponse, any>>;
|
|
2995
|
+
}
|
|
2996
|
+
/**
|
|
2997
|
+
* DefaultApi - axios parameter creator
|
|
2998
|
+
* @export
|
|
2999
|
+
*/
|
|
3000
|
+
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3001
|
+
/**
|
|
3002
|
+
* Generate a new API key, if one already exists it will be rotated, but the old one will still be valid for a short period of time. Important that API key is only returned once, so make sure to store it securely.
|
|
3003
|
+
* @summary Generate API key for the current tenant
|
|
3004
|
+
* @param {*} [options] Override http request option.
|
|
3005
|
+
* @throws {RequiredError}
|
|
3006
|
+
*/
|
|
3007
|
+
generateApiKey: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3008
|
+
/**
|
|
3009
|
+
* Import events to the system to be processed
|
|
3010
|
+
* @summary Add event
|
|
3011
|
+
* @param {Array<EventCreationRequest>} eventCreationRequest Entities
|
|
3012
|
+
* @param {*} [options] Override http request option.
|
|
3013
|
+
* @throws {RequiredError}
|
|
3014
|
+
*/
|
|
3015
|
+
importEvent: (eventCreationRequest: Array<EventCreationRequest>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3016
|
+
/**
|
|
3017
|
+
* List all webhooks for current tenant
|
|
3018
|
+
* @summary List webhooks
|
|
3019
|
+
* @param {*} [options] Override http request option.
|
|
3020
|
+
* @throws {RequiredError}
|
|
3021
|
+
*/
|
|
3022
|
+
listWebhooks: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3023
|
+
/**
|
|
3024
|
+
* Set up webhook url for a given integration
|
|
3025
|
+
* @summary Update webhook
|
|
3026
|
+
* @param {Webhook} webhook webhook data
|
|
3027
|
+
* @param {*} [options] Override http request option.
|
|
3028
|
+
* @throws {RequiredError}
|
|
3029
|
+
*/
|
|
3030
|
+
setWebhook: (webhook: Webhook, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3031
|
+
/**
|
|
3032
|
+
* Test API key security scheme
|
|
3033
|
+
* @summary Test API key security scheme
|
|
3034
|
+
* @param {*} [options] Override http request option.
|
|
3035
|
+
* @throws {RequiredError}
|
|
3036
|
+
*/
|
|
3037
|
+
testApiKey: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3038
|
+
};
|
|
3039
|
+
/**
|
|
3040
|
+
* DefaultApi - functional programming interface
|
|
3041
|
+
* @export
|
|
3042
|
+
*/
|
|
3043
|
+
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
3044
|
+
/**
|
|
3045
|
+
* Generate a new API key, if one already exists it will be rotated, but the old one will still be valid for a short period of time. Important that API key is only returned once, so make sure to store it securely.
|
|
3046
|
+
* @summary Generate API key for the current tenant
|
|
3047
|
+
* @param {*} [options] Override http request option.
|
|
3048
|
+
* @throws {RequiredError}
|
|
3049
|
+
*/
|
|
3050
|
+
generateApiKey(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKey>>;
|
|
3051
|
+
/**
|
|
3052
|
+
* Import events to the system to be processed
|
|
3053
|
+
* @summary Add event
|
|
3054
|
+
* @param {Array<EventCreationRequest>} eventCreationRequest Entities
|
|
3055
|
+
* @param {*} [options] Override http request option.
|
|
3056
|
+
* @throws {RequiredError}
|
|
3057
|
+
*/
|
|
3058
|
+
importEvent(eventCreationRequest: Array<EventCreationRequest>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3059
|
+
/**
|
|
3060
|
+
* List all webhooks for current tenant
|
|
3061
|
+
* @summary List webhooks
|
|
3062
|
+
* @param {*} [options] Override http request option.
|
|
3063
|
+
* @throws {RequiredError}
|
|
3064
|
+
*/
|
|
3065
|
+
listWebhooks(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhooksResponse>>;
|
|
3066
|
+
/**
|
|
3067
|
+
* Set up webhook url for a given integration
|
|
3068
|
+
* @summary Update webhook
|
|
3069
|
+
* @param {Webhook} webhook webhook data
|
|
3070
|
+
* @param {*} [options] Override http request option.
|
|
3071
|
+
* @throws {RequiredError}
|
|
3072
|
+
*/
|
|
3073
|
+
setWebhook(webhook: Webhook, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3074
|
+
/**
|
|
3075
|
+
* Test API key security scheme
|
|
3076
|
+
* @summary Test API key security scheme
|
|
3077
|
+
* @param {*} [options] Override http request option.
|
|
3078
|
+
* @throws {RequiredError}
|
|
3079
|
+
*/
|
|
3080
|
+
testApiKey(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3081
|
+
};
|
|
3082
|
+
/**
|
|
3083
|
+
* DefaultApi - factory interface
|
|
3084
|
+
* @export
|
|
3085
|
+
*/
|
|
3086
|
+
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3087
|
+
/**
|
|
3088
|
+
* Generate a new API key, if one already exists it will be rotated, but the old one will still be valid for a short period of time. Important that API key is only returned once, so make sure to store it securely.
|
|
3089
|
+
* @summary Generate API key for the current tenant
|
|
3090
|
+
* @param {*} [options] Override http request option.
|
|
3091
|
+
* @throws {RequiredError}
|
|
3092
|
+
*/
|
|
3093
|
+
generateApiKey(options?: any): AxiosPromise<ApiKey>;
|
|
3094
|
+
/**
|
|
3095
|
+
* Import events to the system to be processed
|
|
3096
|
+
* @summary Add event
|
|
3097
|
+
* @param {Array<EventCreationRequest>} eventCreationRequest Entities
|
|
3098
|
+
* @param {*} [options] Override http request option.
|
|
3099
|
+
* @throws {RequiredError}
|
|
3100
|
+
*/
|
|
3101
|
+
importEvent(eventCreationRequest: Array<EventCreationRequest>, options?: any): AxiosPromise<void>;
|
|
3102
|
+
/**
|
|
3103
|
+
* List all webhooks for current tenant
|
|
3104
|
+
* @summary List webhooks
|
|
3105
|
+
* @param {*} [options] Override http request option.
|
|
3106
|
+
* @throws {RequiredError}
|
|
3107
|
+
*/
|
|
3108
|
+
listWebhooks(options?: any): AxiosPromise<WebhooksResponse>;
|
|
3109
|
+
/**
|
|
3110
|
+
* Set up webhook url for a given integration
|
|
3111
|
+
* @summary Update webhook
|
|
3112
|
+
* @param {Webhook} webhook webhook data
|
|
3113
|
+
* @param {*} [options] Override http request option.
|
|
3114
|
+
* @throws {RequiredError}
|
|
3115
|
+
*/
|
|
3116
|
+
setWebhook(webhook: Webhook, options?: any): AxiosPromise<void>;
|
|
3117
|
+
/**
|
|
3118
|
+
* Test API key security scheme
|
|
3119
|
+
* @summary Test API key security scheme
|
|
3120
|
+
* @param {*} [options] Override http request option.
|
|
3121
|
+
* @throws {RequiredError}
|
|
3122
|
+
*/
|
|
3123
|
+
testApiKey(options?: any): AxiosPromise<void>;
|
|
3124
|
+
};
|
|
3125
|
+
/**
|
|
3126
|
+
* DefaultApi - object-oriented interface
|
|
3127
|
+
* @export
|
|
3128
|
+
* @class DefaultApi
|
|
3129
|
+
* @extends {BaseAPI}
|
|
3130
|
+
*/
|
|
3131
|
+
export declare class DefaultApi extends BaseAPI {
|
|
3132
|
+
/**
|
|
3133
|
+
* Generate a new API key, if one already exists it will be rotated, but the old one will still be valid for a short period of time. Important that API key is only returned once, so make sure to store it securely.
|
|
3134
|
+
* @summary Generate API key for the current tenant
|
|
3135
|
+
* @param {*} [options] Override http request option.
|
|
3136
|
+
* @throws {RequiredError}
|
|
3137
|
+
* @memberof DefaultApi
|
|
3138
|
+
*/
|
|
3139
|
+
generateApiKey(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKey, any>>;
|
|
3140
|
+
/**
|
|
3141
|
+
* Import events to the system to be processed
|
|
3142
|
+
* @summary Add event
|
|
3143
|
+
* @param {Array<EventCreationRequest>} eventCreationRequest Entities
|
|
3144
|
+
* @param {*} [options] Override http request option.
|
|
3145
|
+
* @throws {RequiredError}
|
|
3146
|
+
* @memberof DefaultApi
|
|
3147
|
+
*/
|
|
3148
|
+
importEvent(eventCreationRequest: Array<EventCreationRequest>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3149
|
+
/**
|
|
3150
|
+
* List all webhooks for current tenant
|
|
3151
|
+
* @summary List webhooks
|
|
3152
|
+
* @param {*} [options] Override http request option.
|
|
3153
|
+
* @throws {RequiredError}
|
|
3154
|
+
* @memberof DefaultApi
|
|
3155
|
+
*/
|
|
3156
|
+
listWebhooks(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhooksResponse, any>>;
|
|
3157
|
+
/**
|
|
3158
|
+
* Set up webhook url for a given integration
|
|
3159
|
+
* @summary Update webhook
|
|
3160
|
+
* @param {Webhook} webhook webhook data
|
|
3161
|
+
* @param {*} [options] Override http request option.
|
|
3162
|
+
* @throws {RequiredError}
|
|
3163
|
+
* @memberof DefaultApi
|
|
3164
|
+
*/
|
|
3165
|
+
setWebhook(webhook: Webhook, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3166
|
+
/**
|
|
3167
|
+
* Test API key security scheme
|
|
3168
|
+
* @summary Test API key security scheme
|
|
3169
|
+
* @param {*} [options] Override http request option.
|
|
3170
|
+
* @throws {RequiredError}
|
|
3171
|
+
* @memberof DefaultApi
|
|
3172
|
+
*/
|
|
3173
|
+
testApiKey(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3174
|
+
}
|
|
3175
|
+
/**
|
|
3176
|
+
* NotificationApi - axios parameter creator
|
|
3177
|
+
* @export
|
|
3178
|
+
*/
|
|
3179
|
+
export declare const NotificationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3180
|
+
/**
|
|
3181
|
+
* Marks all notifications as read for the authenticated user
|
|
3182
|
+
* @summary Mark all notifications as read
|
|
3183
|
+
* @param {BulkNotificationsReadRequest} bulkNotificationsReadRequest ids of the notifications to be set as product
|
|
3184
|
+
* @param {*} [options] Override http request option.
|
|
3185
|
+
* @throws {RequiredError}
|
|
3186
|
+
*/
|
|
3187
|
+
bulkMarkNotificationAsRead: (bulkNotificationsReadRequest: BulkNotificationsReadRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3188
|
+
/**
|
|
3189
|
+
* Get notification by ID
|
|
3190
|
+
* @summary Get notification
|
|
3191
|
+
* @param {string} notificationID notification ID
|
|
3192
|
+
* @param {*} [options] Override http request option.
|
|
3193
|
+
* @throws {RequiredError}
|
|
3194
|
+
*/
|
|
3195
|
+
getNotification: (notificationID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3196
|
+
/**
|
|
3197
|
+
* List paginated notifications
|
|
3198
|
+
* @summary List notifications
|
|
3199
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3200
|
+
* @param {NotificationStatus} [status] Notification status
|
|
3201
|
+
* @param {*} [options] Override http request option.
|
|
3202
|
+
* @throws {RequiredError}
|
|
3203
|
+
*/
|
|
3204
|
+
listNotifications: (nextToken?: string, status?: NotificationStatus, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3205
|
+
/**
|
|
3206
|
+
* Update notification by ID
|
|
3207
|
+
* @summary Update notification
|
|
3208
|
+
* @param {string} notificationID notification ID
|
|
3209
|
+
* @param {*} [options] Override http request option.
|
|
3210
|
+
* @throws {RequiredError}
|
|
3211
|
+
*/
|
|
3212
|
+
markNotificationAsRead: (notificationID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3213
|
+
};
|
|
3214
|
+
/**
|
|
3215
|
+
* NotificationApi - functional programming interface
|
|
3216
|
+
* @export
|
|
3217
|
+
*/
|
|
3218
|
+
export declare const NotificationApiFp: (configuration?: Configuration) => {
|
|
3219
|
+
/**
|
|
3220
|
+
* Marks all notifications as read for the authenticated user
|
|
3221
|
+
* @summary Mark all notifications as read
|
|
3222
|
+
* @param {BulkNotificationsReadRequest} bulkNotificationsReadRequest ids of the notifications to be set as product
|
|
3223
|
+
* @param {*} [options] Override http request option.
|
|
3224
|
+
* @throws {RequiredError}
|
|
3225
|
+
*/
|
|
3226
|
+
bulkMarkNotificationAsRead(bulkNotificationsReadRequest: BulkNotificationsReadRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3227
|
+
/**
|
|
3228
|
+
* Get notification by ID
|
|
3229
|
+
* @summary Get notification
|
|
3230
|
+
* @param {string} notificationID notification ID
|
|
3231
|
+
* @param {*} [options] Override http request option.
|
|
3232
|
+
* @throws {RequiredError}
|
|
3233
|
+
*/
|
|
3234
|
+
getNotification(notificationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
|
|
3235
|
+
/**
|
|
3236
|
+
* List paginated notifications
|
|
3237
|
+
* @summary List notifications
|
|
3238
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3239
|
+
* @param {NotificationStatus} [status] Notification status
|
|
3240
|
+
* @param {*} [options] Override http request option.
|
|
3241
|
+
* @throws {RequiredError}
|
|
3242
|
+
*/
|
|
3243
|
+
listNotifications(nextToken?: string, status?: NotificationStatus, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationListResponse>>;
|
|
3244
|
+
/**
|
|
3245
|
+
* Update notification by ID
|
|
3246
|
+
* @summary Update notification
|
|
3247
|
+
* @param {string} notificationID notification ID
|
|
3248
|
+
* @param {*} [options] Override http request option.
|
|
3249
|
+
* @throws {RequiredError}
|
|
3250
|
+
*/
|
|
3251
|
+
markNotificationAsRead(notificationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3252
|
+
};
|
|
3253
|
+
/**
|
|
3254
|
+
* NotificationApi - factory interface
|
|
3255
|
+
* @export
|
|
3256
|
+
*/
|
|
3257
|
+
export declare const NotificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3258
|
+
/**
|
|
3259
|
+
* Marks all notifications as read for the authenticated user
|
|
3260
|
+
* @summary Mark all notifications as read
|
|
3261
|
+
* @param {BulkNotificationsReadRequest} bulkNotificationsReadRequest ids of the notifications to be set as product
|
|
3262
|
+
* @param {*} [options] Override http request option.
|
|
3263
|
+
* @throws {RequiredError}
|
|
3264
|
+
*/
|
|
3265
|
+
bulkMarkNotificationAsRead(bulkNotificationsReadRequest: BulkNotificationsReadRequest, options?: any): AxiosPromise<void>;
|
|
3266
|
+
/**
|
|
3267
|
+
* Get notification by ID
|
|
3268
|
+
* @summary Get notification
|
|
3269
|
+
* @param {string} notificationID notification ID
|
|
3270
|
+
* @param {*} [options] Override http request option.
|
|
3271
|
+
* @throws {RequiredError}
|
|
3272
|
+
*/
|
|
3273
|
+
getNotification(notificationID: string, options?: any): AxiosPromise<Notification>;
|
|
3274
|
+
/**
|
|
3275
|
+
* List paginated notifications
|
|
3276
|
+
* @summary List notifications
|
|
3277
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3278
|
+
* @param {NotificationStatus} [status] Notification status
|
|
3279
|
+
* @param {*} [options] Override http request option.
|
|
3280
|
+
* @throws {RequiredError}
|
|
3281
|
+
*/
|
|
3282
|
+
listNotifications(nextToken?: string, status?: NotificationStatus, options?: any): AxiosPromise<NotificationListResponse>;
|
|
3283
|
+
/**
|
|
3284
|
+
* Update notification by ID
|
|
3285
|
+
* @summary Update notification
|
|
3286
|
+
* @param {string} notificationID notification ID
|
|
3287
|
+
* @param {*} [options] Override http request option.
|
|
3288
|
+
* @throws {RequiredError}
|
|
3289
|
+
*/
|
|
3290
|
+
markNotificationAsRead(notificationID: string, options?: any): AxiosPromise<void>;
|
|
3291
|
+
};
|
|
3292
|
+
/**
|
|
3293
|
+
* NotificationApi - object-oriented interface
|
|
3294
|
+
* @export
|
|
3295
|
+
* @class NotificationApi
|
|
3296
|
+
* @extends {BaseAPI}
|
|
3297
|
+
*/
|
|
3298
|
+
export declare class NotificationApi extends BaseAPI {
|
|
3299
|
+
/**
|
|
3300
|
+
* Marks all notifications as read for the authenticated user
|
|
3301
|
+
* @summary Mark all notifications as read
|
|
3302
|
+
* @param {BulkNotificationsReadRequest} bulkNotificationsReadRequest ids of the notifications to be set as product
|
|
3303
|
+
* @param {*} [options] Override http request option.
|
|
3304
|
+
* @throws {RequiredError}
|
|
3305
|
+
* @memberof NotificationApi
|
|
3306
|
+
*/
|
|
3307
|
+
bulkMarkNotificationAsRead(bulkNotificationsReadRequest: BulkNotificationsReadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3308
|
+
/**
|
|
3309
|
+
* Get notification by ID
|
|
3310
|
+
* @summary Get notification
|
|
3311
|
+
* @param {string} notificationID notification ID
|
|
3312
|
+
* @param {*} [options] Override http request option.
|
|
3313
|
+
* @throws {RequiredError}
|
|
3314
|
+
* @memberof NotificationApi
|
|
3315
|
+
*/
|
|
3316
|
+
getNotification(notificationID: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any>>;
|
|
3317
|
+
/**
|
|
3318
|
+
* List paginated notifications
|
|
3319
|
+
* @summary List notifications
|
|
3320
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3321
|
+
* @param {NotificationStatus} [status] Notification status
|
|
3322
|
+
* @param {*} [options] Override http request option.
|
|
3323
|
+
* @throws {RequiredError}
|
|
3324
|
+
* @memberof NotificationApi
|
|
3325
|
+
*/
|
|
3326
|
+
listNotifications(nextToken?: string, status?: NotificationStatus, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NotificationListResponse, any>>;
|
|
3327
|
+
/**
|
|
3328
|
+
* Update notification by ID
|
|
3329
|
+
* @summary Update notification
|
|
3330
|
+
* @param {string} notificationID notification ID
|
|
3331
|
+
* @param {*} [options] Override http request option.
|
|
3332
|
+
* @throws {RequiredError}
|
|
3333
|
+
* @memberof NotificationApi
|
|
3334
|
+
*/
|
|
3335
|
+
markNotificationAsRead(notificationID: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3336
|
+
}
|
|
3337
|
+
/**
|
|
3338
|
+
* ProductApi - axios parameter creator
|
|
3339
|
+
* @export
|
|
3340
|
+
*/
|
|
3341
|
+
export declare const ProductApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3342
|
+
/**
|
|
3343
|
+
* Accept or reject a product by id
|
|
3344
|
+
* @summary Accept or reject a product by id
|
|
3345
|
+
* @param {string} id The product id
|
|
3346
|
+
* @param {ProductRequestApprovalRequest} [productRequestApprovalRequest]
|
|
3347
|
+
* @param {*} [options] Override http request option.
|
|
3348
|
+
* @throws {RequiredError}
|
|
3349
|
+
*/
|
|
3350
|
+
approveProduct: (id: string, productRequestApprovalRequest?: ProductRequestApprovalRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3351
|
+
/**
|
|
3352
|
+
* Create a new product
|
|
3353
|
+
* @summary Create a new product
|
|
3354
|
+
* @param {ProductCreationRequest | null} [productCreationRequest]
|
|
3355
|
+
* @param {*} [options] Override http request option.
|
|
3356
|
+
* @throws {RequiredError}
|
|
3357
|
+
*/
|
|
3358
|
+
createProduct: (productCreationRequest?: ProductCreationRequest | null, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3359
|
+
/**
|
|
3360
|
+
* Create a new product request
|
|
3361
|
+
* @summary Create a new product request
|
|
3362
|
+
* @param {ProductRequestCreationRequest} [productRequestCreationRequest]
|
|
3363
|
+
* @param {*} [options] Override http request option.
|
|
3364
|
+
* @throws {RequiredError}
|
|
3365
|
+
*/
|
|
3366
|
+
createProductRequest: (productRequestCreationRequest?: ProductRequestCreationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3367
|
+
/**
|
|
3368
|
+
* Get a product by id
|
|
3369
|
+
* @summary Get a product by id
|
|
3370
|
+
* @param {string} id The product id
|
|
3371
|
+
* @param {*} [options] Override http request option.
|
|
3372
|
+
* @throws {RequiredError}
|
|
3373
|
+
*/
|
|
3374
|
+
getProductById: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3375
|
+
/**
|
|
3376
|
+
* Get a product request by id
|
|
3377
|
+
* @summary Get a product request by id
|
|
3378
|
+
* @param {string} id The product request id
|
|
3379
|
+
* @param {*} [options] Override http request option.
|
|
3380
|
+
* @throws {RequiredError}
|
|
3381
|
+
*/
|
|
3382
|
+
getProductRequestById: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3383
|
+
/**
|
|
3384
|
+
* List existing product requests
|
|
3385
|
+
* @summary List existing product requests
|
|
3386
|
+
* @param {ProductRequestStatus} [status] The product request status
|
|
3387
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3388
|
+
* @param {*} [options] Override http request option.
|
|
3389
|
+
* @throws {RequiredError}
|
|
3390
|
+
*/
|
|
3391
|
+
listProductRequests: (status?: ProductRequestStatus, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3392
|
+
/**
|
|
3393
|
+
* Update a product by id
|
|
3394
|
+
* @summary Update a product by id
|
|
3395
|
+
* @param {string} id The product id
|
|
3396
|
+
* @param {ProductCreationRequest | null} [productCreationRequest]
|
|
3397
|
+
* @param {*} [options] Override http request option.
|
|
3398
|
+
* @throws {RequiredError}
|
|
3399
|
+
*/
|
|
3400
|
+
updateProduct: (id: string, productCreationRequest?: ProductCreationRequest | null, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3401
|
+
};
|
|
3402
|
+
/**
|
|
3403
|
+
* ProductApi - functional programming interface
|
|
3404
|
+
* @export
|
|
3405
|
+
*/
|
|
3406
|
+
export declare const ProductApiFp: (configuration?: Configuration) => {
|
|
3407
|
+
/**
|
|
3408
|
+
* Accept or reject a product by id
|
|
3409
|
+
* @summary Accept or reject a product by id
|
|
3410
|
+
* @param {string} id The product id
|
|
3411
|
+
* @param {ProductRequestApprovalRequest} [productRequestApprovalRequest]
|
|
3412
|
+
* @param {*} [options] Override http request option.
|
|
3413
|
+
* @throws {RequiredError}
|
|
3414
|
+
*/
|
|
3415
|
+
approveProduct(id: string, productRequestApprovalRequest?: ProductRequestApprovalRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductRequestApprovalResponse>>;
|
|
3416
|
+
/**
|
|
3417
|
+
* Create a new product
|
|
3418
|
+
* @summary Create a new product
|
|
3419
|
+
* @param {ProductCreationRequest | null} [productCreationRequest]
|
|
3420
|
+
* @param {*} [options] Override http request option.
|
|
3421
|
+
* @throws {RequiredError}
|
|
3422
|
+
*/
|
|
3423
|
+
createProduct(productCreationRequest?: ProductCreationRequest | null, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
3424
|
+
/**
|
|
3425
|
+
* Create a new product request
|
|
3426
|
+
* @summary Create a new product request
|
|
3427
|
+
* @param {ProductRequestCreationRequest} [productRequestCreationRequest]
|
|
3428
|
+
* @param {*} [options] Override http request option.
|
|
3429
|
+
* @throws {RequiredError}
|
|
3430
|
+
*/
|
|
3431
|
+
createProductRequest(productRequestCreationRequest?: ProductRequestCreationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductRequest>>;
|
|
3432
|
+
/**
|
|
3433
|
+
* Get a product by id
|
|
3434
|
+
* @summary Get a product by id
|
|
3435
|
+
* @param {string} id The product id
|
|
3436
|
+
* @param {*} [options] Override http request option.
|
|
3437
|
+
* @throws {RequiredError}
|
|
3438
|
+
*/
|
|
3439
|
+
getProductById(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
3440
|
+
/**
|
|
3441
|
+
* Get a product request by id
|
|
3442
|
+
* @summary Get a product request by id
|
|
3443
|
+
* @param {string} id The product request id
|
|
3444
|
+
* @param {*} [options] Override http request option.
|
|
3445
|
+
* @throws {RequiredError}
|
|
3446
|
+
*/
|
|
3447
|
+
getProductRequestById(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductRequestApprovalResponse>>;
|
|
3448
|
+
/**
|
|
3449
|
+
* List existing product requests
|
|
3450
|
+
* @summary List existing product requests
|
|
3451
|
+
* @param {ProductRequestStatus} [status] The product request status
|
|
3452
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3453
|
+
* @param {*} [options] Override http request option.
|
|
3454
|
+
* @throws {RequiredError}
|
|
3455
|
+
*/
|
|
3456
|
+
listProductRequests(status?: ProductRequestStatus, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductRequestsResponse>>;
|
|
3457
|
+
/**
|
|
3458
|
+
* Update a product by id
|
|
3459
|
+
* @summary Update a product by id
|
|
3460
|
+
* @param {string} id The product id
|
|
3461
|
+
* @param {ProductCreationRequest | null} [productCreationRequest]
|
|
3462
|
+
* @param {*} [options] Override http request option.
|
|
3463
|
+
* @throws {RequiredError}
|
|
3464
|
+
*/
|
|
3465
|
+
updateProduct(id: string, productCreationRequest?: ProductCreationRequest | null, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
3466
|
+
};
|
|
3467
|
+
/**
|
|
3468
|
+
* ProductApi - factory interface
|
|
3469
|
+
* @export
|
|
3470
|
+
*/
|
|
3471
|
+
export declare const ProductApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3472
|
+
/**
|
|
3473
|
+
* Accept or reject a product by id
|
|
3474
|
+
* @summary Accept or reject a product by id
|
|
3475
|
+
* @param {string} id The product id
|
|
3476
|
+
* @param {ProductRequestApprovalRequest} [productRequestApprovalRequest]
|
|
3477
|
+
* @param {*} [options] Override http request option.
|
|
3478
|
+
* @throws {RequiredError}
|
|
3479
|
+
*/
|
|
3480
|
+
approveProduct(id: string, productRequestApprovalRequest?: ProductRequestApprovalRequest, options?: any): AxiosPromise<ProductRequestApprovalResponse>;
|
|
3481
|
+
/**
|
|
3482
|
+
* Create a new product
|
|
3483
|
+
* @summary Create a new product
|
|
3484
|
+
* @param {ProductCreationRequest | null} [productCreationRequest]
|
|
3485
|
+
* @param {*} [options] Override http request option.
|
|
3486
|
+
* @throws {RequiredError}
|
|
3487
|
+
*/
|
|
3488
|
+
createProduct(productCreationRequest?: ProductCreationRequest | null, options?: any): AxiosPromise<Product>;
|
|
3489
|
+
/**
|
|
3490
|
+
* Create a new product request
|
|
3491
|
+
* @summary Create a new product request
|
|
3492
|
+
* @param {ProductRequestCreationRequest} [productRequestCreationRequest]
|
|
3493
|
+
* @param {*} [options] Override http request option.
|
|
3494
|
+
* @throws {RequiredError}
|
|
3495
|
+
*/
|
|
3496
|
+
createProductRequest(productRequestCreationRequest?: ProductRequestCreationRequest, options?: any): AxiosPromise<ProductRequest>;
|
|
3497
|
+
/**
|
|
3498
|
+
* Get a product by id
|
|
3499
|
+
* @summary Get a product by id
|
|
3500
|
+
* @param {string} id The product id
|
|
3501
|
+
* @param {*} [options] Override http request option.
|
|
3502
|
+
* @throws {RequiredError}
|
|
3503
|
+
*/
|
|
3504
|
+
getProductById(id: string, options?: any): AxiosPromise<Product>;
|
|
3505
|
+
/**
|
|
3506
|
+
* Get a product request by id
|
|
3507
|
+
* @summary Get a product request by id
|
|
3508
|
+
* @param {string} id The product request id
|
|
3509
|
+
* @param {*} [options] Override http request option.
|
|
3510
|
+
* @throws {RequiredError}
|
|
3511
|
+
*/
|
|
3512
|
+
getProductRequestById(id: string, options?: any): AxiosPromise<ProductRequestApprovalResponse>;
|
|
3513
|
+
/**
|
|
3514
|
+
* List existing product requests
|
|
3515
|
+
* @summary List existing product requests
|
|
3516
|
+
* @param {ProductRequestStatus} [status] The product request status
|
|
3517
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3518
|
+
* @param {*} [options] Override http request option.
|
|
3519
|
+
* @throws {RequiredError}
|
|
3520
|
+
*/
|
|
3521
|
+
listProductRequests(status?: ProductRequestStatus, nextToken?: string, options?: any): AxiosPromise<ProductRequestsResponse>;
|
|
3522
|
+
/**
|
|
3523
|
+
* Update a product by id
|
|
3524
|
+
* @summary Update a product by id
|
|
3525
|
+
* @param {string} id The product id
|
|
3526
|
+
* @param {ProductCreationRequest | null} [productCreationRequest]
|
|
3527
|
+
* @param {*} [options] Override http request option.
|
|
3528
|
+
* @throws {RequiredError}
|
|
3529
|
+
*/
|
|
3530
|
+
updateProduct(id: string, productCreationRequest?: ProductCreationRequest | null, options?: any): AxiosPromise<Product>;
|
|
3531
|
+
};
|
|
3532
|
+
/**
|
|
3533
|
+
* ProductApi - object-oriented interface
|
|
3534
|
+
* @export
|
|
3535
|
+
* @class ProductApi
|
|
3536
|
+
* @extends {BaseAPI}
|
|
3537
|
+
*/
|
|
3538
|
+
export declare class ProductApi extends BaseAPI {
|
|
3539
|
+
/**
|
|
3540
|
+
* Accept or reject a product by id
|
|
3541
|
+
* @summary Accept or reject a product by id
|
|
3542
|
+
* @param {string} id The product id
|
|
3543
|
+
* @param {ProductRequestApprovalRequest} [productRequestApprovalRequest]
|
|
3544
|
+
* @param {*} [options] Override http request option.
|
|
3545
|
+
* @throws {RequiredError}
|
|
3546
|
+
* @memberof ProductApi
|
|
3547
|
+
*/
|
|
3548
|
+
approveProduct(id: string, productRequestApprovalRequest?: ProductRequestApprovalRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductRequestApprovalResponse, any>>;
|
|
3549
|
+
/**
|
|
3550
|
+
* Create a new product
|
|
3551
|
+
* @summary Create a new product
|
|
3552
|
+
* @param {ProductCreationRequest | null} [productCreationRequest]
|
|
3553
|
+
* @param {*} [options] Override http request option.
|
|
3554
|
+
* @throws {RequiredError}
|
|
3555
|
+
* @memberof ProductApi
|
|
3556
|
+
*/
|
|
3557
|
+
createProduct(productCreationRequest?: ProductCreationRequest | null, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
3558
|
+
/**
|
|
3559
|
+
* Create a new product request
|
|
3560
|
+
* @summary Create a new product request
|
|
3561
|
+
* @param {ProductRequestCreationRequest} [productRequestCreationRequest]
|
|
3562
|
+
* @param {*} [options] Override http request option.
|
|
3563
|
+
* @throws {RequiredError}
|
|
3564
|
+
* @memberof ProductApi
|
|
3565
|
+
*/
|
|
3566
|
+
createProductRequest(productRequestCreationRequest?: ProductRequestCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductRequest, any>>;
|
|
3567
|
+
/**
|
|
3568
|
+
* Get a product by id
|
|
3569
|
+
* @summary Get a product by id
|
|
3570
|
+
* @param {string} id The product id
|
|
3571
|
+
* @param {*} [options] Override http request option.
|
|
3572
|
+
* @throws {RequiredError}
|
|
3573
|
+
* @memberof ProductApi
|
|
3574
|
+
*/
|
|
3575
|
+
getProductById(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
3576
|
+
/**
|
|
3577
|
+
* Get a product request by id
|
|
3578
|
+
* @summary Get a product request by id
|
|
3579
|
+
* @param {string} id The product request id
|
|
3580
|
+
* @param {*} [options] Override http request option.
|
|
3581
|
+
* @throws {RequiredError}
|
|
3582
|
+
* @memberof ProductApi
|
|
3583
|
+
*/
|
|
3584
|
+
getProductRequestById(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductRequestApprovalResponse, any>>;
|
|
3585
|
+
/**
|
|
3586
|
+
* List existing product requests
|
|
3587
|
+
* @summary List existing product requests
|
|
3588
|
+
* @param {ProductRequestStatus} [status] The product request status
|
|
3589
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3590
|
+
* @param {*} [options] Override http request option.
|
|
3591
|
+
* @throws {RequiredError}
|
|
3592
|
+
* @memberof ProductApi
|
|
3593
|
+
*/
|
|
3594
|
+
listProductRequests(status?: ProductRequestStatus, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductRequestsResponse, any>>;
|
|
3595
|
+
/**
|
|
3596
|
+
* Update a product by id
|
|
3597
|
+
* @summary Update a product by id
|
|
3598
|
+
* @param {string} id The product id
|
|
3599
|
+
* @param {ProductCreationRequest | null} [productCreationRequest]
|
|
3600
|
+
* @param {*} [options] Override http request option.
|
|
3601
|
+
* @throws {RequiredError}
|
|
3602
|
+
* @memberof ProductApi
|
|
3603
|
+
*/
|
|
3604
|
+
updateProduct(id: string, productCreationRequest?: ProductCreationRequest | null, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
3605
|
+
}
|
|
3606
|
+
/**
|
|
3607
|
+
* ProgressApi - axios parameter creator
|
|
3608
|
+
* @export
|
|
3609
|
+
*/
|
|
3610
|
+
export declare const ProgressApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3611
|
+
/**
|
|
3612
|
+
* List all progress of a promotion
|
|
3613
|
+
* @summary List promotion\'s progress
|
|
3614
|
+
* @param {string} id Promotion ID
|
|
3615
|
+
* @param {number} [periodID] Period ID
|
|
3616
|
+
* @param {string} [userID] User ID
|
|
3617
|
+
* @param {string} [clientID] Client ID
|
|
3618
|
+
* @param {ListProgressIntervalEnum} [interval] Interval
|
|
3619
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3620
|
+
* @param {*} [options] Override http request option.
|
|
3621
|
+
* @throws {RequiredError}
|
|
3622
|
+
*/
|
|
3623
|
+
listProgress: (id: string, periodID?: number, userID?: string, clientID?: string, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3624
|
+
};
|
|
3625
|
+
/**
|
|
3626
|
+
* ProgressApi - functional programming interface
|
|
3627
|
+
* @export
|
|
3628
|
+
*/
|
|
3629
|
+
export declare const ProgressApiFp: (configuration?: Configuration) => {
|
|
3630
|
+
/**
|
|
3631
|
+
* List all progress of a promotion
|
|
3632
|
+
* @summary List promotion\'s progress
|
|
3633
|
+
* @param {string} id Promotion ID
|
|
3634
|
+
* @param {number} [periodID] Period ID
|
|
3635
|
+
* @param {string} [userID] User ID
|
|
3636
|
+
* @param {string} [clientID] Client ID
|
|
3637
|
+
* @param {ListProgressIntervalEnum} [interval] Interval
|
|
3638
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3639
|
+
* @param {*} [options] Override http request option.
|
|
3640
|
+
* @throws {RequiredError}
|
|
3641
|
+
*/
|
|
3642
|
+
listProgress(id: string, periodID?: number, userID?: string, clientID?: string, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgressResponse>>;
|
|
3643
|
+
};
|
|
3644
|
+
/**
|
|
3645
|
+
* ProgressApi - factory interface
|
|
3646
|
+
* @export
|
|
3647
|
+
*/
|
|
3648
|
+
export declare const ProgressApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3649
|
+
/**
|
|
3650
|
+
* List all progress of a promotion
|
|
3651
|
+
* @summary List promotion\'s progress
|
|
3652
|
+
* @param {string} id Promotion ID
|
|
3653
|
+
* @param {number} [periodID] Period ID
|
|
3654
|
+
* @param {string} [userID] User ID
|
|
3655
|
+
* @param {string} [clientID] Client ID
|
|
3656
|
+
* @param {ListProgressIntervalEnum} [interval] Interval
|
|
3657
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3658
|
+
* @param {*} [options] Override http request option.
|
|
3659
|
+
* @throws {RequiredError}
|
|
3660
|
+
*/
|
|
3661
|
+
listProgress(id: string, periodID?: number, userID?: string, clientID?: string, interval?: ListProgressIntervalEnum, nextToken?: string, options?: any): AxiosPromise<ProgressResponse>;
|
|
3662
|
+
};
|
|
3663
|
+
/**
|
|
3664
|
+
* ProgressApi - object-oriented interface
|
|
3665
|
+
* @export
|
|
3666
|
+
* @class ProgressApi
|
|
3667
|
+
* @extends {BaseAPI}
|
|
3668
|
+
*/
|
|
3669
|
+
export declare class ProgressApi extends BaseAPI {
|
|
3670
|
+
/**
|
|
3671
|
+
* List all progress of a promotion
|
|
3672
|
+
* @summary List promotion\'s progress
|
|
3673
|
+
* @param {string} id Promotion ID
|
|
3674
|
+
* @param {number} [periodID] Period ID
|
|
3675
|
+
* @param {string} [userID] User ID
|
|
3676
|
+
* @param {string} [clientID] Client ID
|
|
3677
|
+
* @param {ListProgressIntervalEnum} [interval] Interval
|
|
3678
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3679
|
+
* @param {*} [options] Override http request option.
|
|
3680
|
+
* @throws {RequiredError}
|
|
3681
|
+
* @memberof ProgressApi
|
|
3682
|
+
*/
|
|
3683
|
+
listProgress(id: string, periodID?: number, userID?: string, clientID?: string, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
|
|
3684
|
+
}
|
|
3685
|
+
/**
|
|
3686
|
+
* @export
|
|
3687
|
+
*/
|
|
3688
|
+
export declare const ListProgressIntervalEnum: {
|
|
3689
|
+
readonly _100: "100";
|
|
3690
|
+
readonly _9975: "99-75";
|
|
3691
|
+
readonly _7550: "75-50";
|
|
3692
|
+
readonly _501: "50-1";
|
|
3693
|
+
};
|
|
3694
|
+
export type ListProgressIntervalEnum = typeof ListProgressIntervalEnum[keyof typeof ListProgressIntervalEnum];
|
|
3695
|
+
/**
|
|
3696
|
+
* PromotionApi - axios parameter creator
|
|
3697
|
+
* @export
|
|
3698
|
+
*/
|
|
3699
|
+
export declare const PromotionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3700
|
+
/**
|
|
3701
|
+
* Configure a promotion
|
|
3702
|
+
* @summary Create promotion
|
|
3703
|
+
* @param {PromotionRequest} promotionRequest Promotion configuration
|
|
3704
|
+
* @param {*} [options] Override http request option.
|
|
3705
|
+
* @throws {RequiredError}
|
|
3706
|
+
*/
|
|
3707
|
+
createPromotion: (promotionRequest: PromotionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3708
|
+
/**
|
|
3709
|
+
* Delete promotion by id
|
|
3710
|
+
* @summary Delete promotion
|
|
3711
|
+
* @param {string} id Promotion id
|
|
3712
|
+
* @param {*} [options] Override http request option.
|
|
3713
|
+
* @throws {RequiredError}
|
|
3714
|
+
*/
|
|
3715
|
+
deletePromotion: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3716
|
+
/**
|
|
3717
|
+
* Get promotion by id
|
|
3718
|
+
* @summary Get promotion
|
|
3719
|
+
* @param {string} id Promotion id
|
|
3720
|
+
* @param {*} [options] Override http request option.
|
|
3721
|
+
* @throws {RequiredError}
|
|
3722
|
+
*/
|
|
3723
|
+
getPromotion: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3724
|
+
/**
|
|
3725
|
+
* List all promotions
|
|
3726
|
+
* @summary List promotions
|
|
3727
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3728
|
+
* @param {string} [tags] tags to filter by, format is key1=value1;key2=value2. Should be url encoded.
|
|
3729
|
+
* @param {string} [segmentId] segment ID to filter by
|
|
3730
|
+
* @param {string} [ownerID] ownerID to filter by
|
|
3731
|
+
* @param {PromotionType} [type] type to filter by
|
|
3732
|
+
* @param {string} [startingAfter] start time after time
|
|
3733
|
+
* @param {string} [endingBefore] end time before time
|
|
3734
|
+
* @param {string} [clientID] client ID to filter by
|
|
3735
|
+
* @param {string} [search] search by name or description
|
|
3736
|
+
* @param {*} [options] Override http request option.
|
|
3737
|
+
* @throws {RequiredError}
|
|
3738
|
+
*/
|
|
3739
|
+
listPromotions: (nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, clientID?: string, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3740
|
+
/**
|
|
3741
|
+
* Update promotion by id
|
|
3742
|
+
* @summary Update promotion
|
|
3743
|
+
* @param {string} id Promotion id
|
|
3744
|
+
* @param {UpdatePromotionRequest} updatePromotionRequest Promotion configuration
|
|
3745
|
+
* @param {*} [options] Override http request option.
|
|
3746
|
+
* @throws {RequiredError}
|
|
3747
|
+
*/
|
|
3748
|
+
updatePromotion: (id: string, updatePromotionRequest: UpdatePromotionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3749
|
+
};
|
|
3750
|
+
/**
|
|
3751
|
+
* PromotionApi - functional programming interface
|
|
3752
|
+
* @export
|
|
3753
|
+
*/
|
|
3754
|
+
export declare const PromotionApiFp: (configuration?: Configuration) => {
|
|
3755
|
+
/**
|
|
3756
|
+
* Configure a promotion
|
|
3757
|
+
* @summary Create promotion
|
|
3758
|
+
* @param {PromotionRequest} promotionRequest Promotion configuration
|
|
3759
|
+
* @param {*} [options] Override http request option.
|
|
3760
|
+
* @throws {RequiredError}
|
|
3761
|
+
*/
|
|
3762
|
+
createPromotion(promotionRequest: PromotionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Promotion>>;
|
|
3763
|
+
/**
|
|
3764
|
+
* Delete promotion by id
|
|
3765
|
+
* @summary Delete promotion
|
|
3766
|
+
* @param {string} id Promotion id
|
|
3767
|
+
* @param {*} [options] Override http request option.
|
|
3768
|
+
* @throws {RequiredError}
|
|
3769
|
+
*/
|
|
3770
|
+
deletePromotion(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Promotion>>;
|
|
3771
|
+
/**
|
|
3772
|
+
* Get promotion by id
|
|
3773
|
+
* @summary Get promotion
|
|
3774
|
+
* @param {string} id Promotion id
|
|
3775
|
+
* @param {*} [options] Override http request option.
|
|
3776
|
+
* @throws {RequiredError}
|
|
3777
|
+
*/
|
|
3778
|
+
getPromotion(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Promotion>>;
|
|
3779
|
+
/**
|
|
3780
|
+
* List all promotions
|
|
3781
|
+
* @summary List promotions
|
|
3782
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3783
|
+
* @param {string} [tags] tags to filter by, format is key1=value1;key2=value2. Should be url encoded.
|
|
3784
|
+
* @param {string} [segmentId] segment ID to filter by
|
|
3785
|
+
* @param {string} [ownerID] ownerID to filter by
|
|
3786
|
+
* @param {PromotionType} [type] type to filter by
|
|
3787
|
+
* @param {string} [startingAfter] start time after time
|
|
3788
|
+
* @param {string} [endingBefore] end time before time
|
|
3789
|
+
* @param {string} [clientID] client ID to filter by
|
|
3790
|
+
* @param {string} [search] search by name or description
|
|
3791
|
+
* @param {*} [options] Override http request option.
|
|
3792
|
+
* @throws {RequiredError}
|
|
3793
|
+
*/
|
|
3794
|
+
listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, clientID?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
|
|
3795
|
+
/**
|
|
3796
|
+
* Update promotion by id
|
|
3797
|
+
* @summary Update promotion
|
|
3798
|
+
* @param {string} id Promotion id
|
|
3799
|
+
* @param {UpdatePromotionRequest} updatePromotionRequest Promotion configuration
|
|
3800
|
+
* @param {*} [options] Override http request option.
|
|
3801
|
+
* @throws {RequiredError}
|
|
3802
|
+
*/
|
|
3803
|
+
updatePromotion(id: string, updatePromotionRequest: UpdatePromotionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Promotion>>;
|
|
3804
|
+
};
|
|
3805
|
+
/**
|
|
3806
|
+
* PromotionApi - factory interface
|
|
3807
|
+
* @export
|
|
3808
|
+
*/
|
|
3809
|
+
export declare const PromotionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3810
|
+
/**
|
|
3811
|
+
* Configure a promotion
|
|
3812
|
+
* @summary Create promotion
|
|
3813
|
+
* @param {PromotionRequest} promotionRequest Promotion configuration
|
|
3814
|
+
* @param {*} [options] Override http request option.
|
|
3815
|
+
* @throws {RequiredError}
|
|
3816
|
+
*/
|
|
3817
|
+
createPromotion(promotionRequest: PromotionRequest, options?: any): AxiosPromise<Promotion>;
|
|
3818
|
+
/**
|
|
3819
|
+
* Delete promotion by id
|
|
3820
|
+
* @summary Delete promotion
|
|
3821
|
+
* @param {string} id Promotion id
|
|
3822
|
+
* @param {*} [options] Override http request option.
|
|
3823
|
+
* @throws {RequiredError}
|
|
3824
|
+
*/
|
|
3825
|
+
deletePromotion(id: string, options?: any): AxiosPromise<Promotion>;
|
|
3826
|
+
/**
|
|
3827
|
+
* Get promotion by id
|
|
3828
|
+
* @summary Get promotion
|
|
3829
|
+
* @param {string} id Promotion id
|
|
3830
|
+
* @param {*} [options] Override http request option.
|
|
3831
|
+
* @throws {RequiredError}
|
|
3832
|
+
*/
|
|
3833
|
+
getPromotion(id: string, options?: any): AxiosPromise<Promotion>;
|
|
3834
|
+
/**
|
|
3835
|
+
* List all promotions
|
|
3836
|
+
* @summary List promotions
|
|
3837
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3838
|
+
* @param {string} [tags] tags to filter by, format is key1=value1;key2=value2. Should be url encoded.
|
|
3839
|
+
* @param {string} [segmentId] segment ID to filter by
|
|
3840
|
+
* @param {string} [ownerID] ownerID to filter by
|
|
3841
|
+
* @param {PromotionType} [type] type to filter by
|
|
3842
|
+
* @param {string} [startingAfter] start time after time
|
|
3843
|
+
* @param {string} [endingBefore] end time before time
|
|
3844
|
+
* @param {string} [clientID] client ID to filter by
|
|
3845
|
+
* @param {string} [search] search by name or description
|
|
3846
|
+
* @param {*} [options] Override http request option.
|
|
3847
|
+
* @throws {RequiredError}
|
|
3848
|
+
*/
|
|
3849
|
+
listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, clientID?: string, search?: string, options?: any): AxiosPromise<PromotionsResponse>;
|
|
3850
|
+
/**
|
|
3851
|
+
* Update promotion by id
|
|
3852
|
+
* @summary Update promotion
|
|
3853
|
+
* @param {string} id Promotion id
|
|
3854
|
+
* @param {UpdatePromotionRequest} updatePromotionRequest Promotion configuration
|
|
3855
|
+
* @param {*} [options] Override http request option.
|
|
3856
|
+
* @throws {RequiredError}
|
|
3857
|
+
*/
|
|
3858
|
+
updatePromotion(id: string, updatePromotionRequest: UpdatePromotionRequest, options?: any): AxiosPromise<Promotion>;
|
|
3859
|
+
};
|
|
3860
|
+
/**
|
|
3861
|
+
* PromotionApi - object-oriented interface
|
|
3862
|
+
* @export
|
|
3863
|
+
* @class PromotionApi
|
|
3864
|
+
* @extends {BaseAPI}
|
|
3865
|
+
*/
|
|
3866
|
+
export declare class PromotionApi extends BaseAPI {
|
|
3867
|
+
/**
|
|
3868
|
+
* Configure a promotion
|
|
3869
|
+
* @summary Create promotion
|
|
3870
|
+
* @param {PromotionRequest} promotionRequest Promotion configuration
|
|
3871
|
+
* @param {*} [options] Override http request option.
|
|
3872
|
+
* @throws {RequiredError}
|
|
3873
|
+
* @memberof PromotionApi
|
|
3874
|
+
*/
|
|
3875
|
+
createPromotion(promotionRequest: PromotionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Promotion, any>>;
|
|
3876
|
+
/**
|
|
3877
|
+
* Delete promotion by id
|
|
3878
|
+
* @summary Delete promotion
|
|
3879
|
+
* @param {string} id Promotion id
|
|
3880
|
+
* @param {*} [options] Override http request option.
|
|
3881
|
+
* @throws {RequiredError}
|
|
3882
|
+
* @memberof PromotionApi
|
|
3883
|
+
*/
|
|
3884
|
+
deletePromotion(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Promotion, any>>;
|
|
3885
|
+
/**
|
|
3886
|
+
* Get promotion by id
|
|
3887
|
+
* @summary Get promotion
|
|
3888
|
+
* @param {string} id Promotion id
|
|
3889
|
+
* @param {*} [options] Override http request option.
|
|
3890
|
+
* @throws {RequiredError}
|
|
3891
|
+
* @memberof PromotionApi
|
|
3892
|
+
*/
|
|
3893
|
+
getPromotion(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Promotion, any>>;
|
|
3894
|
+
/**
|
|
3895
|
+
* List all promotions
|
|
3896
|
+
* @summary List promotions
|
|
3897
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3898
|
+
* @param {string} [tags] tags to filter by, format is key1=value1;key2=value2. Should be url encoded.
|
|
3899
|
+
* @param {string} [segmentId] segment ID to filter by
|
|
3900
|
+
* @param {string} [ownerID] ownerID to filter by
|
|
3901
|
+
* @param {PromotionType} [type] type to filter by
|
|
3902
|
+
* @param {string} [startingAfter] start time after time
|
|
3903
|
+
* @param {string} [endingBefore] end time before time
|
|
3904
|
+
* @param {string} [clientID] client ID to filter by
|
|
3905
|
+
* @param {string} [search] search by name or description
|
|
3906
|
+
* @param {*} [options] Override http request option.
|
|
3907
|
+
* @throws {RequiredError}
|
|
3908
|
+
* @memberof PromotionApi
|
|
3909
|
+
*/
|
|
3910
|
+
listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, clientID?: string, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
|
|
3911
|
+
/**
|
|
3912
|
+
* Update promotion by id
|
|
3913
|
+
* @summary Update promotion
|
|
3914
|
+
* @param {string} id Promotion id
|
|
3915
|
+
* @param {UpdatePromotionRequest} updatePromotionRequest Promotion configuration
|
|
3916
|
+
* @param {*} [options] Override http request option.
|
|
3917
|
+
* @throws {RequiredError}
|
|
3918
|
+
* @memberof PromotionApi
|
|
3919
|
+
*/
|
|
3920
|
+
updatePromotion(id: string, updatePromotionRequest: UpdatePromotionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Promotion, any>>;
|
|
3921
|
+
}
|
|
3922
|
+
/**
|
|
3923
|
+
* RewardApi - axios parameter creator
|
|
3924
|
+
* @export
|
|
3925
|
+
*/
|
|
3926
|
+
export declare const RewardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3927
|
+
/**
|
|
3928
|
+
* Create upload URL for reward
|
|
3929
|
+
* @summary Create upload URL for reward
|
|
3930
|
+
* @param {*} [options] Override http request option.
|
|
3931
|
+
* @throws {RequiredError}
|
|
3932
|
+
*/
|
|
3933
|
+
createUploadURL: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3934
|
+
/**
|
|
3935
|
+
* List existing products
|
|
3936
|
+
* @summary List existing products
|
|
3937
|
+
* @param {ProductKind} [kind] The product kind
|
|
3938
|
+
* @param {string} [search] search string
|
|
3939
|
+
* @param {ProductUsage} [usage] The product usage
|
|
3940
|
+
* @param {ProductStatus} [status] The product status
|
|
3941
|
+
* @param {ProductAvailability} [availability] The product availability
|
|
3942
|
+
* @param {string} [segmentID] The segment ID
|
|
3943
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3944
|
+
* @param {*} [options] Override http request option.
|
|
3945
|
+
* @throws {RequiredError}
|
|
3946
|
+
*/
|
|
3947
|
+
listProducts: (kind?: ProductKind, search?: string, usage?: ProductUsage, status?: ProductStatus, availability?: ProductAvailability, segmentID?: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3948
|
+
};
|
|
3949
|
+
/**
|
|
3950
|
+
* RewardApi - functional programming interface
|
|
3951
|
+
* @export
|
|
3952
|
+
*/
|
|
3953
|
+
export declare const RewardApiFp: (configuration?: Configuration) => {
|
|
3954
|
+
/**
|
|
3955
|
+
* Create upload URL for reward
|
|
3956
|
+
* @summary Create upload URL for reward
|
|
3957
|
+
* @param {*} [options] Override http request option.
|
|
3958
|
+
* @throws {RequiredError}
|
|
3959
|
+
*/
|
|
3960
|
+
createUploadURL(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadURLResponse>>;
|
|
3961
|
+
/**
|
|
3962
|
+
* List existing products
|
|
3963
|
+
* @summary List existing products
|
|
3964
|
+
* @param {ProductKind} [kind] The product kind
|
|
3965
|
+
* @param {string} [search] search string
|
|
3966
|
+
* @param {ProductUsage} [usage] The product usage
|
|
3967
|
+
* @param {ProductStatus} [status] The product status
|
|
3968
|
+
* @param {ProductAvailability} [availability] The product availability
|
|
3969
|
+
* @param {string} [segmentID] The segment ID
|
|
3970
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3971
|
+
* @param {*} [options] Override http request option.
|
|
3972
|
+
* @throws {RequiredError}
|
|
3973
|
+
*/
|
|
3974
|
+
listProducts(kind?: ProductKind, search?: string, usage?: ProductUsage, status?: ProductStatus, availability?: ProductAvailability, segmentID?: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
3975
|
+
};
|
|
3976
|
+
/**
|
|
3977
|
+
* RewardApi - factory interface
|
|
3978
|
+
* @export
|
|
3979
|
+
*/
|
|
3980
|
+
export declare const RewardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3981
|
+
/**
|
|
3982
|
+
* Create upload URL for reward
|
|
3983
|
+
* @summary Create upload URL for reward
|
|
3984
|
+
* @param {*} [options] Override http request option.
|
|
3985
|
+
* @throws {RequiredError}
|
|
3986
|
+
*/
|
|
3987
|
+
createUploadURL(options?: any): AxiosPromise<UploadURLResponse>;
|
|
3988
|
+
/**
|
|
3989
|
+
* List existing products
|
|
3990
|
+
* @summary List existing products
|
|
3991
|
+
* @param {ProductKind} [kind] The product kind
|
|
3992
|
+
* @param {string} [search] search string
|
|
3993
|
+
* @param {ProductUsage} [usage] The product usage
|
|
3994
|
+
* @param {ProductStatus} [status] The product status
|
|
3995
|
+
* @param {ProductAvailability} [availability] The product availability
|
|
3996
|
+
* @param {string} [segmentID] The segment ID
|
|
3997
|
+
* @param {string} [nextToken] This is the pagination token
|
|
3998
|
+
* @param {*} [options] Override http request option.
|
|
3999
|
+
* @throws {RequiredError}
|
|
4000
|
+
*/
|
|
4001
|
+
listProducts(kind?: ProductKind, search?: string, usage?: ProductUsage, status?: ProductStatus, availability?: ProductAvailability, segmentID?: string, nextToken?: string, options?: any): AxiosPromise<ProductsResponse>;
|
|
4002
|
+
};
|
|
4003
|
+
/**
|
|
4004
|
+
* RewardApi - object-oriented interface
|
|
4005
|
+
* @export
|
|
4006
|
+
* @class RewardApi
|
|
4007
|
+
* @extends {BaseAPI}
|
|
4008
|
+
*/
|
|
4009
|
+
export declare class RewardApi extends BaseAPI {
|
|
4010
|
+
/**
|
|
4011
|
+
* Create upload URL for reward
|
|
4012
|
+
* @summary Create upload URL for reward
|
|
4013
|
+
* @param {*} [options] Override http request option.
|
|
4014
|
+
* @throws {RequiredError}
|
|
4015
|
+
* @memberof RewardApi
|
|
4016
|
+
*/
|
|
4017
|
+
createUploadURL(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadURLResponse, any>>;
|
|
4018
|
+
/**
|
|
4019
|
+
* List existing products
|
|
4020
|
+
* @summary List existing products
|
|
4021
|
+
* @param {ProductKind} [kind] The product kind
|
|
4022
|
+
* @param {string} [search] search string
|
|
4023
|
+
* @param {ProductUsage} [usage] The product usage
|
|
4024
|
+
* @param {ProductStatus} [status] The product status
|
|
4025
|
+
* @param {ProductAvailability} [availability] The product availability
|
|
4026
|
+
* @param {string} [segmentID] The segment ID
|
|
4027
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4028
|
+
* @param {*} [options] Override http request option.
|
|
4029
|
+
* @throws {RequiredError}
|
|
4030
|
+
* @memberof RewardApi
|
|
4031
|
+
*/
|
|
4032
|
+
listProducts(kind?: ProductKind, search?: string, usage?: ProductUsage, status?: ProductStatus, availability?: ProductAvailability, segmentID?: string, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
4033
|
+
}
|
|
4034
|
+
/**
|
|
4035
|
+
* SegmentApi - axios parameter creator
|
|
4036
|
+
* @export
|
|
4037
|
+
*/
|
|
4038
|
+
export declare const SegmentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4039
|
+
/**
|
|
4040
|
+
* This method allows adding a new Segment to the system.
|
|
4041
|
+
* @summary Method allows to create new segment.
|
|
4042
|
+
* @param {CreateSegmentRequest} [createSegmentRequest]
|
|
4043
|
+
* @param {*} [options] Override http request option.
|
|
4044
|
+
* @throws {RequiredError}
|
|
4045
|
+
*/
|
|
4046
|
+
createSegment: (createSegmentRequest?: CreateSegmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4047
|
+
/**
|
|
4048
|
+
* This method returns all information about a specific Segment.
|
|
4049
|
+
* @summary Method will return segment details.
|
|
4050
|
+
* @param {string} segmentId Segment ID
|
|
4051
|
+
* @param {*} [options] Override http request option.
|
|
4052
|
+
* @throws {RequiredError}
|
|
4053
|
+
*/
|
|
4054
|
+
getSegmentById: (segmentId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4055
|
+
/**
|
|
4056
|
+
* This method returns a list of all Segment in the system.
|
|
4057
|
+
* @summary Method returns segments list.
|
|
4058
|
+
* @param {string} [nextToken]
|
|
4059
|
+
* @param {string} [search] search string
|
|
4060
|
+
* @param {*} [options] Override http request option.
|
|
4061
|
+
* @throws {RequiredError}
|
|
4062
|
+
*/
|
|
4063
|
+
listSegments: (nextToken?: string, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4064
|
+
};
|
|
4065
|
+
/**
|
|
4066
|
+
* SegmentApi - functional programming interface
|
|
4067
|
+
* @export
|
|
4068
|
+
*/
|
|
4069
|
+
export declare const SegmentApiFp: (configuration?: Configuration) => {
|
|
4070
|
+
/**
|
|
4071
|
+
* This method allows adding a new Segment to the system.
|
|
4072
|
+
* @summary Method allows to create new segment.
|
|
4073
|
+
* @param {CreateSegmentRequest} [createSegmentRequest]
|
|
4074
|
+
* @param {*} [options] Override http request option.
|
|
4075
|
+
* @throws {RequiredError}
|
|
4076
|
+
*/
|
|
4077
|
+
createSegment(createSegmentRequest?: CreateSegmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Segment>>;
|
|
4078
|
+
/**
|
|
4079
|
+
* This method returns all information about a specific Segment.
|
|
4080
|
+
* @summary Method will return segment details.
|
|
4081
|
+
* @param {string} segmentId Segment ID
|
|
4082
|
+
* @param {*} [options] Override http request option.
|
|
4083
|
+
* @throws {RequiredError}
|
|
4084
|
+
*/
|
|
4085
|
+
getSegmentById(segmentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Segment>>;
|
|
4086
|
+
/**
|
|
4087
|
+
* This method returns a list of all Segment in the system.
|
|
4088
|
+
* @summary Method returns segments list.
|
|
4089
|
+
* @param {string} [nextToken]
|
|
4090
|
+
* @param {string} [search] search string
|
|
4091
|
+
* @param {*} [options] Override http request option.
|
|
4092
|
+
* @throws {RequiredError}
|
|
4093
|
+
*/
|
|
4094
|
+
listSegments(nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentListResponse>>;
|
|
4095
|
+
};
|
|
4096
|
+
/**
|
|
4097
|
+
* SegmentApi - factory interface
|
|
4098
|
+
* @export
|
|
4099
|
+
*/
|
|
4100
|
+
export declare const SegmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4101
|
+
/**
|
|
4102
|
+
* This method allows adding a new Segment to the system.
|
|
4103
|
+
* @summary Method allows to create new segment.
|
|
4104
|
+
* @param {CreateSegmentRequest} [createSegmentRequest]
|
|
4105
|
+
* @param {*} [options] Override http request option.
|
|
4106
|
+
* @throws {RequiredError}
|
|
4107
|
+
*/
|
|
4108
|
+
createSegment(createSegmentRequest?: CreateSegmentRequest, options?: any): AxiosPromise<Segment>;
|
|
4109
|
+
/**
|
|
4110
|
+
* This method returns all information about a specific Segment.
|
|
4111
|
+
* @summary Method will return segment details.
|
|
4112
|
+
* @param {string} segmentId Segment ID
|
|
4113
|
+
* @param {*} [options] Override http request option.
|
|
4114
|
+
* @throws {RequiredError}
|
|
4115
|
+
*/
|
|
4116
|
+
getSegmentById(segmentId: string, options?: any): AxiosPromise<Segment>;
|
|
4117
|
+
/**
|
|
4118
|
+
* This method returns a list of all Segment in the system.
|
|
4119
|
+
* @summary Method returns segments list.
|
|
4120
|
+
* @param {string} [nextToken]
|
|
4121
|
+
* @param {string} [search] search string
|
|
4122
|
+
* @param {*} [options] Override http request option.
|
|
4123
|
+
* @throws {RequiredError}
|
|
4124
|
+
*/
|
|
4125
|
+
listSegments(nextToken?: string, search?: string, options?: any): AxiosPromise<SegmentListResponse>;
|
|
4126
|
+
};
|
|
4127
|
+
/**
|
|
4128
|
+
* SegmentApi - object-oriented interface
|
|
4129
|
+
* @export
|
|
4130
|
+
* @class SegmentApi
|
|
4131
|
+
* @extends {BaseAPI}
|
|
4132
|
+
*/
|
|
4133
|
+
export declare class SegmentApi extends BaseAPI {
|
|
4134
|
+
/**
|
|
4135
|
+
* This method allows adding a new Segment to the system.
|
|
4136
|
+
* @summary Method allows to create new segment.
|
|
4137
|
+
* @param {CreateSegmentRequest} [createSegmentRequest]
|
|
4138
|
+
* @param {*} [options] Override http request option.
|
|
4139
|
+
* @throws {RequiredError}
|
|
4140
|
+
* @memberof SegmentApi
|
|
4141
|
+
*/
|
|
4142
|
+
createSegment(createSegmentRequest?: CreateSegmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Segment, any>>;
|
|
4143
|
+
/**
|
|
4144
|
+
* This method returns all information about a specific Segment.
|
|
4145
|
+
* @summary Method will return segment details.
|
|
4146
|
+
* @param {string} segmentId Segment ID
|
|
4147
|
+
* @param {*} [options] Override http request option.
|
|
4148
|
+
* @throws {RequiredError}
|
|
4149
|
+
* @memberof SegmentApi
|
|
4150
|
+
*/
|
|
4151
|
+
getSegmentById(segmentId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Segment, any>>;
|
|
4152
|
+
/**
|
|
4153
|
+
* This method returns a list of all Segment in the system.
|
|
4154
|
+
* @summary Method returns segments list.
|
|
4155
|
+
* @param {string} [nextToken]
|
|
4156
|
+
* @param {string} [search] search string
|
|
4157
|
+
* @param {*} [options] Override http request option.
|
|
4158
|
+
* @throws {RequiredError}
|
|
4159
|
+
* @memberof SegmentApi
|
|
4160
|
+
*/
|
|
4161
|
+
listSegments(nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SegmentListResponse, any>>;
|
|
4162
|
+
}
|
|
4163
|
+
/**
|
|
4164
|
+
* TagApi - axios parameter creator
|
|
4165
|
+
* @export
|
|
4166
|
+
*/
|
|
4167
|
+
export declare const TagApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4168
|
+
/**
|
|
4169
|
+
* This method allows adding a new tag to the system. Tag key must be unique.
|
|
4170
|
+
* @summary Method allows to create new tag.
|
|
4171
|
+
* @param {CreateTagRequest} [createTagRequest]
|
|
4172
|
+
* @param {*} [options] Override http request option.
|
|
4173
|
+
* @throws {RequiredError}
|
|
4174
|
+
*/
|
|
4175
|
+
createTag: (createTagRequest?: CreateTagRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4176
|
+
/**
|
|
4177
|
+
* This method allows deleting a tag from the system.
|
|
4178
|
+
* @summary Method allows to delete tag.
|
|
4179
|
+
* @param {string} key Tag key
|
|
4180
|
+
* @param {*} [options] Override http request option.
|
|
4181
|
+
* @throws {RequiredError}
|
|
4182
|
+
*/
|
|
4183
|
+
deleteTag: (key: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4184
|
+
/**
|
|
4185
|
+
* This method returns all information about a specific tag.
|
|
4186
|
+
* @summary Method will return tag details.
|
|
4187
|
+
* @param {string} key Tag key
|
|
4188
|
+
* @param {*} [options] Override http request option.
|
|
4189
|
+
* @throws {RequiredError}
|
|
4190
|
+
*/
|
|
4191
|
+
getTagByKey: (key: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4192
|
+
/**
|
|
4193
|
+
* This method returns a list of all tags in the system.
|
|
4194
|
+
* @summary Method returns tags list.
|
|
4195
|
+
* @param {string} [tagKey] Tag key
|
|
4196
|
+
* @param {*} [options] Override http request option.
|
|
4197
|
+
* @throws {RequiredError}
|
|
4198
|
+
*/
|
|
4199
|
+
listTags: (tagKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4200
|
+
/**
|
|
4201
|
+
* This method allows updating a tag in the system.
|
|
4202
|
+
* @summary Method allows to update tag.
|
|
4203
|
+
* @param {string} key Tag key
|
|
4204
|
+
* @param {CreateTagRequest} [createTagRequest]
|
|
4205
|
+
* @param {*} [options] Override http request option.
|
|
4206
|
+
* @throws {RequiredError}
|
|
4207
|
+
*/
|
|
4208
|
+
updateTag: (key: string, createTagRequest?: CreateTagRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4209
|
+
};
|
|
4210
|
+
/**
|
|
4211
|
+
* TagApi - functional programming interface
|
|
4212
|
+
* @export
|
|
4213
|
+
*/
|
|
4214
|
+
export declare const TagApiFp: (configuration?: Configuration) => {
|
|
4215
|
+
/**
|
|
4216
|
+
* This method allows adding a new tag to the system. Tag key must be unique.
|
|
4217
|
+
* @summary Method allows to create new tag.
|
|
4218
|
+
* @param {CreateTagRequest} [createTagRequest]
|
|
4219
|
+
* @param {*} [options] Override http request option.
|
|
4220
|
+
* @throws {RequiredError}
|
|
4221
|
+
*/
|
|
4222
|
+
createTag(createTagRequest?: CreateTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>>;
|
|
4223
|
+
/**
|
|
4224
|
+
* This method allows deleting a tag from the system.
|
|
4225
|
+
* @summary Method allows to delete tag.
|
|
4226
|
+
* @param {string} key Tag key
|
|
4227
|
+
* @param {*} [options] Override http request option.
|
|
4228
|
+
* @throws {RequiredError}
|
|
4229
|
+
*/
|
|
4230
|
+
deleteTag(key: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4231
|
+
/**
|
|
4232
|
+
* This method returns all information about a specific tag.
|
|
4233
|
+
* @summary Method will return tag details.
|
|
4234
|
+
* @param {string} key Tag key
|
|
4235
|
+
* @param {*} [options] Override http request option.
|
|
4236
|
+
* @throws {RequiredError}
|
|
4237
|
+
*/
|
|
4238
|
+
getTagByKey(key: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TagDetailed>>;
|
|
4239
|
+
/**
|
|
4240
|
+
* This method returns a list of all tags in the system.
|
|
4241
|
+
* @summary Method returns tags list.
|
|
4242
|
+
* @param {string} [tagKey] Tag key
|
|
4243
|
+
* @param {*} [options] Override http request option.
|
|
4244
|
+
* @throws {RequiredError}
|
|
4245
|
+
*/
|
|
4246
|
+
listTags(tagKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TagListResponse>>;
|
|
4247
|
+
/**
|
|
4248
|
+
* This method allows updating a tag in the system.
|
|
4249
|
+
* @summary Method allows to update tag.
|
|
4250
|
+
* @param {string} key Tag key
|
|
4251
|
+
* @param {CreateTagRequest} [createTagRequest]
|
|
4252
|
+
* @param {*} [options] Override http request option.
|
|
4253
|
+
* @throws {RequiredError}
|
|
4254
|
+
*/
|
|
4255
|
+
updateTag(key: string, createTagRequest?: CreateTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tag>>;
|
|
4256
|
+
};
|
|
4257
|
+
/**
|
|
4258
|
+
* TagApi - factory interface
|
|
4259
|
+
* @export
|
|
4260
|
+
*/
|
|
4261
|
+
export declare const TagApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4262
|
+
/**
|
|
4263
|
+
* This method allows adding a new tag to the system. Tag key must be unique.
|
|
4264
|
+
* @summary Method allows to create new tag.
|
|
4265
|
+
* @param {CreateTagRequest} [createTagRequest]
|
|
4266
|
+
* @param {*} [options] Override http request option.
|
|
4267
|
+
* @throws {RequiredError}
|
|
4268
|
+
*/
|
|
4269
|
+
createTag(createTagRequest?: CreateTagRequest, options?: any): AxiosPromise<Tag>;
|
|
4270
|
+
/**
|
|
4271
|
+
* This method allows deleting a tag from the system.
|
|
4272
|
+
* @summary Method allows to delete tag.
|
|
4273
|
+
* @param {string} key Tag key
|
|
4274
|
+
* @param {*} [options] Override http request option.
|
|
4275
|
+
* @throws {RequiredError}
|
|
4276
|
+
*/
|
|
4277
|
+
deleteTag(key: string, options?: any): AxiosPromise<void>;
|
|
4278
|
+
/**
|
|
4279
|
+
* This method returns all information about a specific tag.
|
|
4280
|
+
* @summary Method will return tag details.
|
|
4281
|
+
* @param {string} key Tag key
|
|
4282
|
+
* @param {*} [options] Override http request option.
|
|
4283
|
+
* @throws {RequiredError}
|
|
4284
|
+
*/
|
|
4285
|
+
getTagByKey(key: string, options?: any): AxiosPromise<TagDetailed>;
|
|
4286
|
+
/**
|
|
4287
|
+
* This method returns a list of all tags in the system.
|
|
4288
|
+
* @summary Method returns tags list.
|
|
4289
|
+
* @param {string} [tagKey] Tag key
|
|
4290
|
+
* @param {*} [options] Override http request option.
|
|
4291
|
+
* @throws {RequiredError}
|
|
4292
|
+
*/
|
|
4293
|
+
listTags(tagKey?: string, options?: any): AxiosPromise<TagListResponse>;
|
|
4294
|
+
/**
|
|
4295
|
+
* This method allows updating a tag in the system.
|
|
4296
|
+
* @summary Method allows to update tag.
|
|
4297
|
+
* @param {string} key Tag key
|
|
4298
|
+
* @param {CreateTagRequest} [createTagRequest]
|
|
4299
|
+
* @param {*} [options] Override http request option.
|
|
4300
|
+
* @throws {RequiredError}
|
|
4301
|
+
*/
|
|
4302
|
+
updateTag(key: string, createTagRequest?: CreateTagRequest, options?: any): AxiosPromise<Tag>;
|
|
4303
|
+
};
|
|
4304
|
+
/**
|
|
4305
|
+
* TagApi - object-oriented interface
|
|
4306
|
+
* @export
|
|
4307
|
+
* @class TagApi
|
|
4308
|
+
* @extends {BaseAPI}
|
|
4309
|
+
*/
|
|
4310
|
+
export declare class TagApi extends BaseAPI {
|
|
4311
|
+
/**
|
|
4312
|
+
* This method allows adding a new tag to the system. Tag key must be unique.
|
|
4313
|
+
* @summary Method allows to create new tag.
|
|
4314
|
+
* @param {CreateTagRequest} [createTagRequest]
|
|
4315
|
+
* @param {*} [options] Override http request option.
|
|
4316
|
+
* @throws {RequiredError}
|
|
4317
|
+
* @memberof TagApi
|
|
4318
|
+
*/
|
|
4319
|
+
createTag(createTagRequest?: CreateTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Tag, any>>;
|
|
4320
|
+
/**
|
|
4321
|
+
* This method allows deleting a tag from the system.
|
|
4322
|
+
* @summary Method allows to delete tag.
|
|
4323
|
+
* @param {string} key Tag key
|
|
4324
|
+
* @param {*} [options] Override http request option.
|
|
4325
|
+
* @throws {RequiredError}
|
|
4326
|
+
* @memberof TagApi
|
|
4327
|
+
*/
|
|
4328
|
+
deleteTag(key: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4329
|
+
/**
|
|
4330
|
+
* This method returns all information about a specific tag.
|
|
4331
|
+
* @summary Method will return tag details.
|
|
4332
|
+
* @param {string} key Tag key
|
|
4333
|
+
* @param {*} [options] Override http request option.
|
|
4334
|
+
* @throws {RequiredError}
|
|
4335
|
+
* @memberof TagApi
|
|
4336
|
+
*/
|
|
4337
|
+
getTagByKey(key: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TagDetailed, any>>;
|
|
4338
|
+
/**
|
|
4339
|
+
* This method returns a list of all tags in the system.
|
|
4340
|
+
* @summary Method returns tags list.
|
|
4341
|
+
* @param {string} [tagKey] Tag key
|
|
4342
|
+
* @param {*} [options] Override http request option.
|
|
4343
|
+
* @throws {RequiredError}
|
|
4344
|
+
* @memberof TagApi
|
|
4345
|
+
*/
|
|
4346
|
+
listTags(tagKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TagListResponse, any>>;
|
|
4347
|
+
/**
|
|
4348
|
+
* This method allows updating a tag in the system.
|
|
4349
|
+
* @summary Method allows to update tag.
|
|
4350
|
+
* @param {string} key Tag key
|
|
4351
|
+
* @param {CreateTagRequest} [createTagRequest]
|
|
4352
|
+
* @param {*} [options] Override http request option.
|
|
4353
|
+
* @throws {RequiredError}
|
|
4354
|
+
* @memberof TagApi
|
|
4355
|
+
*/
|
|
4356
|
+
updateTag(key: string, createTagRequest?: CreateTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Tag, any>>;
|
|
4357
|
+
}
|
|
4358
|
+
/**
|
|
4359
|
+
* TransactionApi - axios parameter creator
|
|
4360
|
+
* @export
|
|
4361
|
+
*/
|
|
4362
|
+
export declare const TransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4363
|
+
/**
|
|
4364
|
+
* List existing transactions
|
|
4365
|
+
* @summary List existing transactions
|
|
4366
|
+
* @param {string} clientID This is the client ID
|
|
4367
|
+
* @param {string} [paginationToken] This is the pagination token
|
|
4368
|
+
* @param {*} [options] Override http request option.
|
|
4369
|
+
* @throws {RequiredError}
|
|
4370
|
+
*/
|
|
4371
|
+
listTransactions: (clientID: string, paginationToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4372
|
+
};
|
|
4373
|
+
/**
|
|
4374
|
+
* TransactionApi - functional programming interface
|
|
4375
|
+
* @export
|
|
4376
|
+
*/
|
|
4377
|
+
export declare const TransactionApiFp: (configuration?: Configuration) => {
|
|
4378
|
+
/**
|
|
4379
|
+
* List existing transactions
|
|
4380
|
+
* @summary List existing transactions
|
|
4381
|
+
* @param {string} clientID This is the client ID
|
|
4382
|
+
* @param {string} [paginationToken] This is the pagination token
|
|
4383
|
+
* @param {*} [options] Override http request option.
|
|
4384
|
+
* @throws {RequiredError}
|
|
4385
|
+
*/
|
|
4386
|
+
listTransactions(clientID: string, paginationToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionsResponse>>;
|
|
4387
|
+
};
|
|
4388
|
+
/**
|
|
4389
|
+
* TransactionApi - factory interface
|
|
4390
|
+
* @export
|
|
4391
|
+
*/
|
|
4392
|
+
export declare const TransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4393
|
+
/**
|
|
4394
|
+
* List existing transactions
|
|
4395
|
+
* @summary List existing transactions
|
|
4396
|
+
* @param {string} clientID This is the client ID
|
|
4397
|
+
* @param {string} [paginationToken] This is the pagination token
|
|
4398
|
+
* @param {*} [options] Override http request option.
|
|
4399
|
+
* @throws {RequiredError}
|
|
4400
|
+
*/
|
|
4401
|
+
listTransactions(clientID: string, paginationToken?: string, options?: any): AxiosPromise<TransactionsResponse>;
|
|
4402
|
+
};
|
|
4403
|
+
/**
|
|
4404
|
+
* TransactionApi - object-oriented interface
|
|
4405
|
+
* @export
|
|
4406
|
+
* @class TransactionApi
|
|
4407
|
+
* @extends {BaseAPI}
|
|
4408
|
+
*/
|
|
4409
|
+
export declare class TransactionApi extends BaseAPI {
|
|
4410
|
+
/**
|
|
4411
|
+
* List existing transactions
|
|
4412
|
+
* @summary List existing transactions
|
|
4413
|
+
* @param {string} clientID This is the client ID
|
|
4414
|
+
* @param {string} [paginationToken] This is the pagination token
|
|
4415
|
+
* @param {*} [options] Override http request option.
|
|
4416
|
+
* @throws {RequiredError}
|
|
4417
|
+
* @memberof TransactionApi
|
|
4418
|
+
*/
|
|
4419
|
+
listTransactions(clientID: string, paginationToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionsResponse, any>>;
|
|
4420
|
+
}
|
|
4421
|
+
/**
|
|
4422
|
+
* UserApi - axios parameter creator
|
|
4423
|
+
* @export
|
|
4424
|
+
*/
|
|
4425
|
+
export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4426
|
+
/**
|
|
4427
|
+
* Get user by id
|
|
4428
|
+
* @summary Get user
|
|
4429
|
+
* @param {string} id user id
|
|
4430
|
+
* @param {*} [options] Override http request option.
|
|
4431
|
+
* @throws {RequiredError}
|
|
4432
|
+
*/
|
|
4433
|
+
getUserByID: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4434
|
+
/**
|
|
4435
|
+
* List all users
|
|
4436
|
+
* @summary List users
|
|
4437
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4438
|
+
* @param {UserRole} [role] role to filter by
|
|
4439
|
+
* @param {string} [search] search string
|
|
4440
|
+
* @param {string} [clientID] client ID to filter by
|
|
4441
|
+
* @param {string} [userIds] user ids to filter by, list of ids separated by commas.
|
|
4442
|
+
* @param {UserSource} [source] source to filter by
|
|
4443
|
+
* @param {*} [options] Override http request option.
|
|
4444
|
+
* @throws {RequiredError}
|
|
4445
|
+
*/
|
|
4446
|
+
listUsers: (nextToken?: string, role?: UserRole, search?: string, clientID?: string, userIds?: string, source?: UserSource, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4447
|
+
};
|
|
4448
|
+
/**
|
|
4449
|
+
* UserApi - functional programming interface
|
|
4450
|
+
* @export
|
|
4451
|
+
*/
|
|
4452
|
+
export declare const UserApiFp: (configuration?: Configuration) => {
|
|
4453
|
+
/**
|
|
4454
|
+
* Get user by id
|
|
4455
|
+
* @summary Get user
|
|
4456
|
+
* @param {string} id user id
|
|
4457
|
+
* @param {*} [options] Override http request option.
|
|
4458
|
+
* @throws {RequiredError}
|
|
4459
|
+
*/
|
|
4460
|
+
getUserByID(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
|
|
4461
|
+
/**
|
|
4462
|
+
* List all users
|
|
4463
|
+
* @summary List users
|
|
4464
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4465
|
+
* @param {UserRole} [role] role to filter by
|
|
4466
|
+
* @param {string} [search] search string
|
|
4467
|
+
* @param {string} [clientID] client ID to filter by
|
|
4468
|
+
* @param {string} [userIds] user ids to filter by, list of ids separated by commas.
|
|
4469
|
+
* @param {UserSource} [source] source to filter by
|
|
4470
|
+
* @param {*} [options] Override http request option.
|
|
4471
|
+
* @throws {RequiredError}
|
|
4472
|
+
*/
|
|
4473
|
+
listUsers(nextToken?: string, role?: UserRole, search?: string, clientID?: string, userIds?: string, source?: UserSource, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserListResponse>>;
|
|
4474
|
+
};
|
|
4475
|
+
/**
|
|
4476
|
+
* UserApi - factory interface
|
|
4477
|
+
* @export
|
|
4478
|
+
*/
|
|
4479
|
+
export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4480
|
+
/**
|
|
4481
|
+
* Get user by id
|
|
4482
|
+
* @summary Get user
|
|
4483
|
+
* @param {string} id user id
|
|
4484
|
+
* @param {*} [options] Override http request option.
|
|
4485
|
+
* @throws {RequiredError}
|
|
4486
|
+
*/
|
|
4487
|
+
getUserByID(id: string, options?: any): AxiosPromise<User>;
|
|
4488
|
+
/**
|
|
4489
|
+
* List all users
|
|
4490
|
+
* @summary List users
|
|
4491
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4492
|
+
* @param {UserRole} [role] role to filter by
|
|
4493
|
+
* @param {string} [search] search string
|
|
4494
|
+
* @param {string} [clientID] client ID to filter by
|
|
4495
|
+
* @param {string} [userIds] user ids to filter by, list of ids separated by commas.
|
|
4496
|
+
* @param {UserSource} [source] source to filter by
|
|
4497
|
+
* @param {*} [options] Override http request option.
|
|
4498
|
+
* @throws {RequiredError}
|
|
4499
|
+
*/
|
|
4500
|
+
listUsers(nextToken?: string, role?: UserRole, search?: string, clientID?: string, userIds?: string, source?: UserSource, options?: any): AxiosPromise<UserListResponse>;
|
|
4501
|
+
};
|
|
4502
|
+
/**
|
|
4503
|
+
* UserApi - object-oriented interface
|
|
4504
|
+
* @export
|
|
4505
|
+
* @class UserApi
|
|
4506
|
+
* @extends {BaseAPI}
|
|
4507
|
+
*/
|
|
4508
|
+
export declare class UserApi extends BaseAPI {
|
|
4509
|
+
/**
|
|
4510
|
+
* Get user by id
|
|
4511
|
+
* @summary Get user
|
|
4512
|
+
* @param {string} id user id
|
|
4513
|
+
* @param {*} [options] Override http request option.
|
|
4514
|
+
* @throws {RequiredError}
|
|
4515
|
+
* @memberof UserApi
|
|
4516
|
+
*/
|
|
4517
|
+
getUserByID(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<User, any>>;
|
|
4518
|
+
/**
|
|
4519
|
+
* List all users
|
|
4520
|
+
* @summary List users
|
|
4521
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4522
|
+
* @param {UserRole} [role] role to filter by
|
|
4523
|
+
* @param {string} [search] search string
|
|
4524
|
+
* @param {string} [clientID] client ID to filter by
|
|
4525
|
+
* @param {string} [userIds] user ids to filter by, list of ids separated by commas.
|
|
4526
|
+
* @param {UserSource} [source] source to filter by
|
|
4527
|
+
* @param {*} [options] Override http request option.
|
|
4528
|
+
* @throws {RequiredError}
|
|
4529
|
+
* @memberof UserApi
|
|
4530
|
+
*/
|
|
4531
|
+
listUsers(nextToken?: string, role?: UserRole, search?: string, clientID?: string, userIds?: string, source?: UserSource, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserListResponse, any>>;
|
|
4532
|
+
}
|