tremendous 3.3.0 → 3.4.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.
Files changed (4) hide show
  1. package/README.md +2 -2
  2. package/dist/api.d.ts +1933 -715
  3. package/dist/api.js +1013 -53
  4. package/package.json +1 -1
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
@@ -50,6 +102,25 @@ export interface BalanceTransaction {
50
102
  */
51
103
  'description'?: string;
52
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;
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.
55
126
  * @export
@@ -319,314 +390,18 @@ export interface CreateMemberRequest {
319
390
  * @interface CreateOrder200Response
320
391
  */
321
392
  export interface CreateOrder200Response {
322
- /**
323
- *
324
- * @type {CreateOrder200ResponseOrder}
325
- * @memberof CreateOrder200Response
326
- */
327
- 'order': CreateOrder200ResponseOrder;
328
- }
329
- /**
330
- * An order wraps around the fulfilment of one or more rewards.
331
- * @export
332
- * @interface CreateOrder200ResponseOrder
333
- */
334
- export interface CreateOrder200ResponseOrder {
335
- /**
336
- * Tremendous ID of the order
337
- * @type {string}
338
- * @memberof CreateOrder200ResponseOrder
339
- */
340
- 'id': string;
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;
347
- /**
348
- * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
349
- * @type {string}
350
- * @memberof CreateOrder200ResponseOrder
351
- */
352
- 'campaign_id'?: string | null;
353
- /**
354
- * Date the order has been created
355
- * @type {string}
356
- * @memberof CreateOrder200ResponseOrder
357
- */
358
- 'created_at': string;
359
- /**
360
- * 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>
361
- * @type {string}
362
- * @memberof CreateOrder200ResponseOrder
363
- */
364
- 'status': CreateOrder200ResponseOrderStatusEnum;
365
- /**
366
- *
367
- * @type {ListOrders200ResponseOrdersInnerPayment}
368
- * @memberof CreateOrder200ResponseOrder
369
- */
370
- 'payment'?: ListOrders200ResponseOrdersInnerPayment;
371
- /**
372
- * The ID for the invoice associated with this order
373
- * @type {string}
374
- * @memberof CreateOrder200ResponseOrder
375
- */
376
- 'invoice_id'?: string;
377
- /**
378
- *
379
- * @type {Array<CreateOrder200ResponseOrderRewardsInner>}
380
- * @memberof CreateOrder200ResponseOrder
381
- */
382
- 'rewards'?: Array<CreateOrder200ResponseOrderRewardsInner>;
383
- }
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
- /**
394
- * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
395
- * @export
396
- * @interface CreateOrder200ResponseOrderRewardsInner
397
- */
398
- export interface CreateOrder200ResponseOrderRewardsInner {
399
- /**
400
- * Tremendous ID of the reward
401
- * @type {string}
402
- * @memberof CreateOrder200ResponseOrderRewardsInner
403
- */
404
- 'id'?: string;
405
- /**
406
- * Tremendous ID of the order this reward is part of.
407
- * @type {string}
408
- * @memberof CreateOrder200ResponseOrderRewardsInner
409
- */
410
- 'order_id'?: string;
411
- /**
412
- * Date the reward was created
413
- * @type {string}
414
- * @memberof CreateOrder200ResponseOrderRewardsInner
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
427
- */
428
- 'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
429
- /**
430
- * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
431
- * @type {string}
432
- * @memberof CreateOrder200ResponseOrderRewardsInner
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
445
- */
446
- 'delivery'?: CreateOrder200ResponseOrderRewardsInnerDelivery;
447
- }
448
- /**
449
- * Details on how the reward is delivered to the recipient.
450
- * @export
451
- * @interface CreateOrder200ResponseOrderRewardsInnerDelivery
452
- */
453
- export interface CreateOrder200ResponseOrderRewardsInnerDelivery {
454
- /**
455
- * 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>
456
- * @type {string}
457
- * @memberof CreateOrder200ResponseOrderRewardsInnerDelivery
458
- */
459
- 'method': CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum;
460
- /**
461
- * 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.
462
- * @type {string}
463
- * @memberof CreateOrder200ResponseOrderRewardsInnerDelivery
464
- */
465
- 'status': CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum;
466
- /**
467
- * 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`.
468
- * @type {string}
469
- * @memberof CreateOrder200ResponseOrderRewardsInnerDelivery
470
- */
471
- 'link'?: string;
472
- }
473
- export declare const CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum: {
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";
483
- readonly Pending: "PENDING";
484
- };
485
- export type CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum = typeof CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum[keyof typeof CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum];
486
- /**
487
- *
488
- * @export
489
- * @interface CreateOrder201Response
490
- */
491
- export interface CreateOrder201Response {
492
393
  /**
493
394
  *
494
395
  * @type {ListOrders200ResponseOrdersInner}
495
- * @memberof CreateOrder201Response
396
+ * @memberof CreateOrder200Response
496
397
  */
497
398
  'order': ListOrders200ResponseOrdersInner;
498
399
  }
499
400
  /**
500
- *
401
+ * @type CreateOrderRequest
501
402
  * @export
502
- * @interface CreateOrderRequest
503
403
  */
504
- export interface CreateOrderRequest {
505
- /**
506
- * 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.
507
- * @type {string}
508
- * @memberof CreateOrderRequest
509
- */
510
- 'external_id'?: string | null;
511
- /**
512
- *
513
- * @type {CreateOrderRequestPayment}
514
- * @memberof CreateOrderRequest
515
- */
516
- 'payment': CreateOrderRequestPayment;
517
- /**
518
- *
519
- * @type {CreateOrderRequestReward}
520
- * @memberof CreateOrderRequest
521
- */
522
- 'reward': CreateOrderRequestReward;
523
- }
524
- /**
525
- *
526
- * @export
527
- * @interface CreateOrderRequestPayment
528
- */
529
- export interface CreateOrderRequestPayment {
530
- /**
531
- * Tremendous ID of the funding source that will be used to pay for the order. Use `balance` to use your Tremendous\'s balance.
532
- * @type {string}
533
- * @memberof CreateOrderRequestPayment
534
- */
535
- 'funding_source_id': string;
536
- }
537
- /**
538
- * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
539
- * @export
540
- * @interface CreateOrderRequestReward
541
- */
542
- export interface CreateOrderRequestReward {
543
- /**
544
- * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
545
- * @type {string}
546
- * @memberof CreateOrderRequestReward
547
- */
548
- 'campaign_id'?: string | null;
549
- /**
550
- * 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.
551
- * @type {Array<string>}
552
- * @memberof CreateOrderRequestReward
553
- */
554
- 'products'?: Array<string>;
555
- /**
556
- *
557
- * @type {ListRewards200ResponseRewardsInnerValue}
558
- * @memberof CreateOrderRequestReward
559
- */
560
- 'value'?: ListRewards200ResponseRewardsInnerValue;
561
- /**
562
- *
563
- * @type {ListRewards200ResponseRewardsInnerRecipient}
564
- * @memberof CreateOrderRequestReward
565
- */
566
- 'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
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];
404
+ export type CreateOrderRequest = SingleRewardOrder1;
630
405
  /**
631
406
  *
632
407
  * @export
@@ -1032,6 +807,19 @@ export interface CustomField {
1032
807
  */
1033
808
  'label'?: string;
1034
809
  }
810
+ /**
811
+ *
812
+ * @export
813
+ * @interface DeleteFraudRule200Response
814
+ */
815
+ export interface DeleteFraudRule200Response {
816
+ /**
817
+ * A description of the result
818
+ * @type {string}
819
+ * @memberof DeleteFraudRule200Response
820
+ */
821
+ 'message': string;
822
+ }
1035
823
  /**
1036
824
  * Details on how the reward is delivered to the recipient.
1037
825
  * @export
@@ -1065,124 +853,672 @@ export declare const DeliveryDetailsStatusEnum: {
1065
853
  };
1066
854
  export type DeliveryDetailsStatusEnum = typeof DeliveryDetailsStatusEnum[keyof typeof DeliveryDetailsStatusEnum];
1067
855
  /**
1068
- * Details on how the reward is delivered to the recipient.
856
+ * 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>
857
+ * @export
858
+ * @enum {string}
859
+ */
860
+ export declare const DeliveryMethod: {
861
+ readonly Email: "EMAIL";
862
+ readonly Link: "LINK";
863
+ readonly Phone: "PHONE";
864
+ };
865
+ export type DeliveryMethod = typeof DeliveryMethod[keyof typeof DeliveryMethod];
866
+ /**
867
+ * 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.
868
+ * @export
869
+ * @enum {string}
870
+ */
871
+ export declare const DeliveryStatus: {
872
+ readonly Scheduled: "SCHEDULED";
873
+ readonly Failed: "FAILED";
874
+ readonly Succeeded: "SUCCEEDED";
875
+ readonly Pending: "PENDING";
876
+ };
877
+ export type DeliveryStatus = typeof DeliveryStatus[keyof typeof DeliveryStatus];
878
+ /**
879
+ *
880
+ * @export
881
+ * @interface ErrorModel
882
+ */
883
+ export interface ErrorModel {
884
+ /**
885
+ *
886
+ * @type {ListRewards401ResponseErrors}
887
+ * @memberof ErrorModel
888
+ */
889
+ 'errors': ListRewards401ResponseErrors;
890
+ }
891
+ /**
892
+ *
893
+ * @export
894
+ * @interface Field
895
+ */
896
+ export interface Field {
897
+ /**
898
+ *
899
+ * @type {string}
900
+ * @memberof Field
901
+ */
902
+ 'id'?: string;
903
+ /**
904
+ * Label of the field
905
+ * @type {string}
906
+ * @memberof Field
907
+ */
908
+ 'label'?: string;
909
+ /**
910
+ * Type of the values of the field
911
+ * @type {string}
912
+ * @memberof Field
913
+ */
914
+ 'data_type'?: string;
915
+ /**
916
+ *
917
+ * @type {{ [key: string]: any; }}
918
+ * @memberof Field
919
+ */
920
+ 'data'?: {
921
+ [key: string]: any;
922
+ };
923
+ /**
924
+ * Is this field required (true) or optional (false)
925
+ * @type {boolean}
926
+ * @memberof Field
927
+ */
928
+ 'required'?: boolean;
929
+ /**
930
+ * Type of objects this field gets associated with
931
+ * @type {string}
932
+ * @memberof Field
933
+ */
934
+ 'scope'?: string;
935
+ }
936
+ /**
937
+ *
938
+ * @export
939
+ * @interface FraudConfigAllowEmail
940
+ */
941
+ export interface FraudConfigAllowEmail {
942
+ /**
943
+ * The list of emails.
944
+ * @type {Array<string>}
945
+ * @memberof FraudConfigAllowEmail
946
+ */
947
+ 'emails': Array<string>;
948
+ }
949
+ /**
950
+ *
951
+ * @export
952
+ * @interface FraudConfigCountry
953
+ */
954
+ export interface FraudConfigCountry {
955
+ /**
956
+ * 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.
957
+ * @type {string}
958
+ * @memberof FraudConfigCountry
959
+ */
960
+ 'type': FraudConfigCountryTypeEnum;
961
+ /**
962
+ * An array of country codes (ISO-3166 alpha-2 character code)
963
+ * @type {Array<string>}
964
+ * @memberof FraudConfigCountry
965
+ */
966
+ 'countries': Array<string>;
967
+ }
968
+ export declare const FraudConfigCountryTypeEnum: {
969
+ readonly Whitelist: "whitelist";
970
+ readonly Blacklist: "blacklist";
971
+ };
972
+ export type FraudConfigCountryTypeEnum = typeof FraudConfigCountryTypeEnum[keyof typeof FraudConfigCountryTypeEnum];
973
+ /**
974
+ *
975
+ * @export
976
+ * @interface FraudConfigCountryUpdateList
977
+ */
978
+ export interface FraudConfigCountryUpdateList {
979
+ /**
980
+ * An array of country codes (ISO-3166 alpha-2 character code)
981
+ * @type {Array<string>}
982
+ * @memberof FraudConfigCountryUpdateList
983
+ */
984
+ 'countries': Array<string>;
985
+ }
986
+ /**
987
+ *
988
+ * @export
989
+ * @interface FraudConfigIP
990
+ */
991
+ export interface FraudConfigIP {
992
+ /**
993
+ * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
994
+ * @type {Array<string>}
995
+ * @memberof FraudConfigIP
996
+ */
997
+ 'ips': Array<string>;
998
+ }
999
+ /**
1000
+ *
1001
+ * @export
1002
+ * @interface FraudConfigRedeemedRewardsAmount
1003
+ */
1004
+ export interface FraudConfigRedeemedRewardsAmount {
1005
+ /**
1006
+ * The total amount in USD of redeemed rewards to use as a threshold.
1007
+ * @type {number}
1008
+ * @memberof FraudConfigRedeemedRewardsAmount
1009
+ */
1010
+ 'amount': number;
1011
+ /**
1012
+ * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
1013
+ * @type {string}
1014
+ * @memberof FraudConfigRedeemedRewardsAmount
1015
+ */
1016
+ 'period': FraudConfigRedeemedRewardsAmountPeriodEnum;
1017
+ }
1018
+ export declare const FraudConfigRedeemedRewardsAmountPeriodEnum: {
1019
+ readonly _7: "7";
1020
+ readonly _30: "30";
1021
+ readonly _90: "90";
1022
+ readonly _120: "120";
1023
+ readonly _365: "365";
1024
+ readonly AllTime: "all_time";
1025
+ };
1026
+ export type FraudConfigRedeemedRewardsAmountPeriodEnum = typeof FraudConfigRedeemedRewardsAmountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsAmountPeriodEnum];
1027
+ /**
1028
+ *
1029
+ * @export
1030
+ * @interface FraudConfigRedeemedRewardsCount
1031
+ */
1032
+ export interface FraudConfigRedeemedRewardsCount {
1033
+ /**
1034
+ * The number of redeemed rewards to use as a threshold.
1035
+ * @type {number}
1036
+ * @memberof FraudConfigRedeemedRewardsCount
1037
+ */
1038
+ 'amount': number;
1039
+ /**
1040
+ * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
1041
+ * @type {string}
1042
+ * @memberof FraudConfigRedeemedRewardsCount
1043
+ */
1044
+ 'period': FraudConfigRedeemedRewardsCountPeriodEnum;
1045
+ }
1046
+ export declare const FraudConfigRedeemedRewardsCountPeriodEnum: {
1047
+ readonly _7: "7";
1048
+ readonly _30: "30";
1049
+ readonly _90: "90";
1050
+ readonly _120: "120";
1051
+ readonly _365: "365";
1052
+ readonly AllTime: "all_time";
1053
+ };
1054
+ export type FraudConfigRedeemedRewardsCountPeriodEnum = typeof FraudConfigRedeemedRewardsCountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsCountPeriodEnum];
1055
+ /**
1056
+ *
1057
+ * @export
1058
+ * @interface FraudConfigReviewEmail
1059
+ */
1060
+ export interface FraudConfigReviewEmail {
1061
+ /**
1062
+ * The list of emails.
1063
+ * @type {Array<string>}
1064
+ * @memberof FraudConfigReviewEmail
1065
+ */
1066
+ 'emails'?: Array<string>;
1067
+ /**
1068
+ * The list of domains. Any subdomains will also be matched against each entry in the list.
1069
+ * @type {Array<string>}
1070
+ * @memberof FraudConfigReviewEmail
1071
+ */
1072
+ 'domains'?: Array<string>;
1073
+ }
1074
+ /**
1075
+ *
1076
+ * @export
1077
+ * @interface FraudGenericResponse
1078
+ */
1079
+ export interface FraudGenericResponse {
1080
+ /**
1081
+ * A description of the result
1082
+ * @type {string}
1083
+ * @memberof FraudGenericResponse
1084
+ */
1085
+ 'message': string;
1086
+ }
1087
+ /**
1088
+ * The fraud review associated with a reward.
1089
+ * @export
1090
+ * @interface FraudReview
1091
+ */
1092
+ export interface FraudReview {
1093
+ /**
1094
+ * 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.
1095
+ * @type {string}
1096
+ * @memberof FraudReview
1097
+ */
1098
+ 'status'?: FraudReviewStatusEnum;
1099
+ /**
1100
+ * 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`
1101
+ * @type {Array<string>}
1102
+ * @memberof FraudReview
1103
+ */
1104
+ 'reasons'?: Array<FraudReviewReasonsEnum>;
1105
+ /**
1106
+ * 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`.
1107
+ * @type {string}
1108
+ * @memberof FraudReview
1109
+ */
1110
+ 'reviewed_by'?: string;
1111
+ /**
1112
+ * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
1113
+ * @type {string}
1114
+ * @memberof FraudReview
1115
+ */
1116
+ 'reviewed_at'?: string;
1117
+ /**
1118
+ *
1119
+ * @type {GetFraudReview200ResponseFraudReviewRelatedRewards}
1120
+ * @memberof FraudReview
1121
+ */
1122
+ 'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
1123
+ /**
1124
+ * The device fingerprint, if known.
1125
+ * @type {string}
1126
+ * @memberof FraudReview
1127
+ */
1128
+ 'device_id'?: string;
1129
+ /**
1130
+ * The product selected to claim the reward
1131
+ * @type {string}
1132
+ * @memberof FraudReview
1133
+ */
1134
+ 'redemption_method'?: FraudReviewRedemptionMethodEnum;
1135
+ /**
1136
+ * Date the reward was redeemed
1137
+ * @type {string}
1138
+ * @memberof FraudReview
1139
+ */
1140
+ 'redeemed_at'?: string;
1141
+ /**
1142
+ *
1143
+ * @type {GetFraudReview200ResponseFraudReviewGeo}
1144
+ * @memberof FraudReview
1145
+ */
1146
+ 'geo'?: GetFraudReview200ResponseFraudReviewGeo;
1147
+ /**
1148
+ *
1149
+ * @type {OrderWithoutLinkReward}
1150
+ * @memberof FraudReview
1151
+ */
1152
+ 'reward'?: OrderWithoutLinkReward;
1153
+ }
1154
+ export declare const FraudReviewStatusEnum: {
1155
+ readonly Flagged: "flagged";
1156
+ readonly Blocked: "blocked";
1157
+ readonly Released: "released";
1158
+ };
1159
+ export type FraudReviewStatusEnum = typeof FraudReviewStatusEnum[keyof typeof FraudReviewStatusEnum];
1160
+ export declare const FraudReviewReasonsEnum: {
1161
+ readonly DisallowedIp: "Disallowed IP";
1162
+ readonly DisallowedEmail: "Disallowed email";
1163
+ readonly DisallowedCountry: "Disallowed country";
1164
+ readonly OverRewardDollarLimit: "Over reward dollar limit";
1165
+ readonly OverRewardCountLimit: "Over reward count limit";
1166
+ readonly VpnDetected: "VPN detected";
1167
+ readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
1168
+ readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
1169
+ readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
1170
+ readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
1171
+ readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
1172
+ readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
1173
+ readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
1174
+ readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
1175
+ readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
1176
+ readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
1177
+ readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
1178
+ readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
1179
+ readonly AllowedIp: "Allowed IP";
1180
+ readonly AllowedEmail: "Allowed email";
1181
+ };
1182
+ export type FraudReviewReasonsEnum = typeof FraudReviewReasonsEnum[keyof typeof FraudReviewReasonsEnum];
1183
+ export declare const FraudReviewRedemptionMethodEnum: {
1184
+ readonly Paypal: "paypal";
1185
+ readonly Bank: "bank";
1186
+ readonly MerchantCard: "merchant card";
1187
+ readonly VisaCard: "visa card";
1188
+ readonly Charity: "charity";
1189
+ readonly Venmo: "venmo";
1190
+ };
1191
+ export type FraudReviewRedemptionMethodEnum = typeof FraudReviewRedemptionMethodEnum[keyof typeof FraudReviewRedemptionMethodEnum];
1192
+ /**
1193
+ *
1194
+ * @export
1195
+ * @interface FraudReviewGeo
1196
+ */
1197
+ export interface FraudReviewGeo {
1198
+ /**
1199
+ * The recipient\'s IP.
1200
+ * @type {string}
1201
+ * @memberof FraudReviewGeo
1202
+ */
1203
+ 'ip'?: string;
1204
+ /**
1205
+ * The country code (ISO-3166 alpha-2 character code) linked to the recipient\'s IP.
1206
+ * @type {string}
1207
+ * @memberof FraudReviewGeo
1208
+ */
1209
+ 'country'?: string;
1210
+ /**
1211
+ * The city associated with the recipient\'s IP.
1212
+ * @type {string}
1213
+ * @memberof FraudReviewGeo
1214
+ */
1215
+ 'city'?: string;
1216
+ }
1217
+ /**
1218
+ * The fraud review associated with a reward.
1069
1219
  * @export
1070
- * @interface DeliveryDetailsWithLink
1220
+ * @interface FraudReviewListItem
1071
1221
  */
