tremendous 3.3.0 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/api.d.ts +2260 -947
- package/dist/api.js +1071 -52
- package/dist/environments.d.ts +4 -5
- package/dist/environments.js +1 -1
- package/package.json +2 -2
package/dist/api.d.ts
CHANGED
|
@@ -13,6 +13,58 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
* Ignore flagging rules for rewards redeemed by an email or domain matching this list.
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AllowEmail
|
|
20
|
+
*/
|
|
21
|
+
export interface AllowEmail {
|
|
22
|
+
/**
|
|
23
|
+
* The list of emails.
|
|
24
|
+
* @type {Array<string>}
|
|
25
|
+
* @memberof AllowEmail
|
|
26
|
+
*/
|
|
27
|
+
'emails': Array<string>;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* The list of emails and domains where a matching redemption will ignore other flagging rules and automatically go through.
|
|
31
|
+
* @export
|
|
32
|
+
* @interface AllowEmail1
|
|
33
|
+
*/
|
|
34
|
+
export interface AllowEmail1 {
|
|
35
|
+
/**
|
|
36
|
+
* The list of emails.
|
|
37
|
+
* @type {Array<string>}
|
|
38
|
+
* @memberof AllowEmail1
|
|
39
|
+
*/
|
|
40
|
+
'emails': Array<string>;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Ignore flagging rules for rewards redeemed by an IP matching this list.
|
|
44
|
+
* @export
|
|
45
|
+
* @interface AllowIp
|
|
46
|
+
*/
|
|
47
|
+
export interface AllowIp {
|
|
48
|
+
/**
|
|
49
|
+
* The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
|
|
50
|
+
* @type {Array<string>}
|
|
51
|
+
* @memberof AllowIp
|
|
52
|
+
*/
|
|
53
|
+
'ips': Array<string>;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* The list of IP addresses and/or IP ranges where a matching redemption will ignore other flagging rules and automatically go through.
|
|
57
|
+
* @export
|
|
58
|
+
* @interface AllowIp1
|
|
59
|
+
*/
|
|
60
|
+
export interface AllowIp1 {
|
|
61
|
+
/**
|
|
62
|
+
* The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
|
|
63
|
+
* @type {Array<string>}
|
|
64
|
+
* @memberof AllowIp1
|
|
65
|
+
*/
|
|
66
|
+
'ips': Array<string>;
|
|
67
|
+
}
|
|
16
68
|
/**
|
|
17
69
|
* A balance transaction represents a specific movement or change in an account\'s balance.
|
|
18
70
|
* @export
|
|
@@ -24,31 +76,50 @@ export interface BalanceTransaction {
|
|
|
24
76
|
* @type {string}
|
|
25
77
|
* @memberof BalanceTransaction
|
|
26
78
|
*/
|
|
27
|
-
'created_at'
|
|
79
|
+
'created_at': string;
|
|
28
80
|
/**
|
|
29
81
|
* Amount of the transaction in USD
|
|
30
82
|
* @type {number}
|
|
31
83
|
* @memberof BalanceTransaction
|
|
32
84
|
*/
|
|
33
|
-
'amount'
|
|
85
|
+
'amount': number;
|
|
34
86
|
/**
|
|
35
87
|
* The updated total after the transaction. Note that this running balance may be delayed and contain `null`.
|
|
36
88
|
* @type {number}
|
|
37
89
|
* @memberof BalanceTransaction
|
|
38
90
|
*/
|
|
39
|
-
'balance'
|
|
91
|
+
'balance': number;
|
|
40
92
|
/**
|
|
41
93
|
* The action that was performed
|
|
42
94
|
* @type {string}
|
|
43
95
|
* @memberof BalanceTransaction
|
|
44
96
|
*/
|
|
45
|
-
'action'
|
|
97
|
+
'action': string;
|
|
46
98
|
/**
|
|
47
99
|
* A brief description of the transaction
|
|
48
100
|
* @type {string}
|
|
49
101
|
* @memberof BalanceTransaction
|
|
50
102
|
*/
|
|
51
|
-
'description'
|
|
103
|
+
'description': string;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @export
|
|
108
|
+
* @interface BaseOrderForCreate
|
|
109
|
+
*/
|
|
110
|
+
export interface BaseOrderForCreate {
|
|
111
|
+
/**
|
|
112
|
+
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
113
|
+
* @type {string}
|
|
114
|
+
* @memberof BaseOrderForCreate
|
|
115
|
+
*/
|
|
116
|
+
'external_id'?: string | null;
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @type {SingleRewardOrder1Payment}
|
|
120
|
+
* @memberof BaseOrderForCreate
|
|
121
|
+
*/
|
|
122
|
+
'payment': SingleRewardOrder1Payment;
|
|
52
123
|
}
|
|
53
124
|
/**
|
|
54
125
|
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
@@ -136,6 +207,21 @@ export interface CampaignBase {
|
|
|
136
207
|
*/
|
|
137
208
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
138
209
|
}
|
|
210
|
+
/**
|
|
211
|
+
* Name of the channel in which the order was created
|
|
212
|
+
* @export
|
|
213
|
+
* @enum {string}
|
|
214
|
+
*/
|
|
215
|
+
export declare const Channel: {
|
|
216
|
+
readonly Ui: "UI";
|
|
217
|
+
readonly Api: "API";
|
|
218
|
+
readonly Embed: "EMBED";
|
|
219
|
+
readonly Decipher: "DECIPHER";
|
|
220
|
+
readonly Qualtrics: "QUALTRICS";
|
|
221
|
+
readonly Typeform: "TYPEFORM";
|
|
222
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
223
|
+
};
|
|
224
|
+
export type Channel = typeof Channel[keyof typeof Channel];
|
|
139
225
|
/**
|
|
140
226
|
*
|
|
141
227
|
* @export
|
|
@@ -321,478 +407,182 @@ export interface CreateMemberRequest {
|
|
|
321
407
|
export interface CreateOrder200Response {
|
|
322
408
|
/**
|
|
323
409
|
*
|
|
324
|
-
* @type {
|
|
410
|
+
* @type {ListOrders200ResponseOrdersInner}
|
|
325
411
|
* @memberof CreateOrder200Response
|
|
326
412
|
*/
|
|
327
|
-
'order':
|
|
413
|
+
'order': ListOrders200ResponseOrdersInner;
|
|
328
414
|
}
|
|
329
415
|
/**
|
|
330
|
-
*
|
|
416
|
+
* @type CreateOrderRequest
|
|
331
417
|
* @export
|
|
332
|
-
* @interface CreateOrder200ResponseOrder
|
|
333
418
|
*/
|
|
334
|
-
export
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
/**
|
|
342
|
-
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
343
|
-
* @type {string}
|
|
344
|
-
* @memberof CreateOrder200ResponseOrder
|
|
345
|
-
*/
|
|
346
|
-
'external_id'?: string | null;
|
|
419
|
+
export type CreateOrderRequest = SingleRewardOrder1;
|
|
420
|
+
/**
|
|
421
|
+
*
|
|
422
|
+
* @export
|
|
423
|
+
* @interface CreateOrganization
|
|
424
|
+
*/
|
|
425
|
+
export interface CreateOrganization {
|
|
347
426
|
/**
|
|
348
|
-
*
|
|
427
|
+
* Name of the organization
|
|
349
428
|
* @type {string}
|
|
350
|
-
* @memberof
|
|
429
|
+
* @memberof CreateOrganization
|
|
351
430
|
*/
|
|
352
|
-
'
|
|
431
|
+
'name': string;
|
|
353
432
|
/**
|
|
354
|
-
*
|
|
433
|
+
* URL of the website of that organization
|
|
355
434
|
* @type {string}
|
|
356
|
-
* @memberof
|
|
435
|
+
* @memberof CreateOrganization
|
|
357
436
|
*/
|
|
358
|
-
'
|
|
437
|
+
'website': string;
|
|
359
438
|
/**
|
|
360
|
-
*
|
|
361
|
-
* @type {
|
|
362
|
-
* @memberof
|
|
439
|
+
* Default value is `false`. Set to true to also generate an API key associated to the new organization.
|
|
440
|
+
* @type {boolean}
|
|
441
|
+
* @memberof CreateOrganization
|
|
363
442
|
*/
|
|
364
|
-
'
|
|
443
|
+
'with_api_key'?: boolean;
|
|
365
444
|
/**
|
|
366
445
|
*
|
|
367
|
-
* @type {
|
|
368
|
-
* @memberof
|
|
446
|
+
* @type {CreateOrganizationRequestCopySettings}
|
|
447
|
+
* @memberof CreateOrganization
|
|
369
448
|
*/
|
|
370
|
-
'
|
|
449
|
+
'copy_settings'?: CreateOrganizationRequestCopySettings;
|
|
371
450
|
/**
|
|
372
|
-
*
|
|
451
|
+
* Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
|
|
373
452
|
* @type {string}
|
|
374
|
-
* @memberof
|
|
453
|
+
* @memberof CreateOrganization
|
|
375
454
|
*/
|
|
376
|
-
'
|
|
455
|
+
'phone'?: string;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
*
|
|
459
|
+
* @export
|
|
460
|
+
* @interface CreateOrganization200Response
|
|
461
|
+
*/
|
|
462
|
+
export interface CreateOrganization200Response {
|
|
377
463
|
/**
|
|
378
464
|
*
|
|
379
|
-
* @type {
|
|
380
|
-
* @memberof
|
|
465
|
+
* @type {CreateOrganization200ResponseOrganization}
|
|
466
|
+
* @memberof CreateOrganization200Response
|
|
381
467
|
*/
|
|
382
|
-
'
|
|
468
|
+
'organization'?: CreateOrganization200ResponseOrganization;
|
|
383
469
|
}
|
|
384
|
-
export declare const CreateOrder200ResponseOrderStatusEnum: {
|
|
385
|
-
readonly Canceled: "CANCELED";
|
|
386
|
-
readonly Cart: "CART";
|
|
387
|
-
readonly Executed: "EXECUTED";
|
|
388
|
-
readonly Failed: "FAILED";
|
|
389
|
-
readonly PendingApproval: "PENDING APPROVAL";
|
|
390
|
-
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
391
|
-
};
|
|
392
|
-
export type CreateOrder200ResponseOrderStatusEnum = typeof CreateOrder200ResponseOrderStatusEnum[keyof typeof CreateOrder200ResponseOrderStatusEnum];
|
|
393
470
|
/**
|
|
394
|
-
*
|
|
471
|
+
* Organizations are a way to separate different parts of your business within the same Tremendous account. Your root Tremendous account is an organization itself and can have multiple sub-organizations. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. Each organizations can have it\'s own API key.
|
|
395
472
|
* @export
|
|
396
|
-
* @interface
|
|
473
|
+
* @interface CreateOrganization200ResponseOrganization
|
|
397
474
|
*/
|
|
398
|
-
export interface
|
|
475
|
+
export interface CreateOrganization200ResponseOrganization {
|
|
399
476
|
/**
|
|
400
|
-
*
|
|
477
|
+
*
|
|
401
478
|
* @type {string}
|
|
402
|
-
* @memberof
|
|
479
|
+
* @memberof CreateOrganization200ResponseOrganization
|
|
403
480
|
*/
|
|
404
481
|
'id'?: string;
|
|
405
482
|
/**
|
|
406
|
-
*
|
|
407
|
-
* @type {string}
|
|
408
|
-
* @memberof CreateOrder200ResponseOrderRewardsInner
|
|
409
|
-
*/
|
|
410
|
-
'order_id'?: string;
|
|
411
|
-
/**
|
|
412
|
-
* Date the reward was created
|
|
483
|
+
* Name of the organization
|
|
413
484
|
* @type {string}
|
|
414
|
-
* @memberof
|
|
415
|
-
*/
|
|
416
|
-
'created_at'?: string;
|
|
417
|
-
/**
|
|
418
|
-
*
|
|
419
|
-
* @type {ListRewards200ResponseRewardsInnerValue}
|
|
420
|
-
* @memberof CreateOrder200ResponseOrderRewardsInner
|
|
421
|
-
*/
|
|
422
|
-
'value'?: ListRewards200ResponseRewardsInnerValue;
|
|
423
|
-
/**
|
|
424
|
-
*
|
|
425
|
-
* @type {ListRewards200ResponseRewardsInnerRecipient}
|
|
426
|
-
* @memberof CreateOrder200ResponseOrderRewardsInner
|
|
485
|
+
* @memberof CreateOrganization200ResponseOrganization
|
|
427
486
|
*/
|
|
428
|
-
'
|
|
487
|
+
'name': string;
|
|
429
488
|
/**
|
|
430
|
-
*
|
|
489
|
+
* URL of the website of that organization
|
|
431
490
|
* @type {string}
|
|
432
|
-
* @memberof
|
|
433
|
-
*/
|
|
434
|
-
'deliver_at'?: string;
|
|
435
|
-
/**
|
|
436
|
-
*
|
|
437
|
-
* @type {Array<ListRewards200ResponseRewardsInnerCustomFieldsInner>}
|
|
438
|
-
* @memberof CreateOrder200ResponseOrderRewardsInner
|
|
439
|
-
*/
|
|
440
|
-
'custom_fields'?: Array<ListRewards200ResponseRewardsInnerCustomFieldsInner>;
|
|
441
|
-
/**
|
|
442
|
-
*
|
|
443
|
-
* @type {CreateOrder200ResponseOrderRewardsInnerDelivery}
|
|
444
|
-
* @memberof CreateOrder200ResponseOrderRewardsInner
|
|
491
|
+
* @memberof CreateOrganization200ResponseOrganization
|
|
445
492
|
*/
|
|
446
|
-
'
|
|
447
|
-
}
|
|
448
|
-
/**
|
|
449
|
-
* Details on how the reward is delivered to the recipient.
|
|
450
|
-
* @export
|
|
451
|
-
* @interface CreateOrder200ResponseOrderRewardsInnerDelivery
|
|
452
|
-
*/
|
|
453
|
-
export interface CreateOrder200ResponseOrderRewardsInnerDelivery {
|
|
493
|
+
'website': string;
|
|
454
494
|
/**
|
|
455
|
-
*
|
|
495
|
+
* Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
456
496
|
* @type {string}
|
|
457
|
-
* @memberof
|
|
497
|
+
* @memberof CreateOrganization200ResponseOrganization
|
|
458
498
|
*/
|
|
459
|
-
'
|
|
499
|
+
'status'?: CreateOrganization200ResponseOrganizationStatusEnum;
|
|
460
500
|
/**
|
|
461
|
-
*
|
|
501
|
+
* Timestamp of when the organization has been created. *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations.
|
|
462
502
|
* @type {string}
|
|
463
|
-
* @memberof
|
|
503
|
+
* @memberof CreateOrganization200ResponseOrganization
|
|
464
504
|
*/
|
|
465
|
-
'
|
|
505
|
+
'created_at'?: string;
|
|
466
506
|
/**
|
|
467
|
-
*
|
|
507
|
+
* The API key for the created organization. This property is only returned when `with_api_key` is set to `true`.
|
|
468
508
|
* @type {string}
|
|
469
|
-
* @memberof
|
|
509
|
+
* @memberof CreateOrganization200ResponseOrganization
|
|
470
510
|
*/
|
|
471
|
-
'
|
|
511
|
+
'api_key'?: string;
|
|
472
512
|
}
|
|
473
|
-
export declare const
|
|
474
|
-
readonly Email: "EMAIL";
|
|
475
|
-
readonly Link: "LINK";
|
|
476
|
-
readonly Phone: "PHONE";
|
|
477
|
-
};
|
|
478
|
-
export type CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum = typeof CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum[keyof typeof CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum];
|
|
479
|
-
export declare const CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum: {
|
|
480
|
-
readonly Scheduled: "SCHEDULED";
|
|
481
|
-
readonly Failed: "FAILED";
|
|
482
|
-
readonly Succeeded: "SUCCEEDED";
|
|
513
|
+
export declare const CreateOrganization200ResponseOrganizationStatusEnum: {
|
|
483
514
|
readonly Pending: "PENDING";
|
|
515
|
+
readonly Approved: "APPROVED";
|
|
516
|
+
readonly Rejected: "REJECTED";
|
|
484
517
|
};
|
|
485
|
-
export type
|
|
518
|
+
export type CreateOrganization200ResponseOrganizationStatusEnum = typeof CreateOrganization200ResponseOrganizationStatusEnum[keyof typeof CreateOrganization200ResponseOrganizationStatusEnum];
|
|
486
519
|
/**
|
|
487
520
|
*
|
|
488
521
|
* @export
|
|
489
|
-
* @interface
|
|
522
|
+
* @interface CreateOrganizationRequest
|
|
490
523
|
*/
|
|
491
|
-
export interface
|
|
524
|
+
export interface CreateOrganizationRequest {
|
|
492
525
|
/**
|
|
493
|
-
*
|
|
494
|
-
* @type {
|
|
495
|
-
* @memberof
|
|
526
|
+
* Name of the organization
|
|
527
|
+
* @type {string}
|
|
528
|
+
* @memberof CreateOrganizationRequest
|
|
496
529
|
*/
|
|
497
|
-
'
|
|
498
|
-
}
|
|
499
|
-
/**
|
|
500
|
-
*
|
|
501
|
-
* @export
|
|
502
|
-
* @interface CreateOrderRequest
|
|
503
|
-
*/
|
|
504
|
-
export interface CreateOrderRequest {
|
|
530
|
+
'name': string;
|
|
505
531
|
/**
|
|
506
|
-
*
|
|
532
|
+
* URL of the website of that organization
|
|
507
533
|
* @type {string}
|
|
508
|
-
* @memberof
|
|
534
|
+
* @memberof CreateOrganizationRequest
|
|
509
535
|
*/
|
|
510
|
-
'
|
|
536
|
+
'website': string;
|
|
511
537
|
/**
|
|
512
|
-
*
|
|
513
|
-
* @type {
|
|
514
|
-
* @memberof
|
|
538
|
+
* Default value is `false`. Set to true to also generate an API key associated to the new organization.
|
|
539
|
+
* @type {boolean}
|
|
540
|
+
* @memberof CreateOrganizationRequest
|
|
515
541
|
*/
|
|
516
|
-
'
|
|
542
|
+
'with_api_key'?: boolean;
|
|
517
543
|
/**
|
|
518
544
|
*
|
|
519
|
-
* @type {
|
|
520
|
-
* @memberof
|
|
545
|
+
* @type {CreateOrganizationRequestCopySettings}
|
|
546
|
+
* @memberof CreateOrganizationRequest
|
|
521
547
|
*/
|
|
522
|
-
'
|
|
523
|
-
}
|
|
524
|
-
/**
|
|
525
|
-
*
|
|
526
|
-
* @export
|
|
527
|
-
* @interface CreateOrderRequestPayment
|
|
528
|
-
*/
|
|
529
|
-
export interface CreateOrderRequestPayment {
|
|
548
|
+
'copy_settings'?: CreateOrganizationRequestCopySettings;
|
|
530
549
|
/**
|
|
531
|
-
*
|
|
550
|
+
* Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
|
|
532
551
|
* @type {string}
|
|
533
|
-
* @memberof
|
|
552
|
+
* @memberof CreateOrganizationRequest
|
|
534
553
|
*/
|
|
535
|
-
'
|
|
554
|
+
'phone'?: string;
|
|
536
555
|
}
|
|
537
556
|
/**
|
|
538
|
-
* A
|
|
557
|
+
* A list of the settings that you wish to copy over to the new organization.
|
|
539
558
|
* @export
|
|
540
|
-
* @interface
|
|
559
|
+
* @interface CreateOrganizationRequestCopySettings
|
|
541
560
|
*/
|
|
542
|
-
export interface
|
|
561
|
+
export interface CreateOrganizationRequestCopySettings {
|
|
543
562
|
/**
|
|
544
|
-
*
|
|
545
|
-
* @type {
|
|
546
|
-
* @memberof
|
|
563
|
+
* Copy over the campaigns from the current organization to the new organization. Defaults to `false`.
|
|
564
|
+
* @type {boolean}
|
|
565
|
+
* @memberof CreateOrganizationRequestCopySettings
|
|
547
566
|
*/
|
|
548
|
-
'
|
|
567
|
+
'campaigns'?: boolean;
|
|
549
568
|
/**
|
|
550
|
-
*
|
|
551
|
-
* @type {
|
|
552
|
-
* @memberof
|
|
569
|
+
* Copy over the custom fields from the current organization to the new organization. Defaults to `false`.
|
|
570
|
+
* @type {boolean}
|
|
571
|
+
* @memberof CreateOrganizationRequestCopySettings
|
|
553
572
|
*/
|
|
554
|
-
'
|
|
573
|
+
'custom_fields'?: boolean;
|
|
555
574
|
/**
|
|
556
|
-
*
|
|
557
|
-
* @type {
|
|
558
|
-
* @memberof
|
|
575
|
+
* Copy over the order approvals settings from the current organization to the new organization. Defaults to `false`.
|
|
576
|
+
* @type {boolean}
|
|
577
|
+
* @memberof CreateOrganizationRequestCopySettings
|
|
559
578
|
*/
|
|
560
|
-
'
|
|
579
|
+
'order_approvals'?: boolean;
|
|
561
580
|
/**
|
|
562
|
-
*
|
|
563
|
-
* @type {
|
|
564
|
-
* @memberof
|
|
581
|
+
* Copy over the payment methods from the current organization to the new organization. Defaults to `false`.
|
|
582
|
+
* @type {boolean}
|
|
583
|
+
* @memberof CreateOrganizationRequestCopySettings
|
|
565
584
|
*/
|
|
566
|
-
'
|
|
567
|
-
/**
|
|
568
|
-
* Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
|
|
569
|
-
* @type {string}
|
|
570
|
-
* @memberof CreateOrderRequestReward
|
|
571
|
-
*/
|
|
572
|
-
'deliver_at'?: string;
|
|
573
|
-
/**
|
|
574
|
-
*
|
|
575
|
-
* @type {Array<CreateOrderRequestRewardCustomFieldsInner>}
|
|
576
|
-
* @memberof CreateOrderRequestReward
|
|
577
|
-
*/
|
|
578
|
-
'custom_fields'?: Array<CreateOrderRequestRewardCustomFieldsInner>;
|
|
579
|
-
/**
|
|
580
|
-
* Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to `en`.
|
|
581
|
-
* @type {string}
|
|
582
|
-
* @memberof CreateOrderRequestReward
|
|
583
|
-
*/
|
|
584
|
-
'language'?: string;
|
|
585
|
-
/**
|
|
586
|
-
*
|
|
587
|
-
* @type {CreateOrderRequestRewardDelivery}
|
|
588
|
-
* @memberof CreateOrderRequestReward
|
|
589
|
-
*/
|
|
590
|
-
'delivery'?: CreateOrderRequestRewardDelivery;
|
|
591
|
-
}
|
|
592
|
-
/**
|
|
593
|
-
* Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/reference/using-custom-fields-to-add-custom-data-to-rewards).)
|
|
594
|
-
* @export
|
|
595
|
-
* @interface CreateOrderRequestRewardCustomFieldsInner
|
|
596
|
-
*/
|
|
597
|
-
export interface CreateOrderRequestRewardCustomFieldsInner {
|
|
598
|
-
/**
|
|
599
|
-
* Tremendous ID of the custom field
|
|
600
|
-
* @type {string}
|
|
601
|
-
* @memberof CreateOrderRequestRewardCustomFieldsInner
|
|
602
|
-
*/
|
|
603
|
-
'id'?: string;
|
|
604
|
-
/**
|
|
605
|
-
* Value of the custom field
|
|
606
|
-
* @type {string}
|
|
607
|
-
* @memberof CreateOrderRequestRewardCustomFieldsInner
|
|
608
|
-
*/
|
|
609
|
-
'value'?: string | null;
|
|
610
|
-
}
|
|
611
|
-
/**
|
|
612
|
-
* Details on how the reward is delivered to the recipient.
|
|
613
|
-
* @export
|
|
614
|
-
* @interface CreateOrderRequestRewardDelivery
|
|
615
|
-
*/
|
|
616
|
-
export interface CreateOrderRequestRewardDelivery {
|
|
617
|
-
/**
|
|
618
|
-
* How to deliver the reward to the recipient. <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table>
|
|
619
|
-
* @type {string}
|
|
620
|
-
* @memberof CreateOrderRequestRewardDelivery
|
|
621
|
-
*/
|
|
622
|
-
'method'?: CreateOrderRequestRewardDeliveryMethodEnum;
|
|
623
|
-
}
|
|
624
|
-
export declare const CreateOrderRequestRewardDeliveryMethodEnum: {
|
|
625
|
-
readonly Email: "EMAIL";
|
|
626
|
-
readonly Link: "LINK";
|
|
627
|
-
readonly Phone: "PHONE";
|
|
628
|
-
};
|
|
629
|
-
export type CreateOrderRequestRewardDeliveryMethodEnum = typeof CreateOrderRequestRewardDeliveryMethodEnum[keyof typeof CreateOrderRequestRewardDeliveryMethodEnum];
|
|
630
|
-
/**
|
|
631
|
-
*
|
|
632
|
-
* @export
|
|
633
|
-
* @interface CreateOrganization
|
|
634
|
-
*/
|
|
635
|
-
export interface CreateOrganization {
|
|
636
|
-
/**
|
|
637
|
-
* Name of the organization
|
|
638
|
-
* @type {string}
|
|
639
|
-
* @memberof CreateOrganization
|
|
640
|
-
*/
|
|
641
|
-
'name': string;
|
|
642
|
-
/**
|
|
643
|
-
* URL of the website of that organization
|
|
644
|
-
* @type {string}
|
|
645
|
-
* @memberof CreateOrganization
|
|
646
|
-
*/
|
|
647
|
-
'website': string;
|
|
648
|
-
/**
|
|
649
|
-
* Default value is `false`. Set to true to also generate an API key associated to the new organization.
|
|
650
|
-
* @type {boolean}
|
|
651
|
-
* @memberof CreateOrganization
|
|
652
|
-
*/
|
|
653
|
-
'with_api_key'?: boolean;
|
|
654
|
-
/**
|
|
655
|
-
*
|
|
656
|
-
* @type {CreateOrganizationRequestCopySettings}
|
|
657
|
-
* @memberof CreateOrganization
|
|
658
|
-
*/
|
|
659
|
-
'copy_settings'?: CreateOrganizationRequestCopySettings;
|
|
660
|
-
/**
|
|
661
|
-
* Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
|
|
662
|
-
* @type {string}
|
|
663
|
-
* @memberof CreateOrganization
|
|
664
|
-
*/
|
|
665
|
-
'phone'?: string;
|
|
666
|
-
}
|
|
667
|
-
/**
|
|
668
|
-
*
|
|
669
|
-
* @export
|
|
670
|
-
* @interface CreateOrganization200Response
|
|
671
|
-
*/
|
|
672
|
-
export interface CreateOrganization200Response {
|
|
673
|
-
/**
|
|
674
|
-
*
|
|
675
|
-
* @type {CreateOrganization200ResponseOrganization}
|
|
676
|
-
* @memberof CreateOrganization200Response
|
|
677
|
-
*/
|
|
678
|
-
'organization'?: CreateOrganization200ResponseOrganization;
|
|
679
|
-
}
|
|
680
|
-
/**
|
|
681
|
-
* Organizations are a way to separate different parts of your business within the same Tremendous account. Your root Tremendous account is an organization itself and can have multiple sub-organizations. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. Each organizations can have it\'s own API key.
|
|
682
|
-
* @export
|
|
683
|
-
* @interface CreateOrganization200ResponseOrganization
|
|
684
|
-
*/
|
|
685
|
-
export interface CreateOrganization200ResponseOrganization {
|
|
686
|
-
/**
|
|
687
|
-
*
|
|
688
|
-
* @type {string}
|
|
689
|
-
* @memberof CreateOrganization200ResponseOrganization
|
|
690
|
-
*/
|
|
691
|
-
'id'?: string;
|
|
692
|
-
/**
|
|
693
|
-
* Name of the organization
|
|
694
|
-
* @type {string}
|
|
695
|
-
* @memberof CreateOrganization200ResponseOrganization
|
|
696
|
-
*/
|
|
697
|
-
'name': string;
|
|
698
|
-
/**
|
|
699
|
-
* URL of the website of that organization
|
|
700
|
-
* @type {string}
|
|
701
|
-
* @memberof CreateOrganization200ResponseOrganization
|
|
702
|
-
*/
|
|
703
|
-
'website': string;
|
|
704
|
-
/**
|
|
705
|
-
* Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
706
|
-
* @type {string}
|
|
707
|
-
* @memberof CreateOrganization200ResponseOrganization
|
|
708
|
-
*/
|
|
709
|
-
'status'?: CreateOrganization200ResponseOrganizationStatusEnum;
|
|
710
|
-
/**
|
|
711
|
-
* Timestamp of when the organization has been created. *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations.
|
|
712
|
-
* @type {string}
|
|
713
|
-
* @memberof CreateOrganization200ResponseOrganization
|
|
714
|
-
*/
|
|
715
|
-
'created_at'?: string;
|
|
716
|
-
/**
|
|
717
|
-
* The API key for the created organization. This property is only returned when `with_api_key` is set to `true`.
|
|
718
|
-
* @type {string}
|
|
719
|
-
* @memberof CreateOrganization200ResponseOrganization
|
|
720
|
-
*/
|
|
721
|
-
'api_key'?: string;
|
|
722
|
-
}
|
|
723
|
-
export declare const CreateOrganization200ResponseOrganizationStatusEnum: {
|
|
724
|
-
readonly Pending: "PENDING";
|
|
725
|
-
readonly Approved: "APPROVED";
|
|
726
|
-
readonly Rejected: "REJECTED";
|
|
727
|
-
};
|
|
728
|
-
export type CreateOrganization200ResponseOrganizationStatusEnum = typeof CreateOrganization200ResponseOrganizationStatusEnum[keyof typeof CreateOrganization200ResponseOrganizationStatusEnum];
|
|
729
|
-
/**
|
|
730
|
-
*
|
|
731
|
-
* @export
|
|
732
|
-
* @interface CreateOrganizationRequest
|
|
733
|
-
*/
|
|
734
|
-
export interface CreateOrganizationRequest {
|
|
735
|
-
/**
|
|
736
|
-
* Name of the organization
|
|
737
|
-
* @type {string}
|
|
738
|
-
* @memberof CreateOrganizationRequest
|
|
739
|
-
*/
|
|
740
|
-
'name': string;
|
|
741
|
-
/**
|
|
742
|
-
* URL of the website of that organization
|
|
743
|
-
* @type {string}
|
|
744
|
-
* @memberof CreateOrganizationRequest
|
|
745
|
-
*/
|
|
746
|
-
'website': string;
|
|
747
|
-
/**
|
|
748
|
-
* Default value is `false`. Set to true to also generate an API key associated to the new organization.
|
|
749
|
-
* @type {boolean}
|
|
750
|
-
* @memberof CreateOrganizationRequest
|
|
751
|
-
*/
|
|
752
|
-
'with_api_key'?: boolean;
|
|
753
|
-
/**
|
|
754
|
-
*
|
|
755
|
-
* @type {CreateOrganizationRequestCopySettings}
|
|
756
|
-
* @memberof CreateOrganizationRequest
|
|
757
|
-
*/
|
|
758
|
-
'copy_settings'?: CreateOrganizationRequestCopySettings;
|
|
759
|
-
/**
|
|
760
|
-
* Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).
|
|
761
|
-
* @type {string}
|
|
762
|
-
* @memberof CreateOrganizationRequest
|
|
763
|
-
*/
|
|
764
|
-
'phone'?: string;
|
|
765
|
-
}
|
|
766
|
-
/**
|
|
767
|
-
* A list of the settings that you wish to copy over to the new organization.
|
|
768
|
-
* @export
|
|
769
|
-
* @interface CreateOrganizationRequestCopySettings
|
|
770
|
-
*/
|
|
771
|
-
export interface CreateOrganizationRequestCopySettings {
|
|
772
|
-
/**
|
|
773
|
-
* Copy over the campaigns from the current organization to the new organization. Defaults to `false`.
|
|
774
|
-
* @type {boolean}
|
|
775
|
-
* @memberof CreateOrganizationRequestCopySettings
|
|
776
|
-
*/
|
|
777
|
-
'campaigns'?: boolean;
|
|
778
|
-
/**
|
|
779
|
-
* Copy over the custom fields from the current organization to the new organization. Defaults to `false`.
|
|
780
|
-
* @type {boolean}
|
|
781
|
-
* @memberof CreateOrganizationRequestCopySettings
|
|
782
|
-
*/
|
|
783
|
-
'custom_fields'?: boolean;
|
|
784
|
-
/**
|
|
785
|
-
* Copy over the order approvals settings from the current organization to the new organization. Defaults to `false`.
|
|
786
|
-
* @type {boolean}
|
|
787
|
-
* @memberof CreateOrganizationRequestCopySettings
|
|
788
|
-
*/
|
|
789
|
-
'order_approvals'?: boolean;
|
|
790
|
-
/**
|
|
791
|
-
* Copy over the payment methods from the current organization to the new organization. Defaults to `false`.
|
|
792
|
-
* @type {boolean}
|
|
793
|
-
* @memberof CreateOrganizationRequestCopySettings
|
|
794
|
-
*/
|
|
795
|
-
'payment_methods'?: boolean;
|
|
585
|
+
'payment_methods'?: boolean;
|
|
796
586
|
/**
|
|
797
587
|
* Copy over the security settings from the current organization to the new organization. Defaults to `true`.
|
|
798
588
|
* @type {boolean}
|
|
@@ -1032,6 +822,19 @@ export interface CustomField {
|
|
|
1032
822
|
*/
|
|
1033
823
|
'label'?: string;
|
|
1034
824
|
}
|
|
825
|
+
/**
|
|
826
|
+
*
|
|
827
|
+
* @export
|
|
828
|
+
* @interface DeleteFraudRule200Response
|
|
829
|
+
*/
|
|
830
|
+
export interface DeleteFraudRule200Response {
|
|
831
|
+
/**
|
|
832
|
+
* A description of the result
|
|
833
|
+
* @type {string}
|
|
834
|
+
* @memberof DeleteFraudRule200Response
|
|
835
|
+
*/
|
|
836
|
+
'message': string;
|
|
837
|
+
}
|
|
1035
838
|
/**
|
|
1036
839
|
* Details on how the reward is delivered to the recipient.
|
|
1037
840
|
* @export
|
|
@@ -1064,44 +867,6 @@ export declare const DeliveryDetailsStatusEnum: {
|
|
|
1064
867
|
readonly Pending: "PENDING";
|
|
1065
868
|
};
|
|
1066
869
|
export type DeliveryDetailsStatusEnum = typeof DeliveryDetailsStatusEnum[keyof typeof DeliveryDetailsStatusEnum];
|
|
1067
|
-
/**
|
|
1068
|
-
* Details on how the reward is delivered to the recipient.
|
|
1069
|
-
* @export
|
|
1070
|
-
* @interface DeliveryDetailsWithLink
|
|
1071
|
-
*/
|
|
1072
|
-
export interface DeliveryDetailsWithLink {
|
|
1073
|
-
/**
|
|
1074
|
-
* How to deliver the reward to the recipient. <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table>
|
|
1075
|
-
* @type {string}
|
|
1076
|
-
* @memberof DeliveryDetailsWithLink
|
|
1077
|
-
*/
|
|
1078
|
-
'method': DeliveryDetailsWithLinkMethodEnum;
|
|
1079
|
-
/**
|
|
1080
|
-
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link opened). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
1081
|
-
* @type {string}
|
|
1082
|
-
* @memberof DeliveryDetailsWithLink
|
|
1083
|
-
*/
|
|
1084
|
-
'status': DeliveryDetailsWithLinkStatusEnum;
|
|
1085
|
-
/**
|
|
1086
|
-
* Link to redeem the reward at. You need to deliver this link to the recipient. Only available for rewards for which the `method` for delivery is set to `LINK`.
|
|
1087
|
-
* @type {string}
|
|
1088
|
-
* @memberof DeliveryDetailsWithLink
|
|
1089
|
-
*/
|
|
1090
|
-
'link'?: string;
|
|
1091
|
-
}
|
|
1092
|
-
export declare const DeliveryDetailsWithLinkMethodEnum: {
|
|
1093
|
-
readonly Email: "EMAIL";
|
|
1094
|
-
readonly Link: "LINK";
|
|
1095
|
-
readonly Phone: "PHONE";
|
|
1096
|
-
};
|
|
1097
|
-
export type DeliveryDetailsWithLinkMethodEnum = typeof DeliveryDetailsWithLinkMethodEnum[keyof typeof DeliveryDetailsWithLinkMethodEnum];
|
|
1098
|
-
export declare const DeliveryDetailsWithLinkStatusEnum: {
|
|
1099
|
-
readonly Scheduled: "SCHEDULED";
|
|
1100
|
-
readonly Failed: "FAILED";
|
|
1101
|
-
readonly Succeeded: "SUCCEEDED";
|
|
1102
|
-
readonly Pending: "PENDING";
|
|
1103
|
-
};
|
|
1104
|
-
export type DeliveryDetailsWithLinkStatusEnum = typeof DeliveryDetailsWithLinkStatusEnum[keyof typeof DeliveryDetailsWithLinkStatusEnum];
|
|
1105
870
|
/**
|
|
1106
871
|
* How to deliver the reward to the recipient. <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table>
|
|
1107
872
|
* @export
|
|
@@ -1186,19 +951,605 @@ export interface Field {
|
|
|
1186
951
|
/**
|
|
1187
952
|
*
|
|
1188
953
|
* @export
|
|
1189
|
-
* @interface
|
|
954
|
+
* @interface FraudConfigAllowEmail
|
|
1190
955
|
*/
|
|
1191
|
-
export interface
|
|
956
|
+
export interface FraudConfigAllowEmail {
|
|
1192
957
|
/**
|
|
1193
|
-
*
|
|
1194
|
-
* @type {string}
|
|
1195
|
-
* @memberof
|
|
958
|
+
* The list of emails.
|
|
959
|
+
* @type {Array<string>}
|
|
960
|
+
* @memberof FraudConfigAllowEmail
|
|
1196
961
|
*/
|
|
1197
|
-
'
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
962
|
+
'emails': Array<string>;
|
|
963
|
+
}
|
|
964
|
+
/**
|
|
965
|
+
*
|
|
966
|
+
* @export
|
|
967
|
+
* @interface FraudConfigCountry
|
|
968
|
+
*/
|
|
969
|
+
export interface FraudConfigCountry {
|
|
970
|
+
/**
|
|
971
|
+
* When type is `whitelist`, it flags any countries that *are not* present in the list. When type is `blacklist`, it flags any countries that *are* present in the list.
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof FraudConfigCountry
|
|
974
|
+
*/
|
|
975
|
+
'type': FraudConfigCountryTypeEnum;
|
|
976
|
+
/**
|
|
977
|
+
* An array of country codes (ISO-3166 alpha-2 character code)
|
|
978
|
+
* @type {Array<string>}
|
|
979
|
+
* @memberof FraudConfigCountry
|
|
980
|
+
*/
|
|
981
|
+
'countries': Array<string>;
|
|
982
|
+
}
|
|
983
|
+
export declare const FraudConfigCountryTypeEnum: {
|
|
984
|
+
readonly Whitelist: "whitelist";
|
|
985
|
+
readonly Blacklist: "blacklist";
|
|
986
|
+
};
|
|
987
|
+
export type FraudConfigCountryTypeEnum = typeof FraudConfigCountryTypeEnum[keyof typeof FraudConfigCountryTypeEnum];
|
|
988
|
+
/**
|
|
989
|
+
*
|
|
990
|
+
* @export
|
|
991
|
+
* @interface FraudConfigCountryUpdateList
|
|
992
|
+
*/
|
|
993
|
+
export interface FraudConfigCountryUpdateList {
|
|
994
|
+
/**
|
|
995
|
+
* An array of country codes (ISO-3166 alpha-2 character code)
|
|
996
|
+
* @type {Array<string>}
|
|
997
|
+
* @memberof FraudConfigCountryUpdateList
|
|
998
|
+
*/
|
|
999
|
+
'countries': Array<string>;
|
|
1000
|
+
}
|
|
1001
|
+
/**
|
|
1002
|
+
*
|
|
1003
|
+
* @export
|
|
1004
|
+
* @interface FraudConfigIP
|
|
1005
|
+
*/
|
|
1006
|
+
export interface FraudConfigIP {
|
|
1007
|
+
/**
|
|
1008
|
+
* The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
|
|
1009
|
+
* @type {Array<string>}
|
|
1010
|
+
* @memberof FraudConfigIP
|
|
1011
|
+
*/
|
|
1012
|
+
'ips': Array<string>;
|
|
1013
|
+
}
|
|
1014
|
+
/**
|
|
1015
|
+
*
|
|
1016
|
+
* @export
|
|
1017
|
+
* @interface FraudConfigRedeemedRewardsAmount
|
|
1018
|
+
*/
|
|
1019
|
+
export interface FraudConfigRedeemedRewardsAmount {
|
|
1020
|
+
/**
|
|
1021
|
+
* The total amount in USD of redeemed rewards to use as a threshold.
|
|
1022
|
+
* @type {number}
|
|
1023
|
+
* @memberof FraudConfigRedeemedRewardsAmount
|
|
1024
|
+
*/
|
|
1025
|
+
'amount': number;
|
|
1026
|
+
/**
|
|
1027
|
+
* The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
|
|
1028
|
+
* @type {string}
|
|
1029
|
+
* @memberof FraudConfigRedeemedRewardsAmount
|
|
1030
|
+
*/
|
|
1031
|
+
'period': FraudConfigRedeemedRewardsAmountPeriodEnum;
|
|
1032
|
+
}
|
|
1033
|
+
export declare const FraudConfigRedeemedRewardsAmountPeriodEnum: {
|
|
1034
|
+
readonly _7: "7";
|
|
1035
|
+
readonly _30: "30";
|
|
1036
|
+
readonly _90: "90";
|
|
1037
|
+
readonly _120: "120";
|
|
1038
|
+
readonly _365: "365";
|
|
1039
|
+
readonly AllTime: "all_time";
|
|
1040
|
+
};
|
|
1041
|
+
export type FraudConfigRedeemedRewardsAmountPeriodEnum = typeof FraudConfigRedeemedRewardsAmountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsAmountPeriodEnum];
|
|
1042
|
+
/**
|
|
1043
|
+
*
|
|
1044
|
+
* @export
|
|
1045
|
+
* @interface FraudConfigRedeemedRewardsCount
|
|
1046
|
+
*/
|
|
1047
|
+
export interface FraudConfigRedeemedRewardsCount {
|
|
1048
|
+
/**
|
|
1049
|
+
* The number of redeemed rewards to use as a threshold.
|
|
1050
|
+
* @type {number}
|
|
1051
|
+
* @memberof FraudConfigRedeemedRewardsCount
|
|
1052
|
+
*/
|
|
1053
|
+
'amount': number;
|
|
1054
|
+
/**
|
|
1055
|
+
* The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
|
|
1056
|
+
* @type {string}
|
|
1057
|
+
* @memberof FraudConfigRedeemedRewardsCount
|
|
1058
|
+
*/
|
|
1059
|
+
'period': FraudConfigRedeemedRewardsCountPeriodEnum;
|
|
1060
|
+
}
|
|
1061
|
+
export declare const FraudConfigRedeemedRewardsCountPeriodEnum: {
|
|
1062
|
+
readonly _7: "7";
|
|
1063
|
+
readonly _30: "30";
|
|
1064
|
+
readonly _90: "90";
|
|
1065
|
+
readonly _120: "120";
|
|
1066
|
+
readonly _365: "365";
|
|
1067
|
+
readonly AllTime: "all_time";
|
|
1068
|
+
};
|
|
1069
|
+
export type FraudConfigRedeemedRewardsCountPeriodEnum = typeof FraudConfigRedeemedRewardsCountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsCountPeriodEnum];
|
|
1070
|
+
/**
|
|
1071
|
+
*
|
|
1072
|
+
* @export
|
|
1073
|
+
* @interface FraudConfigReviewEmail
|
|
1074
|
+
*/
|
|
1075
|
+
export interface FraudConfigReviewEmail {
|
|
1076
|
+
/**
|
|
1077
|
+
* The list of emails.
|
|
1078
|
+
* @type {Array<string>}
|
|
1079
|
+
* @memberof FraudConfigReviewEmail
|
|
1080
|
+
*/
|
|
1081
|
+
'emails'?: Array<string>;
|
|
1082
|
+
/**
|
|
1083
|
+
* The list of domains. Any subdomains will also be matched against each entry in the list.
|
|
1084
|
+
* @type {Array<string>}
|
|
1085
|
+
* @memberof FraudConfigReviewEmail
|
|
1086
|
+
*/
|
|
1087
|
+
'domains'?: Array<string>;
|
|
1088
|
+
}
|
|
1089
|
+
/**
|
|
1090
|
+
*
|
|
1091
|
+
* @export
|
|
1092
|
+
* @interface FraudGenericResponse
|
|
1093
|
+
*/
|
|
1094
|
+
export interface FraudGenericResponse {
|
|
1095
|
+
/**
|
|
1096
|
+
* A description of the result
|
|
1097
|
+
* @type {string}
|
|
1098
|
+
* @memberof FraudGenericResponse
|
|
1099
|
+
*/
|
|
1100
|
+
'message': string;
|
|
1101
|
+
}
|
|
1102
|
+
/**
|
|
1103
|
+
* The fraud review associated with a reward.
|
|
1104
|
+
* @export
|
|
1105
|
+
* @interface FraudReview
|
|
1106
|
+
*/
|
|
1107
|
+
export interface FraudReview {
|
|
1108
|
+
/**
|
|
1109
|
+
* The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
|
|
1110
|
+
* @type {string}
|
|
1111
|
+
* @memberof FraudReview
|
|
1112
|
+
*/
|
|
1113
|
+
'status'?: FraudReviewStatusEnum;
|
|
1114
|
+
/**
|
|
1115
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
1116
|
+
* @type {Array<string>}
|
|
1117
|
+
* @memberof FraudReview
|
|
1118
|
+
*/
|
|
1119
|
+
'reasons'?: Array<FraudReviewReasonsEnum>;
|
|
1120
|
+
/**
|
|
1121
|
+
* The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`.
|
|
1122
|
+
* @type {string}
|
|
1123
|
+
* @memberof FraudReview
|
|
1124
|
+
*/
|
|
1125
|
+
'reviewed_by'?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
|
|
1128
|
+
* @type {string}
|
|
1129
|
+
* @memberof FraudReview
|
|
1130
|
+
*/
|
|
1131
|
+
'reviewed_at'?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
*
|
|
1134
|
+
* @type {GetFraudReview200ResponseFraudReviewRelatedRewards}
|
|
1135
|
+
* @memberof FraudReview
|
|
1136
|
+
*/
|
|
1137
|
+
'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
|
|
1138
|
+
/**
|
|
1139
|
+
* The device fingerprint, if known.
|
|
1140
|
+
* @type {string}
|
|
1141
|
+
* @memberof FraudReview
|
|
1142
|
+
*/
|
|
1143
|
+
'device_id'?: string;
|
|
1144
|
+
/**
|
|
1145
|
+
* The product selected to claim the reward
|
|
1146
|
+
* @type {string}
|
|
1147
|
+
* @memberof FraudReview
|
|
1148
|
+
*/
|
|
1149
|
+
'redemption_method'?: FraudReviewRedemptionMethodEnum;
|
|
1150
|
+
/**
|
|
1151
|
+
* Date the reward was redeemed
|
|
1152
|
+
* @type {string}
|
|
1153
|
+
* @memberof FraudReview
|
|
1154
|
+
*/
|
|
1155
|
+
'redeemed_at'?: string;
|
|
1156
|
+
/**
|
|
1157
|
+
*
|
|
1158
|
+
* @type {GetFraudReview200ResponseFraudReviewGeo}
|
|
1159
|
+
* @memberof FraudReview
|
|
1160
|
+
*/
|
|
1161
|
+
'geo'?: GetFraudReview200ResponseFraudReviewGeo;
|
|
1162
|
+
/**
|
|
1163
|
+
*
|
|
1164
|
+
* @type {OrderWithoutLinkRewardsInner}
|
|
1165
|
+
* @memberof FraudReview
|
|
1166
|
+
*/
|
|
1167
|
+
'reward'?: OrderWithoutLinkRewardsInner;
|
|
1168
|
+
}
|
|
1169
|
+
export declare const FraudReviewStatusEnum: {
|
|
1170
|
+
readonly Flagged: "flagged";
|
|
1171
|
+
readonly Blocked: "blocked";
|
|
1172
|
+
readonly Released: "released";
|
|
1173
|
+
};
|
|
1174
|
+
export type FraudReviewStatusEnum = typeof FraudReviewStatusEnum[keyof typeof FraudReviewStatusEnum];
|
|
1175
|
+
export declare const FraudReviewReasonsEnum: {
|
|
1176
|
+
readonly DisallowedIp: "Disallowed IP";
|
|
1177
|
+
readonly DisallowedEmail: "Disallowed email";
|
|
1178
|
+
readonly DisallowedCountry: "Disallowed country";
|
|
1179
|
+
readonly OverRewardDollarLimit: "Over reward dollar limit";
|
|
1180
|
+
readonly OverRewardCountLimit: "Over reward count limit";
|
|
1181
|
+
readonly VpnDetected: "VPN detected";
|
|
1182
|
+
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
1183
|
+
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
1184
|
+
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
1185
|
+
readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
|
|
1186
|
+
readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
|
|
1187
|
+
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
1188
|
+
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
1189
|
+
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
1190
|
+
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
1191
|
+
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
1192
|
+
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
1193
|
+
readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
|
|
1194
|
+
readonly AllowedIp: "Allowed IP";
|
|
1195
|
+
readonly AllowedEmail: "Allowed email";
|
|
1196
|
+
};
|
|
1197
|
+
export type FraudReviewReasonsEnum = typeof FraudReviewReasonsEnum[keyof typeof FraudReviewReasonsEnum];
|
|
1198
|
+
export declare const FraudReviewRedemptionMethodEnum: {
|
|
1199
|
+
readonly Paypal: "paypal";
|
|
1200
|
+
readonly Bank: "bank";
|
|
1201
|
+
readonly MerchantCard: "merchant card";
|
|
1202
|
+
readonly VisaCard: "visa card";
|
|
1203
|
+
readonly Charity: "charity";
|
|
1204
|
+
readonly Venmo: "venmo";
|
|
1205
|
+
};
|
|
1206
|
+
export type FraudReviewRedemptionMethodEnum = typeof FraudReviewRedemptionMethodEnum[keyof typeof FraudReviewRedemptionMethodEnum];
|
|
1207
|
+
/**
|
|
1208
|
+
*
|
|
1209
|
+
* @export
|
|
1210
|
+
* @interface FraudReviewGeo
|
|
1211
|
+
*/
|
|
1212
|
+
export interface FraudReviewGeo {
|
|
1213
|
+
/**
|
|
1214
|
+
* The recipient\'s IP.
|
|
1215
|
+
* @type {string}
|
|
1216
|
+
* @memberof FraudReviewGeo
|
|
1217
|
+
*/
|
|
1218
|
+
'ip'?: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* The country code (ISO-3166 alpha-2 character code) linked to the recipient\'s IP.
|
|
1221
|
+
* @type {string}
|
|
1222
|
+
* @memberof FraudReviewGeo
|
|
1223
|
+
*/
|
|
1224
|
+
'country'?: string;
|
|
1225
|
+
/**
|
|
1226
|
+
* The city associated with the recipient\'s IP.
|
|
1227
|
+
* @type {string}
|
|
1228
|
+
* @memberof FraudReviewGeo
|
|
1229
|
+
*/
|
|
1230
|
+
'city'?: string;
|
|
1231
|
+
}
|
|
1232
|
+
/**
|
|
1233
|
+
* The fraud review associated with a reward.
|
|
1234
|
+
* @export
|
|
1235
|
+
* @interface FraudReviewListItem
|
|
1236
|
+
*/
|
|
1237
|
+
export interface FraudReviewListItem {
|
|
1238
|
+
/**
|
|
1239
|
+
* The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
|
|
1240
|
+
* @type {string}
|
|
1241
|
+
* @memberof FraudReviewListItem
|
|
1242
|
+
*/
|
|
1243
|
+
'status'?: FraudReviewListItemStatusEnum;
|
|
1244
|
+
/**
|
|
1245
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
1246
|
+
* @type {Array<string>}
|
|
1247
|
+
* @memberof FraudReviewListItem
|
|
1248
|
+
*/
|
|
1249
|
+
'reasons'?: Array<FraudReviewListItemReasonsEnum>;
|
|
1250
|
+
/**
|
|
1251
|
+
*
|
|
1252
|
+
* @type {OrderWithoutLinkRewardsInner}
|
|
1253
|
+
* @memberof FraudReviewListItem
|
|
1254
|
+
*/
|
|
1255
|
+
'reward'?: OrderWithoutLinkRewardsInner;
|
|
1256
|
+
}
|
|
1257
|
+
export declare const FraudReviewListItemStatusEnum: {
|
|
1258
|
+
readonly Flagged: "flagged";
|
|
1259
|
+
readonly Blocked: "blocked";
|
|
1260
|
+
readonly Released: "released";
|
|
1261
|
+
};
|
|
1262
|
+
export type FraudReviewListItemStatusEnum = typeof FraudReviewListItemStatusEnum[keyof typeof FraudReviewListItemStatusEnum];
|
|
1263
|
+
export declare const FraudReviewListItemReasonsEnum: {
|
|
1264
|
+
readonly DisallowedIp: "Disallowed IP";
|
|
1265
|
+
readonly DisallowedEmail: "Disallowed email";
|
|
1266
|
+
readonly DisallowedCountry: "Disallowed country";
|
|
1267
|
+
readonly OverRewardDollarLimit: "Over reward dollar limit";
|
|
1268
|
+
readonly OverRewardCountLimit: "Over reward count limit";
|
|
1269
|
+
readonly VpnDetected: "VPN detected";
|
|
1270
|
+
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
1271
|
+
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
1272
|
+
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
1273
|
+
readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
|
|
1274
|
+
readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
|
|
1275
|
+
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
1276
|
+
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
1277
|
+
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
1278
|
+
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
1279
|
+
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
1280
|
+
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
1281
|
+
readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
|
|
1282
|
+
readonly AllowedIp: "Allowed IP";
|
|
1283
|
+
readonly AllowedEmail: "Allowed email";
|
|
1284
|
+
};
|
|
1285
|
+
export type FraudReviewListItemReasonsEnum = typeof FraudReviewListItemReasonsEnum[keyof typeof FraudReviewListItemReasonsEnum];
|
|
1286
|
+
/**
|
|
1287
|
+
*
|
|
1288
|
+
* @export
|
|
1289
|
+
* @enum {string}
|
|
1290
|
+
*/
|
|
1291
|
+
export declare const FraudReviewReason: {
|
|
1292
|
+
readonly DisallowedIp: "Disallowed IP";
|
|
1293
|
+
readonly DisallowedEmail: "Disallowed email";
|
|
1294
|
+
readonly DisallowedCountry: "Disallowed country";
|
|
1295
|
+
readonly OverRewardDollarLimit: "Over reward dollar limit";
|
|
1296
|
+
readonly OverRewardCountLimit: "Over reward count limit";
|
|
1297
|
+
readonly VpnDetected: "VPN detected";
|
|
1298
|
+
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
1299
|
+
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
1300
|
+
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
1301
|
+
readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
|
|
1302
|
+
readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
|
|
1303
|
+
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
1304
|
+
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
1305
|
+
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
1306
|
+
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
1307
|
+
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
1308
|
+
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
1309
|
+
readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
|
|
1310
|
+
readonly AllowedIp: "Allowed IP";
|
|
1311
|
+
readonly AllowedEmail: "Allowed email";
|
|
1312
|
+
};
|
|
1313
|
+
export type FraudReviewReason = typeof FraudReviewReason[keyof typeof FraudReviewReason];
|
|
1314
|
+
/**
|
|
1315
|
+
*
|
|
1316
|
+
* @export
|
|
1317
|
+
* @enum {string}
|
|
1318
|
+
*/
|
|
1319
|
+
export declare const FraudReviewRedemptionMethod: {
|
|
1320
|
+
readonly Paypal: "paypal";
|
|
1321
|
+
readonly Bank: "bank";
|
|
1322
|
+
readonly MerchantCard: "merchant card";
|
|
1323
|
+
readonly VisaCard: "visa card";
|
|
1324
|
+
readonly Charity: "charity";
|
|
1325
|
+
readonly Venmo: "venmo";
|
|
1326
|
+
};
|
|
1327
|
+
export type FraudReviewRedemptionMethod = typeof FraudReviewRedemptionMethod[keyof typeof FraudReviewRedemptionMethod];
|
|
1328
|
+
/**
|
|
1329
|
+
*
|
|
1330
|
+
* @export
|
|
1331
|
+
* @interface FraudReviewRelatedRewards
|
|
1332
|
+
*/
|
|
1333
|
+
export interface FraudReviewRelatedRewards {
|
|
1334
|
+
/**
|
|
1335
|
+
* The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned.
|
|
1336
|
+
* @type {Array<string>}
|
|
1337
|
+
* @memberof FraudReviewRelatedRewards
|
|
1338
|
+
*/
|
|
1339
|
+
'ids'?: Array<string>;
|
|
1340
|
+
/**
|
|
1341
|
+
* How many related rewards were found in total.
|
|
1342
|
+
* @type {number}
|
|
1343
|
+
* @memberof FraudReviewRelatedRewards
|
|
1344
|
+
*/
|
|
1345
|
+
'count'?: number;
|
|
1346
|
+
/**
|
|
1347
|
+
* How many related rewards have been blocked.
|
|
1348
|
+
* @type {number}
|
|
1349
|
+
* @memberof FraudReviewRelatedRewards
|
|
1350
|
+
*/
|
|
1351
|
+
'blocked_count'?: number;
|
|
1352
|
+
/**
|
|
1353
|
+
* Total amount claimed by the related rewards (in USD).
|
|
1354
|
+
* @type {number}
|
|
1355
|
+
* @memberof FraudReviewRelatedRewards
|
|
1356
|
+
*/
|
|
1357
|
+
'aggregated_value'?: number;
|
|
1358
|
+
}
|
|
1359
|
+
/**
|
|
1360
|
+
* The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
|
|
1361
|
+
* @export
|
|
1362
|
+
* @enum {string}
|
|
1363
|
+
*/
|
|
1364
|
+
export declare const FraudReviewStatus: {
|
|
1365
|
+
readonly Flagged: "flagged";
|
|
1366
|
+
readonly Blocked: "blocked";
|
|
1367
|
+
readonly Released: "released";
|
|
1368
|
+
};
|
|
1369
|
+
export type FraudReviewStatus = typeof FraudReviewStatus[keyof typeof FraudReviewStatus];
|
|
1370
|
+
/**
|
|
1371
|
+
*
|
|
1372
|
+
* @export
|
|
1373
|
+
* @interface FraudRule200Response
|
|
1374
|
+
*/
|
|
1375
|
+
export interface FraudRule200Response {
|
|
1376
|
+
/**
|
|
1377
|
+
* A description of the result
|
|
1378
|
+
* @type {string}
|
|
1379
|
+
* @memberof FraudRule200Response
|
|
1380
|
+
*/
|
|
1381
|
+
'message': string;
|
|
1382
|
+
}
|
|
1383
|
+
/**
|
|
1384
|
+
*
|
|
1385
|
+
* @export
|
|
1386
|
+
* @interface FraudRule400Response
|
|
1387
|
+
*/
|
|
1388
|
+
export interface FraudRule400Response {
|
|
1389
|
+
/**
|
|
1390
|
+
*
|
|
1391
|
+
* @type {ListRewards401ResponseErrors}
|
|
1392
|
+
* @memberof FraudRule400Response
|
|
1393
|
+
*/
|
|
1394
|
+
'errors': ListRewards401ResponseErrors;
|
|
1395
|
+
}
|
|
1396
|
+
/**
|
|
1397
|
+
*
|
|
1398
|
+
* @export
|
|
1399
|
+
* @interface FraudRule422Response
|
|
1400
|
+
*/
|
|
1401
|
+
export interface FraudRule422Response {
|
|
1402
|
+
/**
|
|
1403
|
+
*
|
|
1404
|
+
* @type {ListRewards401ResponseErrors}
|
|
1405
|
+
* @memberof FraudRule422Response
|
|
1406
|
+
*/
|
|
1407
|
+
'errors': ListRewards401ResponseErrors;
|
|
1408
|
+
}
|
|
1409
|
+
/**
|
|
1410
|
+
*
|
|
1411
|
+
* @export
|
|
1412
|
+
* @interface FraudRuleRequest
|
|
1413
|
+
*/
|
|
1414
|
+
export interface FraudRuleRequest {
|
|
1415
|
+
/**
|
|
1416
|
+
*
|
|
1417
|
+
* @type {FraudRuleRequestConfig}
|
|
1418
|
+
* @memberof FraudRuleRequest
|
|
1419
|
+
*/
|
|
1420
|
+
'config'?: FraudRuleRequestConfig;
|
|
1421
|
+
}
|
|
1422
|
+
/**
|
|
1423
|
+
* The configuration associated with the rule. The properties allowed depend on the type of rule.
|
|
1424
|
+
* @export
|
|
1425
|
+
* @interface FraudRuleRequestConfig
|
|
1426
|
+
*/
|
|
1427
|
+
export interface FraudRuleRequestConfig {
|
|
1428
|
+
/**
|
|
1429
|
+
* When type is `whitelist`, it flags any countries that *are not* present in the list. When type is `blacklist`, it flags any countries that *are* present in the list.
|
|
1430
|
+
* @type {string}
|
|
1431
|
+
* @memberof FraudRuleRequestConfig
|
|
1432
|
+
*/
|
|
1433
|
+
'type': FraudRuleRequestConfigTypeEnum;
|
|
1434
|
+
/**
|
|
1435
|
+
* An array of country codes (ISO-3166 alpha-2 character code)
|
|
1436
|
+
* @type {Array<string>}
|
|
1437
|
+
* @memberof FraudRuleRequestConfig
|
|
1438
|
+
*/
|
|
1439
|
+
'countries': Array<string>;
|
|
1440
|
+
/**
|
|
1441
|
+
* The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
|
|
1442
|
+
* @type {Array<string>}
|
|
1443
|
+
* @memberof FraudRuleRequestConfig
|
|
1444
|
+
*/
|
|
1445
|
+
'ips': Array<string>;
|
|
1446
|
+
/**
|
|
1447
|
+
* The list of emails.
|
|
1448
|
+
* @type {Array<string>}
|
|
1449
|
+
* @memberof FraudRuleRequestConfig
|
|
1450
|
+
*/
|
|
1451
|
+
'emails': Array<string>;
|
|
1452
|
+
/**
|
|
1453
|
+
* The list of domains. Any subdomains will also be matched against each entry in the list.
|
|
1454
|
+
* @type {Array<string>}
|
|
1455
|
+
* @memberof FraudRuleRequestConfig
|
|
1456
|
+
*/
|
|
1457
|
+
'domains'?: Array<string>;
|
|
1458
|
+
/**
|
|
1459
|
+
* The total amount in USD of redeemed rewards to use as a threshold.
|
|
1460
|
+
* @type {number}
|
|
1461
|
+
* @memberof FraudRuleRequestConfig
|
|
1462
|
+
*/
|
|
1463
|
+
'amount': number;
|
|
1464
|
+
/**
|
|
1465
|
+
* The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
|
|
1466
|
+
* @type {string}
|
|
1467
|
+
* @memberof FraudRuleRequestConfig
|
|
1468
|
+
*/
|
|
1469
|
+
'period': FraudRuleRequestConfigPeriodEnum;
|
|
1470
|
+
}
|
|
1471
|
+
export declare const FraudRuleRequestConfigTypeEnum: {
|
|
1472
|
+
readonly Whitelist: "whitelist";
|
|
1473
|
+
readonly Blacklist: "blacklist";
|
|
1474
|
+
};
|
|
1475
|
+
export type FraudRuleRequestConfigTypeEnum = typeof FraudRuleRequestConfigTypeEnum[keyof typeof FraudRuleRequestConfigTypeEnum];
|
|
1476
|
+
export declare const FraudRuleRequestConfigPeriodEnum: {
|
|
1477
|
+
readonly _7: "7";
|
|
1478
|
+
readonly _30: "30";
|
|
1479
|
+
readonly _90: "90";
|
|
1480
|
+
readonly _120: "120";
|
|
1481
|
+
readonly _365: "365";
|
|
1482
|
+
readonly AllTime: "all_time";
|
|
1483
|
+
};
|
|
1484
|
+
export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeriodEnum[keyof typeof FraudRuleRequestConfigPeriodEnum];
|
|
1485
|
+
/**
|
|
1486
|
+
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
1487
|
+
* @export
|
|
1488
|
+
* @enum {string}
|
|
1489
|
+
*/
|
|
1490
|
+
export declare const FraudRuleType: {
|
|
1491
|
+
readonly ReviewCountry: "review_country";
|
|
1492
|
+
readonly ReviewIp: "review_ip";
|
|
1493
|
+
readonly ReviewEmail: "review_email";
|
|
1494
|
+
readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
|
|
1495
|
+
readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
|
|
1496
|
+
readonly ReviewMultipleEmails: "review_multiple_emails";
|
|
1497
|
+
readonly ReviewVpn: "review_vpn";
|
|
1498
|
+
readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
|
|
1499
|
+
readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
|
|
1500
|
+
readonly AllowIp: "allow_ip";
|
|
1501
|
+
readonly AllowEmail: "allow_email";
|
|
1502
|
+
};
|
|
1503
|
+
export type FraudRuleType = typeof FraudRuleType[keyof typeof FraudRuleType];
|
|
1504
|
+
/**
|
|
1505
|
+
* An active fraud rule
|
|
1506
|
+
* @export
|
|
1507
|
+
* @interface FraudRulesListItem
|
|
1508
|
+
*/
|
|
1509
|
+
export interface FraudRulesListItem {
|
|
1510
|
+
/**
|
|
1511
|
+
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
1512
|
+
* @type {string}
|
|
1513
|
+
* @memberof FraudRulesListItem
|
|
1514
|
+
*/
|
|
1515
|
+
'rule_type'?: FraudRulesListItemRuleTypeEnum;
|
|
1516
|
+
/**
|
|
1517
|
+
* The configuration associated with the rule. The properties allowed depend on the type of rule. This property is only present for rules that require configuration.
|
|
1518
|
+
* @type {object}
|
|
1519
|
+
* @memberof FraudRulesListItem
|
|
1520
|
+
*/
|
|
1521
|
+
'config'?: object | null;
|
|
1522
|
+
}
|
|
1523
|
+
export declare const FraudRulesListItemRuleTypeEnum: {
|
|
1524
|
+
readonly ReviewCountry: "review_country";
|
|
1525
|
+
readonly ReviewIp: "review_ip";
|
|
1526
|
+
readonly ReviewEmail: "review_email";
|
|
1527
|
+
readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
|
|
1528
|
+
readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
|
|
1529
|
+
readonly ReviewMultipleEmails: "review_multiple_emails";
|
|
1530
|
+
readonly ReviewVpn: "review_vpn";
|
|
1531
|
+
readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
|
|
1532
|
+
readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
|
|
1533
|
+
readonly AllowIp: "allow_ip";
|
|
1534
|
+
readonly AllowEmail: "allow_email";
|
|
1535
|
+
};
|
|
1536
|
+
export type FraudRulesListItemRuleTypeEnum = typeof FraudRulesListItemRuleTypeEnum[keyof typeof FraudRulesListItemRuleTypeEnum];
|
|
1537
|
+
/**
|
|
1538
|
+
*
|
|
1539
|
+
* @export
|
|
1540
|
+
* @interface FundingSource
|
|
1541
|
+
*/
|
|
1542
|
+
export interface FundingSource {
|
|
1543
|
+
/**
|
|
1544
|
+
*
|
|
1545
|
+
* @type {string}
|
|
1546
|
+
* @memberof FundingSource
|
|
1547
|
+
*/
|
|
1548
|
+
'id': string;
|
|
1549
|
+
/**
|
|
1550
|
+
* You can pay for rewards using different payment methods on Tremendous: <table> <thead> <tr> <th>Payment Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>balance</code></td> <td>Pre-funded balance in your Tremendous account to draw funds from to send rewards to recipients.</td> </tr> <tr> <td><code>bank_account</code></td> <td>Bank account to draw funds from to send rewards to recipients.</td> </tr> <tr> <td><code>credit_card</code></td> <td>Credit card to draw funds from to send rewards to recipients.</td> </tr> <tr> <td><code>invoice</code></td> <td>Send rewards to recipients and pay by invoice.</td> </tr> </tbody> </table>
|
|
1551
|
+
* @type {string}
|
|
1552
|
+
* @memberof FundingSource
|
|
1202
1553
|
*/
|
|
1203
1554
|
'method': FundingSourceMethodEnum;
|
|
1204
1555
|
/**
|
|
@@ -1302,13 +1653,187 @@ export interface GenerateRewardToken200ResponseReward {
|
|
|
1302
1653
|
* @type {string}
|
|
1303
1654
|
* @memberof GenerateRewardToken200ResponseReward
|
|
1304
1655
|
*/
|
|
1305
|
-
'token'?: string;
|
|
1656
|
+
'token'?: string;
|
|
1657
|
+
/**
|
|
1658
|
+
* Date the token expires
|
|
1659
|
+
* @type {string}
|
|
1660
|
+
* @memberof GenerateRewardToken200ResponseReward
|
|
1661
|
+
*/
|
|
1662
|
+
'expires_at'?: string;
|
|
1663
|
+
}
|
|
1664
|
+
/**
|
|
1665
|
+
*
|
|
1666
|
+
* @export
|
|
1667
|
+
* @interface GetFraudReview200Response
|
|
1668
|
+
*/
|
|
1669
|
+
export interface GetFraudReview200Response {
|
|
1670
|
+
/**
|
|
1671
|
+
*
|
|
1672
|
+
* @type {GetFraudReview200ResponseFraudReview}
|
|
1673
|
+
* @memberof GetFraudReview200Response
|
|
1674
|
+
*/
|
|
1675
|
+
'fraud_review': GetFraudReview200ResponseFraudReview;
|
|
1676
|
+
}
|
|
1677
|
+
/**
|
|
1678
|
+
* The fraud review associated with a reward.
|
|
1679
|
+
* @export
|
|
1680
|
+
* @interface GetFraudReview200ResponseFraudReview
|
|
1681
|
+
*/
|
|
1682
|
+
export interface GetFraudReview200ResponseFraudReview {
|
|
1683
|
+
/**
|
|
1684
|
+
* The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
|
|
1685
|
+
* @type {string}
|
|
1686
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1687
|
+
*/
|
|
1688
|
+
'status'?: GetFraudReview200ResponseFraudReviewStatusEnum;
|
|
1689
|
+
/**
|
|
1690
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
1691
|
+
* @type {Array<string>}
|
|
1692
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1693
|
+
*/
|
|
1694
|
+
'reasons'?: Array<GetFraudReview200ResponseFraudReviewReasonsEnum>;
|
|
1695
|
+
/**
|
|
1696
|
+
* The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`.
|
|
1697
|
+
* @type {string}
|
|
1698
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1699
|
+
*/
|
|
1700
|
+
'reviewed_by'?: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
|
|
1703
|
+
* @type {string}
|
|
1704
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1705
|
+
*/
|
|
1706
|
+
'reviewed_at'?: string;
|
|
1707
|
+
/**
|
|
1708
|
+
*
|
|
1709
|
+
* @type {GetFraudReview200ResponseFraudReviewRelatedRewards}
|
|
1710
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1711
|
+
*/
|
|
1712
|
+
'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
|
|
1713
|
+
/**
|
|
1714
|
+
* The device fingerprint, if known.
|
|
1715
|
+
* @type {string}
|
|
1716
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1717
|
+
*/
|
|
1718
|
+
'device_id'?: string;
|
|
1719
|
+
/**
|
|
1720
|
+
* The product selected to claim the reward
|
|
1721
|
+
* @type {string}
|
|
1722
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1723
|
+
*/
|
|
1724
|
+
'redemption_method'?: GetFraudReview200ResponseFraudReviewRedemptionMethodEnum;
|
|
1725
|
+
/**
|
|
1726
|
+
* Date the reward was redeemed
|
|
1727
|
+
* @type {string}
|
|
1728
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1729
|
+
*/
|
|
1730
|
+
'redeemed_at'?: string;
|
|
1731
|
+
/**
|
|
1732
|
+
*
|
|
1733
|
+
* @type {GetFraudReview200ResponseFraudReviewGeo}
|
|
1734
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1735
|
+
*/
|
|
1736
|
+
'geo'?: GetFraudReview200ResponseFraudReviewGeo;
|
|
1737
|
+
/**
|
|
1738
|
+
*
|
|
1739
|
+
* @type {ListRewards200ResponseRewardsInner}
|
|
1740
|
+
* @memberof GetFraudReview200ResponseFraudReview
|
|
1741
|
+
*/
|
|
1742
|
+
'reward'?: ListRewards200ResponseRewardsInner;
|
|
1743
|
+
}
|
|
1744
|
+
export declare const GetFraudReview200ResponseFraudReviewStatusEnum: {
|
|
1745
|
+
readonly Flagged: "flagged";
|
|
1746
|
+
readonly Blocked: "blocked";
|
|
1747
|
+
readonly Released: "released";
|
|
1748
|
+
};
|
|
1749
|
+
export type GetFraudReview200ResponseFraudReviewStatusEnum = typeof GetFraudReview200ResponseFraudReviewStatusEnum[keyof typeof GetFraudReview200ResponseFraudReviewStatusEnum];
|
|
1750
|
+
export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
|
|
1751
|
+
readonly DisallowedIp: "Disallowed IP";
|
|
1752
|
+
readonly DisallowedEmail: "Disallowed email";
|
|
1753
|
+
readonly DisallowedCountry: "Disallowed country";
|
|
1754
|
+
readonly OverRewardDollarLimit: "Over reward dollar limit";
|
|
1755
|
+
readonly OverRewardCountLimit: "Over reward count limit";
|
|
1756
|
+
readonly VpnDetected: "VPN detected";
|
|
1757
|
+
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
1758
|
+
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
1759
|
+
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
1760
|
+
readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
|
|
1761
|
+
readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
|
|
1762
|
+
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
1763
|
+
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
1764
|
+
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
1765
|
+
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
1766
|
+
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
1767
|
+
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
1768
|
+
readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
|
|
1769
|
+
readonly AllowedIp: "Allowed IP";
|
|
1770
|
+
readonly AllowedEmail: "Allowed email";
|
|
1771
|
+
};
|
|
1772
|
+
export type GetFraudReview200ResponseFraudReviewReasonsEnum = typeof GetFraudReview200ResponseFraudReviewReasonsEnum[keyof typeof GetFraudReview200ResponseFraudReviewReasonsEnum];
|
|
1773
|
+
export declare const GetFraudReview200ResponseFraudReviewRedemptionMethodEnum: {
|
|
1774
|
+
readonly Paypal: "paypal";
|
|
1775
|
+
readonly Bank: "bank";
|
|
1776
|
+
readonly MerchantCard: "merchant card";
|
|
1777
|
+
readonly VisaCard: "visa card";
|
|
1778
|
+
readonly Charity: "charity";
|
|
1779
|
+
readonly Venmo: "venmo";
|
|
1780
|
+
};
|
|
1781
|
+
export type GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum[keyof typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum];
|
|
1782
|
+
/**
|
|
1783
|
+
* The Geo location, based on the recipient\'s IP.
|
|
1784
|
+
* @export
|
|
1785
|
+
* @interface GetFraudReview200ResponseFraudReviewGeo
|
|
1786
|
+
*/
|
|
1787
|
+
export interface GetFraudReview200ResponseFraudReviewGeo {
|
|
1788
|
+
/**
|
|
1789
|
+
* The recipient\'s IP.
|
|
1790
|
+
* @type {string}
|
|
1791
|
+
* @memberof GetFraudReview200ResponseFraudReviewGeo
|
|
1792
|
+
*/
|
|
1793
|
+
'ip'?: string;
|
|
1794
|
+
/**
|
|
1795
|
+
* The country code (ISO-3166 alpha-2 character code) linked to the recipient\'s IP.
|
|
1796
|
+
* @type {string}
|
|
1797
|
+
* @memberof GetFraudReview200ResponseFraudReviewGeo
|
|
1798
|
+
*/
|
|
1799
|
+
'country'?: string;
|
|
1800
|
+
/**
|
|
1801
|
+
* The city associated with the recipient\'s IP.
|
|
1802
|
+
* @type {string}
|
|
1803
|
+
* @memberof GetFraudReview200ResponseFraudReviewGeo
|
|
1804
|
+
*/
|
|
1805
|
+
'city'?: string;
|
|
1806
|
+
}
|
|
1807
|
+
/**
|
|
1808
|
+
* The related rewards associated with the fraud review.
|
|
1809
|
+
* @export
|
|
1810
|
+
* @interface GetFraudReview200ResponseFraudReviewRelatedRewards
|
|
1811
|
+
*/
|
|
1812
|
+
export interface GetFraudReview200ResponseFraudReviewRelatedRewards {
|
|
1813
|
+
/**
|
|
1814
|
+
* The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned.
|
|
1815
|
+
* @type {Array<string>}
|
|
1816
|
+
* @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
|
|
1817
|
+
*/
|
|
1818
|
+
'ids'?: Array<string>;
|
|
1819
|
+
/**
|
|
1820
|
+
* How many related rewards were found in total.
|
|
1821
|
+
* @type {number}
|
|
1822
|
+
* @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
|
|
1823
|
+
*/
|
|
1824
|
+
'count'?: number;
|
|
1825
|
+
/**
|
|
1826
|
+
* How many related rewards have been blocked.
|
|
1827
|
+
* @type {number}
|
|
1828
|
+
* @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
|
|
1829
|
+
*/
|
|
1830
|
+
'blocked_count'?: number;
|
|
1306
1831
|
/**
|
|
1307
|
-
*
|
|
1308
|
-
* @type {
|
|
1309
|
-
* @memberof
|
|
1832
|
+
* Total amount claimed by the related rewards (in USD).
|
|
1833
|
+
* @type {number}
|
|
1834
|
+
* @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
|
|
1310
1835
|
*/
|
|
1311
|
-
'
|
|
1836
|
+
'aggregated_value'?: number;
|
|
1312
1837
|
}
|
|
1313
1838
|
/**
|
|
1314
1839
|
*
|
|
@@ -1523,47 +2048,47 @@ export type InvoiceStatusEnum = typeof InvoiceStatusEnum[keyof typeof InvoiceSta
|
|
|
1523
2048
|
export interface ListBalanceTransactions200Response {
|
|
1524
2049
|
/**
|
|
1525
2050
|
*
|
|
1526
|
-
* @type {Array<
|
|
2051
|
+
* @type {Array<ListBalanceTransactions200ResponseTransactionsInner>}
|
|
1527
2052
|
* @memberof ListBalanceTransactions200Response
|
|
1528
2053
|
*/
|
|
1529
|
-
'
|
|
2054
|
+
'transactions': Array<ListBalanceTransactions200ResponseTransactionsInner>;
|
|
1530
2055
|
}
|
|
1531
2056
|
/**
|
|
1532
2057
|
* A balance transaction represents a specific movement or change in an account\'s balance.
|
|
1533
2058
|
* @export
|
|
1534
|
-
* @interface
|
|
2059
|
+
* @interface ListBalanceTransactions200ResponseTransactionsInner
|
|
1535
2060
|
*/
|
|
1536
|
-
export interface
|
|
2061
|
+
export interface ListBalanceTransactions200ResponseTransactionsInner {
|
|
1537
2062
|
/**
|
|
1538
2063
|
* Date that the transaction was created
|
|
1539
2064
|
* @type {string}
|
|
1540
|
-
* @memberof
|
|
2065
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
1541
2066
|
*/
|
|
1542
|
-
'created_at'
|
|
2067
|
+
'created_at': string;
|
|
1543
2068
|
/**
|
|
1544
2069
|
* Amount of the transaction in USD
|
|
1545
2070
|
* @type {number}
|
|
1546
|
-
* @memberof
|
|
2071
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
1547
2072
|
*/
|
|
1548
|
-
'amount'
|
|
2073
|
+
'amount': number;
|
|
1549
2074
|
/**
|
|
1550
2075
|
* The updated total after the transaction. Note that this running balance may be delayed and contain `null`.
|
|
1551
2076
|
* @type {number}
|
|
1552
|
-
* @memberof
|
|
2077
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
1553
2078
|
*/
|
|
1554
|
-
'balance'
|
|
2079
|
+
'balance': number;
|
|
1555
2080
|
/**
|
|
1556
2081
|
* The action that was performed
|
|
1557
2082
|
* @type {string}
|
|
1558
|
-
* @memberof
|
|
2083
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
1559
2084
|
*/
|
|
1560
|
-
'action'
|
|
2085
|
+
'action': string;
|
|
1561
2086
|
/**
|
|
1562
2087
|
* A brief description of the transaction
|
|
1563
2088
|
* @type {string}
|
|
1564
|
-
* @memberof
|
|
2089
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
1565
2090
|
*/
|
|
1566
|
-
'description'
|
|
2091
|
+
'description': string;
|
|
1567
2092
|
}
|
|
1568
2093
|
/**
|
|
1569
2094
|
*
|
|
@@ -1632,13 +2157,13 @@ export interface ListCampaigns200ResponseCampaignsInnerEmailStyle {
|
|
|
1632
2157
|
* @type {string}
|
|
1633
2158
|
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1634
2159
|
*/
|
|
1635
|
-
'sender_name'?: string;
|
|
2160
|
+
'sender_name'?: string | null;
|
|
1636
2161
|
/**
|
|
1637
2162
|
* Email subject line
|
|
1638
2163
|
* @type {string}
|
|
1639
2164
|
* @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
|
|
1640
2165
|
*/
|
|
1641
|
-
'subject_line'?: string;
|
|
2166
|
+
'subject_line'?: string | null;
|
|
1642
2167
|
/**
|
|
1643
2168
|
* URL of a publicly-accessible image (png, jpeg, jpg, gif, or svg). This image will be copied to our storage location.
|
|
1644
2169
|
* @type {string}
|
|
@@ -1675,7 +2200,7 @@ export interface ListCampaigns200ResponseCampaignsInnerWebpageStyle {
|
|
|
1675
2200
|
* @type {string}
|
|
1676
2201
|
* @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
|
|
1677
2202
|
*/
|
|
1678
|
-
'headline'?: string;
|
|
2203
|
+
'headline'?: string | null;
|
|
1679
2204
|
/**
|
|
1680
2205
|
* Message for the reward page
|
|
1681
2206
|
* @type {string}
|
|
@@ -1780,6 +2305,119 @@ export interface ListForexResponse {
|
|
|
1780
2305
|
[key: string]: number;
|
|
1781
2306
|
};
|
|
1782
2307
|
}
|
|
2308
|
+
/**
|
|
2309
|
+
*
|
|
2310
|
+
* @export
|
|
2311
|
+
* @interface ListFraudReviews200Response
|
|
2312
|
+
*/
|
|
2313
|
+
export interface ListFraudReviews200Response {
|
|
2314
|
+
/**
|
|
2315
|
+
*
|
|
2316
|
+
* @type {Array<ListFraudReviews200ResponseFraudReviewsInner>}
|
|
2317
|
+
* @memberof ListFraudReviews200Response
|
|
2318
|
+
*/
|
|
2319
|
+
'fraud_reviews': Array<ListFraudReviews200ResponseFraudReviewsInner>;
|
|
2320
|
+
}
|
|
2321
|
+
/**
|
|
2322
|
+
* The fraud review associated with a reward.
|
|
2323
|
+
* @export
|
|
2324
|
+
* @interface ListFraudReviews200ResponseFraudReviewsInner
|
|
2325
|
+
*/
|
|
2326
|
+
export interface ListFraudReviews200ResponseFraudReviewsInner {
|
|
2327
|
+
/**
|
|
2328
|
+
* The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
|
|
2329
|
+
* @type {string}
|
|
2330
|
+
* @memberof ListFraudReviews200ResponseFraudReviewsInner
|
|
2331
|
+
*/
|
|
2332
|
+
'status'?: ListFraudReviews200ResponseFraudReviewsInnerStatusEnum;
|
|
2333
|
+
/**
|
|
2334
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward dollar limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `IP related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email`
|
|
2335
|
+
* @type {Array<string>}
|
|
2336
|
+
* @memberof ListFraudReviews200ResponseFraudReviewsInner
|
|
2337
|
+
*/
|
|
2338
|
+
'reasons'?: Array<ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum>;
|
|
2339
|
+
/**
|
|
2340
|
+
*
|
|
2341
|
+
* @type {ListRewards200ResponseRewardsInner}
|
|
2342
|
+
* @memberof ListFraudReviews200ResponseFraudReviewsInner
|
|
2343
|
+
*/
|
|
2344
|
+
'reward'?: ListRewards200ResponseRewardsInner;
|
|
2345
|
+
}
|
|
2346
|
+
export declare const ListFraudReviews200ResponseFraudReviewsInnerStatusEnum: {
|
|
2347
|
+
readonly Flagged: "flagged";
|
|
2348
|
+
readonly Blocked: "blocked";
|
|
2349
|
+
readonly Released: "released";
|
|
2350
|
+
};
|
|
2351
|
+
export type ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum];
|
|
2352
|
+
export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: {
|
|
2353
|
+
readonly DisallowedIp: "Disallowed IP";
|
|
2354
|
+
readonly DisallowedEmail: "Disallowed email";
|
|
2355
|
+
readonly DisallowedCountry: "Disallowed country";
|
|
2356
|
+
readonly OverRewardDollarLimit: "Over reward dollar limit";
|
|
2357
|
+
readonly OverRewardCountLimit: "Over reward count limit";
|
|
2358
|
+
readonly VpnDetected: "VPN detected";
|
|
2359
|
+
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
2360
|
+
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
2361
|
+
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
2362
|
+
readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
|
|
2363
|
+
readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
|
|
2364
|
+
readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
|
|
2365
|
+
readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
|
|
2366
|
+
readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
|
|
2367
|
+
readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
|
|
2368
|
+
readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
|
|
2369
|
+
readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
|
|
2370
|
+
readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
|
|
2371
|
+
readonly AllowedIp: "Allowed IP";
|
|
2372
|
+
readonly AllowedEmail: "Allowed email";
|
|
2373
|
+
};
|
|
2374
|
+
export type ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum];
|
|
2375
|
+
/**
|
|
2376
|
+
*
|
|
2377
|
+
* @export
|
|
2378
|
+
* @interface ListFraudRules200Response
|
|
2379
|
+
*/
|
|
2380
|
+
export interface ListFraudRules200Response {
|
|
2381
|
+
/**
|
|
2382
|
+
*
|
|
2383
|
+
* @type {Array<ListFraudRules200ResponseFraudRulesInner>}
|
|
2384
|
+
* @memberof ListFraudRules200Response
|
|
2385
|
+
*/
|
|
2386
|
+
'fraud_rules': Array<ListFraudRules200ResponseFraudRulesInner>;
|
|
2387
|
+
}
|
|
2388
|
+
/**
|
|
2389
|
+
* An active fraud rule
|
|
2390
|
+
* @export
|
|
2391
|
+
* @interface ListFraudRules200ResponseFraudRulesInner
|
|
2392
|
+
*/
|
|
2393
|
+
export interface ListFraudRules200ResponseFraudRulesInner {
|
|
2394
|
+
/**
|
|
2395
|
+
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
2396
|
+
* @type {string}
|
|
2397
|
+
* @memberof ListFraudRules200ResponseFraudRulesInner
|
|
2398
|
+
*/
|
|
2399
|
+
'rule_type'?: ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum;
|
|
2400
|
+
/**
|
|
2401
|
+
* The configuration associated with the rule. The properties allowed depend on the type of rule. This property is only present for rules that require configuration.
|
|
2402
|
+
* @type {object}
|
|
2403
|
+
* @memberof ListFraudRules200ResponseFraudRulesInner
|
|
2404
|
+
*/
|
|
2405
|
+
'config'?: object | null;
|
|
2406
|
+
}
|
|
2407
|
+
export declare const ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum: {
|
|
2408
|
+
readonly ReviewCountry: "review_country";
|
|
2409
|
+
readonly ReviewIp: "review_ip";
|
|
2410
|
+
readonly ReviewEmail: "review_email";
|
|
2411
|
+
readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
|
|
2412
|
+
readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
|
|
2413
|
+
readonly ReviewMultipleEmails: "review_multiple_emails";
|
|
2414
|
+
readonly ReviewVpn: "review_vpn";
|
|
2415
|
+
readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
|
|
2416
|
+
readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
|
|
2417
|
+
readonly AllowIp: "allow_ip";
|
|
2418
|
+
readonly AllowEmail: "allow_email";
|
|
2419
|
+
};
|
|
2420
|
+
export type ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum[keyof typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum];
|
|
1783
2421
|
/**
|
|
1784
2422
|
*
|
|
1785
2423
|
* @export
|
|
@@ -2143,6 +2781,12 @@ export interface ListOrders200ResponseOrdersInner {
|
|
|
2143
2781
|
* @memberof ListOrders200ResponseOrdersInner
|
|
2144
2782
|
*/
|
|
2145
2783
|
'status': ListOrders200ResponseOrdersInnerStatusEnum;
|
|
2784
|
+
/**
|
|
2785
|
+
* Name of the channel in which the order was created
|
|
2786
|
+
* @type {string}
|
|
2787
|
+
* @memberof ListOrders200ResponseOrdersInner
|
|
2788
|
+
*/
|
|
2789
|
+
'channel'?: ListOrders200ResponseOrdersInnerChannelEnum;
|
|
2146
2790
|
/**
|
|
2147
2791
|
*
|
|
2148
2792
|
* @type {ListOrders200ResponseOrdersInnerPayment}
|
|
@@ -2157,10 +2801,10 @@ export interface ListOrders200ResponseOrdersInner {
|
|
|
2157
2801
|
'invoice_id'?: string;
|
|
2158
2802
|
/**
|
|
2159
2803
|
*
|
|
2160
|
-
* @type {ListRewards200ResponseRewardsInner}
|
|
2804
|
+
* @type {Array<ListRewards200ResponseRewardsInner>}
|
|
2161
2805
|
* @memberof ListOrders200ResponseOrdersInner
|
|
2162
2806
|
*/
|
|
2163
|
-
'
|
|
2807
|
+
'rewards'?: Array<ListRewards200ResponseRewardsInner>;
|
|
2164
2808
|
}
|
|
2165
2809
|
export declare const ListOrders200ResponseOrdersInnerStatusEnum: {
|
|
2166
2810
|
readonly Canceled: "CANCELED";
|
|
@@ -2171,6 +2815,16 @@ export declare const ListOrders200ResponseOrdersInnerStatusEnum: {
|
|
|
2171
2815
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
2172
2816
|
};
|
|
2173
2817
|
export type ListOrders200ResponseOrdersInnerStatusEnum = typeof ListOrders200ResponseOrdersInnerStatusEnum[keyof typeof ListOrders200ResponseOrdersInnerStatusEnum];
|
|
2818
|
+
export declare const ListOrders200ResponseOrdersInnerChannelEnum: {
|
|
2819
|
+
readonly Ui: "UI";
|
|
2820
|
+
readonly Api: "API";
|
|
2821
|
+
readonly Embed: "EMBED";
|
|
2822
|
+
readonly Decipher: "DECIPHER";
|
|
2823
|
+
readonly Qualtrics: "QUALTRICS";
|
|
2824
|
+
readonly Typeform: "TYPEFORM";
|
|
2825
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
2826
|
+
};
|
|
2827
|
+
export type ListOrders200ResponseOrdersInnerChannelEnum = typeof ListOrders200ResponseOrdersInnerChannelEnum[keyof typeof ListOrders200ResponseOrdersInnerChannelEnum];
|
|
2174
2828
|
/**
|
|
2175
2829
|
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are always denominated in USD, independent from the currency of the ordered rewards. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
|
|
2176
2830
|
* @export
|
|
@@ -2718,7 +3372,7 @@ export interface ListRewards200ResponseRewardsInnerValue {
|
|
|
2718
3372
|
* @type {string}
|
|
2719
3373
|
* @memberof ListRewards200ResponseRewardsInnerValue
|
|
2720
3374
|
*/
|
|
2721
|
-
'currency_code'
|
|
3375
|
+
'currency_code'?: ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum;
|
|
2722
3376
|
}
|
|
2723
3377
|
export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
2724
3378
|
readonly Usd: "USD";
|
|
@@ -3208,266 +3862,55 @@ export interface Order {
|
|
|
3208
3862
|
*/
|
|
3209
3863
|
'id': string;
|
|
3210
3864
|
/**
|
|
3211
|
-
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
3212
|
-
* @type {string}
|
|
3213
|
-
* @memberof Order
|
|
3214
|
-
*/
|
|
3215
|
-
'external_id'?: string | null;
|
|
3216
|
-
/**
|
|
3217
|
-
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
3218
|
-
* @type {string}
|
|
3219
|
-
* @memberof Order
|
|
3220
|
-
*/
|
|
3221
|
-
'campaign_id'?: string | null;
|
|
3222
|
-
/**
|
|
3223
|
-
* Date the order has been created
|
|
3224
|
-
* @type {string}
|
|
3225
|
-
* @memberof Order
|
|
3226
|
-
*/
|
|
3227
|
-
'created_at': string;
|
|
3228
|
-
/**
|
|
3229
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> CART </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
3230
|
-
* @type {string}
|
|
3231
|
-
* @memberof Order
|
|
3232
|
-
*/
|
|
3233
|
-
'status': OrderStatusEnum;
|
|
3234
|
-
/**
|
|
3235
|
-
*
|
|
3236
|
-
* @type {OrderBasePayment}
|
|
3237
|
-
* @memberof Order
|
|
3238
|
-
*/
|
|
3239
|
-
'payment'?: OrderBasePayment;
|
|
3240
|
-
/**
|
|
3241
|
-
* The ID for the invoice associated with this order
|
|
3242
|
-
* @type {string}
|
|
3243
|
-
* @memberof Order
|
|
3244
|
-
*/
|
|
3245
|
-
'invoice_id'?: string;
|
|
3246
|
-
/**
|
|
3247
|
-
*
|
|
3248
|
-
* @type {OrderWithoutLinkReward}
|
|
3249
|
-
* @memberof Order
|
|
3250
|
-
*/
|
|
3251
|
-
'reward'?: OrderWithoutLinkReward;
|
|
3252
|
-
}
|
|
3253
|
-
export declare const OrderStatusEnum: {
|
|
3254
|
-
readonly Canceled: "CANCELED";
|
|
3255
|
-
readonly Cart: "CART";
|
|
3256
|
-
readonly Executed: "EXECUTED";
|
|
3257
|
-
readonly Failed: "FAILED";
|
|
3258
|
-
readonly PendingApproval: "PENDING APPROVAL";
|
|
3259
|
-
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3260
|
-
};
|
|
3261
|
-
export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
|
|
3262
|
-
/**
|
|
3263
|
-
* An order wraps around the fulfilment of one or more rewards.
|
|
3264
|
-
* @export
|
|
3265
|
-
* @interface OrderBase
|
|
3266
|
-
*/
|
|
3267
|
-
export interface OrderBase {
|
|
3268
|
-
/**
|
|
3269
|
-
* Tremendous ID of the order
|
|
3270
|
-
* @type {string}
|
|
3271
|
-
* @memberof OrderBase
|
|
3272
|
-
*/
|
|
3273
|
-
'id': string;
|
|
3274
|
-
/**
|
|
3275
|
-
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
3276
|
-
* @type {string}
|
|
3277
|
-
* @memberof OrderBase
|
|
3278
|
-
*/
|
|
3279
|
-
'external_id'?: string | null;
|
|
3280
|
-
/**
|
|
3281
|
-
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
3282
|
-
* @type {string}
|
|
3283
|
-
* @memberof OrderBase
|
|
3284
|
-
*/
|
|
3285
|
-
'campaign_id'?: string | null;
|
|
3286
|
-
/**
|
|
3287
|
-
* Date the order has been created
|
|
3288
|
-
* @type {string}
|
|
3289
|
-
* @memberof OrderBase
|
|
3290
|
-
*/
|
|
3291
|
-
'created_at': string;
|
|
3292
|
-
/**
|
|
3293
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> CART </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
3294
|
-
* @type {string}
|
|
3295
|
-
* @memberof OrderBase
|
|
3296
|
-
*/
|
|
3297
|
-
'status': OrderBaseStatusEnum;
|
|
3298
|
-
/**
|
|
3299
|
-
*
|
|
3300
|
-
* @type {OrderBasePayment}
|
|
3301
|
-
* @memberof OrderBase
|
|
3302
|
-
*/
|
|
3303
|
-
'payment'?: OrderBasePayment;
|
|
3304
|
-
/**
|
|
3305
|
-
* The ID for the invoice associated with this order
|
|
3306
|
-
* @type {string}
|
|
3307
|
-
* @memberof OrderBase
|
|
3308
|
-
*/
|
|
3309
|
-
'invoice_id'?: string;
|
|
3310
|
-
}
|
|
3311
|
-
export declare const OrderBaseStatusEnum: {
|
|
3312
|
-
readonly Canceled: "CANCELED";
|
|
3313
|
-
readonly Cart: "CART";
|
|
3314
|
-
readonly Executed: "EXECUTED";
|
|
3315
|
-
readonly Failed: "FAILED";
|
|
3316
|
-
readonly PendingApproval: "PENDING APPROVAL";
|
|
3317
|
-
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3318
|
-
};
|
|
3319
|
-
export type OrderBaseStatusEnum = typeof OrderBaseStatusEnum[keyof typeof OrderBaseStatusEnum];
|
|
3320
|
-
/**
|
|
3321
|
-
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are always denominated in USD, independent from the currency of the ordered rewards. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
|
|
3322
|
-
* @export
|
|
3323
|
-
* @interface OrderBasePayment
|
|
3324
|
-
*/
|
|
3325
|
-
export interface OrderBasePayment {
|
|
3326
|
-
/**
|
|
3327
|
-
* Total price of the order before fees (in USD)
|
|
3328
|
-
* @type {number}
|
|
3329
|
-
* @memberof OrderBasePayment
|
|
3330
|
-
*/
|
|
3331
|
-
'subtotal'?: number;
|
|
3332
|
-
/**
|
|
3333
|
-
* Total price of the order including fees (in USD)
|
|
3334
|
-
* @type {number}
|
|
3335
|
-
* @memberof OrderBasePayment
|
|
3336
|
-
*/
|
|
3337
|
-
'total'?: number;
|
|
3338
|
-
/**
|
|
3339
|
-
* Fees for the order (in USD)
|
|
3340
|
-
* @type {number}
|
|
3341
|
-
* @memberof OrderBasePayment
|
|
3342
|
-
*/
|
|
3343
|
-
'fees'?: number;
|
|
3344
|
-
/**
|
|
3345
|
-
*
|
|
3346
|
-
* @type {PaymentDetailsRefund}
|
|
3347
|
-
* @memberof OrderBasePayment
|
|
3348
|
-
*/
|
|
3349
|
-
'refund'?: PaymentDetailsRefund;
|
|
3350
|
-
/**
|
|
3351
|
-
* Name of the channel in which the order was created
|
|
3352
|
-
* @type {string}
|
|
3353
|
-
* @memberof OrderBasePayment
|
|
3354
|
-
*/
|
|
3355
|
-
'channel'?: OrderBasePaymentChannelEnum;
|
|
3356
|
-
}
|
|
3357
|
-
export declare const OrderBasePaymentChannelEnum: {
|
|
3358
|
-
readonly Ui: "UI";
|
|
3359
|
-
readonly Api: "API";
|
|
3360
|
-
readonly Embed: "EMBED";
|
|
3361
|
-
readonly Decipher: "DECIPHER";
|
|
3362
|
-
readonly Qualtrics: "QUALTRICS";
|
|
3363
|
-
readonly Typeform: "TYPEFORM";
|
|
3364
|
-
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
3365
|
-
};
|
|
3366
|
-
export type OrderBasePaymentChannelEnum = typeof OrderBasePaymentChannelEnum[keyof typeof OrderBasePaymentChannelEnum];
|
|
3367
|
-
/**
|
|
3368
|
-
*
|
|
3369
|
-
* @export
|
|
3370
|
-
* @interface OrderForCreate
|
|
3371
|
-
*/
|
|
3372
|
-
export interface OrderForCreate {
|
|
3373
|
-
/**
|
|
3374
|
-
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
3375
|
-
* @type {string}
|
|
3376
|
-
* @memberof OrderForCreate
|
|
3377
|
-
*/
|
|
3378
|
-
'external_id'?: string | null;
|
|
3379
|
-
/**
|
|
3380
|
-
*
|
|
3381
|
-
* @type {CreateOrderRequestPayment}
|
|
3382
|
-
* @memberof OrderForCreate
|
|
3383
|
-
*/
|
|
3384
|
-
'payment': CreateOrderRequestPayment;
|
|
3385
|
-
/**
|
|
3386
|
-
*
|
|
3387
|
-
* @type {OrderForCreateReward}
|
|
3388
|
-
* @memberof OrderForCreate
|
|
3389
|
-
*/
|
|
3390
|
-
'reward': OrderForCreateReward;
|
|
3391
|
-
}
|
|
3392
|
-
/**
|
|
3393
|
-
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
3394
|
-
* @export
|
|
3395
|
-
* @interface OrderForCreateReward
|
|
3396
|
-
*/
|
|
3397
|
-
export interface OrderForCreateReward {
|
|
3398
|
-
/**
|
|
3399
|
-
* Tremendous ID of the reward
|
|
3400
|
-
* @type {string}
|
|
3401
|
-
* @memberof OrderForCreateReward
|
|
3402
|
-
*/
|
|
3403
|
-
'id'?: string;
|
|
3404
|
-
/**
|
|
3405
|
-
* Tremendous ID of the order this reward is part of.
|
|
3406
|
-
* @type {string}
|
|
3407
|
-
* @memberof OrderForCreateReward
|
|
3408
|
-
*/
|
|
3409
|
-
'order_id'?: string;
|
|
3410
|
-
/**
|
|
3411
|
-
* Date the reward was created
|
|
3865
|
+
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
3412
3866
|
* @type {string}
|
|
3413
|
-
* @memberof
|
|
3867
|
+
* @memberof Order
|
|
3414
3868
|
*/
|
|
3415
|
-
'
|
|
3869
|
+
'external_id'?: string | null;
|
|
3416
3870
|
/**
|
|
3417
3871
|
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
3418
3872
|
* @type {string}
|
|
3419
|
-
* @memberof
|
|
3873
|
+
* @memberof Order
|
|
3420
3874
|
*/
|
|
3421
3875
|
'campaign_id'?: string | null;
|
|
3422
3876
|
/**
|
|
3423
|
-
*
|
|
3424
|
-
* @type {
|
|
3425
|
-
* @memberof
|
|
3426
|
-
*/
|
|
3427
|
-
'products'?: Array<string>;
|
|
3428
|
-
/**
|
|
3429
|
-
*
|
|
3430
|
-
* @type {ListRewards200ResponseRewardsInnerValue}
|
|
3431
|
-
* @memberof OrderForCreateReward
|
|
3877
|
+
* Date the order has been created
|
|
3878
|
+
* @type {string}
|
|
3879
|
+
* @memberof Order
|
|
3432
3880
|
*/
|
|
3433
|
-
'
|
|
3881
|
+
'created_at': string;
|
|
3434
3882
|
/**
|
|
3435
|
-
*
|
|
3436
|
-
* @type {
|
|
3437
|
-
* @memberof
|
|
3883
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> CART </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
3884
|
+
* @type {string}
|
|
3885
|
+
* @memberof Order
|
|
3438
3886
|
*/
|
|
3439
|
-
'
|
|
3887
|
+
'status': OrderStatusEnum;
|
|
3440
3888
|
/**
|
|
3441
|
-
*
|
|
3889
|
+
* Name of the channel in which the order was created
|
|
3442
3890
|
* @type {string}
|
|
3443
|
-
* @memberof
|
|
3891
|
+
* @memberof Order
|
|
3444
3892
|
*/
|
|
3445
|
-
'
|
|
3893
|
+
'channel'?: OrderChannelEnum;
|
|
3446
3894
|
/**
|
|
3447
3895
|
*
|
|
3448
|
-
* @type {
|
|
3449
|
-
* @memberof
|
|
3896
|
+
* @type {OrderBasePayment}
|
|
3897
|
+
* @memberof Order
|
|
3450
3898
|
*/
|
|
3451
|
-
'
|
|
3899
|
+
'payment'?: OrderBasePayment;
|
|
3452
3900
|
/**
|
|
3453
|
-
*
|
|
3901
|
+
* The ID for the invoice associated with this order
|
|
3454
3902
|
* @type {string}
|
|
3455
|
-
* @memberof
|
|
3903
|
+
* @memberof Order
|
|
3456
3904
|
*/
|
|
3457
|
-
'
|
|
3905
|
+
'invoice_id'?: string;
|
|
3458
3906
|
/**
|
|
3459
3907
|
*
|
|
3460
|
-
* @type {
|
|
3461
|
-
* @memberof
|
|
3908
|
+
* @type {Array<OrderWithoutLinkRewardsInner>}
|
|
3909
|
+
* @memberof Order
|
|
3462
3910
|
*/
|
|
3463
|
-
'
|
|
3911
|
+
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
3464
3912
|
}
|
|
3465
|
-
|
|
3466
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> CART </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
3467
|
-
* @export
|
|
3468
|
-
* @enum {string}
|
|
3469
|
-
*/
|
|
3470
|
-
export declare const OrderStatus: {
|
|
3913
|
+
export declare const OrderStatusEnum: {
|
|
3471
3914
|
readonly Canceled: "CANCELED";
|
|
3472
3915
|
readonly Cart: "CART";
|
|
3473
3916
|
readonly Executed: "EXECUTED";
|
|
@@ -3475,63 +3918,73 @@ export declare const OrderStatus: {
|
|
|
3475
3918
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
3476
3919
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3477
3920
|
};
|
|
3478
|
-
export type
|
|
3921
|
+
export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
|
|
3922
|
+
export declare const OrderChannelEnum: {
|
|
3923
|
+
readonly Ui: "UI";
|
|
3924
|
+
readonly Api: "API";
|
|
3925
|
+
readonly Embed: "EMBED";
|
|
3926
|
+
readonly Decipher: "DECIPHER";
|
|
3927
|
+
readonly Qualtrics: "QUALTRICS";
|
|
3928
|
+
readonly Typeform: "TYPEFORM";
|
|
3929
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
3930
|
+
};
|
|
3931
|
+
export type OrderChannelEnum = typeof OrderChannelEnum[keyof typeof OrderChannelEnum];
|
|
3479
3932
|
/**
|
|
3480
3933
|
* An order wraps around the fulfilment of one or more rewards.
|
|
3481
3934
|
* @export
|
|
3482
|
-
* @interface
|
|
3935
|
+
* @interface OrderBase
|
|
3483
3936
|
*/
|
|
3484
|
-
export interface
|
|
3937
|
+
export interface OrderBase {
|
|
3485
3938
|
/**
|
|
3486
3939
|
* Tremendous ID of the order
|
|
3487
3940
|
* @type {string}
|
|
3488
|
-
* @memberof
|
|
3941
|
+
* @memberof OrderBase
|
|
3489
3942
|
*/
|
|
3490
3943
|
'id': string;
|
|
3491
3944
|
/**
|
|
3492
3945
|
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
3493
3946
|
* @type {string}
|
|
3494
|
-
* @memberof
|
|
3947
|
+
* @memberof OrderBase
|
|
3495
3948
|
*/
|
|
3496
3949
|
'external_id'?: string | null;
|
|
3497
3950
|
/**
|
|
3498
3951
|
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
3499
3952
|
* @type {string}
|
|
3500
|
-
* @memberof
|
|
3953
|
+
* @memberof OrderBase
|
|
3501
3954
|
*/
|
|
3502
3955
|
'campaign_id'?: string | null;
|
|
3503
3956
|
/**
|
|
3504
3957
|
* Date the order has been created
|
|
3505
3958
|
* @type {string}
|
|
3506
|
-
* @memberof
|
|
3959
|
+
* @memberof OrderBase
|
|
3507
3960
|
*/
|
|
3508
3961
|
'created_at': string;
|
|
3509
3962
|
/**
|
|
3510
3963
|
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> CART </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
3511
3964
|
* @type {string}
|
|
3512
|
-
* @memberof
|
|
3965
|
+
* @memberof OrderBase
|
|
3966
|
+
*/
|
|
3967
|
+
'status': OrderBaseStatusEnum;
|
|
3968
|
+
/**
|
|
3969
|
+
* Name of the channel in which the order was created
|
|
3970
|
+
* @type {string}
|
|
3971
|
+
* @memberof OrderBase
|
|
3513
3972
|
*/
|
|
3514
|
-
'
|
|
3973
|
+
'channel'?: OrderBaseChannelEnum;
|
|
3515
3974
|
/**
|
|
3516
3975
|
*
|
|
3517
3976
|
* @type {OrderBasePayment}
|
|
3518
|
-
* @memberof
|
|
3977
|
+
* @memberof OrderBase
|
|
3519
3978
|
*/
|
|
3520
3979
|
'payment'?: OrderBasePayment;
|
|
3521
3980
|
/**
|
|
3522
3981
|
* The ID for the invoice associated with this order
|
|
3523
3982
|
* @type {string}
|
|
3524
|
-
* @memberof
|
|
3983
|
+
* @memberof OrderBase
|
|
3525
3984
|
*/
|
|
3526
3985
|
'invoice_id'?: string;
|
|
3527
|
-
/**
|
|
3528
|
-
*
|
|
3529
|
-
* @type {Array<OrderWithLinkRewardsInner>}
|
|
3530
|
-
* @memberof OrderWithLink
|
|
3531
|
-
*/
|
|
3532
|
-
'rewards'?: Array<OrderWithLinkRewardsInner>;
|
|
3533
3986
|
}
|
|
3534
|
-
export declare const
|
|
3987
|
+
export declare const OrderBaseStatusEnum: {
|
|
3535
3988
|
readonly Canceled: "CANCELED";
|
|
3536
3989
|
readonly Cart: "CART";
|
|
3537
3990
|
readonly Executed: "EXECUTED";
|
|
@@ -3539,74 +3992,78 @@ export declare const OrderWithLinkStatusEnum: {
|
|
|
3539
3992
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
3540
3993
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3541
3994
|
};
|
|
3542
|
-
export type
|
|
3995
|
+
export type OrderBaseStatusEnum = typeof OrderBaseStatusEnum[keyof typeof OrderBaseStatusEnum];
|
|
3996
|
+
export declare const OrderBaseChannelEnum: {
|
|
3997
|
+
readonly Ui: "UI";
|
|
3998
|
+
readonly Api: "API";
|
|
3999
|
+
readonly Embed: "EMBED";
|
|
4000
|
+
readonly Decipher: "DECIPHER";
|
|
4001
|
+
readonly Qualtrics: "QUALTRICS";
|
|
4002
|
+
readonly Typeform: "TYPEFORM";
|
|
4003
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
4004
|
+
};
|
|
4005
|
+
export type OrderBaseChannelEnum = typeof OrderBaseChannelEnum[keyof typeof OrderBaseChannelEnum];
|
|
3543
4006
|
/**
|
|
3544
|
-
*
|
|
4007
|
+
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are always denominated in USD, independent from the currency of the ordered rewards. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
|
|
3545
4008
|
* @export
|
|
3546
|
-
* @interface
|
|
4009
|
+
* @interface OrderBasePayment
|
|
3547
4010
|
*/
|
|
3548
|
-
export interface
|
|
3549
|
-
/**
|
|
3550
|
-
* Tremendous ID of the reward
|
|
3551
|
-
* @type {string}
|
|
3552
|
-
* @memberof OrderWithLinkRewardsInner
|
|
3553
|
-
*/
|
|
3554
|
-
'id'?: string;
|
|
3555
|
-
/**
|
|
3556
|
-
* Tremendous ID of the order this reward is part of.
|
|
3557
|
-
* @type {string}
|
|
3558
|
-
* @memberof OrderWithLinkRewardsInner
|
|
3559
|
-
*/
|
|
3560
|
-
'order_id'?: string;
|
|
3561
|
-
/**
|
|
3562
|
-
* Date the reward was created
|
|
3563
|
-
* @type {string}
|
|
3564
|
-
* @memberof OrderWithLinkRewardsInner
|
|
3565
|
-
*/
|
|
3566
|
-
'created_at'?: string;
|
|
4011
|
+
export interface OrderBasePayment {
|
|
3567
4012
|
/**
|
|
3568
|
-
*
|
|
3569
|
-
* @type {
|
|
3570
|
-
* @memberof
|
|
4013
|
+
* Total price of the order before fees (in USD)
|
|
4014
|
+
* @type {number}
|
|
4015
|
+
* @memberof OrderBasePayment
|
|
3571
4016
|
*/
|
|
3572
|
-
'
|
|
4017
|
+
'subtotal'?: number;
|
|
3573
4018
|
/**
|
|
3574
|
-
*
|
|
3575
|
-
* @type {
|
|
3576
|
-
* @memberof
|
|
4019
|
+
* Total price of the order including fees (in USD)
|
|
4020
|
+
* @type {number}
|
|
4021
|
+
* @memberof OrderBasePayment
|
|
3577
4022
|
*/
|
|
3578
|
-
'
|
|
4023
|
+
'total'?: number;
|
|
3579
4024
|
/**
|
|
3580
|
-
*
|
|
3581
|
-
* @type {
|
|
3582
|
-
* @memberof
|
|
4025
|
+
* Fees for the order (in USD)
|
|
4026
|
+
* @type {number}
|
|
4027
|
+
* @memberof OrderBasePayment
|
|
3583
4028
|
*/
|
|
3584
|
-
'
|
|
4029
|
+
'fees'?: number;
|
|
3585
4030
|
/**
|
|
3586
4031
|
*
|
|
3587
|
-
* @type {
|
|
3588
|
-
* @memberof
|
|
4032
|
+
* @type {PaymentDetailsRefund}
|
|
4033
|
+
* @memberof OrderBasePayment
|
|
3589
4034
|
*/
|
|
3590
|
-
'
|
|
4035
|
+
'refund'?: PaymentDetailsRefund;
|
|
3591
4036
|
/**
|
|
3592
|
-
*
|
|
4037
|
+
* Name of the channel in which the order was created
|
|
3593
4038
|
* @type {string}
|
|
3594
|
-
* @memberof
|
|
3595
|
-
*/
|
|
3596
|
-
'deliver_at'?: string;
|
|
3597
|
-
/**
|
|
3598
|
-
*
|
|
3599
|
-
* @type {Array<RewardBaseCustomFieldsInner>}
|
|
3600
|
-
* @memberof OrderWithLinkRewardsInner
|
|
3601
|
-
*/
|
|
3602
|
-
'custom_fields'?: Array<RewardBaseCustomFieldsInner>;
|
|
3603
|
-
/**
|
|
3604
|
-
*
|
|
3605
|
-
* @type {RewardWithLinkDelivery}
|
|
3606
|
-
* @memberof OrderWithLinkRewardsInner
|
|
4039
|
+
* @memberof OrderBasePayment
|
|
3607
4040
|
*/
|
|
3608
|
-
'
|
|
4041
|
+
'channel'?: OrderBasePaymentChannelEnum;
|
|
3609
4042
|
}
|
|
4043
|
+
export declare const OrderBasePaymentChannelEnum: {
|
|
4044
|
+
readonly Ui: "UI";
|
|
4045
|
+
readonly Api: "API";
|
|
4046
|
+
readonly Embed: "EMBED";
|
|
4047
|
+
readonly Decipher: "DECIPHER";
|
|
4048
|
+
readonly Qualtrics: "QUALTRICS";
|
|
4049
|
+
readonly Typeform: "TYPEFORM";
|
|
4050
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
4051
|
+
};
|
|
4052
|
+
export type OrderBasePaymentChannelEnum = typeof OrderBasePaymentChannelEnum[keyof typeof OrderBasePaymentChannelEnum];
|
|
4053
|
+
/**
|
|
4054
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> CART </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
4055
|
+
* @export
|
|
4056
|
+
* @enum {string}
|
|
4057
|
+
*/
|
|
4058
|
+
export declare const OrderStatus: {
|
|
4059
|
+
readonly Canceled: "CANCELED";
|
|
4060
|
+
readonly Cart: "CART";
|
|
4061
|
+
readonly Executed: "EXECUTED";
|
|
4062
|
+
readonly Failed: "FAILED";
|
|
4063
|
+
readonly PendingApproval: "PENDING APPROVAL";
|
|
4064
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
4065
|
+
};
|
|
4066
|
+
export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
|
|
3610
4067
|
/**
|
|
3611
4068
|
* An order wraps around the fulfilment of one or more rewards.
|
|
3612
4069
|
* @export
|
|
@@ -3643,6 +4100,12 @@ export interface OrderWithoutLink {
|
|
|
3643
4100
|
* @memberof OrderWithoutLink
|
|
3644
4101
|
*/
|
|
3645
4102
|
'status': OrderWithoutLinkStatusEnum;
|
|
4103
|
+
/**
|
|
4104
|
+
* Name of the channel in which the order was created
|
|
4105
|
+
* @type {string}
|
|
4106
|
+
* @memberof OrderWithoutLink
|
|
4107
|
+
*/
|
|
4108
|
+
'channel'?: OrderWithoutLinkChannelEnum;
|
|
3646
4109
|
/**
|
|
3647
4110
|
*
|
|
3648
4111
|
* @type {OrderBasePayment}
|
|
@@ -3657,10 +4120,10 @@ export interface OrderWithoutLink {
|
|
|
3657
4120
|
'invoice_id'?: string;
|
|
3658
4121
|
/**
|
|
3659
4122
|
*
|
|
3660
|
-
* @type {
|
|
4123
|
+
* @type {Array<OrderWithoutLinkRewardsInner>}
|
|
3661
4124
|
* @memberof OrderWithoutLink
|
|
3662
4125
|
*/
|
|
3663
|
-
'
|
|
4126
|
+
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
3664
4127
|
}
|
|
3665
4128
|
export declare const OrderWithoutLinkStatusEnum: {
|
|
3666
4129
|
readonly Canceled: "CANCELED";
|
|
@@ -3671,70 +4134,80 @@ export declare const OrderWithoutLinkStatusEnum: {
|
|
|
3671
4134
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3672
4135
|
};
|
|
3673
4136
|
export type OrderWithoutLinkStatusEnum = typeof OrderWithoutLinkStatusEnum[keyof typeof OrderWithoutLinkStatusEnum];
|
|
4137
|
+
export declare const OrderWithoutLinkChannelEnum: {
|
|
4138
|
+
readonly Ui: "UI";
|
|
4139
|
+
readonly Api: "API";
|
|
4140
|
+
readonly Embed: "EMBED";
|
|
4141
|
+
readonly Decipher: "DECIPHER";
|
|
4142
|
+
readonly Qualtrics: "QUALTRICS";
|
|
4143
|
+
readonly Typeform: "TYPEFORM";
|
|
4144
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
4145
|
+
};
|
|
4146
|
+
export type OrderWithoutLinkChannelEnum = typeof OrderWithoutLinkChannelEnum[keyof typeof OrderWithoutLinkChannelEnum];
|
|
3674
4147
|
/**
|
|
3675
4148
|
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
3676
4149
|
* @export
|
|
3677
|
-
* @interface
|
|
4150
|
+
* @interface OrderWithoutLinkRewardsInner
|
|
3678
4151
|
*/
|
|
3679
|
-
export interface
|
|
4152
|
+
export interface OrderWithoutLinkRewardsInner {
|
|
3680
4153
|
/**
|
|
3681
4154
|
* Tremendous ID of the reward
|
|
3682
4155
|
* @type {string}
|
|
3683
|
-
* @memberof
|
|
4156
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3684
4157
|
*/
|
|
3685
4158
|
'id'?: string;
|
|
3686
4159
|
/**
|
|
3687
4160
|
* Tremendous ID of the order this reward is part of.
|
|
3688
4161
|
* @type {string}
|
|
3689
|
-
* @memberof
|
|
4162
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3690
4163
|
*/
|
|
3691
4164
|
'order_id'?: string;
|
|
3692
4165
|
/**
|
|
3693
4166
|
* Date the reward was created
|
|
3694
4167
|
* @type {string}
|
|
3695
|
-
* @memberof
|
|
4168
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3696
4169
|
*/
|
|
3697
4170
|
'created_at'?: string;
|
|
3698
4171
|
/**
|
|
3699
4172
|
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
3700
4173
|
* @type {string}
|
|
3701
|
-
* @memberof
|
|
4174
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3702
4175
|
*/
|
|
3703
4176
|
'campaign_id'?: string | null;
|
|
3704
4177
|
/**
|
|
3705
4178
|
* List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel.
|
|
3706
4179
|
* @type {Array<string>}
|
|
3707
|
-
* @memberof
|
|
4180
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3708
4181
|
*/
|
|
3709
4182
|
'products'?: Array<string>;
|
|
3710
4183
|
/**
|
|
3711
4184
|
*
|
|
3712
4185
|
* @type {ListRewards200ResponseRewardsInnerValue}
|
|
3713
|
-
* @memberof
|
|
4186
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3714
4187
|
*/
|
|
3715
4188
|
'value'?: ListRewards200ResponseRewardsInnerValue;
|
|
3716
4189
|
/**
|
|
3717
4190
|
*
|
|
3718
4191
|
* @type {ListRewards200ResponseRewardsInnerRecipient}
|
|
3719
|
-
* @memberof
|
|
4192
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3720
4193
|
*/
|
|
3721
4194
|
'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
|
|
3722
4195
|
/**
|
|
3723
4196
|
* Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
|
|
3724
4197
|
* @type {string}
|
|
3725
|
-
* @memberof
|
|
4198
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3726
4199
|
*/
|
|
3727
4200
|
'deliver_at'?: string;
|
|
3728
4201
|
/**
|
|
3729
4202
|
*
|
|
3730
4203
|
* @type {Array<RewardBaseCustomFieldsInner>}
|
|
3731
|
-
* @memberof
|
|
4204
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3732
4205
|
*/
|
|
3733
4206
|
'custom_fields'?: Array<RewardBaseCustomFieldsInner>;
|
|
3734
4207
|
/**
|
|
3735
4208
|
*
|
|
3736
4209
|
* @type {RewardWithoutLinkDelivery}
|
|
3737
|
-
* @memberof
|
|
4210
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
3738
4211
|
*/
|
|
3739
4212
|
'delivery'?: RewardWithoutLinkDelivery;
|
|
3740
4213
|
}
|
|
@@ -4031,7 +4504,7 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
4031
4504
|
};
|
|
4032
4505
|
export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum];
|
|
4033
4506
|
/**
|
|
4034
|
-
* To authenticate your requests using asymmetric key pairs (e.g., for signing
|
|
4507
|
+
* To authenticate your requests using asymmetric key pairs (e.g., for signing embed requests), you need to share your public key with us. The public key resource allows you to manage your active public keys and track their last usage.
|
|
4035
4508
|
* @export
|
|
4036
4509
|
* @interface PublicKey
|
|
4037
4510
|
*/
|
|
@@ -4069,7 +4542,7 @@ export interface PublicKeysResponse {
|
|
|
4069
4542
|
'public_keys': Array<PublicKeysResponsePublicKeysInner>;
|
|
4070
4543
|
}
|
|
4071
4544
|
/**
|
|
4072
|
-
* To authenticate your requests using asymmetric key pairs (e.g., for signing
|
|
4545
|
+
* To authenticate your requests using asymmetric key pairs (e.g., for signing embed requests), you need to share your public key with us. The public key resource allows you to manage your active public keys and track their last usage.
|
|
4073
4546
|
* @export
|
|
4074
4547
|
* @interface PublicKeysResponsePublicKeysInner
|
|
4075
4548
|
*/
|
|
@@ -4134,16 +4607,173 @@ export interface RefundDetails {
|
|
|
4134
4607
|
/**
|
|
4135
4608
|
*
|
|
4136
4609
|
* @export
|
|
4137
|
-
* @interface ResendReward422Response
|
|
4610
|
+
* @interface ResendReward422Response
|
|
4611
|
+
*/
|
|
4612
|
+
export interface ResendReward422Response {
|
|
4613
|
+
/**
|
|
4614
|
+
*
|
|
4615
|
+
* @type {ListRewards401ResponseErrors}
|
|
4616
|
+
* @memberof ResendReward422Response
|
|
4617
|
+
*/
|
|
4618
|
+
'errors': ListRewards401ResponseErrors;
|
|
4619
|
+
}
|
|
4620
|
+
/**
|
|
4621
|
+
* Flag rewards redeemed in these countries.
|
|
4622
|
+
* @export
|
|
4623
|
+
* @interface ReviewCountry
|
|
4624
|
+
*/
|
|
4625
|
+
export interface ReviewCountry {
|
|
4626
|
+
/**
|
|
4627
|
+
* When type is `whitelist`, it flags any countries that *are not* present in the list. When type is `blacklist`, it flags any countries that *are* present in the list.
|
|
4628
|
+
* @type {string}
|
|
4629
|
+
* @memberof ReviewCountry
|
|
4630
|
+
*/
|
|
4631
|
+
'type': ReviewCountryTypeEnum;
|
|
4632
|
+
/**
|
|
4633
|
+
* An array of country codes (ISO-3166 alpha-2 character code)
|
|
4634
|
+
* @type {Array<string>}
|
|
4635
|
+
* @memberof ReviewCountry
|
|
4636
|
+
*/
|
|
4637
|
+
'countries': Array<string>;
|
|
4638
|
+
}
|
|
4639
|
+
export declare const ReviewCountryTypeEnum: {
|
|
4640
|
+
readonly Whitelist: "whitelist";
|
|
4641
|
+
readonly Blacklist: "blacklist";
|
|
4642
|
+
};
|
|
4643
|
+
export type ReviewCountryTypeEnum = typeof ReviewCountryTypeEnum[keyof typeof ReviewCountryTypeEnum];
|
|
4644
|
+
/**
|
|
4645
|
+
* List of countries where a matching redemption will trigger a review.
|
|
4646
|
+
* @export
|
|
4647
|
+
* @interface ReviewCountry1
|
|
4648
|
+
*/
|
|
4649
|
+
export interface ReviewCountry1 {
|
|
4650
|
+
/**
|
|
4651
|
+
* An array of country codes (ISO-3166 alpha-2 character code)
|
|
4652
|
+
* @type {Array<string>}
|
|
4653
|
+
* @memberof ReviewCountry1
|
|
4654
|
+
*/
|
|
4655
|
+
'countries': Array<string>;
|
|
4656
|
+
}
|
|
4657
|
+
/**
|
|
4658
|
+
* Flag rewards with an email or domain matching this list.
|
|
4659
|
+
* @export
|
|
4660
|
+
* @interface ReviewEmail
|
|
4661
|
+
*/
|
|
4662
|
+
export interface ReviewEmail {
|
|
4663
|
+
/**
|
|
4664
|
+
* The list of emails.
|
|
4665
|
+
* @type {Array<string>}
|
|
4666
|
+
* @memberof ReviewEmail
|
|
4667
|
+
*/
|
|
4668
|
+
'emails'?: Array<string>;
|
|
4669
|
+
/**
|
|
4670
|
+
* The list of domains. Any subdomains will also be matched against each entry in the list.
|
|
4671
|
+
* @type {Array<string>}
|
|
4672
|
+
* @memberof ReviewEmail
|
|
4673
|
+
*/
|
|
4674
|
+
'domains'?: Array<string>;
|
|
4675
|
+
}
|
|
4676
|
+
/**
|
|
4677
|
+
* The list of emails and/or domains where a matching redemption will trigger a review. At least one email or domain is required.
|
|
4678
|
+
* @export
|
|
4679
|
+
* @interface ReviewEmail1
|
|
4680
|
+
*/
|
|
4681
|
+
export interface ReviewEmail1 {
|
|
4682
|
+
/**
|
|
4683
|
+
* The list of emails.
|
|
4684
|
+
* @type {Array<string>}
|
|
4685
|
+
* @memberof ReviewEmail1
|
|
4686
|
+
*/
|
|
4687
|
+
'emails'?: Array<string>;
|
|
4688
|
+
/**
|
|
4689
|
+
* The list of domains. Any subdomains will also be matched against each entry in the list.
|
|
4690
|
+
* @type {Array<string>}
|
|
4691
|
+
* @memberof ReviewEmail1
|
|
4692
|
+
*/
|
|
4693
|
+
'domains'?: Array<string>;
|
|
4694
|
+
}
|
|
4695
|
+
/**
|
|
4696
|
+
* Flag rewards redeemed by an IP matching this list.
|
|
4697
|
+
* @export
|
|
4698
|
+
* @interface ReviewIp
|
|
4699
|
+
*/
|
|
4700
|
+
export interface ReviewIp {
|
|
4701
|
+
/**
|
|
4702
|
+
* The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
|
|
4703
|
+
* @type {Array<string>}
|
|
4704
|
+
* @memberof ReviewIp
|
|
4705
|
+
*/
|
|
4706
|
+
'ips': Array<string>;
|
|
4707
|
+
}
|
|
4708
|
+
/**
|
|
4709
|
+
* List of IP addresses and/or IP ranges where a matching redemption will trigger a review.
|
|
4710
|
+
* @export
|
|
4711
|
+
* @interface ReviewIp1
|
|
4712
|
+
*/
|
|
4713
|
+
export interface ReviewIp1 {
|
|
4714
|
+
/**
|
|
4715
|
+
* The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
|
|
4716
|
+
* @type {Array<string>}
|
|
4717
|
+
* @memberof ReviewIp1
|
|
4718
|
+
*/
|
|
4719
|
+
'ips': Array<string>;
|
|
4720
|
+
}
|
|
4721
|
+
/**
|
|
4722
|
+
* If a recipient, device, or IP redeems more than this dollar value of rewards, flag for review.
|
|
4723
|
+
* @export
|
|
4724
|
+
* @interface ReviewRedeemedRewardsAmount
|
|
4725
|
+
*/
|
|
4726
|
+
export interface ReviewRedeemedRewardsAmount {
|
|
4727
|
+
/**
|
|
4728
|
+
* The total amount in USD of redeemed rewards to use as a threshold.
|
|
4729
|
+
* @type {number}
|
|
4730
|
+
* @memberof ReviewRedeemedRewardsAmount
|
|
4731
|
+
*/
|
|
4732
|
+
'amount': number;
|
|
4733
|
+
/**
|
|
4734
|
+
* The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
|
|
4735
|
+
* @type {string}
|
|
4736
|
+
* @memberof ReviewRedeemedRewardsAmount
|
|
4737
|
+
*/
|
|
4738
|
+
'period': ReviewRedeemedRewardsAmountPeriodEnum;
|
|
4739
|
+
}
|
|
4740
|
+
export declare const ReviewRedeemedRewardsAmountPeriodEnum: {
|
|
4741
|
+
readonly _7: "7";
|
|
4742
|
+
readonly _30: "30";
|
|
4743
|
+
readonly _90: "90";
|
|
4744
|
+
readonly _120: "120";
|
|
4745
|
+
readonly _365: "365";
|
|
4746
|
+
readonly AllTime: "all_time";
|
|
4747
|
+
};
|
|
4748
|
+
export type ReviewRedeemedRewardsAmountPeriodEnum = typeof ReviewRedeemedRewardsAmountPeriodEnum[keyof typeof ReviewRedeemedRewardsAmountPeriodEnum];
|
|
4749
|
+
/**
|
|
4750
|
+
* If a recipient, device, or IP redeems more than this number of rewards, flag for review.
|
|
4751
|
+
* @export
|
|
4752
|
+
* @interface ReviewRedeemedRewardsCount
|
|
4138
4753
|
*/
|
|
4139
|
-
export interface
|
|
4754
|
+
export interface ReviewRedeemedRewardsCount {
|
|
4140
4755
|
/**
|
|
4141
|
-
*
|
|
4142
|
-
* @type {
|
|
4143
|
-
* @memberof
|
|
4756
|
+
* The number of redeemed rewards to use as a threshold.
|
|
4757
|
+
* @type {number}
|
|
4758
|
+
* @memberof ReviewRedeemedRewardsCount
|
|
4144
4759
|
*/
|
|
4145
|
-
'
|
|
4760
|
+
'amount': number;
|
|
4761
|
+
/**
|
|
4762
|
+
* The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
|
|
4763
|
+
* @type {string}
|
|
4764
|
+
* @memberof ReviewRedeemedRewardsCount
|
|
4765
|
+
*/
|
|
4766
|
+
'period': ReviewRedeemedRewardsCountPeriodEnum;
|
|
4146
4767
|
}
|
|
4768
|
+
export declare const ReviewRedeemedRewardsCountPeriodEnum: {
|
|
4769
|
+
readonly _7: "7";
|
|
4770
|
+
readonly _30: "30";
|
|
4771
|
+
readonly _90: "90";
|
|
4772
|
+
readonly _120: "120";
|
|
4773
|
+
readonly _365: "365";
|
|
4774
|
+
readonly AllTime: "all_time";
|
|
4775
|
+
};
|
|
4776
|
+
export type ReviewRedeemedRewardsCountPeriodEnum = typeof ReviewRedeemedRewardsCountPeriodEnum[keyof typeof ReviewRedeemedRewardsCountPeriodEnum];
|
|
4147
4777
|
/**
|
|
4148
4778
|
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
4149
4779
|
* @export
|
|
@@ -4365,10 +4995,10 @@ export interface RewardForOrderCreate {
|
|
|
4365
4995
|
'language'?: string;
|
|
4366
4996
|
/**
|
|
4367
4997
|
*
|
|
4368
|
-
* @type {
|
|
4998
|
+
* @type {SingleRewardOrder1RewardDelivery}
|
|
4369
4999
|
* @memberof RewardForOrderCreate
|
|
4370
5000
|
*/
|
|
4371
|
-
'delivery'?:
|
|
5001
|
+
'delivery'?: SingleRewardOrder1RewardDelivery;
|
|
4372
5002
|
}
|
|
4373
5003
|
/**
|
|
4374
5004
|
* The redemption link for a reward.
|
|
@@ -4431,7 +5061,7 @@ export interface RewardValue {
|
|
|
4431
5061
|
* @type {string}
|
|
4432
5062
|
* @memberof RewardValue
|
|
4433
5063
|
*/
|
|
4434
|
-
'currency_code'
|
|
5064
|
+
'currency_code'?: RewardValueCurrencyCodeEnum;
|
|
4435
5065
|
}
|
|
4436
5066
|
export declare const RewardValueCurrencyCodeEnum: {
|
|
4437
5067
|
readonly Usd: "USD";
|
|
@@ -4555,245 +5185,462 @@ export type RewardValueCurrencyCodeEnum = typeof RewardValueCurrencyCodeEnum[key
|
|
|
4555
5185
|
/**
|
|
4556
5186
|
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
4557
5187
|
* @export
|
|
4558
|
-
* @interface
|
|
5188
|
+
* @interface RewardWithoutLink
|
|
4559
5189
|
*/
|
|
4560
|
-
export interface
|
|
5190
|
+
export interface RewardWithoutLink {
|
|
4561
5191
|
/**
|
|
4562
5192
|
* Tremendous ID of the reward
|
|
4563
5193
|
* @type {string}
|
|
4564
|
-
* @memberof
|
|
5194
|
+
* @memberof RewardWithoutLink
|
|
4565
5195
|
*/
|
|
4566
5196
|
'id'?: string;
|
|
4567
5197
|
/**
|
|
4568
5198
|
* Tremendous ID of the order this reward is part of.
|
|
4569
5199
|
* @type {string}
|
|
4570
|
-
* @memberof
|
|
5200
|
+
* @memberof RewardWithoutLink
|
|
4571
5201
|
*/
|
|
4572
5202
|
'order_id'?: string;
|
|
4573
5203
|
/**
|
|
4574
5204
|
* Date the reward was created
|
|
4575
5205
|
* @type {string}
|
|
4576
|
-
* @memberof
|
|
5206
|
+
* @memberof RewardWithoutLink
|
|
4577
5207
|
*/
|
|
4578
5208
|
'created_at'?: string;
|
|
4579
5209
|
/**
|
|
4580
5210
|
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
4581
5211
|
* @type {string}
|
|
4582
|
-
* @memberof
|
|
5212
|
+
* @memberof RewardWithoutLink
|
|
4583
5213
|
*/
|
|
4584
5214
|
'campaign_id'?: string | null;
|
|
4585
5215
|
/**
|
|
4586
5216
|
* List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel.
|
|
4587
5217
|
* @type {Array<string>}
|
|
4588
|
-
* @memberof
|
|
5218
|
+
* @memberof RewardWithoutLink
|
|
4589
5219
|
*/
|
|
4590
5220
|
'products'?: Array<string>;
|
|
4591
5221
|
/**
|
|
4592
5222
|
*
|
|
4593
5223
|
* @type {ListRewards200ResponseRewardsInnerValue}
|
|
4594
|
-
* @memberof
|
|
5224
|
+
* @memberof RewardWithoutLink
|
|
4595
5225
|
*/
|
|
4596
5226
|
'value'?: ListRewards200ResponseRewardsInnerValue;
|
|
4597
5227
|
/**
|
|
4598
5228
|
*
|
|
4599
5229
|
* @type {ListRewards200ResponseRewardsInnerRecipient}
|
|
4600
|
-
* @memberof
|
|
5230
|
+
* @memberof RewardWithoutLink
|
|
4601
5231
|
*/
|
|
4602
5232
|
'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
|
|
4603
5233
|
/**
|
|
4604
5234
|
* Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
|
|
4605
5235
|
* @type {string}
|
|
4606
|
-
* @memberof
|
|
5236
|
+
* @memberof RewardWithoutLink
|
|
4607
5237
|
*/
|
|
4608
5238
|
'deliver_at'?: string;
|
|
4609
5239
|
/**
|
|
4610
5240
|
*
|
|
4611
5241
|
* @type {Array<RewardBaseCustomFieldsInner>}
|
|
4612
|
-
* @memberof
|
|
5242
|
+
* @memberof RewardWithoutLink
|
|
4613
5243
|
*/
|
|
4614
5244
|
'custom_fields'?: Array<RewardBaseCustomFieldsInner>;
|
|
4615
5245
|
/**
|
|
4616
5246
|
*
|
|
4617
|
-
* @type {
|
|
4618
|
-
* @memberof
|
|
5247
|
+
* @type {RewardWithoutLinkDelivery}
|
|
5248
|
+
* @memberof RewardWithoutLink
|
|
4619
5249
|
*/
|
|
4620
|
-
'delivery'?:
|
|
5250
|
+
'delivery'?: RewardWithoutLinkDelivery;
|
|
4621
5251
|
}
|
|
4622
5252
|
/**
|
|
4623
5253
|
* Details on how the reward is delivered to the recipient.
|
|
4624
5254
|
* @export
|
|
4625
|
-
* @interface
|
|
5255
|
+
* @interface RewardWithoutLinkDelivery
|
|
4626
5256
|
*/
|
|
4627
|
-
export interface
|
|
5257
|
+
export interface RewardWithoutLinkDelivery {
|
|
4628
5258
|
/**
|
|
4629
5259
|
* How to deliver the reward to the recipient. <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table>
|
|
4630
5260
|
* @type {string}
|
|
4631
|
-
* @memberof
|
|
5261
|
+
* @memberof RewardWithoutLinkDelivery
|
|
4632
5262
|
*/
|
|
4633
|
-
'method':
|
|
5263
|
+
'method': RewardWithoutLinkDeliveryMethodEnum;
|
|
4634
5264
|
/**
|
|
4635
5265
|
* Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link opened). * `PENDING` - Delivery is pending but not yet scheduled.
|
|
4636
5266
|
* @type {string}
|
|
4637
|
-
* @memberof
|
|
4638
|
-
*/
|
|
4639
|
-
'status': RewardWithLinkDeliveryStatusEnum;
|
|
4640
|
-
/**
|
|
4641
|
-
* Link to redeem the reward at. You need to deliver this link to the recipient. Only available for rewards for which the `method` for delivery is set to `LINK`.
|
|
4642
|
-
* @type {string}
|
|
4643
|
-
* @memberof RewardWithLinkDelivery
|
|
5267
|
+
* @memberof RewardWithoutLinkDelivery
|
|
4644
5268
|
*/
|
|
4645
|
-
'
|
|
5269
|
+
'status': RewardWithoutLinkDeliveryStatusEnum;
|
|
4646
5270
|
}
|
|
4647
|
-
export declare const
|
|
5271
|
+
export declare const RewardWithoutLinkDeliveryMethodEnum: {
|
|
4648
5272
|
readonly Email: "EMAIL";
|
|
4649
5273
|
readonly Link: "LINK";
|
|
4650
5274
|
readonly Phone: "PHONE";
|
|
4651
5275
|
};
|
|
4652
|
-
export type
|
|
4653
|
-
export declare const
|
|
5276
|
+
export type RewardWithoutLinkDeliveryMethodEnum = typeof RewardWithoutLinkDeliveryMethodEnum[keyof typeof RewardWithoutLinkDeliveryMethodEnum];
|
|
5277
|
+
export declare const RewardWithoutLinkDeliveryStatusEnum: {
|
|
4654
5278
|
readonly Scheduled: "SCHEDULED";
|
|
4655
5279
|
readonly Failed: "FAILED";
|
|
4656
5280
|
readonly Succeeded: "SUCCEEDED";
|
|
4657
5281
|
readonly Pending: "PENDING";
|
|
4658
5282
|
};
|
|
4659
|
-
export type
|
|
5283
|
+
export type RewardWithoutLinkDeliveryStatusEnum = typeof RewardWithoutLinkDeliveryStatusEnum[keyof typeof RewardWithoutLinkDeliveryStatusEnum];
|
|
5284
|
+
/**
|
|
5285
|
+
* Each organization member is assigned a role that defines the permissions they have within the organization.
|
|
5286
|
+
* @export
|
|
5287
|
+
* @interface Role
|
|
5288
|
+
*/
|
|
5289
|
+
export interface Role {
|
|
5290
|
+
/**
|
|
5291
|
+
*
|
|
5292
|
+
* @type {string}
|
|
5293
|
+
* @memberof Role
|
|
5294
|
+
*/
|
|
5295
|
+
'id': string;
|
|
5296
|
+
/**
|
|
5297
|
+
*
|
|
5298
|
+
* @type {string}
|
|
5299
|
+
* @memberof Role
|
|
5300
|
+
*/
|
|
5301
|
+
'title': string;
|
|
5302
|
+
/**
|
|
5303
|
+
*
|
|
5304
|
+
* @type {string}
|
|
5305
|
+
* @memberof Role
|
|
5306
|
+
*/
|
|
5307
|
+
'description': string;
|
|
5308
|
+
}
|
|
5309
|
+
/**
|
|
5310
|
+
*
|
|
5311
|
+
* @export
|
|
5312
|
+
* @interface SimulateWebhookRequest
|
|
5313
|
+
*/
|
|
5314
|
+
export interface SimulateWebhookRequest {
|
|
5315
|
+
/**
|
|
5316
|
+
* The event to test. See the [List events endpoint reference](/reference/get_webhooks-id-events) for all available events.
|
|
5317
|
+
* @type {string}
|
|
5318
|
+
* @memberof SimulateWebhookRequest
|
|
5319
|
+
*/
|
|
5320
|
+
'event': string;
|
|
5321
|
+
}
|
|
5322
|
+
/**
|
|
5323
|
+
* An order that contains a single reward. The reward is sent to a single recipient.
|
|
5324
|
+
* @export
|
|
5325
|
+
* @interface SingleRewardOrder
|
|
5326
|
+
*/
|
|
5327
|
+
export interface SingleRewardOrder {
|
|
5328
|
+
/**
|
|
5329
|
+
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
5330
|
+
* @type {string}
|
|
5331
|
+
* @memberof SingleRewardOrder
|
|
5332
|
+
*/
|
|
5333
|
+
'external_id'?: string | null;
|
|
5334
|
+
/**
|
|
5335
|
+
*
|
|
5336
|
+
* @type {SingleRewardOrder1Payment}
|
|
5337
|
+
* @memberof SingleRewardOrder
|
|
5338
|
+
*/
|
|
5339
|
+
'payment'?: SingleRewardOrder1Payment;
|
|
5340
|
+
/**
|
|
5341
|
+
*
|
|
5342
|
+
* @type {SingleRewardOrderReward}
|
|
5343
|
+
* @memberof SingleRewardOrder
|
|
5344
|
+
*/
|
|
5345
|
+
'reward': SingleRewardOrderReward;
|
|
5346
|
+
}
|
|
5347
|
+
/**
|
|
5348
|
+
* An order that contains a single reward. The reward is sent to a single recipient.
|
|
5349
|
+
* @export
|
|
5350
|
+
* @interface SingleRewardOrder1
|
|
5351
|
+
*/
|
|
5352
|
+
export interface SingleRewardOrder1 {
|
|
5353
|
+
/**
|
|
5354
|
+
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
5355
|
+
* @type {string}
|
|
5356
|
+
* @memberof SingleRewardOrder1
|
|
5357
|
+
*/
|
|
5358
|
+
'external_id'?: string | null;
|
|
5359
|
+
/**
|
|
5360
|
+
*
|
|
5361
|
+
* @type {SingleRewardOrder1Payment}
|
|
5362
|
+
* @memberof SingleRewardOrder1
|
|
5363
|
+
*/
|
|
5364
|
+
'payment'?: SingleRewardOrder1Payment;
|
|
5365
|
+
/**
|
|
5366
|
+
*
|
|
5367
|
+
* @type {SingleRewardOrder1Reward}
|
|
5368
|
+
* @memberof SingleRewardOrder1
|
|
5369
|
+
*/
|
|
5370
|
+
'reward': SingleRewardOrder1Reward;
|
|
5371
|
+
}
|
|
5372
|
+
/**
|
|
5373
|
+
*
|
|
5374
|
+
* @export
|
|
5375
|
+
* @interface SingleRewardOrder1Payment
|
|
5376
|
+
*/
|
|
5377
|
+
export interface SingleRewardOrder1Payment {
|
|
5378
|
+
/**
|
|
5379
|
+
* Tremendous ID of the funding source that will be used to pay for the order. Use `balance` to use your Tremendous\'s balance.
|
|
5380
|
+
* @type {string}
|
|
5381
|
+
* @memberof SingleRewardOrder1Payment
|
|
5382
|
+
*/
|
|
5383
|
+
'funding_source_id': string;
|
|
5384
|
+
}
|
|
4660
5385
|
/**
|
|
4661
5386
|
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
4662
5387
|
* @export
|
|
4663
|
-
* @interface
|
|
5388
|
+
* @interface SingleRewardOrder1Reward
|
|
4664
5389
|
*/
|
|
4665
|
-
export interface
|
|
5390
|
+
export interface SingleRewardOrder1Reward {
|
|
5391
|
+
/**
|
|
5392
|
+
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
5393
|
+
* @type {string}
|
|
5394
|
+
* @memberof SingleRewardOrder1Reward
|
|
5395
|
+
*/
|
|
5396
|
+
'campaign_id'?: string | null;
|
|
5397
|
+
/**
|
|
5398
|
+
* List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel.
|
|
5399
|
+
* @type {Array<string>}
|
|
5400
|
+
* @memberof SingleRewardOrder1Reward
|
|
5401
|
+
*/
|
|
5402
|
+
'products'?: Array<string>;
|
|
5403
|
+
/**
|
|
5404
|
+
*
|
|
5405
|
+
* @type {ListRewards200ResponseRewardsInnerValue}
|
|
5406
|
+
* @memberof SingleRewardOrder1Reward
|
|
5407
|
+
*/
|
|
5408
|
+
'value'?: ListRewards200ResponseRewardsInnerValue;
|
|
5409
|
+
/**
|
|
5410
|
+
*
|
|
5411
|
+
* @type {ListRewards200ResponseRewardsInnerRecipient}
|
|
5412
|
+
* @memberof SingleRewardOrder1Reward
|
|
5413
|
+
*/
|
|
5414
|
+
'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
|
|
5415
|
+
/**
|
|
5416
|
+
* Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
|
|
5417
|
+
* @type {string}
|
|
5418
|
+
* @memberof SingleRewardOrder1Reward
|
|
5419
|
+
*/
|
|
5420
|
+
'deliver_at'?: string;
|
|
5421
|
+
/**
|
|
5422
|
+
*
|
|
5423
|
+
* @type {Array<SingleRewardOrder1RewardCustomFieldsInner>}
|
|
5424
|
+
* @memberof SingleRewardOrder1Reward
|
|
5425
|
+
*/
|
|
5426
|
+
'custom_fields'?: Array<SingleRewardOrder1RewardCustomFieldsInner>;
|
|
5427
|
+
/**
|
|
5428
|
+
* Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to `en`.
|
|
5429
|
+
* @type {string}
|
|
5430
|
+
* @memberof SingleRewardOrder1Reward
|
|
5431
|
+
*/
|
|
5432
|
+
'language'?: string;
|
|
5433
|
+
/**
|
|
5434
|
+
*
|
|
5435
|
+
* @type {SingleRewardOrder1RewardDelivery}
|
|
5436
|
+
* @memberof SingleRewardOrder1Reward
|
|
5437
|
+
*/
|
|
5438
|
+
'delivery'?: SingleRewardOrder1RewardDelivery;
|
|
5439
|
+
}
|
|
5440
|
+
/**
|
|
5441
|
+
* Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/reference/using-custom-fields-to-add-custom-data-to-rewards).)
|
|
5442
|
+
* @export
|
|
5443
|
+
* @interface SingleRewardOrder1RewardCustomFieldsInner
|
|
5444
|
+
*/
|
|
5445
|
+
export interface SingleRewardOrder1RewardCustomFieldsInner {
|
|
5446
|
+
/**
|
|
5447
|
+
* Tremendous ID of the custom field
|
|
5448
|
+
* @type {string}
|
|
5449
|
+
* @memberof SingleRewardOrder1RewardCustomFieldsInner
|
|
5450
|
+
*/
|
|
5451
|
+
'id'?: string;
|
|
5452
|
+
/**
|
|
5453
|
+
* Value of the custom field
|
|
5454
|
+
* @type {string}
|
|
5455
|
+
* @memberof SingleRewardOrder1RewardCustomFieldsInner
|
|
5456
|
+
*/
|
|
5457
|
+
'value'?: string | null;
|
|
5458
|
+
}
|
|
5459
|
+
/**
|
|
5460
|
+
* Details on how the reward is delivered to the recipient.
|
|
5461
|
+
* @export
|
|
5462
|
+
* @interface SingleRewardOrder1RewardDelivery
|
|
5463
|
+
*/
|
|
5464
|
+
export interface SingleRewardOrder1RewardDelivery {
|
|
5465
|
+
/**
|
|
5466
|
+
* How to deliver the reward to the recipient. <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table>
|
|
5467
|
+
* @type {string}
|
|
5468
|
+
* @memberof SingleRewardOrder1RewardDelivery
|
|
5469
|
+
*/
|
|
5470
|
+
'method'?: SingleRewardOrder1RewardDeliveryMethodEnum;
|
|
5471
|
+
}
|
|
5472
|
+
export declare const SingleRewardOrder1RewardDeliveryMethodEnum: {
|
|
5473
|
+
readonly Email: "EMAIL";
|
|
5474
|
+
readonly Link: "LINK";
|
|
5475
|
+
readonly Phone: "PHONE";
|
|
5476
|
+
};
|
|
5477
|
+
export type SingleRewardOrder1RewardDeliveryMethodEnum = typeof SingleRewardOrder1RewardDeliveryMethodEnum[keyof typeof SingleRewardOrder1RewardDeliveryMethodEnum];
|
|
5478
|
+
/**
|
|
5479
|
+
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
5480
|
+
* @export
|
|
5481
|
+
* @interface SingleRewardOrderReward
|
|
5482
|
+
*/
|
|
5483
|
+
export interface SingleRewardOrderReward {
|
|
4666
5484
|
/**
|
|
4667
5485
|
* Tremendous ID of the reward
|
|
4668
5486
|
* @type {string}
|
|
4669
|
-
* @memberof
|
|
5487
|
+
* @memberof SingleRewardOrderReward
|
|
4670
5488
|
*/
|
|
4671
5489
|
'id'?: string;
|
|
4672
5490
|
/**
|
|
4673
5491
|
* Tremendous ID of the order this reward is part of.
|
|
4674
5492
|
* @type {string}
|
|
4675
|
-
* @memberof
|
|
5493
|
+
* @memberof SingleRewardOrderReward
|
|
4676
5494
|
*/
|
|
4677
5495
|
'order_id'?: string;
|
|
4678
5496
|
/**
|
|
4679
5497
|
* Date the reward was created
|
|
4680
5498
|
* @type {string}
|
|
4681
|
-
* @memberof
|
|
5499
|
+
* @memberof SingleRewardOrderReward
|
|
4682
5500
|
*/
|
|
4683
5501
|
'created_at'?: string;
|
|
4684
5502
|
/**
|
|
4685
5503
|
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
4686
5504
|
* @type {string}
|
|
4687
|
-
* @memberof
|
|
5505
|
+
* @memberof SingleRewardOrderReward
|
|
4688
5506
|
*/
|
|
4689
5507
|
'campaign_id'?: string | null;
|
|
4690
5508
|
/**
|
|
4691
5509
|
* List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel.
|
|
4692
5510
|
* @type {Array<string>}
|
|
4693
|
-
* @memberof
|
|
5511
|
+
* @memberof SingleRewardOrderReward
|
|
4694
5512
|
*/
|
|
4695
5513
|
'products'?: Array<string>;
|
|
4696
5514
|
/**
|
|
4697
5515
|
*
|
|
4698
5516
|
* @type {ListRewards200ResponseRewardsInnerValue}
|
|
4699
|
-
* @memberof
|
|
5517
|
+
* @memberof SingleRewardOrderReward
|
|
4700
5518
|
*/
|
|
4701
5519
|
'value'?: ListRewards200ResponseRewardsInnerValue;
|
|
4702
5520
|
/**
|
|
4703
5521
|
*
|
|
4704
5522
|
* @type {ListRewards200ResponseRewardsInnerRecipient}
|
|
4705
|
-
* @memberof
|
|
5523
|
+
* @memberof SingleRewardOrderReward
|
|
4706
5524
|
*/
|
|
4707
5525
|
'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
|
|
4708
5526
|
/**
|
|
4709
5527
|
* Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
|
|
4710
5528
|
* @type {string}
|
|
4711
|
-
* @memberof
|
|
5529
|
+
* @memberof SingleRewardOrderReward
|
|
4712
5530
|
*/
|
|
4713
5531
|
'deliver_at'?: string;
|
|
4714
5532
|
/**
|
|
4715
5533
|
*
|
|
4716
5534
|
* @type {Array<RewardBaseCustomFieldsInner>}
|
|
4717
|
-
* @memberof
|
|
5535
|
+
* @memberof SingleRewardOrderReward
|
|
4718
5536
|
*/
|
|
4719
5537
|
'custom_fields'?: Array<RewardBaseCustomFieldsInner>;
|
|
5538
|
+
/**
|
|
5539
|
+
* Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to `en`.
|
|
5540
|
+
* @type {string}
|
|
5541
|
+
* @memberof SingleRewardOrderReward
|
|
5542
|
+
*/
|
|
5543
|
+
'language'?: string;
|
|
4720
5544
|
/**
|
|
4721
5545
|
*
|
|
4722
|
-
* @type {
|
|
4723
|
-
* @memberof
|
|
5546
|
+
* @type {SingleRewardOrder1RewardDelivery}
|
|
5547
|
+
* @memberof SingleRewardOrderReward
|
|
4724
5548
|
*/
|
|
4725
|
-
'delivery'?:
|
|
5549
|
+
'delivery'?: SingleRewardOrder1RewardDelivery;
|
|
4726
5550
|
}
|
|
4727
5551
|
/**
|
|
4728
|
-
*
|
|
5552
|
+
*
|
|
4729
5553
|
* @export
|
|
4730
|
-
* @interface
|
|
5554
|
+
* @interface SingleRewardOrderWithoutLink
|
|
4731
5555
|
*/
|
|
4732
|
-
export interface
|
|
4733
|
-
/**
|
|
4734
|
-
* How to deliver the reward to the recipient. <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table>
|
|
4735
|
-
* @type {string}
|
|
4736
|
-
* @memberof RewardWithoutLinkDelivery
|
|
4737
|
-
*/
|
|
4738
|
-
'method': RewardWithoutLinkDeliveryMethodEnum;
|
|
5556
|
+
export interface SingleRewardOrderWithoutLink {
|
|
4739
5557
|
/**
|
|
4740
|
-
*
|
|
4741
|
-
* @type {
|
|
4742
|
-
* @memberof
|
|
5558
|
+
*
|
|
5559
|
+
* @type {SingleRewardOrderWithoutLinkOrder}
|
|
5560
|
+
* @memberof SingleRewardOrderWithoutLink
|
|
4743
5561
|
*/
|
|
4744
|
-
'
|
|
5562
|
+
'order': SingleRewardOrderWithoutLinkOrder;
|
|
4745
5563
|
}
|
|
4746
|
-
export declare const RewardWithoutLinkDeliveryMethodEnum: {
|
|
4747
|
-
readonly Email: "EMAIL";
|
|
4748
|
-
readonly Link: "LINK";
|
|
4749
|
-
readonly Phone: "PHONE";
|
|
4750
|
-
};
|
|
4751
|
-
export type RewardWithoutLinkDeliveryMethodEnum = typeof RewardWithoutLinkDeliveryMethodEnum[keyof typeof RewardWithoutLinkDeliveryMethodEnum];
|
|
4752
|
-
export declare const RewardWithoutLinkDeliveryStatusEnum: {
|
|
4753
|
-
readonly Scheduled: "SCHEDULED";
|
|
4754
|
-
readonly Failed: "FAILED";
|
|
4755
|
-
readonly Succeeded: "SUCCEEDED";
|
|
4756
|
-
readonly Pending: "PENDING";
|
|
4757
|
-
};
|
|
4758
|
-
export type RewardWithoutLinkDeliveryStatusEnum = typeof RewardWithoutLinkDeliveryStatusEnum[keyof typeof RewardWithoutLinkDeliveryStatusEnum];
|
|
4759
5564
|
/**
|
|
4760
|
-
*
|
|
5565
|
+
* An order wraps around the fulfilment of one or more rewards.
|
|
4761
5566
|
* @export
|
|
4762
|
-
* @interface
|
|
5567
|
+
* @interface SingleRewardOrderWithoutLinkOrder
|
|
4763
5568
|
*/
|
|
4764
|
-
export interface
|
|
5569
|
+
export interface SingleRewardOrderWithoutLinkOrder {
|
|
5570
|
+
/**
|
|
5571
|
+
* Tremendous ID of the order
|
|
5572
|
+
* @type {string}
|
|
5573
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
5574
|
+
*/
|
|
5575
|
+
'id': string;
|
|
5576
|
+
/**
|
|
5577
|
+
* Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only.
|
|
5578
|
+
* @type {string}
|
|
5579
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
5580
|
+
*/
|
|
5581
|
+
'external_id'?: string | null;
|
|
5582
|
+
/**
|
|
5583
|
+
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
5584
|
+
* @type {string}
|
|
5585
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
5586
|
+
*/
|
|
5587
|
+
'campaign_id'?: string | null;
|
|
5588
|
+
/**
|
|
5589
|
+
* Date the order has been created
|
|
5590
|
+
* @type {string}
|
|
5591
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
5592
|
+
*/
|
|
5593
|
+
'created_at': string;
|
|
4765
5594
|
/**
|
|
4766
|
-
*
|
|
5595
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> CART </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
4767
5596
|
* @type {string}
|
|
4768
|
-
* @memberof
|
|
5597
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
4769
5598
|
*/
|
|
4770
|
-
'
|
|
5599
|
+
'status': SingleRewardOrderWithoutLinkOrderStatusEnum;
|
|
4771
5600
|
/**
|
|
4772
|
-
*
|
|
5601
|
+
* Name of the channel in which the order was created
|
|
4773
5602
|
* @type {string}
|
|
4774
|
-
* @memberof
|
|
5603
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
4775
5604
|
*/
|
|
4776
|
-
'
|
|
5605
|
+
'channel'?: SingleRewardOrderWithoutLinkOrderChannelEnum;
|
|
4777
5606
|
/**
|
|
4778
5607
|
*
|
|
4779
|
-
* @type {
|
|
4780
|
-
* @memberof
|
|
5608
|
+
* @type {OrderBasePayment}
|
|
5609
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
4781
5610
|
*/
|
|
4782
|
-
'
|
|
4783
|
-
}
|
|
4784
|
-
/**
|
|
4785
|
-
*
|
|
4786
|
-
* @export
|
|
4787
|
-
* @interface SimulateWebhookRequest
|
|
4788
|
-
*/
|
|
4789
|
-
export interface SimulateWebhookRequest {
|
|
5611
|
+
'payment'?: OrderBasePayment;
|
|
4790
5612
|
/**
|
|
4791
|
-
* The
|
|
5613
|
+
* The ID for the invoice associated with this order
|
|
4792
5614
|
* @type {string}
|
|
4793
|
-
* @memberof
|
|
5615
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
4794
5616
|
*/
|
|
4795
|
-
'
|
|
5617
|
+
'invoice_id'?: string;
|
|
5618
|
+
/**
|
|
5619
|
+
*
|
|
5620
|
+
* @type {Array<OrderWithoutLinkRewardsInner>}
|
|
5621
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
5622
|
+
*/
|
|
5623
|
+
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
4796
5624
|
}
|
|
5625
|
+
export declare const SingleRewardOrderWithoutLinkOrderStatusEnum: {
|
|
5626
|
+
readonly Canceled: "CANCELED";
|
|
5627
|
+
readonly Cart: "CART";
|
|
5628
|
+
readonly Executed: "EXECUTED";
|
|
5629
|
+
readonly Failed: "FAILED";
|
|
5630
|
+
readonly PendingApproval: "PENDING APPROVAL";
|
|
5631
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
5632
|
+
};
|
|
5633
|
+
export type SingleRewardOrderWithoutLinkOrderStatusEnum = typeof SingleRewardOrderWithoutLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithoutLinkOrderStatusEnum];
|
|
5634
|
+
export declare const SingleRewardOrderWithoutLinkOrderChannelEnum: {
|
|
5635
|
+
readonly Ui: "UI";
|
|
5636
|
+
readonly Api: "API";
|
|
5637
|
+
readonly Embed: "EMBED";
|
|
5638
|
+
readonly Decipher: "DECIPHER";
|
|
5639
|
+
readonly Qualtrics: "QUALTRICS";
|
|
5640
|
+
readonly Typeform: "TYPEFORM";
|
|
5641
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
5642
|
+
};
|
|
5643
|
+
export type SingleRewardOrderWithoutLinkOrderChannelEnum = typeof SingleRewardOrderWithoutLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithoutLinkOrderChannelEnum];
|
|
4797
5644
|
/**
|
|
4798
5645
|
*
|
|
4799
5646
|
* @export
|
|
@@ -4900,6 +5747,74 @@ export interface UpdateCampaignRequest {
|
|
|
4900
5747
|
*/
|
|
4901
5748
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
4902
5749
|
}
|
|
5750
|
+
/**
|
|
5751
|
+
*
|
|
5752
|
+
* @export
|
|
5753
|
+
* @interface UpdateFraudRuleList200Response
|
|
5754
|
+
*/
|
|
5755
|
+
export interface UpdateFraudRuleList200Response {
|
|
5756
|
+
/**
|
|
5757
|
+
* A description of the result
|
|
5758
|
+
* @type {string}
|
|
5759
|
+
* @memberof UpdateFraudRuleList200Response
|
|
5760
|
+
*/
|
|
5761
|
+
'message': string;
|
|
5762
|
+
}
|
|
5763
|
+
/**
|
|
5764
|
+
*
|
|
5765
|
+
* @export
|
|
5766
|
+
* @interface UpdateFraudRuleListRequest
|
|
5767
|
+
*/
|
|
5768
|
+
export interface UpdateFraudRuleListRequest {
|
|
5769
|
+
/**
|
|
5770
|
+
* * `add` - append the list to the same key of the current configuration * `remove` - remove the entries in the list from the same key of the current configuration
|
|
5771
|
+
* @type {string}
|
|
5772
|
+
* @memberof UpdateFraudRuleListRequest
|
|
5773
|
+
*/
|
|
5774
|
+
'operation': UpdateFraudRuleListRequestOperationEnum;
|
|
5775
|
+
/**
|
|
5776
|
+
*
|
|
5777
|
+
* @type {UpdateFraudRuleListRequestConfig}
|
|
5778
|
+
* @memberof UpdateFraudRuleListRequest
|
|
5779
|
+
*/
|
|
5780
|
+
'config': UpdateFraudRuleListRequestConfig;
|
|
5781
|
+
}
|
|
5782
|
+
export declare const UpdateFraudRuleListRequestOperationEnum: {
|
|
5783
|
+
readonly Add: "add";
|
|
5784
|
+
readonly Remove: "remove";
|
|
5785
|
+
};
|
|
5786
|
+
export type UpdateFraudRuleListRequestOperationEnum = typeof UpdateFraudRuleListRequestOperationEnum[keyof typeof UpdateFraudRuleListRequestOperationEnum];
|
|
5787
|
+
/**
|
|
5788
|
+
* The configuration associated with the rule. The properties allowed depend on the type of rule.
|
|
5789
|
+
* @export
|
|
5790
|
+
* @interface UpdateFraudRuleListRequestConfig
|
|
5791
|
+
*/
|
|
5792
|
+
export interface UpdateFraudRuleListRequestConfig {
|
|
5793
|
+
/**
|
|
5794
|
+
* An array of country codes (ISO-3166 alpha-2 character code)
|
|
5795
|
+
* @type {Array<string>}
|
|
5796
|
+
* @memberof UpdateFraudRuleListRequestConfig
|
|
5797
|
+
*/
|
|
5798
|
+
'countries': Array<string>;
|
|
5799
|
+
/**
|
|
5800
|
+
* The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
|
|
5801
|
+
* @type {Array<string>}
|
|
5802
|
+
* @memberof UpdateFraudRuleListRequestConfig
|
|
5803
|
+
*/
|
|
5804
|
+
'ips': Array<string>;
|
|
5805
|
+
/**
|
|
5806
|
+
* The list of emails.
|
|
5807
|
+
* @type {Array<string>}
|
|
5808
|
+
* @memberof UpdateFraudRuleListRequestConfig
|
|
5809
|
+
*/
|
|
5810
|
+
'emails': Array<string>;
|
|
5811
|
+
/**
|
|
5812
|
+
* The list of domains. Any subdomains will also be matched against each entry in the list.
|
|
5813
|
+
* @type {Array<string>}
|
|
5814
|
+
* @memberof UpdateFraudRuleListRequestConfig
|
|
5815
|
+
*/
|
|
5816
|
+
'domains'?: Array<string>;
|
|
5817
|
+
}
|
|
4903
5818
|
/**
|
|
4904
5819
|
*
|
|
4905
5820
|
* @export
|
|
@@ -4987,7 +5902,7 @@ export declare const BalanceTransactionsApiFactory: (configuration?: Configurati
|
|
|
4987
5902
|
* @param {*} [options] Override http request option.
|
|
4988
5903
|
* @throws {RequiredError}
|
|
4989
5904
|
*/
|
|
4990
|
-
listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?:
|
|
5905
|
+
listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListBalanceTransactions200Response>;
|
|
4991
5906
|
};
|
|
4992
5907
|
/**
|
|
4993
5908
|
* BalanceTransactionsApi - object-oriented interface
|
|
@@ -5097,7 +6012,7 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
5097
6012
|
* @param {*} [options] Override http request option.
|
|
5098
6013
|
* @throws {RequiredError}
|
|
5099
6014
|
*/
|
|
5100
|
-
createCampaign(createCampaignRequest: CreateCampaignRequest, options?:
|
|
6015
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign201Response>;
|
|
5101
6016
|
/**
|
|
5102
6017
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
5103
6018
|
* @summary Retrieve campaign
|
|
@@ -5105,14 +6020,14 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
5105
6020
|
* @param {*} [options] Override http request option.
|
|
5106
6021
|
* @throws {RequiredError}
|
|
5107
6022
|
*/
|
|
5108
|
-
getCampaign(id: string, options?:
|
|
6023
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign201Response>;
|
|
5109
6024
|
/**
|
|
5110
6025
|
* Retrieve a list of all campaigns created in your account
|
|
5111
6026
|
* @summary List campaigns
|
|
5112
6027
|
* @param {*} [options] Override http request option.
|
|
5113
6028
|
* @throws {RequiredError}
|
|
5114
6029
|
*/
|
|
5115
|
-
listCampaigns(options?:
|
|
6030
|
+
listCampaigns(options?: RawAxiosRequestConfig): AxiosPromise<ListCampaigns200Response>;
|
|
5116
6031
|
/**
|
|
5117
6032
|
*
|
|
5118
6033
|
* @summary Update campaign
|
|
@@ -5121,7 +6036,7 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
5121
6036
|
* @param {*} [options] Override http request option.
|
|
5122
6037
|
* @throws {RequiredError}
|
|
5123
6038
|
*/
|
|
5124
|
-
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?:
|
|
6039
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign201Response>;
|
|
5125
6040
|
};
|
|
5126
6041
|
/**
|
|
5127
6042
|
* CampaignsApi - object-oriented interface
|
|
@@ -5204,7 +6119,7 @@ export declare const FieldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
5204
6119
|
* @param {*} [options] Override http request option.
|
|
5205
6120
|
* @throws {RequiredError}
|
|
5206
6121
|
*/
|
|
5207
|
-
listFields(options?:
|
|
6122
|
+
listFields(options?: RawAxiosRequestConfig): AxiosPromise<ListFields200Response>;
|
|
5208
6123
|
};
|
|
5209
6124
|
/**
|
|
5210
6125
|
* FieldsApi - object-oriented interface
|
|
@@ -5262,7 +6177,7 @@ export declare const ForexApiFactory: (configuration?: Configuration, basePath?:
|
|
|
5262
6177
|
* @param {*} [options] Override http request option.
|
|
5263
6178
|
* @throws {RequiredError}
|
|
5264
6179
|
*/
|
|
5265
|
-
listForex(base?: string, options?:
|
|
6180
|
+
listForex(base?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListForexResponse>;
|
|
5266
6181
|
};
|
|
5267
6182
|
/**
|
|
5268
6183
|
* ForexApi - object-oriented interface
|
|
@@ -5281,6 +6196,404 @@ export declare class ForexApi extends BaseAPI {
|
|
|
5281
6196
|
*/
|
|
5282
6197
|
listForex(base?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListForexResponse, any>>;
|
|
5283
6198
|
}
|
|
6199
|
+
/**
|
|
6200
|
+
* FraudReviewsApi - axios parameter creator
|
|
6201
|
+
* @export
|
|
6202
|
+
*/
|
|
6203
|
+
export declare const FraudReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6204
|
+
/**
|
|
6205
|
+
* Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
|
|
6206
|
+
* @summary Block fraud review
|
|
6207
|
+
* @param {string} id The ID of the reward that should be blocked.
|
|
6208
|
+
* @param {*} [options] Override http request option.
|
|
6209
|
+
* @throws {RequiredError}
|
|
6210
|
+
*/
|
|
6211
|
+
blockFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6212
|
+
/**
|
|
6213
|
+
* Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc.
|
|
6214
|
+
* @summary Retrieve single fraud review
|
|
6215
|
+
* @param {string} id The ID of the reward that should be retrieved.
|
|
6216
|
+
* @param {*} [options] Override http request option.
|
|
6217
|
+
* @throws {RequiredError}
|
|
6218
|
+
*/
|
|
6219
|
+
getFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6220
|
+
/**
|
|
6221
|
+
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
6222
|
+
* @summary List fraud reviews
|
|
6223
|
+
* @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC).
|
|
6224
|
+
* @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
|
|
6225
|
+
* @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`.
|
|
6226
|
+
* @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime.
|
|
6227
|
+
* @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime.
|
|
6228
|
+
* @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime.
|
|
6229
|
+
* @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime.
|
|
6230
|
+
* @param {*} [options] Override http request option.
|
|
6231
|
+
* @throws {RequiredError}
|
|
6232
|
+
*/
|
|
6233
|
+
listFraudReviews: (offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6234
|
+
/**
|
|
6235
|
+
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
6236
|
+
* @summary Release fraud review
|
|
6237
|
+
* @param {string} id The ID of the reward that should be released.
|
|
6238
|
+
* @param {*} [options] Override http request option.
|
|
6239
|
+
* @throws {RequiredError}
|
|
6240
|
+
*/
|
|
6241
|
+
releaseFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6242
|
+
};
|
|
6243
|
+
/**
|
|
6244
|
+
* FraudReviewsApi - functional programming interface
|
|
6245
|
+
* @export
|
|
6246
|
+
*/
|
|
6247
|
+
export declare const FraudReviewsApiFp: (configuration?: Configuration) => {
|
|
6248
|
+
/**
|
|
6249
|
+
* Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
|
|
6250
|
+
* @summary Block fraud review
|
|
6251
|
+
* @param {string} id The ID of the reward that should be blocked.
|
|
6252
|
+
* @param {*} [options] Override http request option.
|
|
6253
|
+
* @throws {RequiredError}
|
|
6254
|
+
*/
|
|
6255
|
+
blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFraudReview200Response>>;
|
|
6256
|
+
/**
|
|
6257
|
+
* Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc.
|
|
6258
|
+
* @summary Retrieve single fraud review
|
|
6259
|
+
* @param {string} id The ID of the reward that should be retrieved.
|
|
6260
|
+
* @param {*} [options] Override http request option.
|
|
6261
|
+
* @throws {RequiredError}
|
|
6262
|
+
*/
|
|
6263
|
+
getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFraudReview200Response>>;
|
|
6264
|
+
/**
|
|
6265
|
+
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
6266
|
+
* @summary List fraud reviews
|
|
6267
|
+
* @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC).
|
|
6268
|
+
* @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
|
|
6269
|
+
* @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`.
|
|
6270
|
+
* @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime.
|
|
6271
|
+
* @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime.
|
|
6272
|
+
* @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime.
|
|
6273
|
+
* @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime.
|
|
6274
|
+
* @param {*} [options] Override http request option.
|
|
6275
|
+
* @throws {RequiredError}
|
|
6276
|
+
*/
|
|
6277
|
+
listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFraudReviews200Response>>;
|
|
6278
|
+
/**
|
|
6279
|
+
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
6280
|
+
* @summary Release fraud review
|
|
6281
|
+
* @param {string} id The ID of the reward that should be released.
|
|
6282
|
+
* @param {*} [options] Override http request option.
|
|
6283
|
+
* @throws {RequiredError}
|
|
6284
|
+
*/
|
|
6285
|
+
releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFraudReview200Response>>;
|
|
6286
|
+
};
|
|
6287
|
+
/**
|
|
6288
|
+
* FraudReviewsApi - factory interface
|
|
6289
|
+
* @export
|
|
6290
|
+
*/
|
|
6291
|
+
export declare const FraudReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6292
|
+
/**
|
|
6293
|
+
* Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
|
|
6294
|
+
* @summary Block fraud review
|
|
6295
|
+
* @param {string} id The ID of the reward that should be blocked.
|
|
6296
|
+
* @param {*} [options] Override http request option.
|
|
6297
|
+
* @throws {RequiredError}
|
|
6298
|
+
*/
|
|
6299
|
+
blockFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFraudReview200Response>;
|
|
6300
|
+
/**
|
|
6301
|
+
* Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc.
|
|
6302
|
+
* @summary Retrieve single fraud review
|
|
6303
|
+
* @param {string} id The ID of the reward that should be retrieved.
|
|
6304
|
+
* @param {*} [options] Override http request option.
|
|
6305
|
+
* @throws {RequiredError}
|
|
6306
|
+
*/
|
|
6307
|
+
getFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFraudReview200Response>;
|
|
6308
|
+
/**
|
|
6309
|
+
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
6310
|
+
* @summary List fraud reviews
|
|
6311
|
+
* @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC).
|
|
6312
|
+
* @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
|
|
6313
|
+
* @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`.
|
|
6314
|
+
* @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime.
|
|
6315
|
+
* @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime.
|
|
6316
|
+
* @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime.
|
|
6317
|
+
* @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime.
|
|
6318
|
+
* @param {*} [options] Override http request option.
|
|
6319
|
+
* @throws {RequiredError}
|
|
6320
|
+
*/
|
|
6321
|
+
listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListFraudReviews200Response>;
|
|
6322
|
+
/**
|
|
6323
|
+
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
6324
|
+
* @summary Release fraud review
|
|
6325
|
+
* @param {string} id The ID of the reward that should be released.
|
|
6326
|
+
* @param {*} [options] Override http request option.
|
|
6327
|
+
* @throws {RequiredError}
|
|
6328
|
+
*/
|
|
6329
|
+
releaseFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFraudReview200Response>;
|
|
6330
|
+
};
|
|
6331
|
+
/**
|
|
6332
|
+
* FraudReviewsApi - object-oriented interface
|
|
6333
|
+
* @export
|
|
6334
|
+
* @class FraudReviewsApi
|
|
6335
|
+
* @extends {BaseAPI}
|
|
6336
|
+
*/
|
|
6337
|
+
export declare class FraudReviewsApi extends BaseAPI {
|
|
6338
|
+
/**
|
|
6339
|
+
* Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
|
|
6340
|
+
* @summary Block fraud review
|
|
6341
|
+
* @param {string} id The ID of the reward that should be blocked.
|
|
6342
|
+
* @param {*} [options] Override http request option.
|
|
6343
|
+
* @throws {RequiredError}
|
|
6344
|
+
* @memberof FraudReviewsApi
|
|
6345
|
+
*/
|
|
6346
|
+
blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFraudReview200Response, any>>;
|
|
6347
|
+
/**
|
|
6348
|
+
* Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc.
|
|
6349
|
+
* @summary Retrieve single fraud review
|
|
6350
|
+
* @param {string} id The ID of the reward that should be retrieved.
|
|
6351
|
+
* @param {*} [options] Override http request option.
|
|
6352
|
+
* @throws {RequiredError}
|
|
6353
|
+
* @memberof FraudReviewsApi
|
|
6354
|
+
*/
|
|
6355
|
+
getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFraudReview200Response, any>>;
|
|
6356
|
+
/**
|
|
6357
|
+
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
6358
|
+
* @summary List fraud reviews
|
|
6359
|
+
* @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC).
|
|
6360
|
+
* @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
|
|
6361
|
+
* @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`.
|
|
6362
|
+
* @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime.
|
|
6363
|
+
* @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime.
|
|
6364
|
+
* @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime.
|
|
6365
|
+
* @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime.
|
|
6366
|
+
* @param {*} [options] Override http request option.
|
|
6367
|
+
* @throws {RequiredError}
|
|
6368
|
+
* @memberof FraudReviewsApi
|
|
6369
|
+
*/
|
|
6370
|
+
listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFraudReviews200Response, any>>;
|
|
6371
|
+
/**
|
|
6372
|
+
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
6373
|
+
* @summary Release fraud review
|
|
6374
|
+
* @param {string} id The ID of the reward that should be released.
|
|
6375
|
+
* @param {*} [options] Override http request option.
|
|
6376
|
+
* @throws {RequiredError}
|
|
6377
|
+
* @memberof FraudReviewsApi
|
|
6378
|
+
*/
|
|
6379
|
+
releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFraudReview200Response, any>>;
|
|
6380
|
+
}
|
|
6381
|
+
/**
|
|
6382
|
+
* @export
|
|
6383
|
+
*/
|
|
6384
|
+
export declare const ListFraudReviewsStatusEnum: {
|
|
6385
|
+
readonly Flagged: "flagged";
|
|
6386
|
+
readonly Blocked: "blocked";
|
|
6387
|
+
readonly Released: "released";
|
|
6388
|
+
};
|
|
6389
|
+
export type ListFraudReviewsStatusEnum = typeof ListFraudReviewsStatusEnum[keyof typeof ListFraudReviewsStatusEnum];
|
|
6390
|
+
/**
|
|
6391
|
+
* FraudRulesApi - axios parameter creator
|
|
6392
|
+
* @export
|
|
6393
|
+
*/
|
|
6394
|
+
export declare const FraudRulesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6395
|
+
/**
|
|
6396
|
+
* Deletes the rule of the type passed in the URL.
|
|
6397
|
+
* @summary Delete fraud rule
|
|
6398
|
+
* @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
6399
|
+
* @param {*} [options] Override http request option.
|
|
6400
|
+
* @throws {RequiredError}
|
|
6401
|
+
*/
|
|
6402
|
+
deleteFraudRule: (ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6403
|
+
/**
|
|
6404
|
+
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
6405
|
+
* @summary Configure fraud rule
|
|
6406
|
+
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
6407
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
|
|
6408
|
+
* @param {*} [options] Override http request option.
|
|
6409
|
+
* @throws {RequiredError}
|
|
6410
|
+
*/
|
|
6411
|
+
fraudRule: (ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6412
|
+
/**
|
|
6413
|
+
* List active fraud rules associated with the organization tied to your API key.
|
|
6414
|
+
* @summary List fraud rules
|
|
6415
|
+
* @param {*} [options] Override http request option.
|
|
6416
|
+
* @throws {RequiredError}
|
|
6417
|
+
*/
|
|
6418
|
+
listFraudRules: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6419
|
+
/**
|
|
6420
|
+
* Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ```
|
|
6421
|
+
* @summary Update fraud rule list
|
|
6422
|
+
* @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
|
|
6423
|
+
* @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
|
|
6424
|
+
* @param {*} [options] Override http request option.
|
|
6425
|
+
* @throws {RequiredError}
|
|
6426
|
+
*/
|
|
6427
|
+
updateFraudRuleList: (ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6428
|
+
};
|
|
6429
|
+
/**
|
|
6430
|
+
* FraudRulesApi - functional programming interface
|
|
6431
|
+
* @export
|
|
6432
|
+
*/
|
|
6433
|
+
export declare const FraudRulesApiFp: (configuration?: Configuration) => {
|
|
6434
|
+
/**
|
|
6435
|
+
* Deletes the rule of the type passed in the URL.
|
|
6436
|
+
* @summary Delete fraud rule
|
|
6437
|
+
* @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
6438
|
+
* @param {*} [options] Override http request option.
|
|
6439
|
+
* @throws {RequiredError}
|
|
6440
|
+
*/
|
|
6441
|
+
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFraudRule200Response>>;
|
|
6442
|
+
/**
|
|
6443
|
+
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
6444
|
+
* @summary Configure fraud rule
|
|
6445
|
+
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
6446
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
|
|
6447
|
+
* @param {*} [options] Override http request option.
|
|
6448
|
+
* @throws {RequiredError}
|
|
6449
|
+
*/
|
|
6450
|
+
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FraudRule200Response>>;
|
|
6451
|
+
/**
|
|
6452
|
+
* List active fraud rules associated with the organization tied to your API key.
|
|
6453
|
+
* @summary List fraud rules
|
|
6454
|
+
* @param {*} [options] Override http request option.
|
|
6455
|
+
* @throws {RequiredError}
|
|
6456
|
+
*/
|
|
6457
|
+
listFraudRules(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFraudRules200Response>>;
|
|
6458
|
+
/**
|
|
6459
|
+
* Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ```
|
|
6460
|
+
* @summary Update fraud rule list
|
|
6461
|
+
* @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
|
|
6462
|
+
* @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
|
|
6463
|
+
* @param {*} [options] Override http request option.
|
|
6464
|
+
* @throws {RequiredError}
|
|
6465
|
+
*/
|
|
6466
|
+
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFraudRuleList200Response>>;
|
|
6467
|
+
};
|
|
6468
|
+
/**
|
|
6469
|
+
* FraudRulesApi - factory interface
|
|
6470
|
+
* @export
|
|
6471
|
+
*/
|
|
6472
|
+
export declare const FraudRulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6473
|
+
/**
|
|
6474
|
+
* Deletes the rule of the type passed in the URL.
|
|
6475
|
+
* @summary Delete fraud rule
|
|
6476
|
+
* @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
6477
|
+
* @param {*} [options] Override http request option.
|
|
6478
|
+
* @throws {RequiredError}
|
|
6479
|
+
*/
|
|
6480
|
+
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<DeleteFraudRule200Response>;
|
|
6481
|
+
/**
|
|
6482
|
+
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
6483
|
+
* @summary Configure fraud rule
|
|
6484
|
+
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
6485
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
|
|
6486
|
+
* @param {*} [options] Override http request option.
|
|
6487
|
+
* @throws {RequiredError}
|
|
6488
|
+
*/
|
|
6489
|
+
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<FraudRule200Response>;
|
|
6490
|
+
/**
|
|
6491
|
+
* List active fraud rules associated with the organization tied to your API key.
|
|
6492
|
+
* @summary List fraud rules
|
|
6493
|
+
* @param {*} [options] Override http request option.
|
|
6494
|
+
* @throws {RequiredError}
|
|
6495
|
+
*/
|
|
6496
|
+
listFraudRules(options?: RawAxiosRequestConfig): AxiosPromise<ListFraudRules200Response>;
|
|
6497
|
+
/**
|
|
6498
|
+
* Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ```
|
|
6499
|
+
* @summary Update fraud rule list
|
|
6500
|
+
* @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
|
|
6501
|
+
* @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
|
|
6502
|
+
* @param {*} [options] Override http request option.
|
|
6503
|
+
* @throws {RequiredError}
|
|
6504
|
+
*/
|
|
6505
|
+
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateFraudRuleList200Response>;
|
|
6506
|
+
};
|
|
6507
|
+
/**
|
|
6508
|
+
* FraudRulesApi - object-oriented interface
|
|
6509
|
+
* @export
|
|
6510
|
+
* @class FraudRulesApi
|
|
6511
|
+
* @extends {BaseAPI}
|
|
6512
|
+
*/
|
|
6513
|
+
export declare class FraudRulesApi extends BaseAPI {
|
|
6514
|
+
/**
|
|
6515
|
+
* Deletes the rule of the type passed in the URL.
|
|
6516
|
+
* @summary Delete fraud rule
|
|
6517
|
+
* @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
6518
|
+
* @param {*} [options] Override http request option.
|
|
6519
|
+
* @throws {RequiredError}
|
|
6520
|
+
* @memberof FraudRulesApi
|
|
6521
|
+
*/
|
|
6522
|
+
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteFraudRule200Response, any>>;
|
|
6523
|
+
/**
|
|
6524
|
+
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
6525
|
+
* @summary Configure fraud rule
|
|
6526
|
+
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
6527
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
|
|
6528
|
+
* @param {*} [options] Override http request option.
|
|
6529
|
+
* @throws {RequiredError}
|
|
6530
|
+
* @memberof FraudRulesApi
|
|
6531
|
+
*/
|
|
6532
|
+
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FraudRule200Response, any>>;
|
|
6533
|
+
/**
|
|
6534
|
+
* List active fraud rules associated with the organization tied to your API key.
|
|
6535
|
+
* @summary List fraud rules
|
|
6536
|
+
* @param {*} [options] Override http request option.
|
|
6537
|
+
* @throws {RequiredError}
|
|
6538
|
+
* @memberof FraudRulesApi
|
|
6539
|
+
*/
|
|
6540
|
+
listFraudRules(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFraudRules200Response, any>>;
|
|
6541
|
+
/**
|
|
6542
|
+
* Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ```
|
|
6543
|
+
* @summary Update fraud rule list
|
|
6544
|
+
* @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
|
|
6545
|
+
* @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
|
|
6546
|
+
* @param {*} [options] Override http request option.
|
|
6547
|
+
* @throws {RequiredError}
|
|
6548
|
+
* @memberof FraudRulesApi
|
|
6549
|
+
*/
|
|
6550
|
+
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFraudRuleList200Response, any>>;
|
|
6551
|
+
}
|
|
6552
|
+
/**
|
|
6553
|
+
* @export
|
|
6554
|
+
*/
|
|
6555
|
+
export declare const DeleteFraudRuleRuleTypeEnum: {
|
|
6556
|
+
readonly ReviewCountry: "review_country";
|
|
6557
|
+
readonly ReviewIp: "review_ip";
|
|
6558
|
+
readonly ReviewEmail: "review_email";
|
|
6559
|
+
readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
|
|
6560
|
+
readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
|
|
6561
|
+
readonly ReviewMultipleEmails: "review_multiple_emails";
|
|
6562
|
+
readonly ReviewVpn: "review_vpn";
|
|
6563
|
+
readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
|
|
6564
|
+
readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
|
|
6565
|
+
readonly AllowIp: "allow_ip";
|
|
6566
|
+
readonly AllowEmail: "allow_email";
|
|
6567
|
+
};
|
|
6568
|
+
export type DeleteFraudRuleRuleTypeEnum = typeof DeleteFraudRuleRuleTypeEnum[keyof typeof DeleteFraudRuleRuleTypeEnum];
|
|
6569
|
+
/**
|
|
6570
|
+
* @export
|
|
6571
|
+
*/
|
|
6572
|
+
export declare const FraudRuleRuleTypeEnum: {
|
|
6573
|
+
readonly ReviewCountry: "review_country";
|
|
6574
|
+
readonly ReviewIp: "review_ip";
|
|
6575
|
+
readonly ReviewEmail: "review_email";
|
|
6576
|
+
readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
|
|
6577
|
+
readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
|
|
6578
|
+
readonly ReviewMultipleEmails: "review_multiple_emails";
|
|
6579
|
+
readonly ReviewVpn: "review_vpn";
|
|
6580
|
+
readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
|
|
6581
|
+
readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
|
|
6582
|
+
readonly AllowIp: "allow_ip";
|
|
6583
|
+
readonly AllowEmail: "allow_email";
|
|
6584
|
+
};
|
|
6585
|
+
export type FraudRuleRuleTypeEnum = typeof FraudRuleRuleTypeEnum[keyof typeof FraudRuleRuleTypeEnum];
|
|
6586
|
+
/**
|
|
6587
|
+
* @export
|
|
6588
|
+
*/
|
|
6589
|
+
export declare const UpdateFraudRuleListRuleTypeEnum: {
|
|
6590
|
+
readonly ReviewCountry: "review_country";
|
|
6591
|
+
readonly ReviewIp: "review_ip";
|
|
6592
|
+
readonly ReviewEmail: "review_email";
|
|
6593
|
+
readonly AllowIp: "allow_ip";
|
|
6594
|
+
readonly AllowEmail: "allow_email";
|
|
6595
|
+
};
|
|
6596
|
+
export type UpdateFraudRuleListRuleTypeEnum = typeof UpdateFraudRuleListRuleTypeEnum[keyof typeof UpdateFraudRuleListRuleTypeEnum];
|
|
5284
6597
|
/**
|
|
5285
6598
|
* FundingSourcesApi - axios parameter creator
|
|
5286
6599
|
* @export
|
|
@@ -5335,14 +6648,14 @@ export declare const FundingSourcesApiFactory: (configuration?: Configuration, b
|
|
|
5335
6648
|
* @param {*} [options] Override http request option.
|
|
5336
6649
|
* @throws {RequiredError}
|
|
5337
6650
|
*/
|
|
5338
|
-
getFundingSource(id: string, options?:
|
|
6651
|
+
getFundingSource(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFundingSource200Response>;
|
|
5339
6652
|
/**
|
|
5340
6653
|
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
5341
6654
|
* @summary List funding sources
|
|
5342
6655
|
* @param {*} [options] Override http request option.
|
|
5343
6656
|
* @throws {RequiredError}
|
|
5344
6657
|
*/
|
|
5345
|
-
listFundingSources(options?:
|
|
6658
|
+
listFundingSources(options?: RawAxiosRequestConfig): AxiosPromise<ListFundingSources200Response>;
|
|
5346
6659
|
};
|
|
5347
6660
|
/**
|
|
5348
6661
|
* FundingSourcesApi - object-oriented interface
|
|
@@ -5491,7 +6804,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
5491
6804
|
* @param {*} [options] Override http request option.
|
|
5492
6805
|
* @throws {RequiredError}
|
|
5493
6806
|
*/
|
|
5494
|
-
createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?:
|
|
6807
|
+
createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateInvoice200Response>;
|
|
5495
6808
|
/**
|
|
5496
6809
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
5497
6810
|
* @summary Delete invoice
|
|
@@ -5499,7 +6812,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
5499
6812
|
* @param {*} [options] Override http request option.
|
|
5500
6813
|
* @throws {RequiredError}
|
|
5501
6814
|
*/
|
|
5502
|
-
deleteInvoices(id: string, options?:
|
|
6815
|
+
deleteInvoices(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateInvoice200Response>;
|
|
5503
6816
|
/**
|
|
5504
6817
|
* Generates a CSV version for an invoice listing the associated rewards and orders
|
|
5505
6818
|
* @summary Retrieve invoice as CSV
|
|
@@ -5507,7 +6820,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
5507
6820
|
* @param {*} [options] Override http request option.
|
|
5508
6821
|
* @throws {RequiredError}
|
|
5509
6822
|
*/
|
|
5510
|
-
downloadInvoiceCsv(id: string, options?:
|
|
6823
|
+
downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
5511
6824
|
/**
|
|
5512
6825
|
* Generates a PDF version for an invoice
|
|
5513
6826
|
* @summary Retrieve invoice as PDF
|
|
@@ -5515,7 +6828,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
5515
6828
|
* @param {*} [options] Override http request option.
|
|
5516
6829
|
* @throws {RequiredError}
|
|
5517
6830
|
*/
|
|
5518
|
-
downloadInvoicePdf(id: string, options?:
|
|
6831
|
+
downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
5519
6832
|
/**
|
|
5520
6833
|
* Retrieve an invoice, identified by the given `id` in the URL > 📘 Deleted Invoices > > This endpoint can be used to retrieve details on deleted invoices > that the list of invoices omits.
|
|
5521
6834
|
* @summary Retrieve invoice
|
|
@@ -5523,7 +6836,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
5523
6836
|
* @param {*} [options] Override http request option.
|
|
5524
6837
|
* @throws {RequiredError}
|
|
5525
6838
|
*/
|
|
5526
|
-
getInvoice(id: string, options?:
|
|
6839
|
+
getInvoice(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateInvoice200Response>;
|
|
5527
6840
|
/**
|
|
5528
6841
|
* Fetch a list of all invoices on your account. > 🚧 Deleted invoices are omitted > > The response does not include any previously deleted invoices.
|
|
5529
6842
|
* @summary List invoices
|
|
@@ -5532,7 +6845,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
5532
6845
|
* @param {*} [options] Override http request option.
|
|
5533
6846
|
* @throws {RequiredError}
|
|
5534
6847
|
*/
|
|
5535
|
-
listInvoices(offset?: number, limit?: number, options?:
|
|
6848
|
+
listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListInvoices200Response>;
|
|
5536
6849
|
};
|
|
5537
6850
|
/**
|
|
5538
6851
|
* InvoicesApi - object-oriented interface
|
|
@@ -5667,7 +6980,7 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
|
|
|
5667
6980
|
* @param {*} [options] Override http request option.
|
|
5668
6981
|
* @throws {RequiredError}
|
|
5669
6982
|
*/
|
|
5670
|
-
createMember(createMemberRequest: CreateMemberRequest, options?:
|
|
6983
|
+
createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateMember200Response>;
|
|
5671
6984
|
/**
|
|
5672
6985
|
*
|
|
5673
6986
|
* @summary Retrieve member
|
|
@@ -5675,14 +6988,14 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
|
|
|
5675
6988
|
* @param {*} [options] Override http request option.
|
|
5676
6989
|
* @throws {RequiredError}
|
|
5677
6990
|
*/
|
|
5678
|
-
getMember(id: string, options?:
|
|
6991
|
+
getMember(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMember200Response>;
|
|
5679
6992
|
/**
|
|
5680
6993
|
* To list members of a sub-organization [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the list members request.
|
|
5681
6994
|
* @summary List members
|
|
5682
6995
|
* @param {*} [options] Override http request option.
|
|
5683
6996
|
* @throws {RequiredError}
|
|
5684
6997
|
*/
|
|
5685
|
-
listMembers(options?:
|
|
6998
|
+
listMembers(options?: RawAxiosRequestConfig): AxiosPromise<ListMembers200Response>;
|
|
5686
6999
|
};
|
|
5687
7000
|
/**
|
|
5688
7001
|
* MembersApi - object-oriented interface
|
|
@@ -5781,7 +7094,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
5781
7094
|
* @param {*} [options] Override http request option.
|
|
5782
7095
|
* @throws {RequiredError}
|
|
5783
7096
|
*/
|
|
5784
|
-
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
7097
|
+
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder200Response>>;
|
|
5785
7098
|
/**
|
|
5786
7099
|
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://tremendous.readme.io/reference/core-funding-source-index). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://tremendous.readme.io/reference/sandbox). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same external_id are idempotent. Submitting an order with an already existing `external_id`, will result in a `201` response code. In this case the response will return a representation of the already existing order in the response body.
|
|
5787
7100
|
* @summary Create order
|
|
@@ -5797,7 +7110,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
5797
7110
|
* @param {*} [options] Override http request option.
|
|
5798
7111
|
* @throws {RequiredError}
|
|
5799
7112
|
*/
|
|
5800
|
-
getOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
7113
|
+
getOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder200Response>>;
|
|
5801
7114
|
/**
|
|
5802
7115
|
* Retrieve a list of orders
|
|
5803
7116
|
* @summary List orders
|
|
@@ -5818,7 +7131,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
5818
7131
|
* @param {*} [options] Override http request option.
|
|
5819
7132
|
* @throws {RequiredError}
|
|
5820
7133
|
*/
|
|
5821
|
-
rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
7134
|
+
rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder200Response>>;
|
|
5822
7135
|
};
|
|
5823
7136
|
/**
|
|
5824
7137
|
* OrdersApi - factory interface
|
|
@@ -5832,7 +7145,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
5832
7145
|
* @param {*} [options] Override http request option.
|
|
5833
7146
|
* @throws {RequiredError}
|
|
5834
7147
|
*/
|
|
5835
|
-
approveOrder(id: string, options?:
|
|
7148
|
+
approveOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrder200Response>;
|
|
5836
7149
|
/**
|
|
5837
7150
|
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://tremendous.readme.io/reference/core-funding-source-index). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://tremendous.readme.io/reference/sandbox). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same external_id are idempotent. Submitting an order with an already existing `external_id`, will result in a `201` response code. In this case the response will return a representation of the already existing order in the response body.
|
|
5838
7151
|
* @summary Create order
|
|
@@ -5840,7 +7153,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
5840
7153
|
* @param {*} [options] Override http request option.
|
|
5841
7154
|
* @throws {RequiredError}
|
|
5842
7155
|
*/
|
|
5843
|
-
createOrder(createOrderRequest: CreateOrderRequest, options?:
|
|
7156
|
+
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrder200Response>;
|
|
5844
7157
|
/**
|
|
5845
7158
|
* Retrieve the order, identified by the given `id` in the URL
|
|
5846
7159
|
* @summary Retrieve order
|
|
@@ -5848,7 +7161,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
5848
7161
|
* @param {*} [options] Override http request option.
|
|
5849
7162
|
* @throws {RequiredError}
|
|
5850
7163
|
*/
|
|
5851
|
-
getOrder(id: string, options?:
|
|
7164
|
+
getOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrder200Response>;
|
|
5852
7165
|
/**
|
|
5853
7166
|
* Retrieve a list of orders
|
|
5854
7167
|
* @summary List orders
|
|
@@ -5861,7 +7174,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
5861
7174
|
* @param {*} [options] Override http request option.
|
|
5862
7175
|
* @throws {RequiredError}
|
|
5863
7176
|
*/
|
|
5864
|
-
listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?:
|
|
7177
|
+
listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListOrders200Response>;
|
|
5865
7178
|
/**
|
|
5866
7179
|
* Rejects an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard.
|
|
5867
7180
|
* @summary Reject order
|
|
@@ -5869,7 +7182,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
5869
7182
|
* @param {*} [options] Override http request option.
|
|
5870
7183
|
* @throws {RequiredError}
|
|
5871
7184
|
*/
|
|
5872
|
-
rejectOrder(id: string, options?:
|
|
7185
|
+
rejectOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrder200Response>;
|
|
5873
7186
|
};
|
|
5874
7187
|
/**
|
|
5875
7188
|
* OrdersApi - object-oriented interface
|
|
@@ -5886,7 +7199,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
5886
7199
|
* @throws {RequiredError}
|
|
5887
7200
|
* @memberof OrdersApi
|
|
5888
7201
|
*/
|
|
5889
|
-
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7202
|
+
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder200Response, any>>;
|
|
5890
7203
|
/**
|
|
5891
7204
|
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://tremendous.readme.io/reference/core-funding-source-index). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://tremendous.readme.io/reference/sandbox). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same external_id are idempotent. Submitting an order with an already existing `external_id`, will result in a `201` response code. In this case the response will return a representation of the already existing order in the response body.
|
|
5892
7205
|
* @summary Create order
|
|
@@ -5904,7 +7217,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
5904
7217
|
* @throws {RequiredError}
|
|
5905
7218
|
* @memberof OrdersApi
|
|
5906
7219
|
*/
|
|
5907
|
-
getOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7220
|
+
getOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder200Response, any>>;
|
|
5908
7221
|
/**
|
|
5909
7222
|
* Retrieve a list of orders
|
|
5910
7223
|
* @summary List orders
|
|
@@ -5927,7 +7240,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
5927
7240
|
* @throws {RequiredError}
|
|
5928
7241
|
* @memberof OrdersApi
|
|
5929
7242
|
*/
|
|
5930
|
-
rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7243
|
+
rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder200Response, any>>;
|
|
5931
7244
|
}
|
|
5932
7245
|
/**
|
|
5933
7246
|
* OrganizationsApi - axios parameter creator
|
|
@@ -6012,7 +7325,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
6012
7325
|
* @param {*} [options] Override http request option.
|
|
6013
7326
|
* @throws {RequiredError}
|
|
6014
7327
|
*/
|
|
6015
|
-
createApiKey(options?:
|
|
7328
|
+
createApiKey(options?: RawAxiosRequestConfig): AxiosPromise<CreateApiKey200Response>;
|
|
6016
7329
|
/**
|
|
6017
7330
|
* Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard.
|
|
6018
7331
|
* @summary Create organization
|
|
@@ -6020,7 +7333,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
6020
7333
|
* @param {*} [options] Override http request option.
|
|
6021
7334
|
* @throws {RequiredError}
|
|
6022
7335
|
*/
|
|
6023
|
-
createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?:
|
|
7336
|
+
createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrganization200Response>;
|
|
6024
7337
|
/**
|
|
6025
7338
|
*
|
|
6026
7339
|
* @summary Retrieve organization
|
|
@@ -6028,14 +7341,14 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
6028
7341
|
* @param {*} [options] Override http request option.
|
|
6029
7342
|
* @throws {RequiredError}
|
|
6030
7343
|
*/
|
|
6031
|
-
getOrganization(id: string, options?:
|
|
7344
|
+
getOrganization(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganization200Response>;
|
|
6032
7345
|
/**
|
|
6033
7346
|
* The returned list only includes the organization to which the API key belongs to, that is used for the request.
|
|
6034
7347
|
* @summary List organizations
|
|
6035
7348
|
* @param {*} [options] Override http request option.
|
|
6036
7349
|
* @throws {RequiredError}
|
|
6037
7350
|
*/
|
|
6038
|
-
listOrganizations(options?:
|
|
7351
|
+
listOrganizations(options?: RawAxiosRequestConfig): AxiosPromise<ListOrganizations200Response>;
|
|
6039
7352
|
};
|
|
6040
7353
|
/**
|
|
6041
7354
|
* OrganizationsApi - object-oriented interface
|
|
@@ -6137,7 +7450,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
6137
7450
|
* @param {*} [options] Override http request option.
|
|
6138
7451
|
* @throws {RequiredError}
|
|
6139
7452
|
*/
|
|
6140
|
-
getProduct(id: string, options?:
|
|
7453
|
+
getProduct(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetProductResponse>;
|
|
6141
7454
|
/**
|
|
6142
7455
|
* Retrieve a list of available products
|
|
6143
7456
|
* @summary List products
|
|
@@ -6146,7 +7459,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
6146
7459
|
* @param {*} [options] Override http request option.
|
|
6147
7460
|
* @throws {RequiredError}
|
|
6148
7461
|
*/
|
|
6149
|
-
listProducts(country?: string, currency?: string, options?:
|
|
7462
|
+
listProducts(country?: string, currency?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListProductsResponse>;
|
|
6150
7463
|
};
|
|
6151
7464
|
/**
|
|
6152
7465
|
* ProductsApi - object-oriented interface
|
|
@@ -6279,7 +7592,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
6279
7592
|
* @param {*} [options] Override http request option.
|
|
6280
7593
|
* @throws {RequiredError}
|
|
6281
7594
|
*/
|
|
6282
|
-
createPublicKey(createPublicKeyRequest: CreatePublicKeyRequest, options?:
|
|
7595
|
+
createPublicKey(createPublicKeyRequest: CreatePublicKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePublicKey200Response>;
|
|
6283
7596
|
/**
|
|
6284
7597
|
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
6285
7598
|
* @summary Delete public key
|
|
@@ -6287,7 +7600,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
6287
7600
|
* @param {*} [options] Override http request option.
|
|
6288
7601
|
* @throws {RequiredError}
|
|
6289
7602
|
*/
|
|
6290
|
-
deletePublicKey(id: string, options?:
|
|
7603
|
+
deletePublicKey(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
6291
7604
|
/**
|
|
6292
7605
|
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
6293
7606
|
* @summary Retrieve public key
|
|
@@ -6295,14 +7608,14 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
6295
7608
|
* @param {*} [options] Override http request option.
|
|
6296
7609
|
* @throws {RequiredError}
|
|
6297
7610
|
*/
|
|
6298
|
-
getPublicKey(id: string, options?:
|
|
7611
|
+
getPublicKey(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreatePublicKey200Response>;
|
|
6299
7612
|
/**
|
|
6300
7613
|
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
6301
7614
|
* @summary List public keys
|
|
6302
7615
|
* @param {*} [options] Override http request option.
|
|
6303
7616
|
* @throws {RequiredError}
|
|
6304
7617
|
*/
|
|
6305
|
-
listPublicKeys(options?:
|
|
7618
|
+
listPublicKeys(options?: RawAxiosRequestConfig): AxiosPromise<PublicKeysResponse>;
|
|
6306
7619
|
/**
|
|
6307
7620
|
* Making a request to this endpoint with a JWT signed with your private key will return a 200 response if the public key is active and the signature is valid. > 💡 Testing your integration > > **You can use [JWT.io](https://jwt.io/) to generate a signed token:** > > > 1. Select “RS256” in their algorithm dropdown; > 3. Define a JSON payload such as `{ \"foo\": \"bar\" }`; > 4. Fill the “Verify signature” fields with your public and private keys and copy the “Encoded” token.
|
|
6308
7621
|
* @summary Test public key
|
|
@@ -6311,7 +7624,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
6311
7624
|
* @param {*} [options] Override http request option.
|
|
6312
7625
|
* @throws {RequiredError}
|
|
6313
7626
|
*/
|
|
6314
|
-
testPublicKey(id: string, testPublicKeyRequest: TestPublicKeyRequest, options?:
|
|
7627
|
+
testPublicKey(id: string, testPublicKeyRequest: TestPublicKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
6315
7628
|
};
|
|
6316
7629
|
/**
|
|
6317
7630
|
* PublicKeysApi - object-oriented interface
|
|
@@ -6470,7 +7783,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
6470
7783
|
* @param {*} [options] Override http request option.
|
|
6471
7784
|
* @throws {RequiredError}
|
|
6472
7785
|
*/
|
|
6473
|
-
generateRewardLink(id: string, options?:
|
|
7786
|
+
generateRewardLink(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GenerateRewardLink200Response>;
|
|
6474
7787
|
/**
|
|
6475
7788
|
* Generate a temporary reward token identified by the `id` in the URL. These tokens are needed to render a reward when using [Tremendous Embed](https://github.com/tremendous-rewards/embed/blob/master/docs/documentation.md). The token is valid for 24 hours.
|
|
6476
7789
|
* @summary Generate a reward token
|
|
@@ -6478,7 +7791,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
6478
7791
|
* @param {*} [options] Override http request option.
|
|
6479
7792
|
* @throws {RequiredError}
|
|
6480
7793
|
*/
|
|
6481
|
-
generateRewardToken(id: string, options?:
|
|
7794
|
+
generateRewardToken(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GenerateRewardToken200Response>;
|
|
6482
7795
|
/**
|
|
6483
7796
|
* Retrieve the reward, identified by the given `id` in the URL
|
|
6484
7797
|
* @summary Retrieve single reward
|
|
@@ -6486,7 +7799,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
6486
7799
|
* @param {*} [options] Override http request option.
|
|
6487
7800
|
* @throws {RequiredError}
|
|
6488
7801
|
*/
|
|
6489
|
-
getReward(id: string, options?:
|
|
7802
|
+
getReward(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetReward200Response>;
|
|
6490
7803
|
/**
|
|
6491
7804
|
* Retrieve a list of all created rewards
|
|
6492
7805
|
* @summary List rewards
|
|
@@ -6494,7 +7807,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
6494
7807
|
* @param {*} [options] Override http request option.
|
|
6495
7808
|
* @throws {RequiredError}
|
|
6496
7809
|
*/
|
|
6497
|
-
listRewards(offset?: number, options?:
|
|
7810
|
+
listRewards(offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListRewards200Response>;
|
|
6498
7811
|
/**
|
|
6499
7812
|
* Resends a reward, identified by the given `id` in the URL, to its recipient.
|
|
6500
7813
|
* @summary Resend reward
|
|
@@ -6502,7 +7815,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
6502
7815
|
* @param {*} [options] Override http request option.
|
|
6503
7816
|
* @throws {RequiredError}
|
|
6504
7817
|
*/
|
|
6505
|
-
resendReward(id: string, options?:
|
|
7818
|
+
resendReward(id: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
6506
7819
|
};
|
|
6507
7820
|
/**
|
|
6508
7821
|
* RewardsApi - object-oriented interface
|
|
@@ -6594,7 +7907,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
6594
7907
|
* @param {*} [options] Override http request option.
|
|
6595
7908
|
* @throws {RequiredError}
|
|
6596
7909
|
*/
|
|
6597
|
-
listRoles(options?:
|
|
7910
|
+
listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRoles200Response>;
|
|
6598
7911
|
};
|
|
6599
7912
|
/**
|
|
6600
7913
|
* RolesApi - object-oriented interface
|
|
@@ -6732,7 +8045,7 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
6732
8045
|
* @param {*} [options] Override http request option.
|
|
6733
8046
|
* @throws {RequiredError}
|
|
6734
8047
|
*/
|
|
6735
|
-
createWebhook(createWebhookRequest: CreateWebhookRequest, options?:
|
|
8048
|
+
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateWebhook200Response>;
|
|
6736
8049
|
/**
|
|
6737
8050
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6738
8051
|
* @summary Delete webhook
|
|
@@ -6740,7 +8053,7 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
6740
8053
|
* @param {*} [options] Override http request option.
|
|
6741
8054
|
* @throws {RequiredError}
|
|
6742
8055
|
*/
|
|
6743
|
-
deleteWebhook(id: string, options?:
|
|
8056
|
+
deleteWebhook(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
6744
8057
|
/**
|
|
6745
8058
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6746
8059
|
* @summary Retrieve webhook
|
|
@@ -6748,7 +8061,7 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
6748
8061
|
* @param {*} [options] Override http request option.
|
|
6749
8062
|
* @throws {RequiredError}
|
|
6750
8063
|
*/
|
|
6751
|
-
getWebhook(id: string, options?:
|
|
8064
|
+
getWebhook(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateWebhook200Response>;
|
|
6752
8065
|
/**
|
|
6753
8066
|
* Lists all event types that can be sent to the configured webhook endpoint. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6754
8067
|
* @summary List events
|
|
@@ -6756,14 +8069,14 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
6756
8069
|
* @param {*} [options] Override http request option.
|
|
6757
8070
|
* @throws {RequiredError}
|
|
6758
8071
|
*/
|
|
6759
|
-
listWebhookEvents(id: string, options?:
|
|
8072
|
+
listWebhookEvents(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ListWebhookEvents200Response>;
|
|
6760
8073
|
/**
|
|
6761
8074
|
* Every organization can only have one webhook. This endpoint shows the details about that webhook. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6762
8075
|
* @summary List webhooks
|
|
6763
8076
|
* @param {*} [options] Override http request option.
|
|
6764
8077
|
* @throws {RequiredError}
|
|
6765
8078
|
*/
|
|
6766
|
-
listWebhooks(options?:
|
|
8079
|
+
listWebhooks(options?: RawAxiosRequestConfig): AxiosPromise<ListWebhooks200Response>;
|
|
6767
8080
|
/**
|
|
6768
8081
|
* Making a request to this endpoint will cause our system to trigger a webhook for the specified event. This can be very useful when testing the setup that processes webhooks on your end. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
6769
8082
|
* @summary Test webhook
|
|
@@ -6772,7 +8085,7 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
6772
8085
|
* @param {*} [options] Override http request option.
|
|
6773
8086
|
* @throws {RequiredError}
|
|
6774
8087
|
*/
|
|
6775
|
-
simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?:
|
|
8088
|
+
simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
6776
8089
|
};
|
|
6777
8090
|
/**
|
|
6778
8091
|
* WebhooksApi - object-oriented interface
|