1072
- export interface DeliveryDetailsWithLink {
1222
+ export interface FraudReviewListItem {
1073
1223
  /**
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>
1224
+ * 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.
1075
1225
  * @type {string}
1076
- * @memberof DeliveryDetailsWithLink
1226
+ * @memberof FraudReviewListItem
1077
1227
  */
1078
- 'method': DeliveryDetailsWithLinkMethodEnum;
1228
+ 'status'?: FraudReviewListItemStatusEnum;
1079
1229
  /**
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
1230
+ * 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`
1231
+ * @type {Array<string>}
1232
+ * @memberof FraudReviewListItem
1083
1233
  */
1084
- 'status': DeliveryDetailsWithLinkStatusEnum;
1234
+ 'reasons'?: Array<FraudReviewListItemReasonsEnum>;
1085
1235
  /**
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
1236
+ *
1237
+ * @type {OrderWithoutLinkReward}
1238
+ * @memberof FraudReviewListItem
1089
1239
  */
1090
- 'link'?: string;
1240
+ 'reward'?: OrderWithoutLinkReward;
1091
1241
  }
1092
- export declare const DeliveryDetailsWithLinkMethodEnum: {
1093
- readonly Email: "EMAIL";
1094
- readonly Link: "LINK";
1095
- readonly Phone: "PHONE";
1242
+ export declare const FraudReviewListItemStatusEnum: {
1243
+ readonly Flagged: "flagged";
1244
+ readonly Blocked: "blocked";
1245
+ readonly Released: "released";
1096
1246
  };
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";
1247
+ export type FraudReviewListItemStatusEnum = typeof FraudReviewListItemStatusEnum[keyof typeof FraudReviewListItemStatusEnum];
1248
+ export declare const FraudReviewListItemReasonsEnum: {
1249
+ readonly DisallowedIp: "Disallowed IP";
1250
+ readonly DisallowedEmail: "Disallowed email";
1251
+ readonly DisallowedCountry: "Disallowed country";
1252
+ readonly OverRewardDollarLimit: "Over reward dollar limit";
1253
+ readonly OverRewardCountLimit: "Over reward count limit";
1254
+ readonly VpnDetected: "VPN detected";
1255
+ readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
1256
+ readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
1257
+ readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
1258
+ readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
1259
+ readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
1260
+ readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
1261
+ readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
1262
+ readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
1263
+ readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
1264
+ readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
1265
+ readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
1266
+ readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
1267
+ readonly AllowedIp: "Allowed IP";
1268
+ readonly AllowedEmail: "Allowed email";
1103
1269
  };
1104
- export type DeliveryDetailsWithLinkStatusEnum = typeof DeliveryDetailsWithLinkStatusEnum[keyof typeof DeliveryDetailsWithLinkStatusEnum];
1270
+ export type FraudReviewListItemReasonsEnum = typeof FraudReviewListItemReasonsEnum[keyof typeof FraudReviewListItemReasonsEnum];
1105
1271
  /**
1106
- * 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>
1272
+ *
1107
1273
  * @export
1108
1274
  * @enum {string}
1109
1275
  */
1110
- export declare const DeliveryMethod: {
1111
- readonly Email: "EMAIL";
1112
- readonly Link: "LINK";
1113
- readonly Phone: "PHONE";
1276
+ export declare const FraudReviewReason: {
1277
+ readonly DisallowedIp: "Disallowed IP";
1278
+ readonly DisallowedEmail: "Disallowed email";
1279
+ readonly DisallowedCountry: "Disallowed country";
1280
+ readonly OverRewardDollarLimit: "Over reward dollar limit";
1281
+ readonly OverRewardCountLimit: "Over reward count limit";
1282
+ readonly VpnDetected: "VPN detected";
1283
+ readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
1284
+ readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
1285
+ readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
1286
+ readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
1287
+ readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
1288
+ readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
1289
+ readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
1290
+ readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
1291
+ readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
1292
+ readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
1293
+ readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
1294
+ readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
1295
+ readonly AllowedIp: "Allowed IP";
1296
+ readonly AllowedEmail: "Allowed email";
1114
1297
  };
1115
- export type DeliveryMethod = typeof DeliveryMethod[keyof typeof DeliveryMethod];
1298
+ export type FraudReviewReason = typeof FraudReviewReason[keyof typeof FraudReviewReason];
1116
1299
  /**
1117
- * 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.
1300
+ *
1118
1301
  * @export
1119
1302
  * @enum {string}
1120
1303
  */
1121
- export declare const DeliveryStatus: {
1122
- readonly Scheduled: "SCHEDULED";
1123
- readonly Failed: "FAILED";
1124
- readonly Succeeded: "SUCCEEDED";
1125
- readonly Pending: "PENDING";
1304
+ export declare const FraudReviewRedemptionMethod: {
1305
+ readonly Paypal: "paypal";
1306
+ readonly Bank: "bank";
1307
+ readonly MerchantCard: "merchant card";
1308
+ readonly VisaCard: "visa card";
1309
+ readonly Charity: "charity";
1310
+ readonly Venmo: "venmo";
1126
1311
  };
1127
- export type DeliveryStatus = typeof DeliveryStatus[keyof typeof DeliveryStatus];
1312
+ export type FraudReviewRedemptionMethod = typeof FraudReviewRedemptionMethod[keyof typeof FraudReviewRedemptionMethod];
1128
1313
  /**
1129
1314
  *
1130
1315
  * @export
1131
- * @interface ErrorModel
1316
+ * @interface FraudReviewRelatedRewards
1132
1317
  */
1133
- export interface ErrorModel {
1318
+ export interface FraudReviewRelatedRewards {
1319
+ /**
1320
+ * The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned.
1321
+ * @type {Array<string>}
1322
+ * @memberof FraudReviewRelatedRewards
1323
+ */
1324
+ 'ids'?: Array<string>;
1325
+ /**
1326
+ * How many related rewards were found in total.
1327
+ * @type {number}
1328
+ * @memberof FraudReviewRelatedRewards
1329
+ */
1330
+ 'count'?: number;
1331
+ /**
1332
+ * How many related rewards have been blocked.
1333
+ * @type {number}
1334
+ * @memberof FraudReviewRelatedRewards
1335
+ */
1336
+ 'blocked_count'?: number;
1337
+ /**
1338
+ * Total amount claimed by the related rewards (in USD).
1339
+ * @type {number}
1340
+ * @memberof FraudReviewRelatedRewards
1341
+ */
1342
+ 'aggregated_value'?: number;
1343
+ }
1344
+ /**
1345
+ * 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.
1346
+ * @export
1347
+ * @enum {string}
1348
+ */
1349
+ export declare const FraudReviewStatus: {
1350
+ readonly Flagged: "flagged";
1351
+ readonly Blocked: "blocked";
1352
+ readonly Released: "released";
1353
+ };
1354
+ export type FraudReviewStatus = typeof FraudReviewStatus[keyof typeof FraudReviewStatus];
1355
+ /**
1356
+ *
1357
+ * @export
1358
+ * @interface FraudRule200Response
1359
+ */
1360
+ export interface FraudRule200Response {
1361
+ /**
1362
+ * A description of the result
1363
+ * @type {string}
1364
+ * @memberof FraudRule200Response
1365
+ */
1366
+ 'message': string;
1367
+ }
1368
+ /**
1369
+ *
1370
+ * @export
1371
+ * @interface FraudRule400Response
1372
+ */
1373
+ export interface FraudRule400Response {
1134
1374
  /**
1135
1375
  *
1136
1376
  * @type {ListRewards401ResponseErrors}
1137
- * @memberof ErrorModel
1377
+ * @memberof FraudRule400Response
1138
1378
  */
1139
1379
  'errors': ListRewards401ResponseErrors;
1140
1380
  }
1141
1381
  /**
1142
1382
  *
1143
1383
  * @export
1144
- * @interface Field
1384
+ * @interface FraudRule422Response
1145
1385
  */
1146
- export interface Field {
1386
+ export interface FraudRule422Response {
1147
1387
  /**
1148
1388
  *
1149
- * @type {string}
1150
- * @memberof Field
1389
+ * @type {ListRewards401ResponseErrors}
1390
+ * @memberof FraudRule422Response
1151
1391
  */
1152
- 'id'?: string;
1392
+ 'errors': ListRewards401ResponseErrors;
1393
+ }
1394
+ /**
1395
+ *
1396
+ * @export
1397
+ * @interface FraudRuleRequest
1398
+ */
1399
+ export interface FraudRuleRequest {
1153
1400
  /**
1154
- * Label of the field
1155
- * @type {string}
1156
- * @memberof Field
1401
+ *
1402
+ * @type {FraudRuleRequestConfig}
1403
+ * @memberof FraudRuleRequest
1157
1404
  */
1158
- 'label'?: string;
1405
+ 'config'?: FraudRuleRequestConfig;
1406
+ }
1407
+ /**
1408
+ * The configuration associated with the rule. The properties allowed depend on the type of rule.
1409
+ * @export
1410
+ * @interface FraudRuleRequestConfig
1411
+ */
1412
+ export interface FraudRuleRequestConfig {
1159
1413
  /**
1160
- * Type of the values of the field
1414
+ * 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.
1161
1415
  * @type {string}
1162
- * @memberof Field
1416
+ * @memberof FraudRuleRequestConfig
1163
1417
  */
1164
- 'data_type'?: string;
1418
+ 'type': FraudRuleRequestConfigTypeEnum;
1165
1419
  /**
1166
- *
1167
- * @type {{ [key: string]: any; }}
1168
- * @memberof Field
1420
+ * An array of country codes (ISO-3166 alpha-2 character code)
1421
+ * @type {Array<string>}
1422
+ * @memberof FraudRuleRequestConfig
1169
1423
  */
1170
- 'data'?: {
1171
- [key: string]: any;
1172
- };
1424
+ 'countries': Array<string>;
1173
1425
  /**
1174
- * Is this field required (true) or optional (false)
1175
- * @type {boolean}
1176
- * @memberof Field
1426
+ * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
1427
+ * @type {Array<string>}
1428
+ * @memberof FraudRuleRequestConfig
1177
1429
  */
1178
- 'required'?: boolean;
1430
+ 'ips': Array<string>;
1179
1431
  /**
1180
- * Type of objects this field gets associated with
1432
+ * The list of emails.
1433
+ * @type {Array<string>}
1434
+ * @memberof FraudRuleRequestConfig
1435
+ */
1436
+ 'emails': Array<string>;
1437
+ /**
1438
+ * The list of domains. Any subdomains will also be matched against each entry in the list.
1439
+ * @type {Array<string>}
1440
+ * @memberof FraudRuleRequestConfig
1441
+ */
1442
+ 'domains'?: Array<string>;
1443
+ /**
1444
+ * The total amount in USD of redeemed rewards to use as a threshold.
1445
+ * @type {number}
1446
+ * @memberof FraudRuleRequestConfig
1447
+ */
1448
+ 'amount': number;
1449
+ /**
1450
+ * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
1181
1451
  * @type {string}
1182
- * @memberof Field
1452
+ * @memberof FraudRuleRequestConfig
1183
1453
  */
1184
- 'scope'?: string;
1454
+ 'period': FraudRuleRequestConfigPeriodEnum;
1185
1455
  }
1456
+ export declare const FraudRuleRequestConfigTypeEnum: {
1457
+ readonly Whitelist: "whitelist";
1458
+ readonly Blacklist: "blacklist";
1459
+ };
1460
+ export type FraudRuleRequestConfigTypeEnum = typeof FraudRuleRequestConfigTypeEnum[keyof typeof FraudRuleRequestConfigTypeEnum];
1461
+ export declare const FraudRuleRequestConfigPeriodEnum: {
1462
+ readonly _7: "7";
1463
+ readonly _30: "30";
1464
+ readonly _90: "90";
1465
+ readonly _120: "120";
1466
+ readonly _365: "365";
1467
+ readonly AllTime: "all_time";
1468
+ };
1469
+ export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeriodEnum[keyof typeof FraudRuleRequestConfigPeriodEnum];
1470
+ /**
1471
+ * * `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
1472
+ * @export
1473
+ * @enum {string}
1474
+ */
1475
+ export declare const FraudRuleType: {
1476
+ readonly ReviewCountry: "review_country";
1477
+ readonly ReviewIp: "review_ip";
1478
+ readonly ReviewEmail: "review_email";
1479
+ readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
1480
+ readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
1481
+ readonly ReviewMultipleEmails: "review_multiple_emails";
1482
+ readonly ReviewVpn: "review_vpn";
1483
+ readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
1484
+ readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
1485
+ readonly AllowIp: "allow_ip";
1486
+ readonly AllowEmail: "allow_email";
1487
+ };
1488
+ export type FraudRuleType = typeof FraudRuleType[keyof typeof FraudRuleType];
1489
+ /**
1490
+ * An active fraud rule
1491
+ * @export
1492
+ * @interface FraudRulesListItem
1493
+ */
1494
+ export interface FraudRulesListItem {
1495
+ /**
1496
+ * * `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
1497
+ * @type {string}
1498
+ * @memberof FraudRulesListItem
1499
+ */
1500
+ 'rule_type'?: FraudRulesListItemRuleTypeEnum;
1501
+ /**
1502
+ * 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.
1503
+ * @type {object}
1504
+ * @memberof FraudRulesListItem
1505
+ */
1506
+ 'config'?: object | null;
1507
+ }
1508
+ export declare const FraudRulesListItemRuleTypeEnum: {
1509
+ readonly ReviewCountry: "review_country";
1510
+ readonly ReviewIp: "review_ip";
1511
+ readonly ReviewEmail: "review_email";
1512
+ readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
1513
+ readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
1514
+ readonly ReviewMultipleEmails: "review_multiple_emails";
1515
+ readonly ReviewVpn: "review_vpn";
1516
+ readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
1517
+ readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
1518
+ readonly AllowIp: "allow_ip";
1519
+ readonly AllowEmail: "allow_email";
1520
+ };
1521
+ export type FraudRulesListItemRuleTypeEnum = typeof FraudRulesListItemRuleTypeEnum[keyof typeof FraudRulesListItemRuleTypeEnum];
1186
1522
  /**
1187
1523
  *
1188
1524
  * @export
@@ -1310,6 +1646,180 @@ export interface GenerateRewardToken200ResponseReward {
1310
1646
  */
1311
1647
  'expires_at'?: string;
1312
1648
  }
1649
+ /**
1650
+ *
1651
+ * @export
1652
+ * @interface GetFraudReview200Response
1653
+ */
1654
+ export interface GetFraudReview200Response {
1655
+ /**
1656
+ *
1657
+ * @type {GetFraudReview200ResponseFraudReview}
1658
+ * @memberof GetFraudReview200Response
1659
+ */
1660
+ 'fraud_review': GetFraudReview200ResponseFraudReview;
1661
+ }
1662
+ /**
1663
+ * The fraud review associated with a reward.
1664
+ * @export
1665
+ * @interface GetFraudReview200ResponseFraudReview
1666
+ */
1667
+ export interface GetFraudReview200ResponseFraudReview {
1668
+ /**
1669
+ * 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.
1670
+ * @type {string}
1671
+ * @memberof GetFraudReview200ResponseFraudReview
1672
+ */
1673
+ 'status'?: GetFraudReview200ResponseFraudReviewStatusEnum;
1674
+ /**
1675
+ * 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`
1676
+ * @type {Array<string>}
1677
+ * @memberof GetFraudReview200ResponseFraudReview
1678
+ */
1679
+ 'reasons'?: Array<GetFraudReview200ResponseFraudReviewReasonsEnum>;
1680
+ /**
1681
+ * 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`.
1682
+ * @type {string}
1683
+ * @memberof GetFraudReview200ResponseFraudReview
1684
+ */
1685
+ 'reviewed_by'?: string;
1686
+ /**
1687
+ * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
1688
+ * @type {string}
1689
+ * @memberof GetFraudReview200ResponseFraudReview
1690
+ */
1691
+ 'reviewed_at'?: string;
1692
+ /**
1693
+ *
1694
+ * @type {GetFraudReview200ResponseFraudReviewRelatedRewards}
1695
+ * @memberof GetFraudReview200ResponseFraudReview
1696
+ */
1697
+ 'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
1698
+ /**
1699
+ * The device fingerprint, if known.
1700
+ * @type {string}
1701
+ * @memberof GetFraudReview200ResponseFraudReview
1702
+ */
1703
+ 'device_id'?: string;
1704
+ /**
1705
+ * The product selected to claim the reward
1706
+ * @type {string}
1707
+ * @memberof GetFraudReview200ResponseFraudReview
1708
+ */
1709
+ 'redemption_method'?: GetFraudReview200ResponseFraudReviewRedemptionMethodEnum;
1710
+ /**
1711
+ * Date the reward was redeemed
1712
+ * @type {string}
1713
+ * @memberof GetFraudReview200ResponseFraudReview
1714
+ */
1715
+ 'redeemed_at'?: string;
1716
+ /**
1717
+ *
1718
+ * @type {GetFraudReview200ResponseFraudReviewGeo}
1719
+ * @memberof GetFraudReview200ResponseFraudReview
1720
+ */
1721
+ 'geo'?: GetFraudReview200ResponseFraudReviewGeo;
1722
+ /**
1723
+ *
1724
+ * @type {ListRewards200ResponseRewardsInner}
1725
+ * @memberof GetFraudReview200ResponseFraudReview
1726
+ */
1727
+ 'reward'?: ListRewards200ResponseRewardsInner;
1728
+ }
1729
+ export declare const GetFraudReview200ResponseFraudReviewStatusEnum: {
1730
+ readonly Flagged: "flagged";
1731
+ readonly Blocked: "blocked";
1732
+ readonly Released: "released";
1733
+ };
1734
+ export type GetFraudReview200ResponseFraudReviewStatusEnum = typeof GetFraudReview200ResponseFraudReviewStatusEnum[keyof typeof GetFraudReview200ResponseFraudReviewStatusEnum];
1735
+ export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
1736
+ readonly DisallowedIp: "Disallowed IP";
1737
+ readonly DisallowedEmail: "Disallowed email";
1738
+ readonly DisallowedCountry: "Disallowed country";
1739
+ readonly OverRewardDollarLimit: "Over reward dollar limit";
1740
+ readonly OverRewardCountLimit: "Over reward count limit";
1741
+ readonly VpnDetected: "VPN detected";
1742
+ readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
1743
+ readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
1744
+ readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
1745
+ readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
1746
+ readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
1747
+ readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
1748
+ readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
1749
+ readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
1750
+ readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
1751
+ readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
1752
+ readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
1753
+ readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
1754
+ readonly AllowedIp: "Allowed IP";
1755
+ readonly AllowedEmail: "Allowed email";
1756
+ };
1757
+ export type GetFraudReview200ResponseFraudReviewReasonsEnum = typeof GetFraudReview200ResponseFraudReviewReasonsEnum[keyof typeof GetFraudReview200ResponseFraudReviewReasonsEnum];
1758
+ export declare const GetFraudReview200ResponseFraudReviewRedemptionMethodEnum: {
1759
+ readonly Paypal: "paypal";
1760
+ readonly Bank: "bank";
1761
+ readonly MerchantCard: "merchant card";
1762
+ readonly VisaCard: "visa card";
1763
+ readonly Charity: "charity";
1764
+ readonly Venmo: "venmo";
1765
+ };
1766
+ export type GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum[keyof typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum];
1767
+ /**
1768
+ * The Geo location, based on the recipient\'s IP.
1769
+ * @export
1770
+ * @interface GetFraudReview200ResponseFraudReviewGeo
1771
+ */
1772
+ export interface GetFraudReview200ResponseFraudReviewGeo {
1773
+ /**
1774
+ * The recipient\'s IP.
1775
+ * @type {string}
1776
+ * @memberof GetFraudReview200ResponseFraudReviewGeo
1777
+ */
1778
+ 'ip'?: string;
1779
+ /**
1780
+ * The country code (ISO-3166 alpha-2 character code) linked to the recipient\'s IP.
1781
+ * @type {string}
1782
+ * @memberof GetFraudReview200ResponseFraudReviewGeo
1783
+ */
1784
+ 'country'?: string;
1785
+ /**
1786
+ * The city associated with the recipient\'s IP.
1787
+ * @type {string}
1788
+ * @memberof GetFraudReview200ResponseFraudReviewGeo
1789
+ */
1790
+ 'city'?: string;
1791
+ }
1792
+ /**
1793
+ * The related rewards associated with the fraud review.
1794
+ * @export
1795
+ * @interface GetFraudReview200ResponseFraudReviewRelatedRewards
1796
+ */
1797
+ export interface GetFraudReview200ResponseFraudReviewRelatedRewards {
1798
+ /**
1799
+ * The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned.
1800
+ * @type {Array<string>}
1801
+ * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
1802
+ */
1803
+ 'ids'?: Array<string>;
1804
+ /**
1805
+ * How many related rewards were found in total.
1806
+ * @type {number}
1807
+ * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
1808
+ */
1809
+ 'count'?: number;
1810
+ /**
1811
+ * How many related rewards have been blocked.
1812
+ * @type {number}
1813
+ * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
1814
+ */
1815
+ 'blocked_count'?: number;
1816
+ /**
1817
+ * Total amount claimed by the related rewards (in USD).
1818
+ * @type {number}
1819
+ * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
1820
+ */
1821
+ 'aggregated_value'?: number;
1822
+ }
1313
1823
  /**
1314
1824
  *
1315
1825
  * @export
@@ -1632,13 +2142,13 @@ export interface ListCampaigns200ResponseCampaignsInnerEmailStyle {
1632
2142
  * @type {string}
1633
2143
  * @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
1634
2144
  */
1635
- 'sender_name'?: string;
2145
+ 'sender_name'?: string | null;
1636
2146
  /**
1637
2147
  * Email subject line
1638
2148
  * @type {string}
1639
2149
  * @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle
1640
2150
  */
1641
- 'subject_line'?: string;
2151
+ 'subject_line'?: string | null;
1642
2152
  /**
1643
2153
  * URL of a publicly-accessible image (png, jpeg, jpg, gif, or svg). This image will be copied to our storage location.
1644
2154
  * @type {string}
@@ -1675,7 +2185,7 @@ export interface ListCampaigns200ResponseCampaignsInnerWebpageStyle {
1675
2185
  * @type {string}
1676
2186
  * @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle
1677
2187
  */
1678
- 'headline'?: string;
2188
+ 'headline'?: string | null;
1679
2189
  /**
1680
2190
  * Message for the reward page
1681
2191
  * @type {string}
@@ -1780,6 +2290,119 @@ export interface ListForexResponse {
1780
2290
  [key: string]: number;
1781
2291
  };
1782
2292
  }
2293
+ /**
2294
+ *
2295
+ * @export
2296
+ * @interface ListFraudReviews200Response
2297
+ */
2298
+ export interface ListFraudReviews200Response {
2299
+ /**
2300
+ *
2301
+ * @type {Array<ListFraudReviews200ResponseFraudReviewsInner>}
2302
+ * @memberof ListFraudReviews200Response
2303
+ */
2304
+ 'fraud_reviews': Array<ListFraudReviews200ResponseFraudReviewsInner>;
2305
+ }
2306
+ /**
2307
+ * The fraud review associated with a reward.
2308
+ * @export
2309
+ * @interface ListFraudReviews200ResponseFraudReviewsInner
2310
+ */
2311
+ export interface ListFraudReviews200ResponseFraudReviewsInner {
2312
+ /**
2313
+ * 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.
2314
+ * @type {string}
2315
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
2316
+ */
2317
+ 'status'?: ListFraudReviews200ResponseFraudReviewsInnerStatusEnum;
2318
+ /**
2319
+ * 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`
2320
+ * @type {Array<string>}
2321
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
2322
+ */
2323
+ 'reasons'?: Array<ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum>;
2324
+ /**
2325
+ *
2326
+ * @type {ListRewards200ResponseRewardsInner}
2327
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
2328
+ */
2329
+ 'reward'?: ListRewards200ResponseRewardsInner;
2330
+ }
2331
+ export declare const ListFraudReviews200ResponseFraudReviewsInnerStatusEnum: {
2332
+ readonly Flagged: "flagged";
2333
+ readonly Blocked: "blocked";
2334
+ readonly Released: "released";
2335
+ };
2336
+ export type ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum];
2337
+ export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: {
2338
+ readonly DisallowedIp: "Disallowed IP";
2339
+ readonly DisallowedEmail: "Disallowed email";
2340
+ readonly DisallowedCountry: "Disallowed country";
2341
+ readonly OverRewardDollarLimit: "Over reward dollar limit";
2342
+ readonly OverRewardCountLimit: "Over reward count limit";
2343
+ readonly VpnDetected: "VPN detected";
2344
+ readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2345
+ readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2346
+ readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
2347
+ readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
2348
+ readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
2349
+ readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
2350
+ readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
2351
+ readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
2352
+ readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
2353
+ readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
2354
+ readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
2355
+ readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
2356
+ readonly AllowedIp: "Allowed IP";
2357
+ readonly AllowedEmail: "Allowed email";
2358
+ };
2359
+ export type ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum];
2360
+ /**
2361
+ *
2362
+ * @export
2363
+ * @interface ListFraudRules200Response
2364
+ */
2365
+ export interface ListFraudRules200Response {
2366
+ /**
2367
+ *
2368
+ * @type {Array<ListFraudRules200ResponseFraudRulesInner>}
2369
+ * @memberof ListFraudRules200Response
2370
+ */
2371
+ 'fraud_rules': Array<ListFraudRules200ResponseFraudRulesInner>;
2372
+ }
2373
+ /**
2374
+ * An active fraud rule
2375
+ * @export
2376
+ * @interface ListFraudRules200ResponseFraudRulesInner
2377
+ */
2378
+ export interface ListFraudRules200ResponseFraudRulesInner {
2379
+ /**
2380
+ * * `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
2381
+ * @type {string}
2382
+ * @memberof ListFraudRules200ResponseFraudRulesInner
2383
+ */
2384
+ 'rule_type'?: ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum;
2385
+ /**
2386
+ * 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.
2387
+ * @type {object}
2388
+ * @memberof ListFraudRules200ResponseFraudRulesInner
2389
+ */
2390
+ 'config'?: object | null;
2391
+ }
2392
+ export declare const ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum: {
2393
+ readonly ReviewCountry: "review_country";
2394
+ readonly ReviewIp: "review_ip";
2395
+ readonly ReviewEmail: "review_email";
2396
+ readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
2397
+ readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
2398
+ readonly ReviewMultipleEmails: "review_multiple_emails";
2399
+ readonly ReviewVpn: "review_vpn";
2400
+ readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
2401
+ readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
2402
+ readonly AllowIp: "allow_ip";
2403
+ readonly AllowEmail: "allow_email";
2404
+ };
2405
+ export type ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum[keyof typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum];
1783
2406
  /**
1784
2407
  *
1785
2408
  * @export
@@ -2718,7 +3341,7 @@ export interface ListRewards200ResponseRewardsInnerValue {
2718
3341
  * @type {string}
2719
3342
  * @memberof ListRewards200ResponseRewardsInnerValue
2720
3343
  */
2721
- 'currency_code': ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum;
3344
+ 'currency_code'?: ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum;
2722
3345
  }
2723
3346
  export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
2724
3347
  readonly Usd: "USD";
@@ -3364,104 +3987,6 @@ export declare const OrderBasePaymentChannelEnum: {
3364
3987
  readonly SurveyMonkey: "SURVEY MONKEY";
3365
3988
  };
3366
3989
  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
3412
- * @type {string}
3413
- * @memberof OrderForCreateReward
3414
- */
3415
- 'created_at'?: string;
3416
- /**
3417
- * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
3418
- * @type {string}
3419
- * @memberof OrderForCreateReward
3420
- */
3421
- 'campaign_id'?: string | null;
3422
- /**
3423
- * 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.
3424
- * @type {Array<string>}
3425
- * @memberof OrderForCreateReward
3426
- */
3427
- 'products'?: Array<string>;
3428
- /**
3429
- *
3430
- * @type {ListRewards200ResponseRewardsInnerValue}
3431
- * @memberof OrderForCreateReward
3432
- */
3433
- 'value'?: ListRewards200ResponseRewardsInnerValue;
3434
- /**
3435
- *
3436
- * @type {ListRewards200ResponseRewardsInnerRecipient}
3437
- * @memberof OrderForCreateReward
3438
- */
3439
- 'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
3440
- /**
3441
- * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
3442
- * @type {string}
3443
- * @memberof OrderForCreateReward
3444
- */
3445
- 'deliver_at'?: string;
3446
- /**
3447
- *
3448
- * @type {Array<RewardBaseCustomFieldsInner>}
3449
- * @memberof OrderForCreateReward
3450
- */
3451
- 'custom_fields'?: Array<RewardBaseCustomFieldsInner>;
3452
- /**
3453
- * 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`.
3454
- * @type {string}
3455
- * @memberof OrderForCreateReward
3456
- */
3457
- 'language'?: string;
3458
- /**
3459
- *
3460
- * @type {CreateOrderRequestRewardDelivery}
3461
- * @memberof OrderForCreateReward
3462
- */
3463
- 'delivery'?: CreateOrderRequestRewardDelivery;
3464
- }
3465
3990
  /**
3466
3991
  * 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
3992
  * @export
@@ -3476,137 +4001,6 @@ export declare const OrderStatus: {
3476
4001
  readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
3477
4002
  };
3478
4003
  export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
3479
- /**
3480
- * An order wraps around the fulfilment of one or more rewards.
3481
- * @export
3482
- * @interface OrderWithLink
3483
- */
3484
- export interface OrderWithLink {
3485
- /**
3486
- * Tremendous ID of the order
3487
- * @type {string}
3488
- * @memberof OrderWithLink
3489
- */
3490
- 'id': string;
3491
- /**
3492
- * 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
- * @type {string}
3494
- * @memberof OrderWithLink
3495
- */
3496
- 'external_id'?: string | null;
3497
- /**
3498
- * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
3499
- * @type {string}
3500
- * @memberof OrderWithLink
3501
- */
3502
- 'campaign_id'?: string | null;
3503
- /**
3504
- * Date the order has been created
3505
- * @type {string}
3506
- * @memberof OrderWithLink
3507
- */
3508
- 'created_at': string;
3509
- /**
3510
- * 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
- * @type {string}
3512
- * @memberof OrderWithLink
3513
- */
3514
- 'status': OrderWithLinkStatusEnum;
3515
- /**
3516
- *
3517
- * @type {OrderBasePayment}
3518
- * @memberof OrderWithLink
3519
- */
3520
- 'payment'?: OrderBasePayment;
3521
- /**
3522
- * The ID for the invoice associated with this order
3523
- * @type {string}
3524
- * @memberof OrderWithLink
3525
- */
3526
- 'invoice_id'?: string;
3527
- /**
3528
- *
3529
- * @type {Array<OrderWithLinkRewardsInner>}
3530
- * @memberof OrderWithLink
3531
- */
3532
- 'rewards'?: Array<OrderWithLinkRewardsInner>;
3533
- }
3534
- export declare const OrderWithLinkStatusEnum: {
3535
- readonly Canceled: "CANCELED";
3536
- readonly Cart: "CART";
3537
- readonly Executed: "EXECUTED";
3538
- readonly Failed: "FAILED";
3539
- readonly PendingApproval: "PENDING APPROVAL";
3540
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
3541
- };
3542
- export type OrderWithLinkStatusEnum = typeof OrderWithLinkStatusEnum[keyof typeof OrderWithLinkStatusEnum];
3543
- /**
3544
- * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
3545
- * @export
3546
- * @interface OrderWithLinkRewardsInner
3547
- */
3548
- export interface OrderWithLinkRewardsInner {
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;
3567
- /**
3568
- * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
3569
- * @type {string}
3570
- * @memberof OrderWithLinkRewardsInner
3571
- */
3572
- 'campaign_id'?: string | null;
3573
- /**
3574
- * 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.
3575
- * @type {Array<string>}
3576
- * @memberof OrderWithLinkRewardsInner
3577
- */
3578
- 'products'?: Array<string>;
3579
- /**
3580
- *
3581
- * @type {ListRewards200ResponseRewardsInnerValue}
3582
- * @memberof OrderWithLinkRewardsInner
3583
- */
3584
- 'value'?: ListRewards200ResponseRewardsInnerValue;
3585
- /**
3586
- *
3587
- * @type {ListRewards200ResponseRewardsInnerRecipient}
3588
- * @memberof OrderWithLinkRewardsInner
3589
- */
3590
- 'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
3591
- /**
3592
- * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
3593
- * @type {string}
3594
- * @memberof OrderWithLinkRewardsInner
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
3607
- */
3608
- 'delivery'?: RewardWithLinkDelivery;
3609
- }
3610
4004
  /**
3611
4005
  * An order wraps around the fulfilment of one or more rewards.
3612
4006
  * @export
@@ -4031,7 +4425,7 @@ export declare const ProductCurrencyCodesEnum: {
4031
4425
  };
4032
4426
  export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum];
4033
4427
  /**
4034
- * 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.
4428
+ * 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
4429
  * @export
4036
4430
  * @interface PublicKey
4037
4431
  */
@@ -4069,7 +4463,7 @@ export interface PublicKeysResponse {
4069
4463
  'public_keys': Array<PublicKeysResponsePublicKeysInner>;
4070
4464
  }
4071
4465
  /**
4072
- * 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.
4466
+ * 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
4467
  * @export
4074
4468
  * @interface PublicKeysResponsePublicKeysInner
4075
4469
  */
@@ -4123,27 +4517,184 @@ export interface Recipient {
4123
4517
  * @export
4124
4518
  * @interface RefundDetails
4125
4519
  */
4126
- export interface RefundDetails {
4520
+ export interface RefundDetails {
4521
+ /**
4522
+ * Total amount of the order refunds (in USD)
4523
+ * @type {number}
4524
+ * @memberof RefundDetails
4525
+ */
4526
+ 'total': number;
4527
+ }
4528
+ /**
4529
+ *
4530
+ * @export
4531
+ * @interface ResendReward422Response
4532
+ */
4533
+ export interface ResendReward422Response {
4534
+ /**
4535
+ *
4536
+ * @type {ListRewards401ResponseErrors}
4537
+ * @memberof ResendReward422Response
4538
+ */
4539
+ 'errors': ListRewards401ResponseErrors;
4540
+ }
4541
+ /**
4542
+ * Flag rewards redeemed in these countries.
4543
+ * @export
4544
+ * @interface ReviewCountry
4545
+ */
4546
+ export interface ReviewCountry {
4547
+ /**
4548
+ * 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.
4549
+ * @type {string}
4550
+ * @memberof ReviewCountry
4551
+ */
4552
+ 'type': ReviewCountryTypeEnum;
4553
+ /**
4554
+ * An array of country codes (ISO-3166 alpha-2 character code)
4555
+ * @type {Array<string>}
4556
+ * @memberof ReviewCountry
4557
+ */
4558
+ 'countries': Array<string>;
4559
+ }
4560
+ export declare const ReviewCountryTypeEnum: {
4561
+ readonly Whitelist: "whitelist";
4562
+ readonly Blacklist: "blacklist";
4563
+ };
4564
+ export type ReviewCountryTypeEnum = typeof ReviewCountryTypeEnum[keyof typeof ReviewCountryTypeEnum];
4565
+ /**
4566
+ * List of countries where a matching redemption will trigger a review.
4567
+ * @export
4568
+ * @interface ReviewCountry1
4569
+ */
4570
+ export interface ReviewCountry1 {
4571
+ /**
4572
+ * An array of country codes (ISO-3166 alpha-2 character code)
4573
+ * @type {Array<string>}
4574
+ * @memberof ReviewCountry1
4575
+ */
4576
+ 'countries': Array<string>;
4577
+ }
4578
+ /**
4579
+ * Flag rewards with an email or domain matching this list.
4580
+ * @export
4581
+ * @interface ReviewEmail
4582
+ */
4583
+ export interface ReviewEmail {
4584
+ /**
4585
+ * The list of emails.
4586
+ * @type {Array<string>}
4587
+ * @memberof ReviewEmail
4588
+ */
4589
+ 'emails'?: Array<string>;
4590
+ /**
4591
+ * The list of domains. Any subdomains will also be matched against each entry in the list.
4592
+ * @type {Array<string>}
4593
+ * @memberof ReviewEmail
4594
+ */
4595
+ 'domains'?: Array<string>;
4596
+ }
4597
+ /**
4598
+ * The list of emails and/or domains where a matching redemption will trigger a review. At least one email or domain is required.
4599
+ * @export
4600
+ * @interface ReviewEmail1
4601
+ */
4602
+ export interface ReviewEmail1 {
4603
+ /**
4604
+ * The list of emails.
4605
+ * @type {Array<string>}
4606
+ * @memberof ReviewEmail1
4607
+ */
4608
+ 'emails'?: Array<string>;
4609
+ /**
4610
+ * The list of domains. Any subdomains will also be matched against each entry in the list.
4611
+ * @type {Array<string>}
4612
+ * @memberof ReviewEmail1
4613
+ */
4614
+ 'domains'?: Array<string>;
4615
+ }
4616
+ /**
4617
+ * Flag rewards redeemed by an IP matching this list.
4618
+ * @export
4619
+ * @interface ReviewIp
4620
+ */
4621
+ export interface ReviewIp {
4622
+ /**
4623
+ * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
4624
+ * @type {Array<string>}
4625
+ * @memberof ReviewIp
4626
+ */
4627
+ 'ips': Array<string>;
4628
+ }
4629
+ /**
4630
+ * List of IP addresses and/or IP ranges where a matching redemption will trigger a review.
4631
+ * @export
4632
+ * @interface ReviewIp1
4633
+ */
4634
+ export interface ReviewIp1 {
4635
+ /**
4636
+ * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
4637
+ * @type {Array<string>}
4638
+ * @memberof ReviewIp1
4639
+ */
4640
+ 'ips': Array<string>;
4641
+ }
4642
+ /**
4643
+ * If a recipient, device, or IP redeems more than this dollar value of rewards, flag for review.
4644
+ * @export
4645
+ * @interface ReviewRedeemedRewardsAmount
4646
+ */
4647
+ export interface ReviewRedeemedRewardsAmount {
4127
4648
  /**
4128
- * Total amount of the order refunds (in USD)
4649
+ * The total amount in USD of redeemed rewards to use as a threshold.
4129
4650
  * @type {number}
4130
- * @memberof RefundDetails
4651
+ * @memberof ReviewRedeemedRewardsAmount
4131
4652
  */
4132
- 'total': number;
4653
+ 'amount': number;
4654
+ /**
4655
+ * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
4656
+ * @type {string}
4657
+ * @memberof ReviewRedeemedRewardsAmount
4658
+ */
4659
+ 'period': ReviewRedeemedRewardsAmountPeriodEnum;
4133
4660
  }
4661
+ export declare const ReviewRedeemedRewardsAmountPeriodEnum: {
4662
+ readonly _7: "7";
4663
+ readonly _30: "30";
4664
+ readonly _90: "90";
4665
+ readonly _120: "120";
4666
+ readonly _365: "365";
4667
+ readonly AllTime: "all_time";
4668
+ };
4669
+ export type ReviewRedeemedRewardsAmountPeriodEnum = typeof ReviewRedeemedRewardsAmountPeriodEnum[keyof typeof ReviewRedeemedRewardsAmountPeriodEnum];
4134
4670
  /**
4135
- *
4671
+ * If a recipient, device, or IP redeems more than this number of rewards, flag for review.
4136
4672
  * @export
4137
- * @interface ResendReward422Response
4673
+ * @interface ReviewRedeemedRewardsCount
4138
4674
  */
4139
- export interface ResendReward422Response {
4675
+ export interface ReviewRedeemedRewardsCount {
4140
4676
  /**
4141
- *
4142
- * @type {ListRewards401ResponseErrors}
4143
- * @memberof ResendReward422Response
4677
+ * The number of redeemed rewards to use as a threshold.
4678
+ * @type {number}
4679
+ * @memberof ReviewRedeemedRewardsCount
4144
4680
  */
4145
- 'errors': ListRewards401ResponseErrors;
4681
+ 'amount': number;
4682
+ /**
4683
+ * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.
4684
+ * @type {string}
4685
+ * @memberof ReviewRedeemedRewardsCount
4686
+ */
4687
+ 'period': ReviewRedeemedRewardsCountPeriodEnum;
4146
4688
  }
4689
+ export declare const ReviewRedeemedRewardsCountPeriodEnum: {
4690
+ readonly _7: "7";
4691
+ readonly _30: "30";
4692
+ readonly _90: "90";
4693
+ readonly _120: "120";
4694
+ readonly _365: "365";
4695
+ readonly AllTime: "all_time";
4696
+ };
4697
+ export type ReviewRedeemedRewardsCountPeriodEnum = typeof ReviewRedeemedRewardsCountPeriodEnum[keyof typeof ReviewRedeemedRewardsCountPeriodEnum];
4147
4698
  /**
4148
4699
  * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
4149
4700
  * @export
@@ -4365,10 +4916,10 @@ export interface RewardForOrderCreate {
4365
4916
  'language'?: string;
4366
4917
  /**
4367
4918
  *
4368
- * @type {CreateOrderRequestRewardDelivery}
4919
+ * @type {SingleRewardOrder1RewardDelivery}
4369
4920
  * @memberof RewardForOrderCreate
4370
4921
  */
4371
- 'delivery'?: CreateOrderRequestRewardDelivery;
4922
+ 'delivery'?: SingleRewardOrder1RewardDelivery;
4372
4923
  }
4373
4924
  /**
4374
4925
  * The redemption link for a reward.
@@ -4431,7 +4982,7 @@ export interface RewardValue {
4431
4982
  * @type {string}
4432
4983
  * @memberof RewardValue
4433
4984
  */
4434
- 'currency_code': RewardValueCurrencyCodeEnum;
4985
+ 'currency_code'?: RewardValueCurrencyCodeEnum;
4435
4986
  }
4436
4987
  export declare const RewardValueCurrencyCodeEnum: {
4437
4988
  readonly Usd: "USD";
@@ -4555,245 +5106,446 @@ export type RewardValueCurrencyCodeEnum = typeof RewardValueCurrencyCodeEnum[key
4555
5106
  /**
4556
5107
  * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
4557
5108
  * @export
4558
- * @interface RewardWithLink
5109
+ * @interface RewardWithoutLink
4559
5110
  */
4560
- export interface RewardWithLink {
5111
+ export interface RewardWithoutLink {
4561
5112
  /**
4562
5113
  * Tremendous ID of the reward
4563
5114
  * @type {string}
4564
- * @memberof RewardWithLink
5115
+ * @memberof RewardWithoutLink
4565
5116
  */
4566
5117
  'id'?: string;
4567
5118
  /**
4568
5119
  * Tremendous ID of the order this reward is part of.
4569
5120
  * @type {string}
4570
- * @memberof RewardWithLink
5121
+ * @memberof RewardWithoutLink
4571
5122
  */
4572
5123
  'order_id'?: string;
4573
5124
  /**
4574
5125
  * Date the reward was created
4575
5126
  * @type {string}
4576
- * @memberof RewardWithLink
5127
+ * @memberof RewardWithoutLink
4577
5128
  */
4578
5129
  'created_at'?: string;
4579
5130
  /**
4580
5131
  * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
4581
5132
  * @type {string}
4582
- * @memberof RewardWithLink
5133
+ * @memberof RewardWithoutLink
4583
5134
  */
4584
5135
  'campaign_id'?: string | null;
4585
5136
  /**
4586
5137
  * 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
5138
  * @type {Array<string>}
4588
- * @memberof RewardWithLink
5139
+ * @memberof RewardWithoutLink
4589
5140
  */
4590
5141
  'products'?: Array<string>;
4591
5142
  /**
4592
5143
  *
4593
5144
  * @type {ListRewards200ResponseRewardsInnerValue}
4594
- * @memberof RewardWithLink
5145
+ * @memberof RewardWithoutLink
4595
5146
  */
4596
5147
  'value'?: ListRewards200ResponseRewardsInnerValue;
4597
5148
  /**
4598
5149
  *
4599
5150
  * @type {ListRewards200ResponseRewardsInnerRecipient}
4600
- * @memberof RewardWithLink
5151
+ * @memberof RewardWithoutLink
4601
5152
  */
4602
5153
  'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
4603
5154
  /**
4604
5155
  * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
4605
5156
  * @type {string}
4606
- * @memberof RewardWithLink
5157
+ * @memberof RewardWithoutLink
4607
5158
  */
4608
5159
  'deliver_at'?: string;
4609
5160
  /**
4610
5161
  *
4611
5162
  * @type {Array<RewardBaseCustomFieldsInner>}
4612
- * @memberof RewardWithLink
5163
+ * @memberof RewardWithoutLink
4613
5164
  */
4614
5165
  'custom_fields'?: Array<RewardBaseCustomFieldsInner>;
4615
5166
  /**
4616
5167
  *
4617
- * @type {RewardWithLinkDelivery}
4618
- * @memberof RewardWithLink
5168
+ * @type {RewardWithoutLinkDelivery}
5169
+ * @memberof RewardWithoutLink
4619
5170
  */
4620
- 'delivery'?: RewardWithLinkDelivery;
5171
+ 'delivery'?: RewardWithoutLinkDelivery;
4621
5172
  }
4622
5173
  /**
4623
5174
  * Details on how the reward is delivered to the recipient.
4624
5175
  * @export
4625
- * @interface RewardWithLinkDelivery
5176
+ * @interface RewardWithoutLinkDelivery
4626
5177
  */
4627
- export interface RewardWithLinkDelivery {
5178
+ export interface RewardWithoutLinkDelivery {
4628
5179
  /**
4629
5180
  * 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
5181
  * @type {string}
4631
- * @memberof RewardWithLinkDelivery
5182
+ * @memberof RewardWithoutLinkDelivery
4632
5183
  */
4633
- 'method': RewardWithLinkDeliveryMethodEnum;
5184
+ 'method': RewardWithoutLinkDeliveryMethodEnum;
4634
5185
  /**
4635
5186
  * 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
5187
  * @type {string}
4637
- * @memberof RewardWithLinkDelivery
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
5188
+ * @memberof RewardWithoutLinkDelivery
4644
5189
  */
4645
- 'link'?: string;
5190
+ 'status': RewardWithoutLinkDeliveryStatusEnum;
4646
5191
  }
4647
- export declare const RewardWithLinkDeliveryMethodEnum: {
5192
+ export declare const RewardWithoutLinkDeliveryMethodEnum: {
4648
5193
  readonly Email: "EMAIL";
4649
5194
  readonly Link: "LINK";
4650
5195
  readonly Phone: "PHONE";
4651
5196
  };
4652
- export type RewardWithLinkDeliveryMethodEnum = typeof RewardWithLinkDeliveryMethodEnum[keyof typeof RewardWithLinkDeliveryMethodEnum];
4653
- export declare const RewardWithLinkDeliveryStatusEnum: {
5197
+ export type RewardWithoutLinkDeliveryMethodEnum = typeof RewardWithoutLinkDeliveryMethodEnum[keyof typeof RewardWithoutLinkDeliveryMethodEnum];
5198
+ export declare const RewardWithoutLinkDeliveryStatusEnum: {
4654
5199
  readonly Scheduled: "SCHEDULED";
4655
5200
  readonly Failed: "FAILED";
4656
5201
  readonly Succeeded: "SUCCEEDED";
4657
5202
  readonly Pending: "PENDING";
4658
5203
  };
4659
- export type RewardWithLinkDeliveryStatusEnum = typeof RewardWithLinkDeliveryStatusEnum[keyof typeof RewardWithLinkDeliveryStatusEnum];
5204
+ export type RewardWithoutLinkDeliveryStatusEnum = typeof RewardWithoutLinkDeliveryStatusEnum[keyof typeof RewardWithoutLinkDeliveryStatusEnum];
5205
+ /**
5206
+ * Each organization member is assigned a role that defines the permissions they have within the organization.
5207
+ * @export
5208
+ * @interface Role
5209
+ */
5210
+ export interface Role {
5211
+ /**
5212
+ *
5213
+ * @type {string}
5214
+ * @memberof Role
5215
+ */
5216
+ 'id': string;
5217
+ /**
5218
+ *
5219
+ * @type {string}
5220
+ * @memberof Role
5221
+ */
5222
+ 'title': string;
5223
+ /**
5224
+ *
5225
+ * @type {string}
5226
+ * @memberof Role
5227
+ */
5228
+ 'description': string;
5229
+ }
5230
+ /**
5231
+ *
5232
+ * @export
5233
+ * @interface SimulateWebhookRequest
5234
+ */
5235
+ export interface SimulateWebhookRequest {
5236
+ /**
5237
+ * The event to test. See the [List events endpoint reference](/reference/get_webhooks-id-events) for all available events.
5238
+ * @type {string}
5239
+ * @memberof SimulateWebhookRequest
5240
+ */
5241
+ 'event': string;
5242
+ }
5243
+ /**
5244
+ * An order that contains a single reward. The reward is sent to a single recipient.
5245
+ * @export
5246
+ * @interface SingleRewardOrder
5247
+ */
5248
+ export interface SingleRewardOrder {
5249
+ /**
5250
+ * 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.
5251
+ * @type {string}
5252
+ * @memberof SingleRewardOrder
5253
+ */
5254
+ 'external_id'?: string | null;
5255
+ /**
5256
+ *
5257
+ * @type {SingleRewardOrder1Payment}
5258
+ * @memberof SingleRewardOrder
5259
+ */
5260
+ 'payment'?: SingleRewardOrder1Payment;
5261
+ /**
5262
+ *
5263
+ * @type {SingleRewardOrderReward}
5264
+ * @memberof SingleRewardOrder
5265
+ */
5266
+ 'reward': SingleRewardOrderReward;
5267
+ }
5268
+ /**
5269
+ * An order that contains a single reward. The reward is sent to a single recipient.
5270
+ * @export
5271
+ * @interface SingleRewardOrder1
5272
+ */
5273
+ export interface SingleRewardOrder1 {
5274
+ /**
5275
+ * 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.
5276
+ * @type {string}
5277
+ * @memberof SingleRewardOrder1
5278
+ */
5279
+ 'external_id'?: string | null;
5280
+ /**
5281
+ *
5282
+ * @type {SingleRewardOrder1Payment}
5283
+ * @memberof SingleRewardOrder1
5284
+ */
5285
+ 'payment'?: SingleRewardOrder1Payment;
5286
+ /**
5287
+ *
5288
+ * @type {SingleRewardOrder1Reward}
5289
+ * @memberof SingleRewardOrder1
5290
+ */
5291
+ 'reward': SingleRewardOrder1Reward;
5292
+ }
5293
+ /**
5294
+ *
5295
+ * @export
5296
+ * @interface SingleRewardOrder1Payment
5297
+ */
5298
+ export interface SingleRewardOrder1Payment {
5299
+ /**
5300
+ * Tremendous ID of the funding source that will be used to pay for the order. Use `balance` to use your Tremendous\'s balance.
5301
+ * @type {string}
5302
+ * @memberof SingleRewardOrder1Payment
5303
+ */
5304
+ 'funding_source_id': string;
5305
+ }
5306
+ /**
5307
+ * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
5308
+ * @export
5309
+ * @interface SingleRewardOrder1Reward
5310
+ */
5311
+ export interface SingleRewardOrder1Reward {
5312
+ /**
5313
+ * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
5314
+ * @type {string}
5315
+ * @memberof SingleRewardOrder1Reward
5316
+ */
5317
+ 'campaign_id'?: string | null;
5318
+ /**
5319
+ * 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.
5320
+ * @type {Array<string>}
5321
+ * @memberof SingleRewardOrder1Reward
5322
+ */
5323
+ 'products'?: Array<string>;
5324
+ /**
5325
+ *
5326
+ * @type {ListRewards200ResponseRewardsInnerValue}
5327
+ * @memberof SingleRewardOrder1Reward
5328
+ */
5329
+ 'value'?: ListRewards200ResponseRewardsInnerValue;
5330
+ /**
5331
+ *
5332
+ * @type {ListRewards200ResponseRewardsInnerRecipient}
5333
+ * @memberof SingleRewardOrder1Reward
5334
+ */
5335
+ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
5336
+ /**
5337
+ * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
5338
+ * @type {string}
5339
+ * @memberof SingleRewardOrder1Reward
5340
+ */
5341
+ 'deliver_at'?: string;
5342
+ /**
5343
+ *
5344
+ * @type {Array<SingleRewardOrder1RewardCustomFieldsInner>}
5345
+ * @memberof SingleRewardOrder1Reward
5346
+ */
5347
+ 'custom_fields'?: Array<SingleRewardOrder1RewardCustomFieldsInner>;
5348
+ /**
5349
+ * 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`.
5350
+ * @type {string}
5351
+ * @memberof SingleRewardOrder1Reward
5352
+ */
5353
+ 'language'?: string;
5354
+ /**
5355
+ *
5356
+ * @type {SingleRewardOrder1RewardDelivery}
5357
+ * @memberof SingleRewardOrder1Reward
5358
+ */
5359
+ 'delivery'?: SingleRewardOrder1RewardDelivery;
5360
+ }
5361
+ /**
5362
+ * 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).)
5363
+ * @export
5364
+ * @interface SingleRewardOrder1RewardCustomFieldsInner
5365
+ */
5366
+ export interface SingleRewardOrder1RewardCustomFieldsInner {
5367
+ /**
5368
+ * Tremendous ID of the custom field
5369
+ * @type {string}
5370
+ * @memberof SingleRewardOrder1RewardCustomFieldsInner
5371
+ */
5372
+ 'id'?: string;
5373
+ /**
5374
+ * Value of the custom field
5375
+ * @type {string}
5376
+ * @memberof SingleRewardOrder1RewardCustomFieldsInner
5377
+ */
5378
+ 'value'?: string | null;
5379
+ }
5380
+ /**
5381
+ * Details on how the reward is delivered to the recipient.
5382
+ * @export
5383
+ * @interface SingleRewardOrder1RewardDelivery
5384
+ */
5385
+ export interface SingleRewardOrder1RewardDelivery {
5386
+ /**
5387
+ * 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>
5388
+ * @type {string}
5389
+ * @memberof SingleRewardOrder1RewardDelivery
5390
+ */
5391
+ 'method'?: SingleRewardOrder1RewardDeliveryMethodEnum;
5392
+ }
5393
+ export declare const SingleRewardOrder1RewardDeliveryMethodEnum: {
5394
+ readonly Email: "EMAIL";
5395
+ readonly Link: "LINK";
5396
+ readonly Phone: "PHONE";
5397
+ };
5398
+ export type SingleRewardOrder1RewardDeliveryMethodEnum = typeof SingleRewardOrder1RewardDeliveryMethodEnum[keyof typeof SingleRewardOrder1RewardDeliveryMethodEnum];
4660
5399
  /**
4661
5400
  * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
4662
5401
  * @export
4663
- * @interface RewardWithoutLink
5402
+ * @interface SingleRewardOrderReward
4664
5403
  */
4665
- export interface RewardWithoutLink {
5404
+ export interface SingleRewardOrderReward {
4666
5405
  /**
4667
5406
  * Tremendous ID of the reward
4668
5407
  * @type {string}
4669
- * @memberof RewardWithoutLink
5408
+ * @memberof SingleRewardOrderReward
4670
5409
  */
4671
5410
  'id'?: string;
4672
5411
  /**
4673
5412
  * Tremendous ID of the order this reward is part of.
4674
5413
  * @type {string}
4675
- * @memberof RewardWithoutLink
5414
+ * @memberof SingleRewardOrderReward
4676
5415
  */
4677
5416
  'order_id'?: string;
4678
5417
  /**
4679
5418
  * Date the reward was created
4680
5419
  * @type {string}
4681
- * @memberof RewardWithoutLink
5420
+ * @memberof SingleRewardOrderReward
4682
5421
  */
4683
5422
  'created_at'?: string;
4684
5423
  /**
4685
5424
  * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
4686
5425
  * @type {string}
4687
- * @memberof RewardWithoutLink
5426
+ * @memberof SingleRewardOrderReward
4688
5427
  */
4689
5428
  'campaign_id'?: string | null;
4690
5429
  /**
4691
5430
  * 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
5431
  * @type {Array<string>}
4693
- * @memberof RewardWithoutLink
5432
+ * @memberof SingleRewardOrderReward
4694
5433
  */
4695
5434
  'products'?: Array<string>;
4696
5435
  /**
4697
5436
  *
4698
5437
  * @type {ListRewards200ResponseRewardsInnerValue}
4699
- * @memberof RewardWithoutLink
5438
+ * @memberof SingleRewardOrderReward
4700
5439
  */
4701
5440
  'value'?: ListRewards200ResponseRewardsInnerValue;
4702
5441
  /**
4703
5442
  *
4704
5443
  * @type {ListRewards200ResponseRewardsInnerRecipient}
4705
- * @memberof RewardWithoutLink
5444
+ * @memberof SingleRewardOrderReward
4706
5445
  */
4707
5446
  'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
4708
5447
  /**
4709
5448
  * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
4710
5449
  * @type {string}
4711
- * @memberof RewardWithoutLink
5450
+ * @memberof SingleRewardOrderReward
4712
5451
  */
4713
5452
  'deliver_at'?: string;
4714
5453
  /**
4715
5454
  *
4716
5455
  * @type {Array<RewardBaseCustomFieldsInner>}
4717
- * @memberof RewardWithoutLink
5456
+ * @memberof SingleRewardOrderReward
4718
5457
  */
4719
5458
  'custom_fields'?: Array<RewardBaseCustomFieldsInner>;
5459
+ /**
5460
+ * 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`.
5461
+ * @type {string}
5462
+ * @memberof SingleRewardOrderReward
5463
+ */
5464
+ 'language'?: string;
4720
5465
  /**
4721
5466
  *
4722
- * @type {RewardWithoutLinkDelivery}
4723
- * @memberof RewardWithoutLink
5467
+ * @type {SingleRewardOrder1RewardDelivery}
5468
+ * @memberof SingleRewardOrderReward
4724
5469
  */
4725
- 'delivery'?: RewardWithoutLinkDelivery;
5470
+ 'delivery'?: SingleRewardOrder1RewardDelivery;
4726
5471
  }
4727
5472
  /**
4728
- * Details on how the reward is delivered to the recipient.
5473
+ *
4729
5474
  * @export
4730
- * @interface RewardWithoutLinkDelivery
5475
+ * @interface SingleRewardOrderWithoutLink
4731
5476
  */
4732
- export interface RewardWithoutLinkDelivery {
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;
5477
+ export interface SingleRewardOrderWithoutLink {
4739
5478
  /**
4740
- * 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.
4741
- * @type {string}
4742
- * @memberof RewardWithoutLinkDelivery
5479
+ *
5480
+ * @type {SingleRewardOrderWithoutLinkOrder}
5481
+ * @memberof SingleRewardOrderWithoutLink
4743
5482
  */
4744
- 'status': RewardWithoutLinkDeliveryStatusEnum;
5483
+ 'order': SingleRewardOrderWithoutLinkOrder;
4745
5484
  }
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
5485
  /**
4760
- * Each organization member is assigned a role that defines the permissions they have within the organization.
5486
+ * An order wraps around the fulfilment of one or more rewards.
4761
5487
  * @export
4762
- * @interface Role
5488
+ * @interface SingleRewardOrderWithoutLinkOrder
4763
5489
  */
4764
- export interface Role {
5490
+ export interface SingleRewardOrderWithoutLinkOrder {
5491
+ /**
5492
+ * Tremendous ID of the order
5493
+ * @type {string}
5494
+ * @memberof SingleRewardOrderWithoutLinkOrder
5495
+ */
5496
+ 'id': string;
5497
+ /**
5498
+ * 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.
5499
+ * @type {string}
5500
+ * @memberof SingleRewardOrderWithoutLinkOrder
5501
+ */
5502
+ 'external_id'?: string | null;
4765
5503
  /**
4766
- *
5504
+ * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
4767
5505
  * @type {string}
4768
- * @memberof Role
5506
+ * @memberof SingleRewardOrderWithoutLinkOrder
4769
5507
  */
4770
- 'id': string;
5508
+ 'campaign_id'?: string | null;
4771
5509
  /**
4772
- *
5510
+ * Date the order has been created
4773
5511
  * @type {string}
4774
- * @memberof Role
5512
+ * @memberof SingleRewardOrderWithoutLinkOrder
4775
5513
  */
4776
- 'title': string;
5514
+ 'created_at': string;
4777
5515
  /**
4778
- *
5516
+ * 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>
4779
5517
  * @type {string}
4780
- * @memberof Role
5518
+ * @memberof SingleRewardOrderWithoutLinkOrder
4781
5519
  */
4782
- 'description': string;
4783
- }
4784
- /**
4785
- *
4786
- * @export
4787
- * @interface SimulateWebhookRequest
4788
- */
4789
- export interface SimulateWebhookRequest {
5520
+ 'status': SingleRewardOrderWithoutLinkOrderStatusEnum;
4790
5521
  /**
4791
- * The event to test. See the [List events endpoint reference](/reference/get_webhooks-id-events) for all available events.
5522
+ *
5523
+ * @type {OrderBasePayment}
5524
+ * @memberof SingleRewardOrderWithoutLinkOrder
5525
+ */
5526
+ 'payment'?: OrderBasePayment;
5527
+ /**
5528
+ * The ID for the invoice associated with this order
4792
5529
  * @type {string}
4793
- * @memberof SimulateWebhookRequest
5530
+ * @memberof SingleRewardOrderWithoutLinkOrder
4794
5531
  */
4795
- 'event': string;
5532
+ 'invoice_id'?: string;
5533
+ /**
5534
+ *
5535
+ * @type {OrderWithoutLinkReward}
5536
+ * @memberof SingleRewardOrderWithoutLinkOrder
5537
+ */
5538
+ 'reward'?: OrderWithoutLinkReward;
4796
5539
  }
5540
+ export declare const SingleRewardOrderWithoutLinkOrderStatusEnum: {
5541
+ readonly Canceled: "CANCELED";
5542
+ readonly Cart: "CART";
5543
+ readonly Executed: "EXECUTED";
5544
+ readonly Failed: "FAILED";
5545
+ readonly PendingApproval: "PENDING APPROVAL";
5546
+ readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
5547
+ };
5548
+ export type SingleRewardOrderWithoutLinkOrderStatusEnum = typeof SingleRewardOrderWithoutLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithoutLinkOrderStatusEnum];
4797
5549
  /**
4798
5550
  *
4799
5551
  * @export
@@ -4900,6 +5652,74 @@ export interface UpdateCampaignRequest {
4900
5652
  */
4901
5653
  'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
4902
5654
  }
5655
+ /**
5656
+ *
5657
+ * @export
5658
+ * @interface UpdateFraudRuleList200Response
5659
+ */
5660
+ export interface UpdateFraudRuleList200Response {
5661
+ /**
5662
+ * A description of the result
5663
+ * @type {string}
5664
+ * @memberof UpdateFraudRuleList200Response
5665
+ */
5666
+ 'message': string;
5667
+ }
5668
+ /**
5669
+ *
5670
+ * @export
5671
+ * @interface UpdateFraudRuleListRequest
5672
+ */
5673
+ export interface UpdateFraudRuleListRequest {
5674
+ /**
5675
+ * * `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
5676
+ * @type {string}
5677
+ * @memberof UpdateFraudRuleListRequest
5678
+ */
5679
+ 'operation': UpdateFraudRuleListRequestOperationEnum;
5680
+ /**
5681
+ *
5682
+ * @type {UpdateFraudRuleListRequestConfig}
5683
+ * @memberof UpdateFraudRuleListRequest
5684
+ */
5685
+ 'config': UpdateFraudRuleListRequestConfig;
5686
+ }
5687
+ export declare const UpdateFraudRuleListRequestOperationEnum: {
5688
+ readonly Add: "add";
5689
+ readonly Remove: "remove";
5690
+ };
5691
+ export type UpdateFraudRuleListRequestOperationEnum = typeof UpdateFraudRuleListRequestOperationEnum[keyof typeof UpdateFraudRuleListRequestOperationEnum];
5692
+ /**
5693
+ * The configuration associated with the rule. The properties allowed depend on the type of rule.
5694
+ * @export
5695
+ * @interface UpdateFraudRuleListRequestConfig
5696
+ */
5697
+ export interface UpdateFraudRuleListRequestConfig {
5698
+ /**
5699
+ * An array of country codes (ISO-3166 alpha-2 character code)
5700
+ * @type {Array<string>}
5701
+ * @memberof UpdateFraudRuleListRequestConfig
5702
+ */
5703
+ 'countries': Array<string>;
5704
+ /**
5705
+ * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation.
5706
+ * @type {Array<string>}
5707
+ * @memberof UpdateFraudRuleListRequestConfig
5708
+ */
5709
+ 'ips': Array<string>;
5710
+ /**
5711
+ * The list of emails.
5712
+ * @type {Array<string>}
5713
+ * @memberof UpdateFraudRuleListRequestConfig
5714
+ */
5715
+ 'emails': Array<string>;
5716
+ /**
5717
+ * The list of domains. Any subdomains will also be matched against each entry in the list.
5718
+ * @type {Array<string>}
5719
+ * @memberof UpdateFraudRuleListRequestConfig
5720
+ */
5721
+ 'domains'?: Array<string>;
5722
+ }
4903
5723
  /**
4904
5724
  *
4905
5725
  * @export
@@ -5281,6 +6101,404 @@ export declare class ForexApi extends BaseAPI {
5281
6101
  */
5282
6102
  listForex(base?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListForexResponse, any>>;
5283
6103
  }
6104
+ /**
6105
+ * FraudReviewsApi - axios parameter creator
6106
+ * @export
6107
+ */
6108
+ export declare const FraudReviewsApiAxiosParamCreator: (configuration?: Configuration) => {
6109
+ /**
6110
+ * Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
6111
+ * @summary Block fraud review
6112
+ * @param {string} id The ID of the reward that should be blocked.
6113
+ * @param {*} [options] Override http request option.
6114
+ * @throws {RequiredError}
6115
+ */
6116
+ blockFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6117
+ /**
6118
+ * 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.
6119
+ * @summary Retrieve single fraud review
6120
+ * @param {string} id The ID of the reward that should be retrieved.
6121
+ * @param {*} [options] Override http request option.
6122
+ * @throws {RequiredError}
6123
+ */
6124
+ getFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6125
+ /**
6126
+ * Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
6127
+ * @summary List fraud reviews
6128
+ * @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).
6129
+ * @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
6130
+ * @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be &#x60;flagged&#x60;, &#x60;blocked&#x60; or &#x60;released&#x60;.
6131
+ * @param {string} [createdAtGte] Return results where the created_at field is &gt;&#x3D; to the supplied value. Expects an ISO 8601 datetime.
6132
+ * @param {string} [createdAtLte] Return results where the created_at field is &lt;&#x3D; to the supplied value. Expects an ISO 8601 datetime.
6133
+ * @param {string} [redeemedAtGte] Return results where the redeemed_at field is &gt;&#x3D; the supplied value. Expects an ISO 8601 datetime.
6134
+ * @param {string} [redeemedAtLte] Return results where the redeemed_at field is &lt;&#x3D; the supplied value. Expects an ISO 8601 datetime.
6135
+ * @param {*} [options] Override http request option.
6136
+ * @throws {RequiredError}
6137
+ */
6138
+ listFraudReviews: (offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6139
+ /**
6140
+ * Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
6141
+ * @summary Release fraud review
6142
+ * @param {string} id The ID of the reward that should be released.
6143
+ * @param {*} [options] Override http request option.
6144
+ * @throws {RequiredError}
6145
+ */
6146
+ releaseFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6147
+ };
6148
+ /**
6149
+ * FraudReviewsApi - functional programming interface
6150
+ * @export
6151
+ */
6152
+ export declare const FraudReviewsApiFp: (configuration?: Configuration) => {
6153
+ /**
6154
+ * Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
6155
+ * @summary Block fraud review
6156
+ * @param {string} id The ID of the reward that should be blocked.
6157
+ * @param {*} [options] Override http request option.
6158
+ * @throws {RequiredError}
6159
+ */
6160
+ blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFraudReview200Response>>;
6161
+ /**
6162
+ * 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.
6163
+ * @summary Retrieve single fraud review
6164
+ * @param {string} id The ID of the reward that should be retrieved.
6165
+ * @param {*} [options] Override http request option.
6166
+ * @throws {RequiredError}
6167
+ */
6168
+ getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFraudReview200Response>>;
6169
+ /**
6170
+ * Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
6171
+ * @summary List fraud reviews
6172
+ * @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).
6173
+ * @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
6174
+ * @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be &#x60;flagged&#x60;, &#x60;blocked&#x60; or &#x60;released&#x60;.
6175
+ * @param {string} [createdAtGte] Return results where the created_at field is &gt;&#x3D; to the supplied value. Expects an ISO 8601 datetime.
6176
+ * @param {string} [createdAtLte] Return results where the created_at field is &lt;&#x3D; to the supplied value. Expects an ISO 8601 datetime.
6177
+ * @param {string} [redeemedAtGte] Return results where the redeemed_at field is &gt;&#x3D; the supplied value. Expects an ISO 8601 datetime.
6178
+ * @param {string} [redeemedAtLte] Return results where the redeemed_at field is &lt;&#x3D; the supplied value. Expects an ISO 8601 datetime.
6179
+ * @param {*} [options] Override http request option.
6180
+ * @throws {RequiredError}
6181
+ */
6182
+ listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFraudReviews200Response>>;
6183
+ /**
6184
+ * Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
6185
+ * @summary Release fraud review
6186
+ * @param {string} id The ID of the reward that should be released.
6187
+ * @param {*} [options] Override http request option.
6188
+ * @throws {RequiredError}
6189
+ */
6190
+ releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFraudReview200Response>>;
6191
+ };
6192
+ /**
6193
+ * FraudReviewsApi - factory interface
6194
+ * @export
6195
+ */
6196
+ export declare const FraudReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6197
+ /**
6198
+ * Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
6199
+ * @summary Block fraud review
6200
+ * @param {string} id The ID of the reward that should be blocked.
6201
+ * @param {*} [options] Override http request option.
6202
+ * @throws {RequiredError}
6203
+ */
6204
+ blockFraudReview(id: string, options?: any): AxiosPromise<GetFraudReview200Response>;
6205
+ /**
6206
+ * 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.
6207
+ * @summary Retrieve single fraud review
6208
+ * @param {string} id The ID of the reward that should be retrieved.
6209
+ * @param {*} [options] Override http request option.
6210
+ * @throws {RequiredError}
6211
+ */
6212
+ getFraudReview(id: string, options?: any): AxiosPromise<GetFraudReview200Response>;
6213
+ /**
6214
+ * Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
6215
+ * @summary List fraud reviews
6216
+ * @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).
6217
+ * @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
6218
+ * @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be &#x60;flagged&#x60;, &#x60;blocked&#x60; or &#x60;released&#x60;.
6219
+ * @param {string} [createdAtGte] Return results where the created_at field is &gt;&#x3D; to the supplied value. Expects an ISO 8601 datetime.
6220
+ * @param {string} [createdAtLte] Return results where the created_at field is &lt;&#x3D; to the supplied value. Expects an ISO 8601 datetime.
6221
+ * @param {string} [redeemedAtGte] Return results where the redeemed_at field is &gt;&#x3D; the supplied value. Expects an ISO 8601 datetime.
6222
+ * @param {string} [redeemedAtLte] Return results where the redeemed_at field is &lt;&#x3D; the supplied value. Expects an ISO 8601 datetime.
6223
+ * @param {*} [options] Override http request option.
6224
+ * @throws {RequiredError}
6225
+ */
6226
+ listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: any): AxiosPromise<ListFraudReviews200Response>;
6227
+ /**
6228
+ * Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
6229
+ * @summary Release fraud review
6230
+ * @param {string} id The ID of the reward that should be released.
6231
+ * @param {*} [options] Override http request option.
6232
+ * @throws {RequiredError}
6233
+ */
6234
+ releaseFraudReview(id: string, options?: any): AxiosPromise<GetFraudReview200Response>;
6235
+ };
6236
+ /**
6237
+ * FraudReviewsApi - object-oriented interface
6238
+ * @export
6239
+ * @class FraudReviewsApi
6240
+ * @extends {BaseAPI}
6241
+ */
6242
+ export declare class FraudReviewsApi extends BaseAPI {
6243
+ /**
6244
+ * Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
6245
+ * @summary Block fraud review
6246
+ * @param {string} id The ID of the reward that should be blocked.
6247
+ * @param {*} [options] Override http request option.
6248
+ * @throws {RequiredError}
6249
+ * @memberof FraudReviewsApi
6250
+ */
6251
+ blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFraudReview200Response, any>>;
6252
+ /**
6253
+ * 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.
6254
+ * @summary Retrieve single fraud review
6255
+ * @param {string} id The ID of the reward that should be retrieved.
6256
+ * @param {*} [options] Override http request option.
6257
+ * @throws {RequiredError}
6258
+ * @memberof FraudReviewsApi
6259
+ */
6260
+ getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFraudReview200Response, any>>;
6261
+ /**
6262
+ * Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
6263
+ * @summary List fraud reviews
6264
+ * @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).
6265
+ * @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
6266
+ * @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be &#x60;flagged&#x60;, &#x60;blocked&#x60; or &#x60;released&#x60;.
6267
+ * @param {string} [createdAtGte] Return results where the created_at field is &gt;&#x3D; to the supplied value. Expects an ISO 8601 datetime.
6268
+ * @param {string} [createdAtLte] Return results where the created_at field is &lt;&#x3D; to the supplied value. Expects an ISO 8601 datetime.
6269
+ * @param {string} [redeemedAtGte] Return results where the redeemed_at field is &gt;&#x3D; the supplied value. Expects an ISO 8601 datetime.
6270
+ * @param {string} [redeemedAtLte] Return results where the redeemed_at field is &lt;&#x3D; the supplied value. Expects an ISO 8601 datetime.
6271
+ * @param {*} [options] Override http request option.
6272
+ * @throws {RequiredError}
6273
+ * @memberof FraudReviewsApi
6274
+ */
6275
+ listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFraudReviews200Response, any>>;
6276
+ /**
6277
+ * Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
6278
+ * @summary Release fraud review
6279
+ * @param {string} id The ID of the reward that should be released.
6280
+ * @param {*} [options] Override http request option.
6281
+ * @throws {RequiredError}
6282
+ * @memberof FraudReviewsApi
6283
+ */
6284
+ releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFraudReview200Response, any>>;
6285
+ }
6286
+ /**
6287
+ * @export
6288
+ */
6289
+ export declare const ListFraudReviewsStatusEnum: {
6290
+ readonly Flagged: "flagged";
6291
+ readonly Blocked: "blocked";
6292
+ readonly Released: "released";
6293
+ };
6294
+ export type ListFraudReviewsStatusEnum = typeof ListFraudReviewsStatusEnum[keyof typeof ListFraudReviewsStatusEnum];
6295
+ /**
6296
+ * FraudRulesApi - axios parameter creator
6297
+ * @export
6298
+ */
6299
+ export declare const FraudRulesApiAxiosParamCreator: (configuration?: Configuration) => {
6300
+ /**
6301
+ * Deletes the rule of the type passed in the URL.
6302
+ * @summary Delete fraud rule
6303
+ * @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
6304
+ * @param {*} [options] Override http request option.
6305
+ * @throws {RequiredError}
6306
+ */
6307
+ deleteFraudRule: (ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6308
+ /**
6309
+ * Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
6310
+ * @summary Configure fraud rule
6311
+ * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
6312
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
6313
+ * @param {*} [options] Override http request option.
6314
+ * @throws {RequiredError}
6315
+ */
6316
+ fraudRule: (ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6317
+ /**
6318
+ * List active fraud rules associated with the organization tied to your API key.
6319
+ * @summary List fraud rules
6320
+ * @param {*} [options] Override http request option.
6321
+ * @throws {RequiredError}
6322
+ */
6323
+ listFraudRules: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6324
+ /**
6325
+ * 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\"] } } ```
6326
+ * @summary Update fraud rule list
6327
+ * @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
6328
+ * @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
6329
+ * @param {*} [options] Override http request option.
6330
+ * @throws {RequiredError}
6331
+ */
6332
+ updateFraudRuleList: (ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6333
+ };
6334
+ /**
6335
+ * FraudRulesApi - functional programming interface
6336
+ * @export
6337
+ */
6338
+ export declare const FraudRulesApiFp: (configuration?: Configuration) => {
6339
+ /**
6340
+ * Deletes the rule of the type passed in the URL.
6341
+ * @summary Delete fraud rule
6342
+ * @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
6343
+ * @param {*} [options] Override http request option.
6344
+ * @throws {RequiredError}
6345
+ */
6346
+ deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFraudRule200Response>>;
6347
+ /**
6348
+ * Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
6349
+ * @summary Configure fraud rule
6350
+ * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
6351
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
6352
+ * @param {*} [options] Override http request option.
6353
+ * @throws {RequiredError}
6354
+ */
6355
+ fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FraudRule200Response>>;
6356
+ /**
6357
+ * List active fraud rules associated with the organization tied to your API key.
6358
+ * @summary List fraud rules
6359
+ * @param {*} [options] Override http request option.
6360
+ * @throws {RequiredError}
6361
+ */
6362
+ listFraudRules(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFraudRules200Response>>;
6363
+ /**
6364
+ * 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\"] } } ```
6365
+ * @summary Update fraud rule list
6366
+ * @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
6367
+ * @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
6368
+ * @param {*} [options] Override http request option.
6369
+ * @throws {RequiredError}
6370
+ */
6371
+ updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFraudRuleList200Response>>;
6372
+ };
6373
+ /**
6374
+ * FraudRulesApi - factory interface
6375
+ * @export
6376
+ */
6377
+ export declare const FraudRulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6378
+ /**
6379
+ * Deletes the rule of the type passed in the URL.
6380
+ * @summary Delete fraud rule
6381
+ * @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
6382
+ * @param {*} [options] Override http request option.
6383
+ * @throws {RequiredError}
6384
+ */
6385
+ deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: any): AxiosPromise<DeleteFraudRule200Response>;
6386
+ /**
6387
+ * Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
6388
+ * @summary Configure fraud rule
6389
+ * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
6390
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
6391
+ * @param {*} [options] Override http request option.
6392
+ * @throws {RequiredError}
6393
+ */
6394
+ fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: any): AxiosPromise<FraudRule200Response>;
6395
+ /**
6396
+ * List active fraud rules associated with the organization tied to your API key.
6397
+ * @summary List fraud rules
6398
+ * @param {*} [options] Override http request option.
6399
+ * @throws {RequiredError}
6400
+ */
6401
+ listFraudRules(options?: any): AxiosPromise<ListFraudRules200Response>;
6402
+ /**
6403
+ * 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\"] } } ```
6404
+ * @summary Update fraud rule list
6405
+ * @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
6406
+ * @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
6407
+ * @param {*} [options] Override http request option.
6408
+ * @throws {RequiredError}
6409
+ */
6410
+ updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: any): AxiosPromise<UpdateFraudRuleList200Response>;
6411
+ };
6412
+ /**
6413
+ * FraudRulesApi - object-oriented interface
6414
+ * @export
6415
+ * @class FraudRulesApi
6416
+ * @extends {BaseAPI}
6417
+ */
6418
+ export declare class FraudRulesApi extends BaseAPI {
6419
+ /**
6420
+ * Deletes the rule of the type passed in the URL.
6421
+ * @summary Delete fraud rule
6422
+ * @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
6423
+ * @param {*} [options] Override http request option.
6424
+ * @throws {RequiredError}
6425
+ * @memberof FraudRulesApi
6426
+ */
6427
+ deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteFraudRule200Response, any>>;
6428
+ /**
6429
+ * Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
6430
+ * @summary Configure fraud rule
6431
+ * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
6432
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
6433
+ * @param {*} [options] Override http request option.
6434
+ * @throws {RequiredError}
6435
+ * @memberof FraudRulesApi
6436
+ */
6437
+ fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FraudRule200Response, any>>;
6438
+ /**
6439
+ * List active fraud rules associated with the organization tied to your API key.
6440
+ * @summary List fraud rules
6441
+ * @param {*} [options] Override http request option.
6442
+ * @throws {RequiredError}
6443
+ * @memberof FraudRulesApi
6444
+ */
6445
+ listFraudRules(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFraudRules200Response, any>>;
6446
+ /**
6447
+ * 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\"] } } ```
6448
+ * @summary Update fraud rule list
6449
+ * @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
6450
+ * @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
6451
+ * @param {*} [options] Override http request option.
6452
+ * @throws {RequiredError}
6453
+ * @memberof FraudRulesApi
6454
+ */
6455
+ updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFraudRuleList200Response, any>>;
6456
+ }
6457
+ /**
6458
+ * @export
6459
+ */
6460
+ export declare const DeleteFraudRuleRuleTypeEnum: {
6461
+ readonly ReviewCountry: "review_country";
6462
+ readonly ReviewIp: "review_ip";
6463
+ readonly ReviewEmail: "review_email";
6464
+ readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
6465
+ readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
6466
+ readonly ReviewMultipleEmails: "review_multiple_emails";
6467
+ readonly ReviewVpn: "review_vpn";
6468
+ readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
6469
+ readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
6470
+ readonly AllowIp: "allow_ip";
6471
+ readonly AllowEmail: "allow_email";
6472
+ };
6473
+ export type DeleteFraudRuleRuleTypeEnum = typeof DeleteFraudRuleRuleTypeEnum[keyof typeof DeleteFraudRuleRuleTypeEnum];
6474
+ /**
6475
+ * @export
6476
+ */
6477
+ export declare const FraudRuleRuleTypeEnum: {
6478
+ readonly ReviewCountry: "review_country";
6479
+ readonly ReviewIp: "review_ip";
6480
+ readonly ReviewEmail: "review_email";
6481
+ readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
6482
+ readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
6483
+ readonly ReviewMultipleEmails: "review_multiple_emails";
6484
+ readonly ReviewVpn: "review_vpn";
6485
+ readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
6486
+ readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
6487
+ readonly AllowIp: "allow_ip";
6488
+ readonly AllowEmail: "allow_email";
6489
+ };
6490
+ export type FraudRuleRuleTypeEnum = typeof FraudRuleRuleTypeEnum[keyof typeof FraudRuleRuleTypeEnum];
6491
+ /**
6492
+ * @export
6493
+ */
6494
+ export declare const UpdateFraudRuleListRuleTypeEnum: {
6495
+ readonly ReviewCountry: "review_country";
6496
+ readonly ReviewIp: "review_ip";
6497
+ readonly ReviewEmail: "review_email";
6498
+ readonly AllowIp: "allow_ip";
6499
+ readonly AllowEmail: "allow_email";
6500
+ };
6501
+ export type UpdateFraudRuleListRuleTypeEnum = typeof UpdateFraudRuleListRuleTypeEnum[keyof typeof UpdateFraudRuleListRuleTypeEnum];
5284
6502
  /**
5285
6503
  * FundingSourcesApi - axios parameter creator
5286
6504
  * @export
@@ -5781,7 +6999,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
5781
6999
  * @param {*} [options] Override http request option.
5782
7000
  * @throws {RequiredError}
5783
7001
  */
5784
- approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder201Response>>;
7002
+ approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder200Response>>;
5785
7003
  /**
5786
7004
  * 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&#39;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
7005
  * @summary Create order
@@ -5797,7 +7015,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
5797
7015
  * @param {*} [options] Override http request option.
5798
7016
  * @throws {RequiredError}
5799
7017
  */
5800
- getOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder201Response>>;
7018
+ getOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder200Response>>;
5801
7019
  /**
5802
7020
  * Retrieve a list of orders
5803
7021
  * @summary List orders
@@ -5818,7 +7036,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
5818
7036
  * @param {*} [options] Override http request option.
5819
7037
  * @throws {RequiredError}
5820
7038
  */
5821
- rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder201Response>>;
7039
+ rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrder200Response>>;
5822
7040
  };
5823
7041
  /**
5824
7042
  * OrdersApi - factory interface
@@ -5832,7 +7050,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
5832
7050
  * @param {*} [options] Override http request option.
5833
7051
  * @throws {RequiredError}
5834
7052
  */
5835
- approveOrder(id: string, options?: any): AxiosPromise<CreateOrder201Response>;
7053
+ approveOrder(id: string, options?: any): AxiosPromise<CreateOrder200Response>;
5836
7054
  /**
5837
7055
  * 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&#39;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
7056
  * @summary Create order
@@ -5848,7 +7066,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
5848
7066
  * @param {*} [options] Override http request option.
5849
7067
  * @throws {RequiredError}
5850
7068
  */
5851
- getOrder(id: string, options?: any): AxiosPromise<CreateOrder201Response>;
7069
+ getOrder(id: string, options?: any): AxiosPromise<CreateOrder200Response>;
5852
7070
  /**
5853
7071
  * Retrieve a list of orders
5854
7072
  * @summary List orders
@@ -5869,7 +7087,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
5869
7087
  * @param {*} [options] Override http request option.
5870
7088
  * @throws {RequiredError}
5871
7089
  */
5872
- rejectOrder(id: string, options?: any): AxiosPromise<CreateOrder201Response>;
7090
+ rejectOrder(id: string, options?: any): AxiosPromise<CreateOrder200Response>;
5873
7091
  };
5874
7092
  /**
5875
7093
  * OrdersApi - object-oriented interface
@@ -5886,7 +7104,7 @@ export declare class OrdersApi extends BaseAPI {
5886
7104
  * @throws {RequiredError}
5887
7105
  * @memberof OrdersApi
5888
7106
  */
5889
- approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder201Response, any>>;
7107
+ approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder200Response, any>>;
5890
7108
  /**
5891
7109
  * 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&#39;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
7110
  * @summary Create order
@@ -5904,7 +7122,7 @@ export declare class OrdersApi extends BaseAPI {
5904
7122
  * @throws {RequiredError}
5905
7123
  * @memberof OrdersApi
5906
7124
  */
5907
- getOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder201Response, any>>;
7125
+ getOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder200Response, any>>;
5908
7126
  /**
5909
7127
  * Retrieve a list of orders
5910
7128
  * @summary List orders
@@ -5927,7 +7145,7 @@ export declare class OrdersApi extends BaseAPI {
5927
7145
  * @throws {RequiredError}
5928
7146
  * @memberof OrdersApi
5929
7147
  */
5930
- rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder201Response, any>>;
7148
+ rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrder200Response, any>>;
5931
7149
  }
5932
7150
  /**
5933
7151
  * OrganizationsApi - axios parameter creator