tremendous 4.13.0 → 4.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -258,8 +258,8 @@ export interface Campaign {
258
258
  'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
259
259
  }
260
260
  export declare const CampaignFeeChargedToEnum: {
261
- readonly Sender: "SENDER";
262
- readonly Recipient: "RECIPIENT";
261
+ readonly Sender: 'SENDER';
262
+ readonly Recipient: 'RECIPIENT';
263
263
  };
264
264
  export type CampaignFeeChargedToEnum = typeof CampaignFeeChargedToEnum[keyof typeof CampaignFeeChargedToEnum];
265
265
  /**
@@ -318,8 +318,8 @@ export interface CampaignBase {
318
318
  'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
319
319
  }
320
320
  export declare const CampaignBaseFeeChargedToEnum: {
321
- readonly Sender: "SENDER";
322
- readonly Recipient: "RECIPIENT";
321
+ readonly Sender: 'SENDER';
322
+ readonly Recipient: 'RECIPIENT';
323
323
  };
324
324
  export type CampaignBaseFeeChargedToEnum = typeof CampaignBaseFeeChargedToEnum[keyof typeof CampaignBaseFeeChargedToEnum];
325
325
  /**
@@ -328,14 +328,14 @@ export type CampaignBaseFeeChargedToEnum = typeof CampaignBaseFeeChargedToEnum[k
328
328
  * @enum {string}
329
329
  */
330
330
  export declare const Channel: {
331
- readonly Ui: "UI";
332
- readonly Api: "API";
333
- readonly Embed: "EMBED";
334
- readonly Decipher: "DECIPHER";
335
- readonly Qualtrics: "QUALTRICS";
336
- readonly Typeform: "TYPEFORM";
337
- readonly SurveyMonkey: "SURVEY MONKEY";
338
- readonly Yotpo: "YOTPO";
331
+ readonly Ui: 'UI';
332
+ readonly Api: 'API';
333
+ readonly Embed: 'EMBED';
334
+ readonly Decipher: 'DECIPHER';
335
+ readonly Qualtrics: 'QUALTRICS';
336
+ readonly Typeform: 'TYPEFORM';
337
+ readonly SurveyMonkey: 'SURVEY MONKEY';
338
+ readonly Yotpo: 'YOTPO';
339
339
  };
340
340
  export type Channel = typeof Channel[keyof typeof Channel];
341
341
  /**
@@ -368,12 +368,6 @@ export interface ConnectedOrganization {
368
368
  * @memberof ConnectedOrganization
369
369
  */
370
370
  'organization'?: ConnectedOrganizationOrganization | null;
371
- /**
372
- *
373
- * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails}
374
- * @memberof ConnectedOrganization
375
- */
376
- 'prefilled_kyb_details'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails | null;
377
371
  }
378
372
  /**
379
373
  *
@@ -474,8 +468,8 @@ export interface ConnectedOrganizationMemberMember {
474
468
  'last_login_at'?: string | null;
475
469
  }
476
470
  export declare const ConnectedOrganizationMemberMemberStatusEnum: {
477
- readonly Registered: "REGISTERED";
478
- readonly Invited: "INVITED";
471
+ readonly Registered: 'REGISTERED';
472
+ readonly Invited: 'INVITED';
479
473
  };
480
474
  export type ConnectedOrganizationMemberMemberStatusEnum = typeof ConnectedOrganizationMemberMemberStatusEnum[keyof typeof ConnectedOrganizationMemberMemberStatusEnum];
481
475
  /**
@@ -502,6 +496,12 @@ export interface ConnectedOrganizationMemberSession {
502
496
  * @memberof ConnectedOrganizationMemberSession
503
497
  */
504
498
  'return_url': string;
499
+ /**
500
+ * The opaque `state` value provided when the session was created, forwarded on the initial OAuth grant redirect. `null` when no value was set.
501
+ * @type {string}
502
+ * @memberof ConnectedOrganizationMemberSession
503
+ */
504
+ 'state'?: string | null;
505
505
  /**
506
506
  * Timestamp of when the session will expire.
507
507
  * @type {string}
@@ -559,9 +559,9 @@ export interface ConnectedOrganizationOrganization {
559
559
  'created_at'?: string;
560
560
  }
561
561
  export declare const ConnectedOrganizationOrganizationStatusEnum: {
562
- readonly Pending: "PENDING";
563
- readonly Approved: "APPROVED";
564
- readonly Rejected: "REJECTED";
562
+ readonly Pending: 'PENDING';
563
+ readonly Approved: 'APPROVED';
564
+ readonly Rejected: 'REJECTED';
565
565
  };
566
566
  export type ConnectedOrganizationOrganizationStatusEnum = typeof ConnectedOrganizationOrganizationStatusEnum[keyof typeof ConnectedOrganizationOrganizationStatusEnum];
567
567
  /**
@@ -577,6 +577,24 @@ export interface CreateApiKey200Response {
577
577
  */
578
578
  'api_key'?: string;
579
579
  }
580
+ /**
581
+ *
582
+ * @export
583
+ * @interface CreateApiKeyRequest
584
+ */
585
+ export interface CreateApiKeyRequest {
586
+ /**
587
+ * The key\'s permission level. `read_write` (the default) can make any request. `read_only` keys can\'t run data-altering requests: they\'re limited to GET requests and non-writing POST requests, like `/reports`. Omit for `read_write`.
588
+ * @type {string}
589
+ * @memberof CreateApiKeyRequest
590
+ */
591
+ 'permission'?: CreateApiKeyRequestPermissionEnum;
592
+ }
593
+ export declare const CreateApiKeyRequestPermissionEnum: {
594
+ readonly ReadWrite: 'read_write';
595
+ readonly ReadOnly: 'read_only';
596
+ };
597
+ export type CreateApiKeyRequestPermissionEnum = typeof CreateApiKeyRequestPermissionEnum[keyof typeof CreateApiKeyRequestPermissionEnum];
580
598
  /**
581
599
  *
582
600
  * @export
@@ -640,8 +658,8 @@ export interface CreateCampaignRequest {
640
658
  'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
641
659
  }
642
660
  export declare const CreateCampaignRequestFeeChargedToEnum: {
643
- readonly Sender: "SENDER";
644
- readonly Recipient: "RECIPIENT";
661
+ readonly Sender: 'SENDER';
662
+ readonly Recipient: 'RECIPIENT';
645
663
  };
646
664
  export type CreateCampaignRequestFeeChargedToEnum = typeof CreateCampaignRequestFeeChargedToEnum[keyof typeof CreateCampaignRequestFeeChargedToEnum];
647
665
  /**
@@ -738,6 +756,12 @@ export interface CreateConnectedOrganizationMemberSession200ResponseConnectedOrg
738
756
  * @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
739
757
  */
740
758
  'return_url': string;
759
+ /**
760
+ * The opaque `state` value provided when the session was created, forwarded on the initial OAuth grant redirect. `null` when no value was set.
761
+ * @type {string}
762
+ * @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
763
+ */
764
+ 'state'?: string | null;
741
765
  /**
742
766
  * Timestamp of when the session will expire.
743
767
  * @type {string}
@@ -763,6 +787,12 @@ export interface CreateConnectedOrganizationMemberSessionRequest {
763
787
  * @memberof CreateConnectedOrganizationMemberSessionRequest
764
788
  */
765
789
  'return_url': string;
790
+ /**
791
+ * Opaque value forwarded unchanged as the OAuth2 `state` parameter on the initial OAuth grant redirect, letting you round-trip per-user context to your registered OAuth `redirect_uri`. Treat it as untrusted since it travels through the end user\'s browser: sign it or use it as a lookup key rather than trusting a raw value, and keep it short. Does not change `return_url` behavior.
792
+ * @type {string}
793
+ * @memberof CreateConnectedOrganizationMemberSessionRequest
794
+ */
795
+ 'state'?: string;
766
796
  }
767
797
  /**
768
798
  *
@@ -778,59 +808,77 @@ export interface CreateConnectedOrganizationRequest {
778
808
  'client_id': string;
779
809
  /**
780
810
  *
781
- * @type {CreateConnectedOrganizationRequestKyb}
811
+ * @type {CreateConnectedOrganizationRequestKybPrefill}
782
812
  * @memberof CreateConnectedOrganizationRequest
783
813
  */
784
- 'kyb'?: CreateConnectedOrganizationRequestKyb;
814
+ 'kyb_prefill'?: CreateConnectedOrganizationRequestKybPrefill;
785
815
  }
786
816
  /**
787
- * Optional KYB details to forward for the end client. When provided, these values pre-fill the end client\'s onboarding form and remain fully editable; the end client still reviews and submits. Every field is optional.
817
+ * Optional KYB details to forward for the end client. When provided, these values prefill the end client\'s onboarding form. Every field is optional.
788
818
  * @export
789
- * @interface CreateConnectedOrganizationRequestKyb
819
+ * @interface CreateConnectedOrganizationRequestKybPrefill
790
820
  */
791
- export interface CreateConnectedOrganizationRequestKyb {
821
+ export interface CreateConnectedOrganizationRequestKybPrefill {
792
822
  /**
793
823
  * The registered legal name of the company.
794
824
  * @type {string}
795
- * @memberof CreateConnectedOrganizationRequestKyb
825
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
796
826
  */
797
827
  'company_name'?: string;
798
828
  /**
799
829
  * The trade name (DBA) the company operates under, if different from its legal name.
800
830
  * @type {string}
801
- * @memberof CreateConnectedOrganizationRequestKyb
831
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
802
832
  */
803
833
  'doing_business_as'?: string;
804
834
  /**
805
- * The company\'s legal entity type. Free-form text any value is accepted to support entity types outside the common presets. Common values are `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`.
835
+ * The company\'s legal entity type. Free-form text; any value is accepted. Common values include `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`.
806
836
  * @type {string}
807
- * @memberof CreateConnectedOrganizationRequestKyb
837
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
808
838
  */
809
839
  'company_structure'?: string;
810
840
  /**
811
841
  * The company\'s tax ID or registration number.
812
842
  * @type {string}
813
- * @memberof CreateConnectedOrganizationRequestKyb
843
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
814
844
  */
815
845
  'company_registration_number'?: string;
816
846
  /**
817
847
  * The ISO 3166-1 alpha-2 country code of the company. Must be a supported country.
818
848
  * @type {string}
819
- * @memberof CreateConnectedOrganizationRequestKyb
849
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
820
850
  */
821
851
  'country_code'?: string;
822
852
  /**
823
853
  * The company\'s website URL. Must be a well-formed URL.
824
854
  * @type {string}
825
- * @memberof CreateConnectedOrganizationRequestKyb
855
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
826
856
  */
827
857
  'website_url'?: string;
828
858
  /**
829
- *
830
- * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress}
831
- * @memberof CreateConnectedOrganizationRequestKyb
859
+ * The company\'s street address.
860
+ * @type {string}
861
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
832
862
  */
833
- 'address'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress;
863
+ 'address_1'?: string;
864
+ /**
865
+ * The company\'s city.
866
+ * @type {string}
867
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
868
+ */
869
+ 'city'?: string;
870
+ /**
871
+ * The company\'s state or province.
872
+ * @type {string}
873
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
874
+ */
875
+ 'state'?: string;
876
+ /**
877
+ * The company\'s ZIP or postal code.
878
+ * @type {string}
879
+ * @memberof CreateConnectedOrganizationRequestKybPrefill
880
+ */
881
+ 'postal_code'?: string;
834
882
  }
835
883
  /**
836
884
  *
@@ -870,16 +918,16 @@ export interface CreateField {
870
918
  'description'?: string;
871
919
  }
872
920
  export declare const CreateFieldDataTypeEnum: {
873
- readonly Checkbox: "Checkbox";
874
- readonly Currency: "Currency";
875
- readonly Date: "Date";
876
- readonly Dropdown: "Dropdown";
877
- readonly Email: "Email";
878
- readonly List: "List";
879
- readonly Number: "Number";
880
- readonly Phone: "Phone";
881
- readonly Text: "Text";
882
- readonly TextArea: "TextArea";
921
+ readonly Checkbox: 'Checkbox';
922
+ readonly Currency: 'Currency';
923
+ readonly Date: 'Date';
924
+ readonly Dropdown: 'Dropdown';
925
+ readonly Email: 'Email';
926
+ readonly List: 'List';
927
+ readonly Number: 'Number';
928
+ readonly Phone: 'Phone';
929
+ readonly Text: 'Text';
930
+ readonly TextArea: 'TextArea';
883
931
  };
884
932
  export type CreateFieldDataTypeEnum = typeof CreateFieldDataTypeEnum[keyof typeof CreateFieldDataTypeEnum];
885
933
  /**
@@ -933,16 +981,16 @@ export interface CreateFieldRequest {
933
981
  'description'?: string;
934
982
  }
935
983
  export declare const CreateFieldRequestDataTypeEnum: {
936
- readonly Checkbox: "Checkbox";
937
- readonly Currency: "Currency";
938
- readonly Date: "Date";
939
- readonly Dropdown: "Dropdown";
940
- readonly Email: "Email";
941
- readonly List: "List";
942
- readonly Number: "Number";
943
- readonly Phone: "Phone";
944
- readonly Text: "Text";
945
- readonly TextArea: "TextArea";
984
+ readonly Checkbox: 'Checkbox';
985
+ readonly Currency: 'Currency';
986
+ readonly Date: 'Date';
987
+ readonly Dropdown: 'Dropdown';
988
+ readonly Email: 'Email';
989
+ readonly List: 'List';
990
+ readonly Number: 'Number';
991
+ readonly Phone: 'Phone';
992
+ readonly Text: 'Text';
993
+ readonly TextArea: 'TextArea';
946
994
  };
947
995
  export type CreateFieldRequestDataTypeEnum = typeof CreateFieldRequestDataTypeEnum[keyof typeof CreateFieldRequestDataTypeEnum];
948
996
  /**
@@ -1010,15 +1058,15 @@ export interface CreateInvoiceRequest {
1010
1058
  'memo'?: string | null;
1011
1059
  }
1012
1060
  export declare const CreateInvoiceRequestCurrencyCodeEnum: {
1013
- readonly Usd: "USD";
1014
- readonly Eur: "EUR";
1015
- readonly Gbp: "GBP";
1061
+ readonly Usd: 'USD';
1062
+ readonly Eur: 'EUR';
1063
+ readonly Gbp: 'GBP';
1016
1064
  };
1017
1065
  export type CreateInvoiceRequestCurrencyCodeEnum = typeof CreateInvoiceRequestCurrencyCodeEnum[keyof typeof CreateInvoiceRequestCurrencyCodeEnum];
1018
1066
  export declare const CreateInvoiceRequestCurrencyEnum: {
1019
- readonly Usd: "USD";
1020
- readonly Eur: "EUR";
1021
- readonly Gbp: "GBP";
1067
+ readonly Usd: 'USD';
1068
+ readonly Eur: 'EUR';
1069
+ readonly Gbp: 'GBP';
1022
1070
  };
1023
1071
  export type CreateInvoiceRequestCurrencyEnum = typeof CreateInvoiceRequestCurrencyEnum[keyof typeof CreateInvoiceRequestCurrencyEnum];
1024
1072
  /**
@@ -1147,24 +1195,24 @@ export interface CreateOrder200ResponseOrder {
1147
1195
  'rewards'?: Array<CreateOrder200ResponseOrderRewardsInner>;
1148
1196
  }
1149
1197
  export declare const CreateOrder200ResponseOrderStatusEnum: {
1150
- readonly Canceled: "CANCELED";
1151
- readonly Open: "OPEN";
1152
- readonly Executed: "EXECUTED";
1153
- readonly Failed: "FAILED";
1154
- readonly PendingApproval: "PENDING APPROVAL";
1155
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
1156
- readonly PendingSettlement: "PENDING SETTLEMENT";
1198
+ readonly Canceled: 'CANCELED';
1199
+ readonly Open: 'OPEN';
1200
+ readonly Executed: 'EXECUTED';
1201
+ readonly Failed: 'FAILED';
1202
+ readonly PendingApproval: 'PENDING APPROVAL';
1203
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
1204
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
1157
1205
  };
1158
1206
  export type CreateOrder200ResponseOrderStatusEnum = typeof CreateOrder200ResponseOrderStatusEnum[keyof typeof CreateOrder200ResponseOrderStatusEnum];
1159
1207
  export declare const CreateOrder200ResponseOrderChannelEnum: {
1160
- readonly Ui: "UI";
1161
- readonly Api: "API";
1162
- readonly Embed: "EMBED";
1163
- readonly Decipher: "DECIPHER";
1164
- readonly Qualtrics: "QUALTRICS";
1165
- readonly Typeform: "TYPEFORM";
1166
- readonly SurveyMonkey: "SURVEY MONKEY";
1167
- readonly Yotpo: "YOTPO";
1208
+ readonly Ui: 'UI';
1209
+ readonly Api: 'API';
1210
+ readonly Embed: 'EMBED';
1211
+ readonly Decipher: 'DECIPHER';
1212
+ readonly Qualtrics: 'QUALTRICS';
1213
+ readonly Typeform: 'TYPEFORM';
1214
+ readonly SurveyMonkey: 'SURVEY MONKEY';
1215
+ readonly Yotpo: 'YOTPO';
1168
1216
  };
1169
1217
  export type CreateOrder200ResponseOrderChannelEnum = typeof CreateOrder200ResponseOrderChannelEnum[keyof typeof CreateOrder200ResponseOrderChannelEnum];
1170
1218
  /**
@@ -1254,16 +1302,16 @@ export interface CreateOrder200ResponseOrderRewardsInnerDelivery {
1254
1302
  'link'?: string;
1255
1303
  }
1256
1304
  export declare const CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum: {
1257
- readonly Email: "EMAIL";
1258
- readonly Link: "LINK";
1259
- readonly Phone: "PHONE";
1305
+ readonly Email: 'EMAIL';
1306
+ readonly Link: 'LINK';
1307
+ readonly Phone: 'PHONE';
1260
1308
  };
1261
1309
  export type CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum = typeof CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum[keyof typeof CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum];
1262
1310
  export declare const CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum: {
1263
- readonly Scheduled: "SCHEDULED";
1264
- readonly Failed: "FAILED";
1265
- readonly Succeeded: "SUCCEEDED";
1266
- readonly Pending: "PENDING";
1311
+ readonly Scheduled: 'SCHEDULED';
1312
+ readonly Failed: 'FAILED';
1313
+ readonly Succeeded: 'SUCCEEDED';
1314
+ readonly Pending: 'PENDING';
1267
1315
  };
1268
1316
  export type CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum = typeof CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum[keyof typeof CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum];
1269
1317
  /**
@@ -1665,10 +1713,10 @@ export interface CreateReport200ResponseReport {
1665
1713
  'url'?: string | null;
1666
1714
  }
1667
1715
  export declare const CreateReport200ResponseReportStatusEnum: {
1668
- readonly Created: "CREATED";
1669
- readonly Processing: "PROCESSING";
1670
- readonly ReadyForDownload: "READY_FOR_DOWNLOAD";
1671
- readonly Failed: "FAILED";
1716
+ readonly Created: 'CREATED';
1717
+ readonly Processing: 'PROCESSING';
1718
+ readonly ReadyForDownload: 'READY_FOR_DOWNLOAD';
1719
+ readonly Failed: 'FAILED';
1672
1720
  };
1673
1721
  export type CreateReport200ResponseReportStatusEnum = typeof CreateReport200ResponseReportStatusEnum[keyof typeof CreateReport200ResponseReportStatusEnum];
1674
1722
  /**
@@ -1697,11 +1745,11 @@ export interface CreateReportRequest {
1697
1745
  'filters'?: CreateReportRequestFilters | null;
1698
1746
  }
1699
1747
  export declare const CreateReportRequestReportTypeEnum: {
1700
- readonly DigitalRewards: "digital_rewards";
1748
+ readonly DigitalRewards: 'digital_rewards';
1701
1749
  };
1702
1750
  export type CreateReportRequestReportTypeEnum = typeof CreateReportRequestReportTypeEnum[keyof typeof CreateReportRequestReportTypeEnum];
1703
1751
  export declare const CreateReportRequestFormatEnum: {
1704
- readonly Csv: "csv";
1752
+ readonly Csv: 'csv';
1705
1753
  };
1706
1754
  export type CreateReportRequestFormatEnum = typeof CreateReportRequestFormatEnum[keyof typeof CreateReportRequestFormatEnum];
1707
1755
  /**
@@ -1773,25 +1821,25 @@ export interface CreateReportRequestFiltersDigitalRewards {
1773
1821
  'status'?: Array<CreateReportRequestFiltersDigitalRewardsStatusEnum> | null;
1774
1822
  }
1775
1823
  export declare const CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum: {
1776
- readonly Phone: "phone";
1777
- readonly Email: "email";
1778
- readonly Link: "link";
1779
- readonly Mail: "mail";
1780
- readonly Direct: "direct";
1824
+ readonly Phone: 'phone';
1825
+ readonly Email: 'email';
1826
+ readonly Link: 'link';
1827
+ readonly Mail: 'mail';
1828
+ readonly Direct: 'direct';
1781
1829
  };
1782
1830
  export type CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum = typeof CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum];
1783
1831
  export declare const CreateReportRequestFiltersDigitalRewardsOrderStatusEnum: {
1784
- readonly Executed: "executed";
1785
- readonly Canceled: "canceled";
1786
- readonly Failed: "failed";
1787
- readonly PendingApproval: "pending_approval";
1832
+ readonly Executed: 'executed';
1833
+ readonly Canceled: 'canceled';
1834
+ readonly Failed: 'failed';
1835
+ readonly PendingApproval: 'pending_approval';
1788
1836
  };
1789
1837
  export type CreateReportRequestFiltersDigitalRewardsOrderStatusEnum = typeof CreateReportRequestFiltersDigitalRewardsOrderStatusEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsOrderStatusEnum];
1790
1838
  export declare const CreateReportRequestFiltersDigitalRewardsStatusEnum: {
1791
- readonly Delivered: "delivered";
1792
- readonly Canceled: "canceled";
1793
- readonly DeliveryFailed: "delivery_failed";
1794
- readonly PendingReview: "pending_review";
1839
+ readonly Delivered: 'delivered';
1840
+ readonly Canceled: 'canceled';
1841
+ readonly DeliveryFailed: 'delivery_failed';
1842
+ readonly PendingReview: 'pending_review';
1795
1843
  };
1796
1844
  export type CreateReportRequestFiltersDigitalRewardsStatusEnum = typeof CreateReportRequestFiltersDigitalRewardsStatusEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsStatusEnum];
1797
1845
  /**
@@ -1902,117 +1950,117 @@ export interface CreateWebhookRequest {
1902
1950
  * @enum {string}
1903
1951
  */
1904
1952
  export declare const CurrencyCodes: {
1905
- readonly Usd: "USD";
1906
- readonly Cad: "CAD";
1907
- readonly Eur: "EUR";
1908
- readonly Aed: "AED";
1909
- readonly Afn: "AFN";
1910
- readonly All: "ALL";
1911
- readonly Amd: "AMD";
1912
- readonly Ars: "ARS";
1913
- readonly Aud: "AUD";
1914
- readonly Azn: "AZN";
1915
- readonly Bam: "BAM";
1916
- readonly Bdt: "BDT";
1917
- readonly Bhd: "BHD";
1918
- readonly Bif: "BIF";
1919
- readonly Bnd: "BND";
1920
- readonly Bob: "BOB";
1921
- readonly Brl: "BRL";
1922
- readonly Bwp: "BWP";
1923
- readonly Byn: "BYN";
1924
- readonly Bzd: "BZD";
1925
- readonly Cdf: "CDF";
1926
- readonly Chf: "CHF";
1927
- readonly Clp: "CLP";
1928
- readonly Cny: "CNY";
1929
- readonly Cop: "COP";
1930
- readonly Crc: "CRC";
1931
- readonly Cve: "CVE";
1932
- readonly Czk: "CZK";
1933
- readonly Djf: "DJF";
1934
- readonly Dkk: "DKK";
1935
- readonly Dop: "DOP";
1936
- readonly Dzd: "DZD";
1937
- readonly Egp: "EGP";
1938
- readonly Ern: "ERN";
1939
- readonly Etb: "ETB";
1940
- readonly Gbp: "GBP";
1941
- readonly Gel: "GEL";
1942
- readonly Ghs: "GHS";
1943
- readonly Gnf: "GNF";
1944
- readonly Gtq: "GTQ";
1945
- readonly Hkd: "HKD";
1946
- readonly Hnl: "HNL";
1947
- readonly Hrk: "HRK";
1948
- readonly Huf: "HUF";
1949
- readonly Idr: "IDR";
1950
- readonly Ils: "ILS";
1951
- readonly Inr: "INR";
1952
- readonly Iqd: "IQD";
1953
- readonly Irr: "IRR";
1954
- readonly Isk: "ISK";
1955
- readonly Jmd: "JMD";
1956
- readonly Jod: "JOD";
1957
- readonly Jpy: "JPY";
1958
- readonly Kes: "KES";
1959
- readonly Khr: "KHR";
1960
- readonly Krw: "KRW";
1961
- readonly Kwd: "KWD";
1962
- readonly Kzt: "KZT";
1963
- readonly Lbp: "LBP";
1964
- readonly Lkr: "LKR";
1965
- readonly Mad: "MAD";
1966
- readonly Mdl: "MDL";
1967
- readonly Mga: "MGA";
1968
- readonly Mkd: "MKD";
1969
- readonly Mmk: "MMK";
1970
- readonly Mop: "MOP";
1971
- readonly Mur: "MUR";
1972
- readonly Mxn: "MXN";
1973
- readonly Myr: "MYR";
1974
- readonly Mzn: "MZN";
1975
- readonly Nad: "NAD";
1976
- readonly Ngn: "NGN";
1977
- readonly Nio: "NIO";
1978
- readonly Nok: "NOK";
1979
- readonly Npr: "NPR";
1980
- readonly Nzd: "NZD";
1981
- readonly Omr: "OMR";
1982
- readonly Pab: "PAB";
1983
- readonly Pen: "PEN";
1984
- readonly Php: "PHP";
1985
- readonly Pkr: "PKR";
1986
- readonly Pln: "PLN";
1987
- readonly Pyg: "PYG";
1988
- readonly Qar: "QAR";
1989
- readonly Ron: "RON";
1990
- readonly Rsd: "RSD";
1991
- readonly Rub: "RUB";
1992
- readonly Rwf: "RWF";
1993
- readonly Sar: "SAR";
1994
- readonly Sdg: "SDG";
1995
- readonly Sek: "SEK";
1996
- readonly Sgd: "SGD";
1997
- readonly Sos: "SOS";
1998
- readonly Syp: "SYP";
1999
- readonly Thb: "THB";
2000
- readonly Tnd: "TND";
2001
- readonly Top: "TOP";
2002
- readonly Try: "TRY";
2003
- readonly Ttd: "TTD";
2004
- readonly Twd: "TWD";
2005
- readonly Tzs: "TZS";
2006
- readonly Uah: "UAH";
2007
- readonly Ugx: "UGX";
2008
- readonly Uyu: "UYU";
2009
- readonly Uzs: "UZS";
2010
- readonly Vef: "VEF";
2011
- readonly Vnd: "VND";
2012
- readonly Xaf: "XAF";
2013
- readonly Xof: "XOF";
2014
- readonly Yer: "YER";
2015
- readonly Zar: "ZAR";
1953
+ readonly Usd: 'USD';
1954
+ readonly Cad: 'CAD';
1955
+ readonly Eur: 'EUR';
1956
+ readonly Aed: 'AED';
1957
+ readonly Afn: 'AFN';
1958
+ readonly All: 'ALL';
1959
+ readonly Amd: 'AMD';
1960
+ readonly Ars: 'ARS';
1961
+ readonly Aud: 'AUD';
1962
+ readonly Azn: 'AZN';
1963
+ readonly Bam: 'BAM';
1964
+ readonly Bdt: 'BDT';
1965
+ readonly Bhd: 'BHD';
1966
+ readonly Bif: 'BIF';
1967
+ readonly Bnd: 'BND';
1968
+ readonly Bob: 'BOB';
1969
+ readonly Brl: 'BRL';
1970
+ readonly Bwp: 'BWP';
1971
+ readonly Byn: 'BYN';
1972
+ readonly Bzd: 'BZD';
1973
+ readonly Cdf: 'CDF';
1974
+ readonly Chf: 'CHF';
1975
+ readonly Clp: 'CLP';
1976
+ readonly Cny: 'CNY';
1977
+ readonly Cop: 'COP';
1978
+ readonly Crc: 'CRC';
1979
+ readonly Cve: 'CVE';
1980
+ readonly Czk: 'CZK';
1981
+ readonly Djf: 'DJF';
1982
+ readonly Dkk: 'DKK';
1983
+ readonly Dop: 'DOP';
1984
+ readonly Dzd: 'DZD';
1985
+ readonly Egp: 'EGP';
1986
+ readonly Ern: 'ERN';
1987
+ readonly Etb: 'ETB';
1988
+ readonly Gbp: 'GBP';
1989
+ readonly Gel: 'GEL';
1990
+ readonly Ghs: 'GHS';
1991
+ readonly Gnf: 'GNF';
1992
+ readonly Gtq: 'GTQ';
1993
+ readonly Hkd: 'HKD';
1994
+ readonly Hnl: 'HNL';
1995
+ readonly Hrk: 'HRK';
1996
+ readonly Huf: 'HUF';
1997
+ readonly Idr: 'IDR';
1998
+ readonly Ils: 'ILS';
1999
+ readonly Inr: 'INR';
2000
+ readonly Iqd: 'IQD';
2001
+ readonly Irr: 'IRR';
2002
+ readonly Isk: 'ISK';
2003
+ readonly Jmd: 'JMD';
2004
+ readonly Jod: 'JOD';
2005
+ readonly Jpy: 'JPY';
2006
+ readonly Kes: 'KES';
2007
+ readonly Khr: 'KHR';
2008
+ readonly Krw: 'KRW';
2009
+ readonly Kwd: 'KWD';
2010
+ readonly Kzt: 'KZT';
2011
+ readonly Lbp: 'LBP';
2012
+ readonly Lkr: 'LKR';
2013
+ readonly Mad: 'MAD';
2014
+ readonly Mdl: 'MDL';
2015
+ readonly Mga: 'MGA';
2016
+ readonly Mkd: 'MKD';
2017
+ readonly Mmk: 'MMK';
2018
+ readonly Mop: 'MOP';
2019
+ readonly Mur: 'MUR';
2020
+ readonly Mxn: 'MXN';
2021
+ readonly Myr: 'MYR';
2022
+ readonly Mzn: 'MZN';
2023
+ readonly Nad: 'NAD';
2024
+ readonly Ngn: 'NGN';
2025
+ readonly Nio: 'NIO';
2026
+ readonly Nok: 'NOK';
2027
+ readonly Npr: 'NPR';
2028
+ readonly Nzd: 'NZD';
2029
+ readonly Omr: 'OMR';
2030
+ readonly Pab: 'PAB';
2031
+ readonly Pen: 'PEN';
2032
+ readonly Php: 'PHP';
2033
+ readonly Pkr: 'PKR';
2034
+ readonly Pln: 'PLN';
2035
+ readonly Pyg: 'PYG';
2036
+ readonly Qar: 'QAR';
2037
+ readonly Ron: 'RON';
2038
+ readonly Rsd: 'RSD';
2039
+ readonly Rub: 'RUB';
2040
+ readonly Rwf: 'RWF';
2041
+ readonly Sar: 'SAR';
2042
+ readonly Sdg: 'SDG';
2043
+ readonly Sek: 'SEK';
2044
+ readonly Sgd: 'SGD';
2045
+ readonly Sos: 'SOS';
2046
+ readonly Syp: 'SYP';
2047
+ readonly Thb: 'THB';
2048
+ readonly Tnd: 'TND';
2049
+ readonly Top: 'TOP';
2050
+ readonly Try: 'TRY';
2051
+ readonly Ttd: 'TTD';
2052
+ readonly Twd: 'TWD';
2053
+ readonly Tzs: 'TZS';
2054
+ readonly Uah: 'UAH';
2055
+ readonly Ugx: 'UGX';
2056
+ readonly Uyu: 'UYU';
2057
+ readonly Uzs: 'UZS';
2058
+ readonly Vef: 'VEF';
2059
+ readonly Vnd: 'VND';
2060
+ readonly Xaf: 'XAF';
2061
+ readonly Xof: 'XOF';
2062
+ readonly Yer: 'YER';
2063
+ readonly Zar: 'ZAR';
2016
2064
  };
2017
2065
  export type CurrencyCodes = typeof CurrencyCodes[keyof typeof CurrencyCodes];
2018
2066
  /**
@@ -2073,16 +2121,16 @@ export interface DeliveryDetails {
2073
2121
  'status'?: DeliveryDetailsStatusEnum;
2074
2122
  }
2075
2123
  export declare const DeliveryDetailsMethodEnum: {
2076
- readonly Email: "EMAIL";
2077
- readonly Link: "LINK";
2078
- readonly Phone: "PHONE";
2124
+ readonly Email: 'EMAIL';
2125
+ readonly Link: 'LINK';
2126
+ readonly Phone: 'PHONE';
2079
2127
  };
2080
2128
  export type DeliveryDetailsMethodEnum = typeof DeliveryDetailsMethodEnum[keyof typeof DeliveryDetailsMethodEnum];
2081
2129
  export declare const DeliveryDetailsStatusEnum: {
2082
- readonly Scheduled: "SCHEDULED";
2083
- readonly Failed: "FAILED";
2084
- readonly Succeeded: "SUCCEEDED";
2085
- readonly Pending: "PENDING";
2130
+ readonly Scheduled: 'SCHEDULED';
2131
+ readonly Failed: 'FAILED';
2132
+ readonly Succeeded: 'SUCCEEDED';
2133
+ readonly Pending: 'PENDING';
2086
2134
  };
2087
2135
  export type DeliveryDetailsStatusEnum = typeof DeliveryDetailsStatusEnum[keyof typeof DeliveryDetailsStatusEnum];
2088
2136
  /**
@@ -2111,16 +2159,16 @@ export interface DeliveryDetailsWithLink {
2111
2159
  'link'?: string;
2112
2160
  }
2113
2161
  export declare const DeliveryDetailsWithLinkMethodEnum: {
2114
- readonly Email: "EMAIL";
2115
- readonly Link: "LINK";
2116
- readonly Phone: "PHONE";
2162
+ readonly Email: 'EMAIL';
2163
+ readonly Link: 'LINK';
2164
+ readonly Phone: 'PHONE';
2117
2165
  };
2118
2166
  export type DeliveryDetailsWithLinkMethodEnum = typeof DeliveryDetailsWithLinkMethodEnum[keyof typeof DeliveryDetailsWithLinkMethodEnum];
2119
2167
  export declare const DeliveryDetailsWithLinkStatusEnum: {
2120
- readonly Scheduled: "SCHEDULED";
2121
- readonly Failed: "FAILED";
2122
- readonly Succeeded: "SUCCEEDED";
2123
- readonly Pending: "PENDING";
2168
+ readonly Scheduled: 'SCHEDULED';
2169
+ readonly Failed: 'FAILED';
2170
+ readonly Succeeded: 'SUCCEEDED';
2171
+ readonly Pending: 'PENDING';
2124
2172
  };
2125
2173
  export type DeliveryDetailsWithLinkStatusEnum = typeof DeliveryDetailsWithLinkStatusEnum[keyof typeof DeliveryDetailsWithLinkStatusEnum];
2126
2174
  /**
@@ -2154,9 +2202,9 @@ export interface DeliveryMetadata {
2154
2202
  * @enum {string}
2155
2203
  */
2156
2204
  export declare const DeliveryMethod: {
2157
- readonly Email: "EMAIL";
2158
- readonly Link: "LINK";
2159
- readonly Phone: "PHONE";
2205
+ readonly Email: 'EMAIL';
2206
+ readonly Link: 'LINK';
2207
+ readonly Phone: 'PHONE';
2160
2208
  };
2161
2209
  export type DeliveryMethod = typeof DeliveryMethod[keyof typeof DeliveryMethod];
2162
2210
  /**
@@ -2165,10 +2213,10 @@ export type DeliveryMethod = typeof DeliveryMethod[keyof typeof DeliveryMethod];
2165
2213
  * @enum {string}
2166
2214
  */
2167
2215
  export declare const DeliveryStatus: {
2168
- readonly Scheduled: "SCHEDULED";
2169
- readonly Failed: "FAILED";
2170
- readonly Succeeded: "SUCCEEDED";
2171
- readonly Pending: "PENDING";
2216
+ readonly Scheduled: 'SCHEDULED';
2217
+ readonly Failed: 'FAILED';
2218
+ readonly Succeeded: 'SUCCEEDED';
2219
+ readonly Pending: 'PENDING';
2172
2220
  };
2173
2221
  export type DeliveryStatus = typeof DeliveryStatus[keyof typeof DeliveryStatus];
2174
2222
  /**
@@ -2234,16 +2282,16 @@ export interface Field {
2234
2282
  'scope'?: string;
2235
2283
  }
2236
2284
  export declare const FieldDataTypeEnum: {
2237
- readonly Checkbox: "Checkbox";
2238
- readonly Currency: "Currency";
2239
- readonly Date: "Date";
2240
- readonly Dropdown: "Dropdown";
2241
- readonly Email: "Email";
2242
- readonly List: "List";
2243
- readonly Number: "Number";
2244
- readonly Phone: "Phone";
2245
- readonly Text: "Text";
2246
- readonly TextArea: "TextArea";
2285
+ readonly Checkbox: 'Checkbox';
2286
+ readonly Currency: 'Currency';
2287
+ readonly Date: 'Date';
2288
+ readonly Dropdown: 'Dropdown';
2289
+ readonly Email: 'Email';
2290
+ readonly List: 'List';
2291
+ readonly Number: 'Number';
2292
+ readonly Phone: 'Phone';
2293
+ readonly Text: 'Text';
2294
+ readonly TextArea: 'TextArea';
2247
2295
  };
2248
2296
  export type FieldDataTypeEnum = typeof FieldDataTypeEnum[keyof typeof FieldDataTypeEnum];
2249
2297
  /**
@@ -2279,8 +2327,8 @@ export interface FraudConfigCountry {
2279
2327
  'countries': Array<string>;
2280
2328
  }
2281
2329
  export declare const FraudConfigCountryTypeEnum: {
2282
- readonly Whitelist: "whitelist";
2283
- readonly Blacklist: "blacklist";
2330
+ readonly Whitelist: 'whitelist';
2331
+ readonly Blacklist: 'blacklist';
2284
2332
  };
2285
2333
  export type FraudConfigCountryTypeEnum = typeof FraudConfigCountryTypeEnum[keyof typeof FraudConfigCountryTypeEnum];
2286
2334
  /**
@@ -2329,12 +2377,12 @@ export interface FraudConfigRedeemedRewardsAmount {
2329
2377
  'period': FraudConfigRedeemedRewardsAmountPeriodEnum;
2330
2378
  }
2331
2379
  export declare const FraudConfigRedeemedRewardsAmountPeriodEnum: {
2332
- readonly _7: "7";
2333
- readonly _30: "30";
2334
- readonly _90: "90";
2335
- readonly _120: "120";
2336
- readonly _365: "365";
2337
- readonly AllTime: "all_time";
2380
+ readonly _7: '7';
2381
+ readonly _30: '30';
2382
+ readonly _90: '90';
2383
+ readonly _120: '120';
2384
+ readonly _365: '365';
2385
+ readonly AllTime: 'all_time';
2338
2386
  };
2339
2387
  export type FraudConfigRedeemedRewardsAmountPeriodEnum = typeof FraudConfigRedeemedRewardsAmountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsAmountPeriodEnum];
2340
2388
  /**
@@ -2357,12 +2405,12 @@ export interface FraudConfigRedeemedRewardsCount {
2357
2405
  'period': FraudConfigRedeemedRewardsCountPeriodEnum;
2358
2406
  }
2359
2407
  export declare const FraudConfigRedeemedRewardsCountPeriodEnum: {
2360
- readonly _7: "7";
2361
- readonly _30: "30";
2362
- readonly _90: "90";
2363
- readonly _120: "120";
2364
- readonly _365: "365";
2365
- readonly AllTime: "all_time";
2408
+ readonly _7: '7';
2409
+ readonly _30: '30';
2410
+ readonly _90: '90';
2411
+ readonly _120: '120';
2412
+ readonly _365: '365';
2413
+ readonly AllTime: 'all_time';
2366
2414
  };
2367
2415
  export type FraudConfigRedeemedRewardsCountPeriodEnum = typeof FraudConfigRedeemedRewardsCountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsCountPeriodEnum];
2368
2416
  /**
@@ -2490,53 +2538,53 @@ export interface FraudReview {
2490
2538
  'related_rewards'?: FraudReviewRelatedRewards;
2491
2539
  }
2492
2540
  export declare const FraudReviewStatusEnum: {
2493
- readonly Flagged: "flagged";
2494
- readonly Blocked: "blocked";
2495
- readonly Released: "released";
2541
+ readonly Flagged: 'flagged';
2542
+ readonly Blocked: 'blocked';
2543
+ readonly Released: 'released';
2496
2544
  };
2497
2545
  export type FraudReviewStatusEnum = typeof FraudReviewStatusEnum[keyof typeof FraudReviewStatusEnum];
2498
2546
  export declare const FraudReviewReasonsEnum: {
2499
- readonly DisallowedIp: "Disallowed IP";
2500
- readonly DisallowedEmail: "Disallowed email";
2501
- readonly DisallowedCountry: "Disallowed country";
2502
- readonly OverRewardAmountLimit: "Over reward amount limit";
2503
- readonly OverRewardCountLimit: "Over reward count limit";
2504
- readonly VpnDetected: "VPN detected";
2505
- readonly ApplePrivateRelay: "Apple Private Relay";
2506
- readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2507
- readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2508
- readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
2509
- readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
2510
- readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
2511
- readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
2512
- readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
2513
- readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list";
2514
- readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
2515
- readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
2516
- readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
2517
- readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
2518
- readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
2519
- readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
2520
- readonly AllowedIp: "Allowed IP";
2521
- readonly AllowedEmail: "Allowed email";
2522
- readonly AllowedCountry: "Allowed country";
2547
+ readonly DisallowedIp: 'Disallowed IP';
2548
+ readonly DisallowedEmail: 'Disallowed email';
2549
+ readonly DisallowedCountry: 'Disallowed country';
2550
+ readonly OverRewardAmountLimit: 'Over reward amount limit';
2551
+ readonly OverRewardCountLimit: 'Over reward count limit';
2552
+ readonly VpnDetected: 'VPN detected';
2553
+ readonly ApplePrivateRelay: 'Apple Private Relay';
2554
+ readonly DeviceRelatedToMultipleEmails: 'Device related to multiple emails';
2555
+ readonly DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails';
2556
+ readonly IpOnATremendousFraudList: 'IP on a Tremendous fraud list';
2557
+ readonly BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list';
2558
+ readonly FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list';
2559
+ readonly EmailOnATremendousFraudList: 'Email on a Tremendous fraud list';
2560
+ readonly PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list';
2561
+ readonly DeviceOnATremendousFraudList: 'Device on a Tremendous fraud list';
2562
+ readonly IpRelatedToABlockedReward: 'IP related to a blocked reward';
2563
+ readonly DeviceRelatedToABlockedReward: 'Device related to a blocked reward';
2564
+ readonly BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward';
2565
+ readonly FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward';
2566
+ readonly EmailRelatedToABlockedReward: 'Email related to a blocked reward';
2567
+ readonly PhoneRelatedToABlockedReward: 'Phone related to a blocked reward';
2568
+ readonly AllowedIp: 'Allowed IP';
2569
+ readonly AllowedEmail: 'Allowed email';
2570
+ readonly AllowedCountry: 'Allowed country';
2523
2571
  };
2524
2572
  export type FraudReviewReasonsEnum = typeof FraudReviewReasonsEnum[keyof typeof FraudReviewReasonsEnum];
2525
2573
  export declare const FraudReviewRedemptionMethodEnum: {
2526
- readonly BankTransfer: "bank transfer";
2527
- readonly Charity: "charity";
2528
- readonly InstantDebitTransfer: "instant debit transfer";
2529
- readonly InternationalBankTransfer: "international bank transfer";
2530
- readonly MerchantCard: "merchant card";
2531
- readonly Paypal: "paypal";
2532
- readonly Venmo: "venmo";
2533
- readonly VisaCard: "visa card";
2574
+ readonly BankTransfer: 'bank transfer';
2575
+ readonly Charity: 'charity';
2576
+ readonly InstantDebitTransfer: 'instant debit transfer';
2577
+ readonly InternationalBankTransfer: 'international bank transfer';
2578
+ readonly MerchantCard: 'merchant card';
2579
+ readonly Paypal: 'paypal';
2580
+ readonly Venmo: 'venmo';
2581
+ readonly VisaCard: 'visa card';
2534
2582
  };
2535
2583
  export type FraudReviewRedemptionMethodEnum = typeof FraudReviewRedemptionMethodEnum[keyof typeof FraudReviewRedemptionMethodEnum];
2536
2584
  export declare const FraudReviewRiskEnum: {
2537
- readonly High: "high";
2538
- readonly Medium: "medium";
2539
- readonly Low: "low";
2585
+ readonly High: 'high';
2586
+ readonly Medium: 'medium';
2587
+ readonly Low: 'low';
2540
2588
  };
2541
2589
  export type FraudReviewRiskEnum = typeof FraudReviewRiskEnum[keyof typeof FraudReviewRiskEnum];
2542
2590
  /**
@@ -2607,47 +2655,47 @@ export interface FraudReviewBase {
2607
2655
  'redemption_method_account_hash'?: string;
2608
2656
  }
2609
2657
  export declare const FraudReviewBaseStatusEnum: {
2610
- readonly Flagged: "flagged";
2611
- readonly Blocked: "blocked";
2612
- readonly Released: "released";
2658
+ readonly Flagged: 'flagged';
2659
+ readonly Blocked: 'blocked';
2660
+ readonly Released: 'released';
2613
2661
  };
2614
2662
  export type FraudReviewBaseStatusEnum = typeof FraudReviewBaseStatusEnum[keyof typeof FraudReviewBaseStatusEnum];
2615
2663
  export declare const FraudReviewBaseReasonsEnum: {
2616
- readonly DisallowedIp: "Disallowed IP";
2617
- readonly DisallowedEmail: "Disallowed email";
2618
- readonly DisallowedCountry: "Disallowed country";
2619
- readonly OverRewardAmountLimit: "Over reward amount limit";
2620
- readonly OverRewardCountLimit: "Over reward count limit";
2621
- readonly VpnDetected: "VPN detected";
2622
- readonly ApplePrivateRelay: "Apple Private Relay";
2623
- readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2624
- readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2625
- readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
2626
- readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
2627
- readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
2628
- readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
2629
- readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
2630
- readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list";
2631
- readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
2632
- readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
2633
- readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
2634
- readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
2635
- readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
2636
- readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
2637
- readonly AllowedIp: "Allowed IP";
2638
- readonly AllowedEmail: "Allowed email";
2639
- readonly AllowedCountry: "Allowed country";
2664
+ readonly DisallowedIp: 'Disallowed IP';
2665
+ readonly DisallowedEmail: 'Disallowed email';
2666
+ readonly DisallowedCountry: 'Disallowed country';
2667
+ readonly OverRewardAmountLimit: 'Over reward amount limit';
2668
+ readonly OverRewardCountLimit: 'Over reward count limit';
2669
+ readonly VpnDetected: 'VPN detected';
2670
+ readonly ApplePrivateRelay: 'Apple Private Relay';
2671
+ readonly DeviceRelatedToMultipleEmails: 'Device related to multiple emails';
2672
+ readonly DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails';
2673
+ readonly IpOnATremendousFraudList: 'IP on a Tremendous fraud list';
2674
+ readonly BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list';
2675
+ readonly FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list';
2676
+ readonly EmailOnATremendousFraudList: 'Email on a Tremendous fraud list';
2677
+ readonly PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list';
2678
+ readonly DeviceOnATremendousFraudList: 'Device on a Tremendous fraud list';
2679
+ readonly IpRelatedToABlockedReward: 'IP related to a blocked reward';
2680
+ readonly DeviceRelatedToABlockedReward: 'Device related to a blocked reward';
2681
+ readonly BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward';
2682
+ readonly FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward';
2683
+ readonly EmailRelatedToABlockedReward: 'Email related to a blocked reward';
2684
+ readonly PhoneRelatedToABlockedReward: 'Phone related to a blocked reward';
2685
+ readonly AllowedIp: 'Allowed IP';
2686
+ readonly AllowedEmail: 'Allowed email';
2687
+ readonly AllowedCountry: 'Allowed country';
2640
2688
  };
2641
2689
  export type FraudReviewBaseReasonsEnum = typeof FraudReviewBaseReasonsEnum[keyof typeof FraudReviewBaseReasonsEnum];
2642
2690
  export declare const FraudReviewBaseRedemptionMethodEnum: {
2643
- readonly BankTransfer: "bank transfer";
2644
- readonly Charity: "charity";
2645
- readonly InstantDebitTransfer: "instant debit transfer";
2646
- readonly InternationalBankTransfer: "international bank transfer";
2647
- readonly MerchantCard: "merchant card";
2648
- readonly Paypal: "paypal";
2649
- readonly Venmo: "venmo";
2650
- readonly VisaCard: "visa card";
2691
+ readonly BankTransfer: 'bank transfer';
2692
+ readonly Charity: 'charity';
2693
+ readonly InstantDebitTransfer: 'instant debit transfer';
2694
+ readonly InternationalBankTransfer: 'international bank transfer';
2695
+ readonly MerchantCard: 'merchant card';
2696
+ readonly Paypal: 'paypal';
2697
+ readonly Venmo: 'venmo';
2698
+ readonly VisaCard: 'visa card';
2651
2699
  };
2652
2700
  export type FraudReviewBaseRedemptionMethodEnum = typeof FraudReviewBaseRedemptionMethodEnum[keyof typeof FraudReviewBaseRedemptionMethodEnum];
2653
2701
  /**
@@ -2743,47 +2791,47 @@ export interface FraudReviewListItem {
2743
2791
  'redemption_method_account_hash'?: string;
2744
2792
  }
2745
2793
  export declare const FraudReviewListItemStatusEnum: {
2746
- readonly Flagged: "flagged";
2747
- readonly Blocked: "blocked";
2748
- readonly Released: "released";
2794
+ readonly Flagged: 'flagged';
2795
+ readonly Blocked: 'blocked';
2796
+ readonly Released: 'released';
2749
2797
  };
2750
2798
  export type FraudReviewListItemStatusEnum = typeof FraudReviewListItemStatusEnum[keyof typeof FraudReviewListItemStatusEnum];
2751
2799
  export declare const FraudReviewListItemReasonsEnum: {
2752
- readonly DisallowedIp: "Disallowed IP";
2753
- readonly DisallowedEmail: "Disallowed email";
2754
- readonly DisallowedCountry: "Disallowed country";
2755
- readonly OverRewardAmountLimit: "Over reward amount limit";
2756
- readonly OverRewardCountLimit: "Over reward count limit";
2757
- readonly VpnDetected: "VPN detected";
2758
- readonly ApplePrivateRelay: "Apple Private Relay";
2759
- readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2760
- readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2761
- readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
2762
- readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
2763
- readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
2764
- readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
2765
- readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
2766
- readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list";
2767
- readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
2768
- readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
2769
- readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
2770
- readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
2771
- readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
2772
- readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
2773
- readonly AllowedIp: "Allowed IP";
2774
- readonly AllowedEmail: "Allowed email";
2775
- readonly AllowedCountry: "Allowed country";
2800
+ readonly DisallowedIp: 'Disallowed IP';
2801
+ readonly DisallowedEmail: 'Disallowed email';
2802
+ readonly DisallowedCountry: 'Disallowed country';
2803
+ readonly OverRewardAmountLimit: 'Over reward amount limit';
2804
+ readonly OverRewardCountLimit: 'Over reward count limit';
2805
+ readonly VpnDetected: 'VPN detected';
2806
+ readonly ApplePrivateRelay: 'Apple Private Relay';
2807
+ readonly DeviceRelatedToMultipleEmails: 'Device related to multiple emails';
2808
+ readonly DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails';
2809
+ readonly IpOnATremendousFraudList: 'IP on a Tremendous fraud list';
2810
+ readonly BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list';
2811
+ readonly FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list';
2812
+ readonly EmailOnATremendousFraudList: 'Email on a Tremendous fraud list';
2813
+ readonly PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list';
2814
+ readonly DeviceOnATremendousFraudList: 'Device on a Tremendous fraud list';
2815
+ readonly IpRelatedToABlockedReward: 'IP related to a blocked reward';
2816
+ readonly DeviceRelatedToABlockedReward: 'Device related to a blocked reward';
2817
+ readonly BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward';
2818
+ readonly FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward';
2819
+ readonly EmailRelatedToABlockedReward: 'Email related to a blocked reward';
2820
+ readonly PhoneRelatedToABlockedReward: 'Phone related to a blocked reward';
2821
+ readonly AllowedIp: 'Allowed IP';
2822
+ readonly AllowedEmail: 'Allowed email';
2823
+ readonly AllowedCountry: 'Allowed country';
2776
2824
  };
2777
2825
  export type FraudReviewListItemReasonsEnum = typeof FraudReviewListItemReasonsEnum[keyof typeof FraudReviewListItemReasonsEnum];
2778
2826
  export declare const FraudReviewListItemRedemptionMethodEnum: {
2779
- readonly BankTransfer: "bank transfer";
2780
- readonly Charity: "charity";
2781
- readonly InstantDebitTransfer: "instant debit transfer";
2782
- readonly InternationalBankTransfer: "international bank transfer";
2783
- readonly MerchantCard: "merchant card";
2784
- readonly Paypal: "paypal";
2785
- readonly Venmo: "venmo";
2786
- readonly VisaCard: "visa card";
2827
+ readonly BankTransfer: 'bank transfer';
2828
+ readonly Charity: 'charity';
2829
+ readonly InstantDebitTransfer: 'instant debit transfer';
2830
+ readonly InternationalBankTransfer: 'international bank transfer';
2831
+ readonly MerchantCard: 'merchant card';
2832
+ readonly Paypal: 'paypal';
2833
+ readonly Venmo: 'venmo';
2834
+ readonly VisaCard: 'visa card';
2787
2835
  };
2788
2836
  export type FraudReviewListItemRedemptionMethodEnum = typeof FraudReviewListItemRedemptionMethodEnum[keyof typeof FraudReviewListItemRedemptionMethodEnum];
2789
2837
  /**
@@ -2792,30 +2840,30 @@ export type FraudReviewListItemRedemptionMethodEnum = typeof FraudReviewListItem
2792
2840
  * @enum {string}
2793
2841
  */
2794
2842
  export declare const FraudReviewReason: {
2795
- readonly DisallowedIp: "Disallowed IP";
2796
- readonly DisallowedEmail: "Disallowed email";
2797
- readonly DisallowedCountry: "Disallowed country";
2798
- readonly OverRewardAmountLimit: "Over reward amount limit";
2799
- readonly OverRewardCountLimit: "Over reward count limit";
2800
- readonly VpnDetected: "VPN detected";
2801
- readonly ApplePrivateRelay: "Apple Private Relay";
2802
- readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2803
- readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2804
- readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
2805
- readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
2806
- readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
2807
- readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
2808
- readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
2809
- readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list";
2810
- readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
2811
- readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
2812
- readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
2813
- readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
2814
- readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
2815
- readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
2816
- readonly AllowedIp: "Allowed IP";
2817
- readonly AllowedEmail: "Allowed email";
2818
- readonly AllowedCountry: "Allowed country";
2843
+ readonly DisallowedIp: 'Disallowed IP';
2844
+ readonly DisallowedEmail: 'Disallowed email';
2845
+ readonly DisallowedCountry: 'Disallowed country';
2846
+ readonly OverRewardAmountLimit: 'Over reward amount limit';
2847
+ readonly OverRewardCountLimit: 'Over reward count limit';
2848
+ readonly VpnDetected: 'VPN detected';
2849
+ readonly ApplePrivateRelay: 'Apple Private Relay';
2850
+ readonly DeviceRelatedToMultipleEmails: 'Device related to multiple emails';
2851
+ readonly DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails';
2852
+ readonly IpOnATremendousFraudList: 'IP on a Tremendous fraud list';
2853
+ readonly BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list';
2854
+ readonly FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list';
2855
+ readonly EmailOnATremendousFraudList: 'Email on a Tremendous fraud list';
2856
+ readonly PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list';
2857
+ readonly DeviceOnATremendousFraudList: 'Device on a Tremendous fraud list';
2858
+ readonly IpRelatedToABlockedReward: 'IP related to a blocked reward';
2859
+ readonly DeviceRelatedToABlockedReward: 'Device related to a blocked reward';
2860
+ readonly BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward';
2861
+ readonly FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward';
2862
+ readonly EmailRelatedToABlockedReward: 'Email related to a blocked reward';
2863
+ readonly PhoneRelatedToABlockedReward: 'Phone related to a blocked reward';
2864
+ readonly AllowedIp: 'Allowed IP';
2865
+ readonly AllowedEmail: 'Allowed email';
2866
+ readonly AllowedCountry: 'Allowed country';
2819
2867
  };
2820
2868
  export type FraudReviewReason = typeof FraudReviewReason[keyof typeof FraudReviewReason];
2821
2869
  /**
@@ -2824,14 +2872,14 @@ export type FraudReviewReason = typeof FraudReviewReason[keyof typeof FraudRevie
2824
2872
  * @enum {string}
2825
2873
  */
2826
2874
  export declare const FraudReviewRedemptionMethod: {
2827
- readonly BankTransfer: "bank transfer";
2828
- readonly Charity: "charity";
2829
- readonly InstantDebitTransfer: "instant debit transfer";
2830
- readonly InternationalBankTransfer: "international bank transfer";
2831
- readonly MerchantCard: "merchant card";
2832
- readonly Paypal: "paypal";
2833
- readonly Venmo: "venmo";
2834
- readonly VisaCard: "visa card";
2875
+ readonly BankTransfer: 'bank transfer';
2876
+ readonly Charity: 'charity';
2877
+ readonly InstantDebitTransfer: 'instant debit transfer';
2878
+ readonly InternationalBankTransfer: 'international bank transfer';
2879
+ readonly MerchantCard: 'merchant card';
2880
+ readonly Paypal: 'paypal';
2881
+ readonly Venmo: 'venmo';
2882
+ readonly VisaCard: 'visa card';
2835
2883
  };
2836
2884
  export type FraudReviewRedemptionMethod = typeof FraudReviewRedemptionMethod[keyof typeof FraudReviewRedemptionMethod];
2837
2885
  /**
@@ -2877,9 +2925,9 @@ export interface FraudReviewRelatedRewards {
2877
2925
  * @enum {string}
2878
2926
  */
2879
2927
  export declare const FraudReviewRisk: {
2880
- readonly High: "high";
2881
- readonly Medium: "medium";
2882
- readonly Low: "low";
2928
+ readonly High: 'high';
2929
+ readonly Medium: 'medium';
2930
+ readonly Low: 'low';
2883
2931
  };
2884
2932
  export type FraudReviewRisk = typeof FraudReviewRisk[keyof typeof FraudReviewRisk];
2885
2933
  /**
@@ -2888,9 +2936,9 @@ export type FraudReviewRisk = typeof FraudReviewRisk[keyof typeof FraudReviewRis
2888
2936
  * @enum {string}
2889
2937
  */
2890
2938
  export declare const FraudReviewStatus: {
2891
- readonly Flagged: "flagged";
2892
- readonly Blocked: "blocked";
2893
- readonly Released: "released";
2939
+ readonly Flagged: 'flagged';
2940
+ readonly Blocked: 'blocked';
2941
+ readonly Released: 'released';
2894
2942
  };
2895
2943
  export type FraudReviewStatus = typeof FraudReviewStatus[keyof typeof FraudReviewStatus];
2896
2944
  /**
@@ -3013,17 +3061,17 @@ export interface FraudRuleRequestConfig {
3013
3061
  'skip_apple_private_relay'?: boolean;
3014
3062
  }
3015
3063
  export declare const FraudRuleRequestConfigTypeEnum: {
3016
- readonly Whitelist: "whitelist";
3017
- readonly Blacklist: "blacklist";
3064
+ readonly Whitelist: 'whitelist';
3065
+ readonly Blacklist: 'blacklist';
3018
3066
  };
3019
3067
  export type FraudRuleRequestConfigTypeEnum = typeof FraudRuleRequestConfigTypeEnum[keyof typeof FraudRuleRequestConfigTypeEnum];
3020
3068
  export declare const FraudRuleRequestConfigPeriodEnum: {
3021
- readonly _7: "7";
3022
- readonly _30: "30";
3023
- readonly _90: "90";
3024
- readonly _120: "120";
3025
- readonly _365: "365";
3026
- readonly AllTime: "all_time";
3069
+ readonly _7: '7';
3070
+ readonly _30: '30';
3071
+ readonly _90: '90';
3072
+ readonly _120: '120';
3073
+ readonly _365: '365';
3074
+ readonly AllTime: 'all_time';
3027
3075
  };
3028
3076
  export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeriodEnum[keyof typeof FraudRuleRequestConfigPeriodEnum];
3029
3077
  /**
@@ -3032,17 +3080,17 @@ export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeri
3032
3080
  * @enum {string}
3033
3081
  */
3034
3082
  export declare const FraudRuleType: {
3035
- readonly ReviewCountry: "review_country";
3036
- readonly ReviewIp: "review_ip";
3037
- readonly ReviewEmail: "review_email";
3038
- readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
3039
- readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
3040
- readonly ReviewMultipleEmails: "review_multiple_emails";
3041
- readonly ReviewVpn: "review_vpn";
3042
- readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
3043
- readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
3044
- readonly AllowIp: "allow_ip";
3045
- readonly AllowEmail: "allow_email";
3083
+ readonly ReviewCountry: 'review_country';
3084
+ readonly ReviewIp: 'review_ip';
3085
+ readonly ReviewEmail: 'review_email';
3086
+ readonly ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count';
3087
+ readonly ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount';
3088
+ readonly ReviewMultipleEmails: 'review_multiple_emails';
3089
+ readonly ReviewVpn: 'review_vpn';
3090
+ readonly ReviewTremendousFlagList: 'review_tremendous_flag_list';
3091
+ readonly ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients';
3092
+ readonly AllowIp: 'allow_ip';
3093
+ readonly AllowEmail: 'allow_email';
3046
3094
  };
3047
3095
  export type FraudRuleType = typeof FraudRuleType[keyof typeof FraudRuleType];
3048
3096
  /**
@@ -3067,17 +3115,17 @@ export interface FraudRulesListItem {
3067
3115
  } | null;
3068
3116
  }
3069
3117
  export declare const FraudRulesListItemRuleTypeEnum: {
3070
- readonly ReviewCountry: "review_country";
3071
- readonly ReviewIp: "review_ip";
3072
- readonly ReviewEmail: "review_email";
3073
- readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
3074
- readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
3075
- readonly ReviewMultipleEmails: "review_multiple_emails";
3076
- readonly ReviewVpn: "review_vpn";
3077
- readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
3078
- readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
3079
- readonly AllowIp: "allow_ip";
3080
- readonly AllowEmail: "allow_email";
3118
+ readonly ReviewCountry: 'review_country';
3119
+ readonly ReviewIp: 'review_ip';
3120
+ readonly ReviewEmail: 'review_email';
3121
+ readonly ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count';
3122
+ readonly ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount';
3123
+ readonly ReviewMultipleEmails: 'review_multiple_emails';
3124
+ readonly ReviewVpn: 'review_vpn';
3125
+ readonly ReviewTremendousFlagList: 'review_tremendous_flag_list';
3126
+ readonly ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients';
3127
+ readonly AllowIp: 'allow_ip';
3128
+ readonly AllowEmail: 'allow_email';
3081
3129
  };
3082
3130
  export type FraudRulesListItemRuleTypeEnum = typeof FraudRulesListItemRuleTypeEnum[keyof typeof FraudRulesListItemRuleTypeEnum];
3083
3131
  /**
@@ -3124,28 +3172,28 @@ export interface FundingSource {
3124
3172
  'meta': ListFundingSources200ResponseFundingSourcesInnerMeta;
3125
3173
  }
3126
3174
  export declare const FundingSourceMethodEnum: {
3127
- readonly Balance: "balance";
3128
- readonly BankAccount: "bank_account";
3129
- readonly CreditCard: "credit_card";
3130
- readonly Invoice: "invoice";
3175
+ readonly Balance: 'balance';
3176
+ readonly BankAccount: 'bank_account';
3177
+ readonly CreditCard: 'credit_card';
3178
+ readonly Invoice: 'invoice';
3131
3179
  };
3132
3180
  export type FundingSourceMethodEnum = typeof FundingSourceMethodEnum[keyof typeof FundingSourceMethodEnum];
3133
3181
  export declare const FundingSourceUsagePermissionsEnum: {
3134
- readonly ApiOrders: "api_orders";
3135
- readonly DashboardOrders: "dashboard_orders";
3136
- readonly BalanceFunding: "balance_funding";
3182
+ readonly ApiOrders: 'api_orders';
3183
+ readonly DashboardOrders: 'dashboard_orders';
3184
+ readonly BalanceFunding: 'balance_funding';
3137
3185
  };
3138
3186
  export type FundingSourceUsagePermissionsEnum = typeof FundingSourceUsagePermissionsEnum[keyof typeof FundingSourceUsagePermissionsEnum];
3139
3187
  export declare const FundingSourceStatusEnum: {
3140
- readonly Active: "active";
3141
- readonly Deleted: "deleted";
3142
- readonly Failed: "failed";
3188
+ readonly Active: 'active';
3189
+ readonly Deleted: 'deleted';
3190
+ readonly Failed: 'failed';
3143
3191
  };
3144
3192
  export type FundingSourceStatusEnum = typeof FundingSourceStatusEnum[keyof typeof FundingSourceStatusEnum];
3145
3193
  export declare const FundingSourceTypeEnum: {
3146
- readonly Commercial: "COMMERCIAL";
3147
- readonly ProForma: "PRO_FORMA";
3148
- readonly PrefundingOnly: "PREFUNDING_ONLY";
3194
+ readonly Commercial: 'COMMERCIAL';
3195
+ readonly ProForma: 'PRO_FORMA';
3196
+ readonly PrefundingOnly: 'PREFUNDING_ONLY';
3149
3197
  };
3150
3198
  export type FundingSourceTypeEnum = typeof FundingSourceTypeEnum[keyof typeof FundingSourceTypeEnum];
3151
3199
  /**
@@ -3292,53 +3340,53 @@ export interface GetFraudReview200ResponseFraudReview {
3292
3340
  'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
3293
3341
  }
3294
3342
  export declare const GetFraudReview200ResponseFraudReviewStatusEnum: {
3295
- readonly Flagged: "flagged";
3296
- readonly Blocked: "blocked";
3297
- readonly Released: "released";
3343
+ readonly Flagged: 'flagged';
3344
+ readonly Blocked: 'blocked';
3345
+ readonly Released: 'released';
3298
3346
  };
3299
3347
  export type GetFraudReview200ResponseFraudReviewStatusEnum = typeof GetFraudReview200ResponseFraudReviewStatusEnum[keyof typeof GetFraudReview200ResponseFraudReviewStatusEnum];
3300
3348
  export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
3301
- readonly DisallowedIp: "Disallowed IP";
3302
- readonly DisallowedEmail: "Disallowed email";
3303
- readonly DisallowedCountry: "Disallowed country";
3304
- readonly OverRewardAmountLimit: "Over reward amount limit";
3305
- readonly OverRewardCountLimit: "Over reward count limit";
3306
- readonly VpnDetected: "VPN detected";
3307
- readonly ApplePrivateRelay: "Apple Private Relay";
3308
- readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
3309
- readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
3310
- readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
3311
- readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
3312
- readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
3313
- readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
3314
- readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
3315
- readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list";
3316
- readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
3317
- readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
3318
- readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
3319
- readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
3320
- readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
3321
- readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
3322
- readonly AllowedIp: "Allowed IP";
3323
- readonly AllowedEmail: "Allowed email";
3324
- readonly AllowedCountry: "Allowed country";
3349
+ readonly DisallowedIp: 'Disallowed IP';
3350
+ readonly DisallowedEmail: 'Disallowed email';
3351
+ readonly DisallowedCountry: 'Disallowed country';
3352
+ readonly OverRewardAmountLimit: 'Over reward amount limit';
3353
+ readonly OverRewardCountLimit: 'Over reward count limit';
3354
+ readonly VpnDetected: 'VPN detected';
3355
+ readonly ApplePrivateRelay: 'Apple Private Relay';
3356
+ readonly DeviceRelatedToMultipleEmails: 'Device related to multiple emails';
3357
+ readonly DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails';
3358
+ readonly IpOnATremendousFraudList: 'IP on a Tremendous fraud list';
3359
+ readonly BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list';
3360
+ readonly FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list';
3361
+ readonly EmailOnATremendousFraudList: 'Email on a Tremendous fraud list';
3362
+ readonly PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list';
3363
+ readonly DeviceOnATremendousFraudList: 'Device on a Tremendous fraud list';
3364
+ readonly IpRelatedToABlockedReward: 'IP related to a blocked reward';
3365
+ readonly DeviceRelatedToABlockedReward: 'Device related to a blocked reward';
3366
+ readonly BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward';
3367
+ readonly FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward';
3368
+ readonly EmailRelatedToABlockedReward: 'Email related to a blocked reward';
3369
+ readonly PhoneRelatedToABlockedReward: 'Phone related to a blocked reward';
3370
+ readonly AllowedIp: 'Allowed IP';
3371
+ readonly AllowedEmail: 'Allowed email';
3372
+ readonly AllowedCountry: 'Allowed country';
3325
3373
  };
3326
3374
  export type GetFraudReview200ResponseFraudReviewReasonsEnum = typeof GetFraudReview200ResponseFraudReviewReasonsEnum[keyof typeof GetFraudReview200ResponseFraudReviewReasonsEnum];
3327
3375
  export declare const GetFraudReview200ResponseFraudReviewRedemptionMethodEnum: {
3328
- readonly BankTransfer: "bank transfer";
3329
- readonly Charity: "charity";
3330
- readonly InstantDebitTransfer: "instant debit transfer";
3331
- readonly InternationalBankTransfer: "international bank transfer";
3332
- readonly MerchantCard: "merchant card";
3333
- readonly Paypal: "paypal";
3334
- readonly Venmo: "venmo";
3335
- readonly VisaCard: "visa card";
3376
+ readonly BankTransfer: 'bank transfer';
3377
+ readonly Charity: 'charity';
3378
+ readonly InstantDebitTransfer: 'instant debit transfer';
3379
+ readonly InternationalBankTransfer: 'international bank transfer';
3380
+ readonly MerchantCard: 'merchant card';
3381
+ readonly Paypal: 'paypal';
3382
+ readonly Venmo: 'venmo';
3383
+ readonly VisaCard: 'visa card';
3336
3384
  };
3337
3385
  export type GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum[keyof typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum];
3338
3386
  export declare const GetFraudReview200ResponseFraudReviewRiskEnum: {
3339
- readonly High: "high";
3340
- readonly Medium: "medium";
3341
- readonly Low: "low";
3387
+ readonly High: 'high';
3388
+ readonly Medium: 'medium';
3389
+ readonly Low: 'low';
3342
3390
  };
3343
3391
  export type GetFraudReview200ResponseFraudReviewRiskEnum = typeof GetFraudReview200ResponseFraudReviewRiskEnum[keyof typeof GetFraudReview200ResponseFraudReviewRiskEnum];
3344
3392
  /**
@@ -3454,8 +3502,8 @@ export interface GetMember200ResponseMember {
3454
3502
  'events'?: Array<GetMember200ResponseMemberEventsInner>;
3455
3503
  }
3456
3504
  export declare const GetMember200ResponseMemberStatusEnum: {
3457
- readonly Registered: "REGISTERED";
3458
- readonly Invited: "INVITED";
3505
+ readonly Registered: 'REGISTERED';
3506
+ readonly Invited: 'INVITED';
3459
3507
  };
3460
3508
  export type GetMember200ResponseMemberStatusEnum = typeof GetMember200ResponseMemberStatusEnum[keyof typeof GetMember200ResponseMemberStatusEnum];
3461
3509
  /**
@@ -3478,8 +3526,8 @@ export interface GetMember200ResponseMemberEventsInner {
3478
3526
  'date_utc'?: string | null;
3479
3527
  }
3480
3528
  export declare const GetMember200ResponseMemberEventsInnerTypeEnum: {
3481
- readonly Created: "created";
3482
- readonly LastLogin: "last_login";
3529
+ readonly Created: 'created';
3530
+ readonly LastLogin: 'last_login';
3483
3531
  };
3484
3532
  export type GetMember200ResponseMemberEventsInnerTypeEnum = typeof GetMember200ResponseMemberEventsInnerTypeEnum[keyof typeof GetMember200ResponseMemberEventsInnerTypeEnum];
3485
3533
  /**
@@ -3666,22 +3714,22 @@ export interface Invoice {
3666
3714
  'paid_at': string | null;
3667
3715
  }
3668
3716
  export declare const InvoiceCurrencyCodeEnum: {
3669
- readonly Usd: "USD";
3670
- readonly Eur: "EUR";
3671
- readonly Gbp: "GBP";
3717
+ readonly Usd: 'USD';
3718
+ readonly Eur: 'EUR';
3719
+ readonly Gbp: 'GBP';
3672
3720
  };
3673
3721
  export type InvoiceCurrencyCodeEnum = typeof InvoiceCurrencyCodeEnum[keyof typeof InvoiceCurrencyCodeEnum];
3674
3722
  export declare const InvoiceCurrencyEnum: {
3675
- readonly Usd: "USD";
3676
- readonly Eur: "EUR";
3677
- readonly Gbp: "GBP";
3723
+ readonly Usd: 'USD';
3724
+ readonly Eur: 'EUR';
3725
+ readonly Gbp: 'GBP';
3678
3726
  };
3679
3727
  export type InvoiceCurrencyEnum = typeof InvoiceCurrencyEnum[keyof typeof InvoiceCurrencyEnum];
3680
3728
  export declare const InvoiceStatusEnum: {
3681
- readonly Deleted: "DELETED";
3682
- readonly Paid: "PAID";
3683
- readonly Open: "OPEN";
3684
- readonly MarkedAsPaid: "MARKED_AS_PAID";
3729
+ readonly Deleted: 'DELETED';
3730
+ readonly Paid: 'PAID';
3731
+ readonly Open: 'OPEN';
3732
+ readonly MarkedAsPaid: 'MARKED_AS_PAID';
3685
3733
  };
3686
3734
  export type InvoiceStatusEnum = typeof InvoiceStatusEnum[keyof typeof InvoiceStatusEnum];
3687
3735
  /**
@@ -3883,8 +3931,8 @@ export interface ListCampaigns200ResponseCampaignsInner {
3883
3931
  'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
3884
3932
  }
3885
3933
  export declare const ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum: {
3886
- readonly Sender: "SENDER";
3887
- readonly Recipient: "RECIPIENT";
3934
+ readonly Sender: 'SENDER';
3935
+ readonly Recipient: 'RECIPIENT';
3888
3936
  };
3889
3937
  export type ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum = typeof ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum[keyof typeof ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum];
3890
3938
  /**
@@ -4116,8 +4164,8 @@ export interface ListConnectedOrganizationMembers200ResponseConnectedOrganizatio
4116
4164
  'last_login_at'?: string | null;
4117
4165
  }
4118
4166
  export declare const ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum: {
4119
- readonly Registered: "REGISTERED";
4120
- readonly Invited: "INVITED";
4167
+ readonly Registered: 'REGISTERED';
4168
+ readonly Invited: 'INVITED';
4121
4169
  };
4122
4170
  export type ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum = typeof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum[keyof typeof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum];
4123
4171
  /**
@@ -4169,12 +4217,6 @@ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInne
4169
4217
  * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner
4170
4218
  */
4171
4219
  'organization'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization | null;
4172
- /**
4173
- *
4174
- * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails}
4175
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner
4176
- */
4177
- 'prefilled_kyb_details'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails | null;
4178
4220
  }
4179
4221
  /**
4180
4222
  * Associated `organization` resource. `null` until the registration flow for the connected organization has been completed.
@@ -4220,91 +4262,11 @@ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInne
4220
4262
  'created_at'?: string;
4221
4263
  }
4222
4264
  export declare const ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum: {
4223
- readonly Pending: "PENDING";
4224
- readonly Approved: "APPROVED";
4225
- readonly Rejected: "REJECTED";
4265
+ readonly Pending: 'PENDING';
4266
+ readonly Approved: 'APPROVED';
4267
+ readonly Rejected: 'REJECTED';
4226
4268
  };
4227
4269
  export type ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum = typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum[keyof typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum];
4228
- /**
4229
- * The optional KYB details forwarded when the connected organization was created (see the `kyb` request object), stored to pre-fill the end client\'s onboarding form. Only returned on the create response — it is omitted from the list, retrieve, and delete responses and from webhook payloads. `null` when no KYB details were provided.
4230
- * @export
4231
- * @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4232
- */
4233
- export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails {
4234
- /**
4235
- * The registered legal name of the company.
4236
- * @type {string}
4237
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4238
- */
4239
- 'company_name'?: string;
4240
- /**
4241
- * The trade name (DBA) the company operates under, if different from its legal name.
4242
- * @type {string}
4243
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4244
- */
4245
- 'doing_business_as'?: string;
4246
- /**
4247
- * The company\'s legal entity type. Free-form text — any value is accepted to support entity types outside the common presets. Common values are `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`.
4248
- * @type {string}
4249
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4250
- */
4251
- 'company_structure'?: string;
4252
- /**
4253
- * The company\'s tax ID or registration number.
4254
- * @type {string}
4255
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4256
- */
4257
- 'company_registration_number'?: string;
4258
- /**
4259
- * The ISO 3166-1 alpha-2 country code of the company.
4260
- * @type {string}
4261
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4262
- */
4263
- 'country_code'?: string;
4264
- /**
4265
- * The company\'s website URL.
4266
- * @type {string}
4267
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4268
- */
4269
- 'website_url'?: string;
4270
- /**
4271
- *
4272
- * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress}
4273
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4274
- */
4275
- 'address'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress;
4276
- }
4277
- /**
4278
- * The company\'s address.
4279
- * @export
4280
- * @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4281
- */
4282
- export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress {
4283
- /**
4284
- * Street address.
4285
- * @type {string}
4286
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4287
- */
4288
- 'line1'?: string;
4289
- /**
4290
- * City.
4291
- * @type {string}
4292
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4293
- */
4294
- 'city'?: string;
4295
- /**
4296
- * State, province, or region.
4297
- * @type {string}
4298
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4299
- */
4300
- 'state'?: string;
4301
- /**
4302
- * ZIP or postal code.
4303
- * @type {string}
4304
- * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4305
- */
4306
- 'zip'?: string;
4307
- }
4308
4270
  /**
4309
4271
  *
4310
4272
  * @export
@@ -4362,16 +4324,16 @@ export interface ListFields200ResponseFieldsInner {
4362
4324
  'scope'?: string;
4363
4325
  }
4364
4326
  export declare const ListFields200ResponseFieldsInnerDataTypeEnum: {
4365
- readonly Checkbox: "Checkbox";
4366
- readonly Currency: "Currency";
4367
- readonly Date: "Date";
4368
- readonly Dropdown: "Dropdown";
4369
- readonly Email: "Email";
4370
- readonly List: "List";
4371
- readonly Number: "Number";
4372
- readonly Phone: "Phone";
4373
- readonly Text: "Text";
4374
- readonly TextArea: "TextArea";
4327
+ readonly Checkbox: 'Checkbox';
4328
+ readonly Currency: 'Currency';
4329
+ readonly Date: 'Date';
4330
+ readonly Dropdown: 'Dropdown';
4331
+ readonly Email: 'Email';
4332
+ readonly List: 'List';
4333
+ readonly Number: 'Number';
4334
+ readonly Phone: 'Phone';
4335
+ readonly Text: 'Text';
4336
+ readonly TextArea: 'TextArea';
4375
4337
  };
4376
4338
  export type ListFields200ResponseFieldsInnerDataTypeEnum = typeof ListFields200ResponseFieldsInnerDataTypeEnum[keyof typeof ListFields200ResponseFieldsInnerDataTypeEnum];
4377
4339
  /**
@@ -4497,47 +4459,47 @@ export interface ListFraudReviews200ResponseFraudReviewsInner {
4497
4459
  'redemption_method_account_hash'?: string;
4498
4460
  }
4499
4461
  export declare const ListFraudReviews200ResponseFraudReviewsInnerStatusEnum: {
4500
- readonly Flagged: "flagged";
4501
- readonly Blocked: "blocked";
4502
- readonly Released: "released";
4462
+ readonly Flagged: 'flagged';
4463
+ readonly Blocked: 'blocked';
4464
+ readonly Released: 'released';
4503
4465
  };
4504
4466
  export type ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum];
4505
4467
  export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: {
4506
- readonly DisallowedIp: "Disallowed IP";
4507
- readonly DisallowedEmail: "Disallowed email";
4508
- readonly DisallowedCountry: "Disallowed country";
4509
- readonly OverRewardAmountLimit: "Over reward amount limit";
4510
- readonly OverRewardCountLimit: "Over reward count limit";
4511
- readonly VpnDetected: "VPN detected";
4512
- readonly ApplePrivateRelay: "Apple Private Relay";
4513
- readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
4514
- readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
4515
- readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
4516
- readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
4517
- readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
4518
- readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
4519
- readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
4520
- readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list";
4521
- readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
4522
- readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
4523
- readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
4524
- readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
4525
- readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
4526
- readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
4527
- readonly AllowedIp: "Allowed IP";
4528
- readonly AllowedEmail: "Allowed email";
4529
- readonly AllowedCountry: "Allowed country";
4468
+ readonly DisallowedIp: 'Disallowed IP';
4469
+ readonly DisallowedEmail: 'Disallowed email';
4470
+ readonly DisallowedCountry: 'Disallowed country';
4471
+ readonly OverRewardAmountLimit: 'Over reward amount limit';
4472
+ readonly OverRewardCountLimit: 'Over reward count limit';
4473
+ readonly VpnDetected: 'VPN detected';
4474
+ readonly ApplePrivateRelay: 'Apple Private Relay';
4475
+ readonly DeviceRelatedToMultipleEmails: 'Device related to multiple emails';
4476
+ readonly DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails';
4477
+ readonly IpOnATremendousFraudList: 'IP on a Tremendous fraud list';
4478
+ readonly BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list';
4479
+ readonly FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list';
4480
+ readonly EmailOnATremendousFraudList: 'Email on a Tremendous fraud list';
4481
+ readonly PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list';
4482
+ readonly DeviceOnATremendousFraudList: 'Device on a Tremendous fraud list';
4483
+ readonly IpRelatedToABlockedReward: 'IP related to a blocked reward';
4484
+ readonly DeviceRelatedToABlockedReward: 'Device related to a blocked reward';
4485
+ readonly BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward';
4486
+ readonly FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward';
4487
+ readonly EmailRelatedToABlockedReward: 'Email related to a blocked reward';
4488
+ readonly PhoneRelatedToABlockedReward: 'Phone related to a blocked reward';
4489
+ readonly AllowedIp: 'Allowed IP';
4490
+ readonly AllowedEmail: 'Allowed email';
4491
+ readonly AllowedCountry: 'Allowed country';
4530
4492
  };
4531
4493
  export type ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum];
4532
4494
  export declare const ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum: {
4533
- readonly BankTransfer: "bank transfer";
4534
- readonly Charity: "charity";
4535
- readonly InstantDebitTransfer: "instant debit transfer";
4536
- readonly InternationalBankTransfer: "international bank transfer";
4537
- readonly MerchantCard: "merchant card";
4538
- readonly Paypal: "paypal";
4539
- readonly Venmo: "venmo";
4540
- readonly VisaCard: "visa card";
4495
+ readonly BankTransfer: 'bank transfer';
4496
+ readonly Charity: 'charity';
4497
+ readonly InstantDebitTransfer: 'instant debit transfer';
4498
+ readonly InternationalBankTransfer: 'international bank transfer';
4499
+ readonly MerchantCard: 'merchant card';
4500
+ readonly Paypal: 'paypal';
4501
+ readonly Venmo: 'venmo';
4502
+ readonly VisaCard: 'visa card';
4541
4503
  };
4542
4504
  export type ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum];
4543
4505
  /**
@@ -4600,17 +4562,17 @@ export interface ListFraudRules200ResponseFraudRulesInner {
4600
4562
  } | null;
4601
4563
  }
4602
4564
  export declare const ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum: {
4603
- readonly ReviewCountry: "review_country";
4604
- readonly ReviewIp: "review_ip";
4605
- readonly ReviewEmail: "review_email";
4606
- readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
4607
- readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
4608
- readonly ReviewMultipleEmails: "review_multiple_emails";
4609
- readonly ReviewVpn: "review_vpn";
4610
- readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
4611
- readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
4612
- readonly AllowIp: "allow_ip";
4613
- readonly AllowEmail: "allow_email";
4565
+ readonly ReviewCountry: 'review_country';
4566
+ readonly ReviewIp: 'review_ip';
4567
+ readonly ReviewEmail: 'review_email';
4568
+ readonly ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count';
4569
+ readonly ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount';
4570
+ readonly ReviewMultipleEmails: 'review_multiple_emails';
4571
+ readonly ReviewVpn: 'review_vpn';
4572
+ readonly ReviewTremendousFlagList: 'review_tremendous_flag_list';
4573
+ readonly ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients';
4574
+ readonly AllowIp: 'allow_ip';
4575
+ readonly AllowEmail: 'allow_email';
4614
4576
  };
4615
4577
  export type ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum[keyof typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum];
4616
4578
  /**
@@ -4670,28 +4632,28 @@ export interface ListFundingSources200ResponseFundingSourcesInner {
4670
4632
  'meta': ListFundingSources200ResponseFundingSourcesInnerMeta;
4671
4633
  }
4672
4634
  export declare const ListFundingSources200ResponseFundingSourcesInnerMethodEnum: {
4673
- readonly Balance: "balance";
4674
- readonly BankAccount: "bank_account";
4675
- readonly CreditCard: "credit_card";
4676
- readonly Invoice: "invoice";
4635
+ readonly Balance: 'balance';
4636
+ readonly BankAccount: 'bank_account';
4637
+ readonly CreditCard: 'credit_card';
4638
+ readonly Invoice: 'invoice';
4677
4639
  };
4678
4640
  export type ListFundingSources200ResponseFundingSourcesInnerMethodEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMethodEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMethodEnum];
4679
4641
  export declare const ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum: {
4680
- readonly ApiOrders: "api_orders";
4681
- readonly DashboardOrders: "dashboard_orders";
4682
- readonly BalanceFunding: "balance_funding";
4642
+ readonly ApiOrders: 'api_orders';
4643
+ readonly DashboardOrders: 'dashboard_orders';
4644
+ readonly BalanceFunding: 'balance_funding';
4683
4645
  };
4684
4646
  export type ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum = typeof ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum];
4685
4647
  export declare const ListFundingSources200ResponseFundingSourcesInnerStatusEnum: {
4686
- readonly Active: "active";
4687
- readonly Deleted: "deleted";
4688
- readonly Failed: "failed";
4648
+ readonly Active: 'active';
4649
+ readonly Deleted: 'deleted';
4650
+ readonly Failed: 'failed';
4689
4651
  };
4690
4652
  export type ListFundingSources200ResponseFundingSourcesInnerStatusEnum = typeof ListFundingSources200ResponseFundingSourcesInnerStatusEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerStatusEnum];
4691
4653
  export declare const ListFundingSources200ResponseFundingSourcesInnerTypeEnum: {
4692
- readonly Commercial: "COMMERCIAL";
4693
- readonly ProForma: "PRO_FORMA";
4694
- readonly PrefundingOnly: "PREFUNDING_ONLY";
4654
+ readonly Commercial: 'COMMERCIAL';
4655
+ readonly ProForma: 'PRO_FORMA';
4656
+ readonly PrefundingOnly: 'PREFUNDING_ONLY';
4695
4657
  };
4696
4658
  export type ListFundingSources200ResponseFundingSourcesInnerTypeEnum = typeof ListFundingSources200ResponseFundingSourcesInnerTypeEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerTypeEnum];
4697
4659
  /**
@@ -4897,21 +4859,21 @@ export interface ListFundingSources200ResponseFundingSourcesInnerMeta {
4897
4859
  'failure_details'?: ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails | null;
4898
4860
  }
4899
4861
  export declare const ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum: {
4900
- readonly Checking: "checking";
4901
- readonly Savings: "savings";
4862
+ readonly Checking: 'checking';
4863
+ readonly Savings: 'savings';
4902
4864
  };
4903
4865
  export type ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum];
4904
4866
  export declare const ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum: {
4905
- readonly MasterCard: "MasterCard";
4906
- readonly Amex: "Amex";
4907
- readonly Jcb: "JCB";
4908
- readonly DinersClub: "Diner's Club";
4909
- readonly Visa: "Visa";
4910
- readonly Discover: "Discover";
4911
- readonly Laser: "Laser";
4912
- readonly Elo: "Elo";
4913
- readonly Maestro: "Maestro";
4914
- readonly Solo: "Solo";
4867
+ readonly MasterCard: 'MasterCard';
4868
+ readonly Amex: 'Amex';
4869
+ readonly Jcb: 'JCB';
4870
+ readonly DinersClub: 'Diner\'s Club';
4871
+ readonly Visa: 'Visa';
4872
+ readonly Discover: 'Discover';
4873
+ readonly Laser: 'Laser';
4874
+ readonly Elo: 'Elo';
4875
+ readonly Maestro: 'Maestro';
4876
+ readonly Solo: 'Solo';
4915
4877
  };
4916
4878
  export type ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum];
4917
4879
  /**
@@ -5027,22 +4989,22 @@ export interface ListInvoices200ResponseInvoicesInner {
5027
4989
  'paid_at': string | null;
5028
4990
  }
5029
4991
  export declare const ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum: {
5030
- readonly Usd: "USD";
5031
- readonly Eur: "EUR";
5032
- readonly Gbp: "GBP";
4992
+ readonly Usd: 'USD';
4993
+ readonly Eur: 'EUR';
4994
+ readonly Gbp: 'GBP';
5033
4995
  };
5034
4996
  export type ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum = typeof ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum[keyof typeof ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum];
5035
4997
  export declare const ListInvoices200ResponseInvoicesInnerCurrencyEnum: {
5036
- readonly Usd: "USD";
5037
- readonly Eur: "EUR";
5038
- readonly Gbp: "GBP";
4998
+ readonly Usd: 'USD';
4999
+ readonly Eur: 'EUR';
5000
+ readonly Gbp: 'GBP';
5039
5001
  };
5040
5002
  export type ListInvoices200ResponseInvoicesInnerCurrencyEnum = typeof ListInvoices200ResponseInvoicesInnerCurrencyEnum[keyof typeof ListInvoices200ResponseInvoicesInnerCurrencyEnum];
5041
5003
  export declare const ListInvoices200ResponseInvoicesInnerStatusEnum: {
5042
- readonly Deleted: "DELETED";
5043
- readonly Paid: "PAID";
5044
- readonly Open: "OPEN";
5045
- readonly MarkedAsPaid: "MARKED_AS_PAID";
5004
+ readonly Deleted: 'DELETED';
5005
+ readonly Paid: 'PAID';
5006
+ readonly Open: 'OPEN';
5007
+ readonly MarkedAsPaid: 'MARKED_AS_PAID';
5046
5008
  };
5047
5009
  export type ListInvoices200ResponseInvoicesInnerStatusEnum = typeof ListInvoices200ResponseInvoicesInnerStatusEnum[keyof typeof ListInvoices200ResponseInvoicesInnerStatusEnum];
5048
5010
  /**
@@ -5114,8 +5076,8 @@ export interface ListMembers200ResponseMembersInner {
5114
5076
  'last_login_at'?: string | null;
5115
5077
  }
5116
5078
  export declare const ListMembers200ResponseMembersInnerStatusEnum: {
5117
- readonly Registered: "REGISTERED";
5118
- readonly Invited: "INVITED";
5079
+ readonly Registered: 'REGISTERED';
5080
+ readonly Invited: 'INVITED';
5119
5081
  };
5120
5082
  export type ListMembers200ResponseMembersInnerStatusEnum = typeof ListMembers200ResponseMembersInnerStatusEnum[keyof typeof ListMembers200ResponseMembersInnerStatusEnum];
5121
5083
  /**
@@ -5199,24 +5161,24 @@ export interface ListOrders200ResponseOrdersInner {
5199
5161
  'rewards'?: Array<ListRewards200ResponseRewardsInner>;
5200
5162
  }
5201
5163
  export declare const ListOrders200ResponseOrdersInnerStatusEnum: {
5202
- readonly Canceled: "CANCELED";
5203
- readonly Open: "OPEN";
5204
- readonly Executed: "EXECUTED";
5205
- readonly Failed: "FAILED";
5206
- readonly PendingApproval: "PENDING APPROVAL";
5207
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
5208
- readonly PendingSettlement: "PENDING SETTLEMENT";
5164
+ readonly Canceled: 'CANCELED';
5165
+ readonly Open: 'OPEN';
5166
+ readonly Executed: 'EXECUTED';
5167
+ readonly Failed: 'FAILED';
5168
+ readonly PendingApproval: 'PENDING APPROVAL';
5169
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
5170
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
5209
5171
  };
5210
5172
  export type ListOrders200ResponseOrdersInnerStatusEnum = typeof ListOrders200ResponseOrdersInnerStatusEnum[keyof typeof ListOrders200ResponseOrdersInnerStatusEnum];
5211
5173
  export declare const ListOrders200ResponseOrdersInnerChannelEnum: {
5212
- readonly Ui: "UI";
5213
- readonly Api: "API";
5214
- readonly Embed: "EMBED";
5215
- readonly Decipher: "DECIPHER";
5216
- readonly Qualtrics: "QUALTRICS";
5217
- readonly Typeform: "TYPEFORM";
5218
- readonly SurveyMonkey: "SURVEY MONKEY";
5219
- readonly Yotpo: "YOTPO";
5174
+ readonly Ui: 'UI';
5175
+ readonly Api: 'API';
5176
+ readonly Embed: 'EMBED';
5177
+ readonly Decipher: 'DECIPHER';
5178
+ readonly Qualtrics: 'QUALTRICS';
5179
+ readonly Typeform: 'TYPEFORM';
5180
+ readonly SurveyMonkey: 'SURVEY MONKEY';
5181
+ readonly Yotpo: 'YOTPO';
5220
5182
  };
5221
5183
  export type ListOrders200ResponseOrdersInnerChannelEnum = typeof ListOrders200ResponseOrdersInnerChannelEnum[keyof typeof ListOrders200ResponseOrdersInnerChannelEnum];
5222
5184
  /**
@@ -5338,9 +5300,9 @@ export interface ListOrganizations200ResponseOrganizationsInner {
5338
5300
  'created_at'?: string;
5339
5301
  }
5340
5302
  export declare const ListOrganizations200ResponseOrganizationsInnerStatusEnum: {
5341
- readonly Pending: "PENDING";
5342
- readonly Approved: "APPROVED";
5343
- readonly Rejected: "REJECTED";
5303
+ readonly Pending: 'PENDING';
5304
+ readonly Approved: 'APPROVED';
5305
+ readonly Rejected: 'REJECTED';
5344
5306
  };
5345
5307
  export type ListOrganizations200ResponseOrganizationsInnerStatusEnum = typeof ListOrganizations200ResponseOrganizationsInnerStatusEnum[keyof typeof ListOrganizations200ResponseOrganizationsInnerStatusEnum];
5346
5308
  /**
@@ -5436,145 +5398,145 @@ export interface ListProductsResponseProductsInner {
5436
5398
  'documents'?: ListProductsResponseProductsInnerDocuments | null;
5437
5399
  }
5438
5400
  export declare const ListProductsResponseProductsInnerCategoryEnum: {
5439
- readonly Ach: "ach";
5440
- readonly Charity: "charity";
5441
- readonly InstantDebitTransfer: "instant_debit_transfer";
5442
- readonly MerchantCard: "merchant_card";
5443
- readonly Paypal: "paypal";
5444
- readonly Venmo: "venmo";
5445
- readonly VisaCard: "visa_card";
5446
- readonly CashApp: "cash_app";
5447
- readonly InternationalBank: "international_bank";
5448
- readonly Wallet: "wallet";
5401
+ readonly Ach: 'ach';
5402
+ readonly Charity: 'charity';
5403
+ readonly InstantDebitTransfer: 'instant_debit_transfer';
5404
+ readonly MerchantCard: 'merchant_card';
5405
+ readonly Paypal: 'paypal';
5406
+ readonly Venmo: 'venmo';
5407
+ readonly VisaCard: 'visa_card';
5408
+ readonly CashApp: 'cash_app';
5409
+ readonly InternationalBank: 'international_bank';
5410
+ readonly Wallet: 'wallet';
5449
5411
  };
5450
5412
  export type ListProductsResponseProductsInnerCategoryEnum = typeof ListProductsResponseProductsInnerCategoryEnum[keyof typeof ListProductsResponseProductsInnerCategoryEnum];
5451
5413
  export declare const ListProductsResponseProductsInnerSubcategoryEnum: {
5452
- readonly BeautyAndHealth: "beauty_and_health";
5453
- readonly DigitalFinancialServices: "digital_financial_services";
5454
- readonly Electronics: "electronics";
5455
- readonly Entertainment: "entertainment";
5456
- readonly Fashion: "fashion";
5457
- readonly FoodAndDrink: "food_and_drink";
5458
- readonly GeneralMerchandise: "general_merchandise";
5459
- readonly GroceryAndSupermarkets: "grocery_and_supermarkets";
5460
- readonly HomeAndLiving: "home_and_living";
5461
- readonly MobilityAndFuel: "mobility_and_fuel";
5462
- readonly SportsAndOutdoorGear: "sports_and_outdoor_gear";
5463
- readonly TravelAndHospitality: "travel_and_hospitality";
5414
+ readonly BeautyAndHealth: 'beauty_and_health';
5415
+ readonly DigitalFinancialServices: 'digital_financial_services';
5416
+ readonly Electronics: 'electronics';
5417
+ readonly Entertainment: 'entertainment';
5418
+ readonly Fashion: 'fashion';
5419
+ readonly FoodAndDrink: 'food_and_drink';
5420
+ readonly GeneralMerchandise: 'general_merchandise';
5421
+ readonly GroceryAndSupermarkets: 'grocery_and_supermarkets';
5422
+ readonly HomeAndLiving: 'home_and_living';
5423
+ readonly MobilityAndFuel: 'mobility_and_fuel';
5424
+ readonly SportsAndOutdoorGear: 'sports_and_outdoor_gear';
5425
+ readonly TravelAndHospitality: 'travel_and_hospitality';
5464
5426
  };
5465
5427
  export type ListProductsResponseProductsInnerSubcategoryEnum = typeof ListProductsResponseProductsInnerSubcategoryEnum[keyof typeof ListProductsResponseProductsInnerSubcategoryEnum];
5466
5428
  export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
5467
- readonly Usd: "USD";
5468
- readonly Cad: "CAD";
5469
- readonly Eur: "EUR";
5470
- readonly Aed: "AED";
5471
- readonly Afn: "AFN";
5472
- readonly All: "ALL";
5473
- readonly Amd: "AMD";
5474
- readonly Ars: "ARS";
5475
- readonly Aud: "AUD";
5476
- readonly Azn: "AZN";
5477
- readonly Bam: "BAM";
5478
- readonly Bdt: "BDT";
5479
- readonly Bhd: "BHD";
5480
- readonly Bif: "BIF";
5481
- readonly Bnd: "BND";
5482
- readonly Bob: "BOB";
5483
- readonly Brl: "BRL";
5484
- readonly Bwp: "BWP";
5485
- readonly Byn: "BYN";
5486
- readonly Bzd: "BZD";
5487
- readonly Cdf: "CDF";
5488
- readonly Chf: "CHF";
5489
- readonly Clp: "CLP";
5490
- readonly Cny: "CNY";
5491
- readonly Cop: "COP";
5492
- readonly Crc: "CRC";
5493
- readonly Cve: "CVE";
5494
- readonly Czk: "CZK";
5495
- readonly Djf: "DJF";
5496
- readonly Dkk: "DKK";
5497
- readonly Dop: "DOP";
5498
- readonly Dzd: "DZD";
5499
- readonly Egp: "EGP";
5500
- readonly Ern: "ERN";
5501
- readonly Etb: "ETB";
5502
- readonly Gbp: "GBP";
5503
- readonly Gel: "GEL";
5504
- readonly Ghs: "GHS";
5505
- readonly Gnf: "GNF";
5506
- readonly Gtq: "GTQ";
5507
- readonly Hkd: "HKD";
5508
- readonly Hnl: "HNL";
5509
- readonly Hrk: "HRK";
5510
- readonly Huf: "HUF";
5511
- readonly Idr: "IDR";
5512
- readonly Ils: "ILS";
5513
- readonly Inr: "INR";
5514
- readonly Iqd: "IQD";
5515
- readonly Irr: "IRR";
5516
- readonly Isk: "ISK";
5517
- readonly Jmd: "JMD";
5518
- readonly Jod: "JOD";
5519
- readonly Jpy: "JPY";
5520
- readonly Kes: "KES";
5521
- readonly Khr: "KHR";
5522
- readonly Krw: "KRW";
5523
- readonly Kwd: "KWD";
5524
- readonly Kzt: "KZT";
5525
- readonly Lbp: "LBP";
5526
- readonly Lkr: "LKR";
5527
- readonly Mad: "MAD";
5528
- readonly Mdl: "MDL";
5529
- readonly Mga: "MGA";
5530
- readonly Mkd: "MKD";
5531
- readonly Mmk: "MMK";
5532
- readonly Mop: "MOP";
5533
- readonly Mur: "MUR";
5534
- readonly Mxn: "MXN";
5535
- readonly Myr: "MYR";
5536
- readonly Mzn: "MZN";
5537
- readonly Nad: "NAD";
5538
- readonly Ngn: "NGN";
5539
- readonly Nio: "NIO";
5540
- readonly Nok: "NOK";
5541
- readonly Npr: "NPR";
5542
- readonly Nzd: "NZD";
5543
- readonly Omr: "OMR";
5544
- readonly Pab: "PAB";
5545
- readonly Pen: "PEN";
5546
- readonly Php: "PHP";
5547
- readonly Pkr: "PKR";
5548
- readonly Pln: "PLN";
5549
- readonly Pyg: "PYG";
5550
- readonly Qar: "QAR";
5551
- readonly Ron: "RON";
5552
- readonly Rsd: "RSD";
5553
- readonly Rub: "RUB";
5554
- readonly Rwf: "RWF";
5555
- readonly Sar: "SAR";
5556
- readonly Sdg: "SDG";
5557
- readonly Sek: "SEK";
5558
- readonly Sgd: "SGD";
5559
- readonly Sos: "SOS";
5560
- readonly Syp: "SYP";
5561
- readonly Thb: "THB";
5562
- readonly Tnd: "TND";
5563
- readonly Top: "TOP";
5564
- readonly Try: "TRY";
5565
- readonly Ttd: "TTD";
5566
- readonly Twd: "TWD";
5567
- readonly Tzs: "TZS";
5568
- readonly Uah: "UAH";
5569
- readonly Ugx: "UGX";
5570
- readonly Uyu: "UYU";
5571
- readonly Uzs: "UZS";
5572
- readonly Vef: "VEF";
5573
- readonly Vnd: "VND";
5574
- readonly Xaf: "XAF";
5575
- readonly Xof: "XOF";
5576
- readonly Yer: "YER";
5577
- readonly Zar: "ZAR";
5429
+ readonly Usd: 'USD';
5430
+ readonly Cad: 'CAD';
5431
+ readonly Eur: 'EUR';
5432
+ readonly Aed: 'AED';
5433
+ readonly Afn: 'AFN';
5434
+ readonly All: 'ALL';
5435
+ readonly Amd: 'AMD';
5436
+ readonly Ars: 'ARS';
5437
+ readonly Aud: 'AUD';
5438
+ readonly Azn: 'AZN';
5439
+ readonly Bam: 'BAM';
5440
+ readonly Bdt: 'BDT';
5441
+ readonly Bhd: 'BHD';
5442
+ readonly Bif: 'BIF';
5443
+ readonly Bnd: 'BND';
5444
+ readonly Bob: 'BOB';
5445
+ readonly Brl: 'BRL';
5446
+ readonly Bwp: 'BWP';
5447
+ readonly Byn: 'BYN';
5448
+ readonly Bzd: 'BZD';
5449
+ readonly Cdf: 'CDF';
5450
+ readonly Chf: 'CHF';
5451
+ readonly Clp: 'CLP';
5452
+ readonly Cny: 'CNY';
5453
+ readonly Cop: 'COP';
5454
+ readonly Crc: 'CRC';
5455
+ readonly Cve: 'CVE';
5456
+ readonly Czk: 'CZK';
5457
+ readonly Djf: 'DJF';
5458
+ readonly Dkk: 'DKK';
5459
+ readonly Dop: 'DOP';
5460
+ readonly Dzd: 'DZD';
5461
+ readonly Egp: 'EGP';
5462
+ readonly Ern: 'ERN';
5463
+ readonly Etb: 'ETB';
5464
+ readonly Gbp: 'GBP';
5465
+ readonly Gel: 'GEL';
5466
+ readonly Ghs: 'GHS';
5467
+ readonly Gnf: 'GNF';
5468
+ readonly Gtq: 'GTQ';
5469
+ readonly Hkd: 'HKD';
5470
+ readonly Hnl: 'HNL';
5471
+ readonly Hrk: 'HRK';
5472
+ readonly Huf: 'HUF';
5473
+ readonly Idr: 'IDR';
5474
+ readonly Ils: 'ILS';
5475
+ readonly Inr: 'INR';
5476
+ readonly Iqd: 'IQD';
5477
+ readonly Irr: 'IRR';
5478
+ readonly Isk: 'ISK';
5479
+ readonly Jmd: 'JMD';
5480
+ readonly Jod: 'JOD';
5481
+ readonly Jpy: 'JPY';
5482
+ readonly Kes: 'KES';
5483
+ readonly Khr: 'KHR';
5484
+ readonly Krw: 'KRW';
5485
+ readonly Kwd: 'KWD';
5486
+ readonly Kzt: 'KZT';
5487
+ readonly Lbp: 'LBP';
5488
+ readonly Lkr: 'LKR';
5489
+ readonly Mad: 'MAD';
5490
+ readonly Mdl: 'MDL';
5491
+ readonly Mga: 'MGA';
5492
+ readonly Mkd: 'MKD';
5493
+ readonly Mmk: 'MMK';
5494
+ readonly Mop: 'MOP';
5495
+ readonly Mur: 'MUR';
5496
+ readonly Mxn: 'MXN';
5497
+ readonly Myr: 'MYR';
5498
+ readonly Mzn: 'MZN';
5499
+ readonly Nad: 'NAD';
5500
+ readonly Ngn: 'NGN';
5501
+ readonly Nio: 'NIO';
5502
+ readonly Nok: 'NOK';
5503
+ readonly Npr: 'NPR';
5504
+ readonly Nzd: 'NZD';
5505
+ readonly Omr: 'OMR';
5506
+ readonly Pab: 'PAB';
5507
+ readonly Pen: 'PEN';
5508
+ readonly Php: 'PHP';
5509
+ readonly Pkr: 'PKR';
5510
+ readonly Pln: 'PLN';
5511
+ readonly Pyg: 'PYG';
5512
+ readonly Qar: 'QAR';
5513
+ readonly Ron: 'RON';
5514
+ readonly Rsd: 'RSD';
5515
+ readonly Rub: 'RUB';
5516
+ readonly Rwf: 'RWF';
5517
+ readonly Sar: 'SAR';
5518
+ readonly Sdg: 'SDG';
5519
+ readonly Sek: 'SEK';
5520
+ readonly Sgd: 'SGD';
5521
+ readonly Sos: 'SOS';
5522
+ readonly Syp: 'SYP';
5523
+ readonly Thb: 'THB';
5524
+ readonly Tnd: 'TND';
5525
+ readonly Top: 'TOP';
5526
+ readonly Try: 'TRY';
5527
+ readonly Ttd: 'TTD';
5528
+ readonly Twd: 'TWD';
5529
+ readonly Tzs: 'TZS';
5530
+ readonly Uah: 'UAH';
5531
+ readonly Ugx: 'UGX';
5532
+ readonly Uyu: 'UYU';
5533
+ readonly Uzs: 'UZS';
5534
+ readonly Vef: 'VEF';
5535
+ readonly Vnd: 'VND';
5536
+ readonly Xaf: 'XAF';
5537
+ readonly Xof: 'XOF';
5538
+ readonly Yer: 'YER';
5539
+ readonly Zar: 'ZAR';
5578
5540
  };
5579
5541
  export type ListProductsResponseProductsInnerCurrencyCodesEnum = typeof ListProductsResponseProductsInnerCurrencyCodesEnum[keyof typeof ListProductsResponseProductsInnerCurrencyCodesEnum];
5580
5542
  /**
@@ -5641,8 +5603,8 @@ export interface ListProductsResponseProductsInnerImagesInner {
5641
5603
  'content_type'?: string | null;
5642
5604
  }
5643
5605
  export declare const ListProductsResponseProductsInnerImagesInnerTypeEnum: {
5644
- readonly Card: "card";
5645
- readonly Logo: "logo";
5606
+ readonly Card: 'card';
5607
+ readonly Logo: 'logo';
5646
5608
  };
5647
5609
  export type ListProductsResponseProductsInnerImagesInnerTypeEnum = typeof ListProductsResponseProductsInnerImagesInnerTypeEnum[keyof typeof ListProductsResponseProductsInnerImagesInnerTypeEnum];
5648
5610
  /**
@@ -5789,16 +5751,16 @@ export interface ListRewards200ResponseRewardsInnerDelivery {
5789
5751
  'status'?: ListRewards200ResponseRewardsInnerDeliveryStatusEnum;
5790
5752
  }
5791
5753
  export declare const ListRewards200ResponseRewardsInnerDeliveryMethodEnum: {
5792
- readonly Email: "EMAIL";
5793
- readonly Link: "LINK";
5794
- readonly Phone: "PHONE";
5754
+ readonly Email: 'EMAIL';
5755
+ readonly Link: 'LINK';
5756
+ readonly Phone: 'PHONE';
5795
5757
  };
5796
5758
  export type ListRewards200ResponseRewardsInnerDeliveryMethodEnum = typeof ListRewards200ResponseRewardsInnerDeliveryMethodEnum[keyof typeof ListRewards200ResponseRewardsInnerDeliveryMethodEnum];
5797
5759
  export declare const ListRewards200ResponseRewardsInnerDeliveryStatusEnum: {
5798
- readonly Scheduled: "SCHEDULED";
5799
- readonly Failed: "FAILED";
5800
- readonly Succeeded: "SUCCEEDED";
5801
- readonly Pending: "PENDING";
5760
+ readonly Scheduled: 'SCHEDULED';
5761
+ readonly Failed: 'FAILED';
5762
+ readonly Succeeded: 'SUCCEEDED';
5763
+ readonly Pending: 'PENDING';
5802
5764
  };
5803
5765
  export type ListRewards200ResponseRewardsInnerDeliveryStatusEnum = typeof ListRewards200ResponseRewardsInnerDeliveryStatusEnum[keyof typeof ListRewards200ResponseRewardsInnerDeliveryStatusEnum];
5804
5766
  /**
@@ -5846,117 +5808,117 @@ export interface ListRewards200ResponseRewardsInnerValue {
5846
5808
  'currency_code'?: ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum;
5847
5809
  }
5848
5810
  export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
5849
- readonly Usd: "USD";
5850
- readonly Cad: "CAD";
5851
- readonly Eur: "EUR";
5852
- readonly Aed: "AED";
5853
- readonly Afn: "AFN";
5854
- readonly All: "ALL";
5855
- readonly Amd: "AMD";
5856
- readonly Ars: "ARS";
5857
- readonly Aud: "AUD";
5858
- readonly Azn: "AZN";
5859
- readonly Bam: "BAM";
5860
- readonly Bdt: "BDT";
5861
- readonly Bhd: "BHD";
5862
- readonly Bif: "BIF";
5863
- readonly Bnd: "BND";
5864
- readonly Bob: "BOB";
5865
- readonly Brl: "BRL";
5866
- readonly Bwp: "BWP";
5867
- readonly Byn: "BYN";
5868
- readonly Bzd: "BZD";
5869
- readonly Cdf: "CDF";
5870
- readonly Chf: "CHF";
5871
- readonly Clp: "CLP";
5872
- readonly Cny: "CNY";
5873
- readonly Cop: "COP";
5874
- readonly Crc: "CRC";
5875
- readonly Cve: "CVE";
5876
- readonly Czk: "CZK";
5877
- readonly Djf: "DJF";
5878
- readonly Dkk: "DKK";
5879
- readonly Dop: "DOP";
5880
- readonly Dzd: "DZD";
5881
- readonly Egp: "EGP";
5882
- readonly Ern: "ERN";
5883
- readonly Etb: "ETB";
5884
- readonly Gbp: "GBP";
5885
- readonly Gel: "GEL";
5886
- readonly Ghs: "GHS";
5887
- readonly Gnf: "GNF";
5888
- readonly Gtq: "GTQ";
5889
- readonly Hkd: "HKD";
5890
- readonly Hnl: "HNL";
5891
- readonly Hrk: "HRK";
5892
- readonly Huf: "HUF";
5893
- readonly Idr: "IDR";
5894
- readonly Ils: "ILS";
5895
- readonly Inr: "INR";
5896
- readonly Iqd: "IQD";
5897
- readonly Irr: "IRR";
5898
- readonly Isk: "ISK";
5899
- readonly Jmd: "JMD";
5900
- readonly Jod: "JOD";
5901
- readonly Jpy: "JPY";
5902
- readonly Kes: "KES";
5903
- readonly Khr: "KHR";
5904
- readonly Krw: "KRW";
5905
- readonly Kwd: "KWD";
5906
- readonly Kzt: "KZT";
5907
- readonly Lbp: "LBP";
5908
- readonly Lkr: "LKR";
5909
- readonly Mad: "MAD";
5910
- readonly Mdl: "MDL";
5911
- readonly Mga: "MGA";
5912
- readonly Mkd: "MKD";
5913
- readonly Mmk: "MMK";
5914
- readonly Mop: "MOP";
5915
- readonly Mur: "MUR";
5916
- readonly Mxn: "MXN";
5917
- readonly Myr: "MYR";
5918
- readonly Mzn: "MZN";
5919
- readonly Nad: "NAD";
5920
- readonly Ngn: "NGN";
5921
- readonly Nio: "NIO";
5922
- readonly Nok: "NOK";
5923
- readonly Npr: "NPR";
5924
- readonly Nzd: "NZD";
5925
- readonly Omr: "OMR";
5926
- readonly Pab: "PAB";
5927
- readonly Pen: "PEN";
5928
- readonly Php: "PHP";
5929
- readonly Pkr: "PKR";
5930
- readonly Pln: "PLN";
5931
- readonly Pyg: "PYG";
5932
- readonly Qar: "QAR";
5933
- readonly Ron: "RON";
5934
- readonly Rsd: "RSD";
5935
- readonly Rub: "RUB";
5936
- readonly Rwf: "RWF";
5937
- readonly Sar: "SAR";
5938
- readonly Sdg: "SDG";
5939
- readonly Sek: "SEK";
5940
- readonly Sgd: "SGD";
5941
- readonly Sos: "SOS";
5942
- readonly Syp: "SYP";
5943
- readonly Thb: "THB";
5944
- readonly Tnd: "TND";
5945
- readonly Top: "TOP";
5946
- readonly Try: "TRY";
5947
- readonly Ttd: "TTD";
5948
- readonly Twd: "TWD";
5949
- readonly Tzs: "TZS";
5950
- readonly Uah: "UAH";
5951
- readonly Ugx: "UGX";
5952
- readonly Uyu: "UYU";
5953
- readonly Uzs: "UZS";
5954
- readonly Vef: "VEF";
5955
- readonly Vnd: "VND";
5956
- readonly Xaf: "XAF";
5957
- readonly Xof: "XOF";
5958
- readonly Yer: "YER";
5959
- readonly Zar: "ZAR";
5811
+ readonly Usd: 'USD';
5812
+ readonly Cad: 'CAD';
5813
+ readonly Eur: 'EUR';
5814
+ readonly Aed: 'AED';
5815
+ readonly Afn: 'AFN';
5816
+ readonly All: 'ALL';
5817
+ readonly Amd: 'AMD';
5818
+ readonly Ars: 'ARS';
5819
+ readonly Aud: 'AUD';
5820
+ readonly Azn: 'AZN';
5821
+ readonly Bam: 'BAM';
5822
+ readonly Bdt: 'BDT';
5823
+ readonly Bhd: 'BHD';
5824
+ readonly Bif: 'BIF';
5825
+ readonly Bnd: 'BND';
5826
+ readonly Bob: 'BOB';
5827
+ readonly Brl: 'BRL';
5828
+ readonly Bwp: 'BWP';
5829
+ readonly Byn: 'BYN';
5830
+ readonly Bzd: 'BZD';
5831
+ readonly Cdf: 'CDF';
5832
+ readonly Chf: 'CHF';
5833
+ readonly Clp: 'CLP';
5834
+ readonly Cny: 'CNY';
5835
+ readonly Cop: 'COP';
5836
+ readonly Crc: 'CRC';
5837
+ readonly Cve: 'CVE';
5838
+ readonly Czk: 'CZK';
5839
+ readonly Djf: 'DJF';
5840
+ readonly Dkk: 'DKK';
5841
+ readonly Dop: 'DOP';
5842
+ readonly Dzd: 'DZD';
5843
+ readonly Egp: 'EGP';
5844
+ readonly Ern: 'ERN';
5845
+ readonly Etb: 'ETB';
5846
+ readonly Gbp: 'GBP';
5847
+ readonly Gel: 'GEL';
5848
+ readonly Ghs: 'GHS';
5849
+ readonly Gnf: 'GNF';
5850
+ readonly Gtq: 'GTQ';
5851
+ readonly Hkd: 'HKD';
5852
+ readonly Hnl: 'HNL';
5853
+ readonly Hrk: 'HRK';
5854
+ readonly Huf: 'HUF';
5855
+ readonly Idr: 'IDR';
5856
+ readonly Ils: 'ILS';
5857
+ readonly Inr: 'INR';
5858
+ readonly Iqd: 'IQD';
5859
+ readonly Irr: 'IRR';
5860
+ readonly Isk: 'ISK';
5861
+ readonly Jmd: 'JMD';
5862
+ readonly Jod: 'JOD';
5863
+ readonly Jpy: 'JPY';
5864
+ readonly Kes: 'KES';
5865
+ readonly Khr: 'KHR';
5866
+ readonly Krw: 'KRW';
5867
+ readonly Kwd: 'KWD';
5868
+ readonly Kzt: 'KZT';
5869
+ readonly Lbp: 'LBP';
5870
+ readonly Lkr: 'LKR';
5871
+ readonly Mad: 'MAD';
5872
+ readonly Mdl: 'MDL';
5873
+ readonly Mga: 'MGA';
5874
+ readonly Mkd: 'MKD';
5875
+ readonly Mmk: 'MMK';
5876
+ readonly Mop: 'MOP';
5877
+ readonly Mur: 'MUR';
5878
+ readonly Mxn: 'MXN';
5879
+ readonly Myr: 'MYR';
5880
+ readonly Mzn: 'MZN';
5881
+ readonly Nad: 'NAD';
5882
+ readonly Ngn: 'NGN';
5883
+ readonly Nio: 'NIO';
5884
+ readonly Nok: 'NOK';
5885
+ readonly Npr: 'NPR';
5886
+ readonly Nzd: 'NZD';
5887
+ readonly Omr: 'OMR';
5888
+ readonly Pab: 'PAB';
5889
+ readonly Pen: 'PEN';
5890
+ readonly Php: 'PHP';
5891
+ readonly Pkr: 'PKR';
5892
+ readonly Pln: 'PLN';
5893
+ readonly Pyg: 'PYG';
5894
+ readonly Qar: 'QAR';
5895
+ readonly Ron: 'RON';
5896
+ readonly Rsd: 'RSD';
5897
+ readonly Rub: 'RUB';
5898
+ readonly Rwf: 'RWF';
5899
+ readonly Sar: 'SAR';
5900
+ readonly Sdg: 'SDG';
5901
+ readonly Sek: 'SEK';
5902
+ readonly Sgd: 'SGD';
5903
+ readonly Sos: 'SOS';
5904
+ readonly Syp: 'SYP';
5905
+ readonly Thb: 'THB';
5906
+ readonly Tnd: 'TND';
5907
+ readonly Top: 'TOP';
5908
+ readonly Try: 'TRY';
5909
+ readonly Ttd: 'TTD';
5910
+ readonly Twd: 'TWD';
5911
+ readonly Tzs: 'TZS';
5912
+ readonly Uah: 'UAH';
5913
+ readonly Ugx: 'UGX';
5914
+ readonly Uyu: 'UYU';
5915
+ readonly Uzs: 'UZS';
5916
+ readonly Vef: 'VEF';
5917
+ readonly Vnd: 'VND';
5918
+ readonly Xaf: 'XAF';
5919
+ readonly Xof: 'XOF';
5920
+ readonly Yer: 'YER';
5921
+ readonly Zar: 'ZAR';
5960
5922
  };
5961
5923
  export type ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum[keyof typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum];
5962
5924
  /**
@@ -6279,8 +6241,8 @@ export interface Member {
6279
6241
  'last_login_at'?: string | null;
6280
6242
  }
6281
6243
  export declare const MemberStatusEnum: {
6282
- readonly Registered: "REGISTERED";
6283
- readonly Invited: "INVITED";
6244
+ readonly Registered: 'REGISTERED';
6245
+ readonly Invited: 'INVITED';
6284
6246
  };
6285
6247
  export type MemberStatusEnum = typeof MemberStatusEnum[keyof typeof MemberStatusEnum];
6286
6248
  /**
@@ -6327,8 +6289,8 @@ export interface MemberBase {
6327
6289
  'status': MemberBaseStatusEnum;
6328
6290
  }
6329
6291
  export declare const MemberBaseStatusEnum: {
6330
- readonly Registered: "REGISTERED";
6331
- readonly Invited: "INVITED";
6292
+ readonly Registered: 'REGISTERED';
6293
+ readonly Invited: 'INVITED';
6332
6294
  };
6333
6295
  export type MemberBaseStatusEnum = typeof MemberBaseStatusEnum[keyof typeof MemberBaseStatusEnum];
6334
6296
  /**
@@ -6381,8 +6343,8 @@ export interface MemberWithEvents {
6381
6343
  'events'?: Array<GetMember200ResponseMemberEventsInner>;
6382
6344
  }
6383
6345
  export declare const MemberWithEventsStatusEnum: {
6384
- readonly Registered: "REGISTERED";
6385
- readonly Invited: "INVITED";
6346
+ readonly Registered: 'REGISTERED';
6347
+ readonly Invited: 'INVITED';
6386
6348
  };
6387
6349
  export type MemberWithEventsStatusEnum = typeof MemberWithEventsStatusEnum[keyof typeof MemberWithEventsStatusEnum];
6388
6350
  /**
@@ -6441,8 +6403,8 @@ export interface MemberWithoutEvents {
6441
6403
  'last_login_at'?: string | null;
6442
6404
  }
6443
6405
  export declare const MemberWithoutEventsStatusEnum: {
6444
- readonly Registered: "REGISTERED";
6445
- readonly Invited: "INVITED";
6406
+ readonly Registered: 'REGISTERED';
6407
+ readonly Invited: 'INVITED';
6446
6408
  };
6447
6409
  export type MemberWithoutEventsStatusEnum = typeof MemberWithoutEventsStatusEnum[keyof typeof MemberWithoutEventsStatusEnum];
6448
6410
  /**
@@ -6507,24 +6469,24 @@ export interface Order {
6507
6469
  'rewards'?: Array<OrderWithoutLinkRewardsInner>;
6508
6470
  }
6509
6471
  export declare const OrderStatusEnum: {
6510
- readonly Canceled: "CANCELED";
6511
- readonly Open: "OPEN";
6512
- readonly Executed: "EXECUTED";
6513
- readonly Failed: "FAILED";
6514
- readonly PendingApproval: "PENDING APPROVAL";
6515
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
6516
- readonly PendingSettlement: "PENDING SETTLEMENT";
6472
+ readonly Canceled: 'CANCELED';
6473
+ readonly Open: 'OPEN';
6474
+ readonly Executed: 'EXECUTED';
6475
+ readonly Failed: 'FAILED';
6476
+ readonly PendingApproval: 'PENDING APPROVAL';
6477
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
6478
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
6517
6479
  };
6518
6480
  export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
6519
6481
  export declare const OrderChannelEnum: {
6520
- readonly Ui: "UI";
6521
- readonly Api: "API";
6522
- readonly Embed: "EMBED";
6523
- readonly Decipher: "DECIPHER";
6524
- readonly Qualtrics: "QUALTRICS";
6525
- readonly Typeform: "TYPEFORM";
6526
- readonly SurveyMonkey: "SURVEY MONKEY";
6527
- readonly Yotpo: "YOTPO";
6482
+ readonly Ui: 'UI';
6483
+ readonly Api: 'API';
6484
+ readonly Embed: 'EMBED';
6485
+ readonly Decipher: 'DECIPHER';
6486
+ readonly Qualtrics: 'QUALTRICS';
6487
+ readonly Typeform: 'TYPEFORM';
6488
+ readonly SurveyMonkey: 'SURVEY MONKEY';
6489
+ readonly Yotpo: 'YOTPO';
6528
6490
  };
6529
6491
  export type OrderChannelEnum = typeof OrderChannelEnum[keyof typeof OrderChannelEnum];
6530
6492
  /**
@@ -6583,24 +6545,24 @@ export interface OrderBase {
6583
6545
  'invoice_id'?: string;
6584
6546
  }
6585
6547
  export declare const OrderBaseStatusEnum: {
6586
- readonly Canceled: "CANCELED";
6587
- readonly Open: "OPEN";
6588
- readonly Executed: "EXECUTED";
6589
- readonly Failed: "FAILED";
6590
- readonly PendingApproval: "PENDING APPROVAL";
6591
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
6592
- readonly PendingSettlement: "PENDING SETTLEMENT";
6548
+ readonly Canceled: 'CANCELED';
6549
+ readonly Open: 'OPEN';
6550
+ readonly Executed: 'EXECUTED';
6551
+ readonly Failed: 'FAILED';
6552
+ readonly PendingApproval: 'PENDING APPROVAL';
6553
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
6554
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
6593
6555
  };
6594
6556
  export type OrderBaseStatusEnum = typeof OrderBaseStatusEnum[keyof typeof OrderBaseStatusEnum];
6595
6557
  export declare const OrderBaseChannelEnum: {
6596
- readonly Ui: "UI";
6597
- readonly Api: "API";
6598
- readonly Embed: "EMBED";
6599
- readonly Decipher: "DECIPHER";
6600
- readonly Qualtrics: "QUALTRICS";
6601
- readonly Typeform: "TYPEFORM";
6602
- readonly SurveyMonkey: "SURVEY MONKEY";
6603
- readonly Yotpo: "YOTPO";
6558
+ readonly Ui: 'UI';
6559
+ readonly Api: 'API';
6560
+ readonly Embed: 'EMBED';
6561
+ readonly Decipher: 'DECIPHER';
6562
+ readonly Qualtrics: 'QUALTRICS';
6563
+ readonly Typeform: 'TYPEFORM';
6564
+ readonly SurveyMonkey: 'SURVEY MONKEY';
6565
+ readonly Yotpo: 'YOTPO';
6604
6566
  };
6605
6567
  export type OrderBaseChannelEnum = typeof OrderBaseChannelEnum[keyof typeof OrderBaseChannelEnum];
6606
6568
  /**
@@ -6652,13 +6614,13 @@ export interface OrderBasePayment {
6652
6614
  * @enum {string}
6653
6615
  */
6654
6616
  export declare const OrderStatus: {
6655
- readonly Canceled: "CANCELED";
6656
- readonly Open: "OPEN";
6657
- readonly Executed: "EXECUTED";
6658
- readonly Failed: "FAILED";
6659
- readonly PendingApproval: "PENDING APPROVAL";
6660
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
6661
- readonly PendingSettlement: "PENDING SETTLEMENT";
6617
+ readonly Canceled: 'CANCELED';
6618
+ readonly Open: 'OPEN';
6619
+ readonly Executed: 'EXECUTED';
6620
+ readonly Failed: 'FAILED';
6621
+ readonly PendingApproval: 'PENDING APPROVAL';
6622
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
6623
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
6662
6624
  };
6663
6625
  export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
6664
6626
  /**
@@ -6723,24 +6685,24 @@ export interface OrderWithLink {
6723
6685
  'rewards'?: Array<OrderWithLinkRewardsInner>;
6724
6686
  }
6725
6687
  export declare const OrderWithLinkStatusEnum: {
6726
- readonly Canceled: "CANCELED";
6727
- readonly Open: "OPEN";
6728
- readonly Executed: "EXECUTED";
6729
- readonly Failed: "FAILED";
6730
- readonly PendingApproval: "PENDING APPROVAL";
6731
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
6732
- readonly PendingSettlement: "PENDING SETTLEMENT";
6688
+ readonly Canceled: 'CANCELED';
6689
+ readonly Open: 'OPEN';
6690
+ readonly Executed: 'EXECUTED';
6691
+ readonly Failed: 'FAILED';
6692
+ readonly PendingApproval: 'PENDING APPROVAL';
6693
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
6694
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
6733
6695
  };
6734
6696
  export type OrderWithLinkStatusEnum = typeof OrderWithLinkStatusEnum[keyof typeof OrderWithLinkStatusEnum];
6735
6697
  export declare const OrderWithLinkChannelEnum: {
6736
- readonly Ui: "UI";
6737
- readonly Api: "API";
6738
- readonly Embed: "EMBED";
6739
- readonly Decipher: "DECIPHER";
6740
- readonly Qualtrics: "QUALTRICS";
6741
- readonly Typeform: "TYPEFORM";
6742
- readonly SurveyMonkey: "SURVEY MONKEY";
6743
- readonly Yotpo: "YOTPO";
6698
+ readonly Ui: 'UI';
6699
+ readonly Api: 'API';
6700
+ readonly Embed: 'EMBED';
6701
+ readonly Decipher: 'DECIPHER';
6702
+ readonly Qualtrics: 'QUALTRICS';
6703
+ readonly Typeform: 'TYPEFORM';
6704
+ readonly SurveyMonkey: 'SURVEY MONKEY';
6705
+ readonly Yotpo: 'YOTPO';
6744
6706
  };
6745
6707
  export type OrderWithLinkChannelEnum = typeof OrderWithLinkChannelEnum[keyof typeof OrderWithLinkChannelEnum];
6746
6708
  /**
@@ -6878,24 +6840,24 @@ export interface OrderWithoutLink {
6878
6840
  'rewards'?: Array<OrderWithoutLinkRewardsInner>;
6879
6841
  }
6880
6842
  export declare const OrderWithoutLinkStatusEnum: {
6881
- readonly Canceled: "CANCELED";
6882
- readonly Open: "OPEN";
6883
- readonly Executed: "EXECUTED";
6884
- readonly Failed: "FAILED";
6885
- readonly PendingApproval: "PENDING APPROVAL";
6886
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
6887
- readonly PendingSettlement: "PENDING SETTLEMENT";
6843
+ readonly Canceled: 'CANCELED';
6844
+ readonly Open: 'OPEN';
6845
+ readonly Executed: 'EXECUTED';
6846
+ readonly Failed: 'FAILED';
6847
+ readonly PendingApproval: 'PENDING APPROVAL';
6848
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
6849
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
6888
6850
  };
6889
6851
  export type OrderWithoutLinkStatusEnum = typeof OrderWithoutLinkStatusEnum[keyof typeof OrderWithoutLinkStatusEnum];
6890
6852
  export declare const OrderWithoutLinkChannelEnum: {
6891
- readonly Ui: "UI";
6892
- readonly Api: "API";
6893
- readonly Embed: "EMBED";
6894
- readonly Decipher: "DECIPHER";
6895
- readonly Qualtrics: "QUALTRICS";
6896
- readonly Typeform: "TYPEFORM";
6897
- readonly SurveyMonkey: "SURVEY MONKEY";
6898
- readonly Yotpo: "YOTPO";
6853
+ readonly Ui: 'UI';
6854
+ readonly Api: 'API';
6855
+ readonly Embed: 'EMBED';
6856
+ readonly Decipher: 'DECIPHER';
6857
+ readonly Qualtrics: 'QUALTRICS';
6858
+ readonly Typeform: 'TYPEFORM';
6859
+ readonly SurveyMonkey: 'SURVEY MONKEY';
6860
+ readonly Yotpo: 'YOTPO';
6899
6861
  };
6900
6862
  export type OrderWithoutLinkChannelEnum = typeof OrderWithoutLinkChannelEnum[keyof typeof OrderWithoutLinkChannelEnum];
6901
6863
  /**
@@ -7015,9 +6977,9 @@ export interface Organization {
7015
6977
  'created_at'?: string;
7016
6978
  }
7017
6979
  export declare const OrganizationStatusEnum: {
7018
- readonly Pending: "PENDING";
7019
- readonly Approved: "APPROVED";
7020
- readonly Rejected: "REJECTED";
6980
+ readonly Pending: 'PENDING';
6981
+ readonly Approved: 'APPROVED';
6982
+ readonly Rejected: 'REJECTED';
7021
6983
  };
7022
6984
  export type OrganizationStatusEnum = typeof OrganizationStatusEnum[keyof typeof OrganizationStatusEnum];
7023
6985
  /**
@@ -7132,12 +7094,12 @@ export interface Payout {
7132
7094
  'defer_execution_until'?: string | null;
7133
7095
  }
7134
7096
  export declare const PayoutStatusEnum: {
7135
- readonly Unexecuted: "UNEXECUTED";
7136
- readonly Completed: "COMPLETED";
7137
- readonly Failed: "FAILED";
7138
- readonly Canceled: "CANCELED";
7139
- readonly OrganizationReview: "ORGANIZATION_REVIEW";
7140
- readonly AdminHeld: "ADMIN_HELD";
7097
+ readonly Unexecuted: 'UNEXECUTED';
7098
+ readonly Completed: 'COMPLETED';
7099
+ readonly Failed: 'FAILED';
7100
+ readonly Canceled: 'CANCELED';
7101
+ readonly OrganizationReview: 'ORGANIZATION_REVIEW';
7102
+ readonly AdminHeld: 'ADMIN_HELD';
7141
7103
  };
7142
7104
  export type PayoutStatusEnum = typeof PayoutStatusEnum[keyof typeof PayoutStatusEnum];
7143
7105
  /**
@@ -7220,145 +7182,145 @@ export interface Product {
7220
7182
  'documents'?: ListProductsResponseProductsInnerDocuments | null;
7221
7183
  }
7222
7184
  export declare const ProductCategoryEnum: {
7223
- readonly Ach: "ach";
7224
- readonly Charity: "charity";
7225
- readonly InstantDebitTransfer: "instant_debit_transfer";
7226
- readonly MerchantCard: "merchant_card";
7227
- readonly Paypal: "paypal";
7228
- readonly Venmo: "venmo";
7229
- readonly VisaCard: "visa_card";
7230
- readonly CashApp: "cash_app";
7231
- readonly InternationalBank: "international_bank";
7232
- readonly Wallet: "wallet";
7185
+ readonly Ach: 'ach';
7186
+ readonly Charity: 'charity';
7187
+ readonly InstantDebitTransfer: 'instant_debit_transfer';
7188
+ readonly MerchantCard: 'merchant_card';
7189
+ readonly Paypal: 'paypal';
7190
+ readonly Venmo: 'venmo';
7191
+ readonly VisaCard: 'visa_card';
7192
+ readonly CashApp: 'cash_app';
7193
+ readonly InternationalBank: 'international_bank';
7194
+ readonly Wallet: 'wallet';
7233
7195
  };
7234
7196
  export type ProductCategoryEnum = typeof ProductCategoryEnum[keyof typeof ProductCategoryEnum];
7235
7197
  export declare const ProductSubcategoryEnum: {
7236
- readonly BeautyAndHealth: "beauty_and_health";
7237
- readonly DigitalFinancialServices: "digital_financial_services";
7238
- readonly Electronics: "electronics";
7239
- readonly Entertainment: "entertainment";
7240
- readonly Fashion: "fashion";
7241
- readonly FoodAndDrink: "food_and_drink";
7242
- readonly GeneralMerchandise: "general_merchandise";
7243
- readonly GroceryAndSupermarkets: "grocery_and_supermarkets";
7244
- readonly HomeAndLiving: "home_and_living";
7245
- readonly MobilityAndFuel: "mobility_and_fuel";
7246
- readonly SportsAndOutdoorGear: "sports_and_outdoor_gear";
7247
- readonly TravelAndHospitality: "travel_and_hospitality";
7198
+ readonly BeautyAndHealth: 'beauty_and_health';
7199
+ readonly DigitalFinancialServices: 'digital_financial_services';
7200
+ readonly Electronics: 'electronics';
7201
+ readonly Entertainment: 'entertainment';
7202
+ readonly Fashion: 'fashion';
7203
+ readonly FoodAndDrink: 'food_and_drink';
7204
+ readonly GeneralMerchandise: 'general_merchandise';
7205
+ readonly GroceryAndSupermarkets: 'grocery_and_supermarkets';
7206
+ readonly HomeAndLiving: 'home_and_living';
7207
+ readonly MobilityAndFuel: 'mobility_and_fuel';
7208
+ readonly SportsAndOutdoorGear: 'sports_and_outdoor_gear';
7209
+ readonly TravelAndHospitality: 'travel_and_hospitality';
7248
7210
  };
7249
7211
  export type ProductSubcategoryEnum = typeof ProductSubcategoryEnum[keyof typeof ProductSubcategoryEnum];
7250
7212
  export declare const ProductCurrencyCodesEnum: {
7251
- readonly Usd: "USD";
7252
- readonly Cad: "CAD";
7253
- readonly Eur: "EUR";
7254
- readonly Aed: "AED";
7255
- readonly Afn: "AFN";
7256
- readonly All: "ALL";
7257
- readonly Amd: "AMD";
7258
- readonly Ars: "ARS";
7259
- readonly Aud: "AUD";
7260
- readonly Azn: "AZN";
7261
- readonly Bam: "BAM";
7262
- readonly Bdt: "BDT";
7263
- readonly Bhd: "BHD";
7264
- readonly Bif: "BIF";
7265
- readonly Bnd: "BND";
7266
- readonly Bob: "BOB";
7267
- readonly Brl: "BRL";
7268
- readonly Bwp: "BWP";
7269
- readonly Byn: "BYN";
7270
- readonly Bzd: "BZD";
7271
- readonly Cdf: "CDF";
7272
- readonly Chf: "CHF";
7273
- readonly Clp: "CLP";
7274
- readonly Cny: "CNY";
7275
- readonly Cop: "COP";
7276
- readonly Crc: "CRC";
7277
- readonly Cve: "CVE";
7278
- readonly Czk: "CZK";
7279
- readonly Djf: "DJF";
7280
- readonly Dkk: "DKK";
7281
- readonly Dop: "DOP";
7282
- readonly Dzd: "DZD";
7283
- readonly Egp: "EGP";
7284
- readonly Ern: "ERN";
7285
- readonly Etb: "ETB";
7286
- readonly Gbp: "GBP";
7287
- readonly Gel: "GEL";
7288
- readonly Ghs: "GHS";
7289
- readonly Gnf: "GNF";
7290
- readonly Gtq: "GTQ";
7291
- readonly Hkd: "HKD";
7292
- readonly Hnl: "HNL";
7293
- readonly Hrk: "HRK";
7294
- readonly Huf: "HUF";
7295
- readonly Idr: "IDR";
7296
- readonly Ils: "ILS";
7297
- readonly Inr: "INR";
7298
- readonly Iqd: "IQD";
7299
- readonly Irr: "IRR";
7300
- readonly Isk: "ISK";
7301
- readonly Jmd: "JMD";
7302
- readonly Jod: "JOD";
7303
- readonly Jpy: "JPY";
7304
- readonly Kes: "KES";
7305
- readonly Khr: "KHR";
7306
- readonly Krw: "KRW";
7307
- readonly Kwd: "KWD";
7308
- readonly Kzt: "KZT";
7309
- readonly Lbp: "LBP";
7310
- readonly Lkr: "LKR";
7311
- readonly Mad: "MAD";
7312
- readonly Mdl: "MDL";
7313
- readonly Mga: "MGA";
7314
- readonly Mkd: "MKD";
7315
- readonly Mmk: "MMK";
7316
- readonly Mop: "MOP";
7317
- readonly Mur: "MUR";
7318
- readonly Mxn: "MXN";
7319
- readonly Myr: "MYR";
7320
- readonly Mzn: "MZN";
7321
- readonly Nad: "NAD";
7322
- readonly Ngn: "NGN";
7323
- readonly Nio: "NIO";
7324
- readonly Nok: "NOK";
7325
- readonly Npr: "NPR";
7326
- readonly Nzd: "NZD";
7327
- readonly Omr: "OMR";
7328
- readonly Pab: "PAB";
7329
- readonly Pen: "PEN";
7330
- readonly Php: "PHP";
7331
- readonly Pkr: "PKR";
7332
- readonly Pln: "PLN";
7333
- readonly Pyg: "PYG";
7334
- readonly Qar: "QAR";
7335
- readonly Ron: "RON";
7336
- readonly Rsd: "RSD";
7337
- readonly Rub: "RUB";
7338
- readonly Rwf: "RWF";
7339
- readonly Sar: "SAR";
7340
- readonly Sdg: "SDG";
7341
- readonly Sek: "SEK";
7342
- readonly Sgd: "SGD";
7343
- readonly Sos: "SOS";
7344
- readonly Syp: "SYP";
7345
- readonly Thb: "THB";
7346
- readonly Tnd: "TND";
7347
- readonly Top: "TOP";
7348
- readonly Try: "TRY";
7349
- readonly Ttd: "TTD";
7350
- readonly Twd: "TWD";
7351
- readonly Tzs: "TZS";
7352
- readonly Uah: "UAH";
7353
- readonly Ugx: "UGX";
7354
- readonly Uyu: "UYU";
7355
- readonly Uzs: "UZS";
7356
- readonly Vef: "VEF";
7357
- readonly Vnd: "VND";
7358
- readonly Xaf: "XAF";
7359
- readonly Xof: "XOF";
7360
- readonly Yer: "YER";
7361
- readonly Zar: "ZAR";
7213
+ readonly Usd: 'USD';
7214
+ readonly Cad: 'CAD';
7215
+ readonly Eur: 'EUR';
7216
+ readonly Aed: 'AED';
7217
+ readonly Afn: 'AFN';
7218
+ readonly All: 'ALL';
7219
+ readonly Amd: 'AMD';
7220
+ readonly Ars: 'ARS';
7221
+ readonly Aud: 'AUD';
7222
+ readonly Azn: 'AZN';
7223
+ readonly Bam: 'BAM';
7224
+ readonly Bdt: 'BDT';
7225
+ readonly Bhd: 'BHD';
7226
+ readonly Bif: 'BIF';
7227
+ readonly Bnd: 'BND';
7228
+ readonly Bob: 'BOB';
7229
+ readonly Brl: 'BRL';
7230
+ readonly Bwp: 'BWP';
7231
+ readonly Byn: 'BYN';
7232
+ readonly Bzd: 'BZD';
7233
+ readonly Cdf: 'CDF';
7234
+ readonly Chf: 'CHF';
7235
+ readonly Clp: 'CLP';
7236
+ readonly Cny: 'CNY';
7237
+ readonly Cop: 'COP';
7238
+ readonly Crc: 'CRC';
7239
+ readonly Cve: 'CVE';
7240
+ readonly Czk: 'CZK';
7241
+ readonly Djf: 'DJF';
7242
+ readonly Dkk: 'DKK';
7243
+ readonly Dop: 'DOP';
7244
+ readonly Dzd: 'DZD';
7245
+ readonly Egp: 'EGP';
7246
+ readonly Ern: 'ERN';
7247
+ readonly Etb: 'ETB';
7248
+ readonly Gbp: 'GBP';
7249
+ readonly Gel: 'GEL';
7250
+ readonly Ghs: 'GHS';
7251
+ readonly Gnf: 'GNF';
7252
+ readonly Gtq: 'GTQ';
7253
+ readonly Hkd: 'HKD';
7254
+ readonly Hnl: 'HNL';
7255
+ readonly Hrk: 'HRK';
7256
+ readonly Huf: 'HUF';
7257
+ readonly Idr: 'IDR';
7258
+ readonly Ils: 'ILS';
7259
+ readonly Inr: 'INR';
7260
+ readonly Iqd: 'IQD';
7261
+ readonly Irr: 'IRR';
7262
+ readonly Isk: 'ISK';
7263
+ readonly Jmd: 'JMD';
7264
+ readonly Jod: 'JOD';
7265
+ readonly Jpy: 'JPY';
7266
+ readonly Kes: 'KES';
7267
+ readonly Khr: 'KHR';
7268
+ readonly Krw: 'KRW';
7269
+ readonly Kwd: 'KWD';
7270
+ readonly Kzt: 'KZT';
7271
+ readonly Lbp: 'LBP';
7272
+ readonly Lkr: 'LKR';
7273
+ readonly Mad: 'MAD';
7274
+ readonly Mdl: 'MDL';
7275
+ readonly Mga: 'MGA';
7276
+ readonly Mkd: 'MKD';
7277
+ readonly Mmk: 'MMK';
7278
+ readonly Mop: 'MOP';
7279
+ readonly Mur: 'MUR';
7280
+ readonly Mxn: 'MXN';
7281
+ readonly Myr: 'MYR';
7282
+ readonly Mzn: 'MZN';
7283
+ readonly Nad: 'NAD';
7284
+ readonly Ngn: 'NGN';
7285
+ readonly Nio: 'NIO';
7286
+ readonly Nok: 'NOK';
7287
+ readonly Npr: 'NPR';
7288
+ readonly Nzd: 'NZD';
7289
+ readonly Omr: 'OMR';
7290
+ readonly Pab: 'PAB';
7291
+ readonly Pen: 'PEN';
7292
+ readonly Php: 'PHP';
7293
+ readonly Pkr: 'PKR';
7294
+ readonly Pln: 'PLN';
7295
+ readonly Pyg: 'PYG';
7296
+ readonly Qar: 'QAR';
7297
+ readonly Ron: 'RON';
7298
+ readonly Rsd: 'RSD';
7299
+ readonly Rub: 'RUB';
7300
+ readonly Rwf: 'RWF';
7301
+ readonly Sar: 'SAR';
7302
+ readonly Sdg: 'SDG';
7303
+ readonly Sek: 'SEK';
7304
+ readonly Sgd: 'SGD';
7305
+ readonly Sos: 'SOS';
7306
+ readonly Syp: 'SYP';
7307
+ readonly Thb: 'THB';
7308
+ readonly Tnd: 'TND';
7309
+ readonly Top: 'TOP';
7310
+ readonly Try: 'TRY';
7311
+ readonly Ttd: 'TTD';
7312
+ readonly Twd: 'TWD';
7313
+ readonly Tzs: 'TZS';
7314
+ readonly Uah: 'UAH';
7315
+ readonly Ugx: 'UGX';
7316
+ readonly Uyu: 'UYU';
7317
+ readonly Uzs: 'UZS';
7318
+ readonly Vef: 'VEF';
7319
+ readonly Vnd: 'VND';
7320
+ readonly Xaf: 'XAF';
7321
+ readonly Xof: 'XOF';
7322
+ readonly Yer: 'YER';
7323
+ readonly Zar: 'ZAR';
7362
7324
  };
7363
7325
  export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum];
7364
7326
  /**
@@ -7468,10 +7430,10 @@ export interface Report {
7468
7430
  'url'?: string | null;
7469
7431
  }
7470
7432
  export declare const ReportStatusEnum: {
7471
- readonly Created: "CREATED";
7472
- readonly Processing: "PROCESSING";
7473
- readonly ReadyForDownload: "READY_FOR_DOWNLOAD";
7474
- readonly Failed: "FAILED";
7433
+ readonly Created: 'CREATED';
7434
+ readonly Processing: 'PROCESSING';
7435
+ readonly ReadyForDownload: 'READY_FOR_DOWNLOAD';
7436
+ readonly Failed: 'FAILED';
7475
7437
  };
7476
7438
  export type ReportStatusEnum = typeof ReportStatusEnum[keyof typeof ReportStatusEnum];
7477
7439
  /**
@@ -7532,8 +7494,8 @@ export interface ReviewCountry {
7532
7494
  'countries': Array<string>;
7533
7495
  }
7534
7496
  export declare const ReviewCountryTypeEnum: {
7535
- readonly Whitelist: "whitelist";
7536
- readonly Blacklist: "blacklist";
7497
+ readonly Whitelist: 'whitelist';
7498
+ readonly Blacklist: 'blacklist';
7537
7499
  };
7538
7500
  export type ReviewCountryTypeEnum = typeof ReviewCountryTypeEnum[keyof typeof ReviewCountryTypeEnum];
7539
7501
  /**
@@ -7633,12 +7595,12 @@ export interface ReviewRedeemedRewardsAmount {
7633
7595
  'period': ReviewRedeemedRewardsAmountPeriodEnum;
7634
7596
  }
7635
7597
  export declare const ReviewRedeemedRewardsAmountPeriodEnum: {
7636
- readonly _7: "7";
7637
- readonly _30: "30";
7638
- readonly _90: "90";
7639
- readonly _120: "120";
7640
- readonly _365: "365";
7641
- readonly AllTime: "all_time";
7598
+ readonly _7: '7';
7599
+ readonly _30: '30';
7600
+ readonly _90: '90';
7601
+ readonly _120: '120';
7602
+ readonly _365: '365';
7603
+ readonly AllTime: 'all_time';
7642
7604
  };
7643
7605
  export type ReviewRedeemedRewardsAmountPeriodEnum = typeof ReviewRedeemedRewardsAmountPeriodEnum[keyof typeof ReviewRedeemedRewardsAmountPeriodEnum];
7644
7606
  /**
@@ -7661,12 +7623,12 @@ export interface ReviewRedeemedRewardsCount {
7661
7623
  'period': ReviewRedeemedRewardsCountPeriodEnum;
7662
7624
  }
7663
7625
  export declare const ReviewRedeemedRewardsCountPeriodEnum: {
7664
- readonly _7: "7";
7665
- readonly _30: "30";
7666
- readonly _90: "90";
7667
- readonly _120: "120";
7668
- readonly _365: "365";
7669
- readonly AllTime: "all_time";
7626
+ readonly _7: '7';
7627
+ readonly _30: '30';
7628
+ readonly _90: '90';
7629
+ readonly _120: '120';
7630
+ readonly _365: '365';
7631
+ readonly AllTime: 'all_time';
7670
7632
  };
7671
7633
  export type ReviewRedeemedRewardsCountPeriodEnum = typeof ReviewRedeemedRewardsCountPeriodEnum[keyof typeof ReviewRedeemedRewardsCountPeriodEnum];
7672
7634
  /**
@@ -7990,117 +7952,117 @@ export interface RewardValue {
7990
7952
  'currency_code'?: RewardValueCurrencyCodeEnum;
7991
7953
  }
7992
7954
  export declare const RewardValueCurrencyCodeEnum: {
7993
- readonly Usd: "USD";
7994
- readonly Cad: "CAD";
7995
- readonly Eur: "EUR";
7996
- readonly Aed: "AED";
7997
- readonly Afn: "AFN";
7998
- readonly All: "ALL";
7999
- readonly Amd: "AMD";
8000
- readonly Ars: "ARS";
8001
- readonly Aud: "AUD";
8002
- readonly Azn: "AZN";
8003
- readonly Bam: "BAM";
8004
- readonly Bdt: "BDT";
8005
- readonly Bhd: "BHD";
8006
- readonly Bif: "BIF";
8007
- readonly Bnd: "BND";
8008
- readonly Bob: "BOB";
8009
- readonly Brl: "BRL";
8010
- readonly Bwp: "BWP";
8011
- readonly Byn: "BYN";
8012
- readonly Bzd: "BZD";
8013
- readonly Cdf: "CDF";
8014
- readonly Chf: "CHF";
8015
- readonly Clp: "CLP";
8016
- readonly Cny: "CNY";
8017
- readonly Cop: "COP";
8018
- readonly Crc: "CRC";
8019
- readonly Cve: "CVE";
8020
- readonly Czk: "CZK";
8021
- readonly Djf: "DJF";
8022
- readonly Dkk: "DKK";
8023
- readonly Dop: "DOP";
8024
- readonly Dzd: "DZD";
8025
- readonly Egp: "EGP";
8026
- readonly Ern: "ERN";
8027
- readonly Etb: "ETB";
8028
- readonly Gbp: "GBP";
8029
- readonly Gel: "GEL";
8030
- readonly Ghs: "GHS";
8031
- readonly Gnf: "GNF";
8032
- readonly Gtq: "GTQ";
8033
- readonly Hkd: "HKD";
8034
- readonly Hnl: "HNL";
8035
- readonly Hrk: "HRK";
8036
- readonly Huf: "HUF";
8037
- readonly Idr: "IDR";
8038
- readonly Ils: "ILS";
8039
- readonly Inr: "INR";
8040
- readonly Iqd: "IQD";
8041
- readonly Irr: "IRR";
8042
- readonly Isk: "ISK";
8043
- readonly Jmd: "JMD";
8044
- readonly Jod: "JOD";
8045
- readonly Jpy: "JPY";
8046
- readonly Kes: "KES";
8047
- readonly Khr: "KHR";
8048
- readonly Krw: "KRW";
8049
- readonly Kwd: "KWD";
8050
- readonly Kzt: "KZT";
8051
- readonly Lbp: "LBP";
8052
- readonly Lkr: "LKR";
8053
- readonly Mad: "MAD";
8054
- readonly Mdl: "MDL";
8055
- readonly Mga: "MGA";
8056
- readonly Mkd: "MKD";
8057
- readonly Mmk: "MMK";
8058
- readonly Mop: "MOP";
8059
- readonly Mur: "MUR";
8060
- readonly Mxn: "MXN";
8061
- readonly Myr: "MYR";
8062
- readonly Mzn: "MZN";
8063
- readonly Nad: "NAD";
8064
- readonly Ngn: "NGN";
8065
- readonly Nio: "NIO";
8066
- readonly Nok: "NOK";
8067
- readonly Npr: "NPR";
8068
- readonly Nzd: "NZD";
8069
- readonly Omr: "OMR";
8070
- readonly Pab: "PAB";
8071
- readonly Pen: "PEN";
8072
- readonly Php: "PHP";
8073
- readonly Pkr: "PKR";
8074
- readonly Pln: "PLN";
8075
- readonly Pyg: "PYG";
8076
- readonly Qar: "QAR";
8077
- readonly Ron: "RON";
8078
- readonly Rsd: "RSD";
8079
- readonly Rub: "RUB";
8080
- readonly Rwf: "RWF";
8081
- readonly Sar: "SAR";
8082
- readonly Sdg: "SDG";
8083
- readonly Sek: "SEK";
8084
- readonly Sgd: "SGD";
8085
- readonly Sos: "SOS";
8086
- readonly Syp: "SYP";
8087
- readonly Thb: "THB";
8088
- readonly Tnd: "TND";
8089
- readonly Top: "TOP";
8090
- readonly Try: "TRY";
8091
- readonly Ttd: "TTD";
8092
- readonly Twd: "TWD";
8093
- readonly Tzs: "TZS";
8094
- readonly Uah: "UAH";
8095
- readonly Ugx: "UGX";
8096
- readonly Uyu: "UYU";
8097
- readonly Uzs: "UZS";
8098
- readonly Vef: "VEF";
8099
- readonly Vnd: "VND";
8100
- readonly Xaf: "XAF";
8101
- readonly Xof: "XOF";
8102
- readonly Yer: "YER";
8103
- readonly Zar: "ZAR";
7955
+ readonly Usd: 'USD';
7956
+ readonly Cad: 'CAD';
7957
+ readonly Eur: 'EUR';
7958
+ readonly Aed: 'AED';
7959
+ readonly Afn: 'AFN';
7960
+ readonly All: 'ALL';
7961
+ readonly Amd: 'AMD';
7962
+ readonly Ars: 'ARS';
7963
+ readonly Aud: 'AUD';
7964
+ readonly Azn: 'AZN';
7965
+ readonly Bam: 'BAM';
7966
+ readonly Bdt: 'BDT';
7967
+ readonly Bhd: 'BHD';
7968
+ readonly Bif: 'BIF';
7969
+ readonly Bnd: 'BND';
7970
+ readonly Bob: 'BOB';
7971
+ readonly Brl: 'BRL';
7972
+ readonly Bwp: 'BWP';
7973
+ readonly Byn: 'BYN';
7974
+ readonly Bzd: 'BZD';
7975
+ readonly Cdf: 'CDF';
7976
+ readonly Chf: 'CHF';
7977
+ readonly Clp: 'CLP';
7978
+ readonly Cny: 'CNY';
7979
+ readonly Cop: 'COP';
7980
+ readonly Crc: 'CRC';
7981
+ readonly Cve: 'CVE';
7982
+ readonly Czk: 'CZK';
7983
+ readonly Djf: 'DJF';
7984
+ readonly Dkk: 'DKK';
7985
+ readonly Dop: 'DOP';
7986
+ readonly Dzd: 'DZD';
7987
+ readonly Egp: 'EGP';
7988
+ readonly Ern: 'ERN';
7989
+ readonly Etb: 'ETB';
7990
+ readonly Gbp: 'GBP';
7991
+ readonly Gel: 'GEL';
7992
+ readonly Ghs: 'GHS';
7993
+ readonly Gnf: 'GNF';
7994
+ readonly Gtq: 'GTQ';
7995
+ readonly Hkd: 'HKD';
7996
+ readonly Hnl: 'HNL';
7997
+ readonly Hrk: 'HRK';
7998
+ readonly Huf: 'HUF';
7999
+ readonly Idr: 'IDR';
8000
+ readonly Ils: 'ILS';
8001
+ readonly Inr: 'INR';
8002
+ readonly Iqd: 'IQD';
8003
+ readonly Irr: 'IRR';
8004
+ readonly Isk: 'ISK';
8005
+ readonly Jmd: 'JMD';
8006
+ readonly Jod: 'JOD';
8007
+ readonly Jpy: 'JPY';
8008
+ readonly Kes: 'KES';
8009
+ readonly Khr: 'KHR';
8010
+ readonly Krw: 'KRW';
8011
+ readonly Kwd: 'KWD';
8012
+ readonly Kzt: 'KZT';
8013
+ readonly Lbp: 'LBP';
8014
+ readonly Lkr: 'LKR';
8015
+ readonly Mad: 'MAD';
8016
+ readonly Mdl: 'MDL';
8017
+ readonly Mga: 'MGA';
8018
+ readonly Mkd: 'MKD';
8019
+ readonly Mmk: 'MMK';
8020
+ readonly Mop: 'MOP';
8021
+ readonly Mur: 'MUR';
8022
+ readonly Mxn: 'MXN';
8023
+ readonly Myr: 'MYR';
8024
+ readonly Mzn: 'MZN';
8025
+ readonly Nad: 'NAD';
8026
+ readonly Ngn: 'NGN';
8027
+ readonly Nio: 'NIO';
8028
+ readonly Nok: 'NOK';
8029
+ readonly Npr: 'NPR';
8030
+ readonly Nzd: 'NZD';
8031
+ readonly Omr: 'OMR';
8032
+ readonly Pab: 'PAB';
8033
+ readonly Pen: 'PEN';
8034
+ readonly Php: 'PHP';
8035
+ readonly Pkr: 'PKR';
8036
+ readonly Pln: 'PLN';
8037
+ readonly Pyg: 'PYG';
8038
+ readonly Qar: 'QAR';
8039
+ readonly Ron: 'RON';
8040
+ readonly Rsd: 'RSD';
8041
+ readonly Rub: 'RUB';
8042
+ readonly Rwf: 'RWF';
8043
+ readonly Sar: 'SAR';
8044
+ readonly Sdg: 'SDG';
8045
+ readonly Sek: 'SEK';
8046
+ readonly Sgd: 'SGD';
8047
+ readonly Sos: 'SOS';
8048
+ readonly Syp: 'SYP';
8049
+ readonly Thb: 'THB';
8050
+ readonly Tnd: 'TND';
8051
+ readonly Top: 'TOP';
8052
+ readonly Try: 'TRY';
8053
+ readonly Ttd: 'TTD';
8054
+ readonly Twd: 'TWD';
8055
+ readonly Tzs: 'TZS';
8056
+ readonly Uah: 'UAH';
8057
+ readonly Ugx: 'UGX';
8058
+ readonly Uyu: 'UYU';
8059
+ readonly Uzs: 'UZS';
8060
+ readonly Vef: 'VEF';
8061
+ readonly Vnd: 'VND';
8062
+ readonly Xaf: 'XAF';
8063
+ readonly Xof: 'XOF';
8064
+ readonly Yer: 'YER';
8065
+ readonly Zar: 'ZAR';
8104
8066
  };
8105
8067
  export type RewardValueCurrencyCodeEnum = typeof RewardValueCurrencyCodeEnum[keyof typeof RewardValueCurrencyCodeEnum];
8106
8068
  /**
@@ -8202,16 +8164,16 @@ export interface RewardWithLinkDelivery {
8202
8164
  'link'?: string;
8203
8165
  }
8204
8166
  export declare const RewardWithLinkDeliveryMethodEnum: {
8205
- readonly Email: "EMAIL";
8206
- readonly Link: "LINK";
8207
- readonly Phone: "PHONE";
8167
+ readonly Email: 'EMAIL';
8168
+ readonly Link: 'LINK';
8169
+ readonly Phone: 'PHONE';
8208
8170
  };
8209
8171
  export type RewardWithLinkDeliveryMethodEnum = typeof RewardWithLinkDeliveryMethodEnum[keyof typeof RewardWithLinkDeliveryMethodEnum];
8210
8172
  export declare const RewardWithLinkDeliveryStatusEnum: {
8211
- readonly Scheduled: "SCHEDULED";
8212
- readonly Failed: "FAILED";
8213
- readonly Succeeded: "SUCCEEDED";
8214
- readonly Pending: "PENDING";
8173
+ readonly Scheduled: 'SCHEDULED';
8174
+ readonly Failed: 'FAILED';
8175
+ readonly Succeeded: 'SUCCEEDED';
8176
+ readonly Pending: 'PENDING';
8215
8177
  };
8216
8178
  export type RewardWithLinkDeliveryStatusEnum = typeof RewardWithLinkDeliveryStatusEnum[keyof typeof RewardWithLinkDeliveryStatusEnum];
8217
8179
  /**
@@ -8307,16 +8269,16 @@ export interface RewardWithoutLinkDelivery {
8307
8269
  'status'?: RewardWithoutLinkDeliveryStatusEnum;
8308
8270
  }
8309
8271
  export declare const RewardWithoutLinkDeliveryMethodEnum: {
8310
- readonly Email: "EMAIL";
8311
- readonly Link: "LINK";
8312
- readonly Phone: "PHONE";
8272
+ readonly Email: 'EMAIL';
8273
+ readonly Link: 'LINK';
8274
+ readonly Phone: 'PHONE';
8313
8275
  };
8314
8276
  export type RewardWithoutLinkDeliveryMethodEnum = typeof RewardWithoutLinkDeliveryMethodEnum[keyof typeof RewardWithoutLinkDeliveryMethodEnum];
8315
8277
  export declare const RewardWithoutLinkDeliveryStatusEnum: {
8316
- readonly Scheduled: "SCHEDULED";
8317
- readonly Failed: "FAILED";
8318
- readonly Succeeded: "SUCCEEDED";
8319
- readonly Pending: "PENDING";
8278
+ readonly Scheduled: 'SCHEDULED';
8279
+ readonly Failed: 'FAILED';
8280
+ readonly Succeeded: 'SUCCEEDED';
8281
+ readonly Pending: 'PENDING';
8320
8282
  };
8321
8283
  export type RewardWithoutLinkDeliveryStatusEnum = typeof RewardWithoutLinkDeliveryStatusEnum[keyof typeof RewardWithoutLinkDeliveryStatusEnum];
8322
8284
  /**
@@ -8489,9 +8451,9 @@ export interface SingleRewardOrderRewardDelivery {
8489
8451
  'meta'?: SingleRewardOrderRewardDeliveryMeta;
8490
8452
  }
8491
8453
  export declare const SingleRewardOrderRewardDeliveryMethodEnum: {
8492
- readonly Email: "EMAIL";
8493
- readonly Link: "LINK";
8494
- readonly Phone: "PHONE";
8454
+ readonly Email: 'EMAIL';
8455
+ readonly Link: 'LINK';
8456
+ readonly Phone: 'PHONE';
8495
8457
  };
8496
8458
  export type SingleRewardOrderRewardDeliveryMethodEnum = typeof SingleRewardOrderRewardDeliveryMethodEnum[keyof typeof SingleRewardOrderRewardDeliveryMethodEnum];
8497
8459
  /**
@@ -8594,24 +8556,24 @@ export interface SingleRewardOrderWithLinkOrder {
8594
8556
  'rewards'?: Array<OrderWithLinkRewardsInner>;
8595
8557
  }
8596
8558
  export declare const SingleRewardOrderWithLinkOrderStatusEnum: {
8597
- readonly Canceled: "CANCELED";
8598
- readonly Open: "OPEN";
8599
- readonly Executed: "EXECUTED";
8600
- readonly Failed: "FAILED";
8601
- readonly PendingApproval: "PENDING APPROVAL";
8602
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
8603
- readonly PendingSettlement: "PENDING SETTLEMENT";
8559
+ readonly Canceled: 'CANCELED';
8560
+ readonly Open: 'OPEN';
8561
+ readonly Executed: 'EXECUTED';
8562
+ readonly Failed: 'FAILED';
8563
+ readonly PendingApproval: 'PENDING APPROVAL';
8564
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
8565
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
8604
8566
  };
8605
8567
  export type SingleRewardOrderWithLinkOrderStatusEnum = typeof SingleRewardOrderWithLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithLinkOrderStatusEnum];
8606
8568
  export declare const SingleRewardOrderWithLinkOrderChannelEnum: {
8607
- readonly Ui: "UI";
8608
- readonly Api: "API";
8609
- readonly Embed: "EMBED";
8610
- readonly Decipher: "DECIPHER";
8611
- readonly Qualtrics: "QUALTRICS";
8612
- readonly Typeform: "TYPEFORM";
8613
- readonly SurveyMonkey: "SURVEY MONKEY";
8614
- readonly Yotpo: "YOTPO";
8569
+ readonly Ui: 'UI';
8570
+ readonly Api: 'API';
8571
+ readonly Embed: 'EMBED';
8572
+ readonly Decipher: 'DECIPHER';
8573
+ readonly Qualtrics: 'QUALTRICS';
8574
+ readonly Typeform: 'TYPEFORM';
8575
+ readonly SurveyMonkey: 'SURVEY MONKEY';
8576
+ readonly Yotpo: 'YOTPO';
8615
8577
  };
8616
8578
  export type SingleRewardOrderWithLinkOrderChannelEnum = typeof SingleRewardOrderWithLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithLinkOrderChannelEnum];
8617
8579
  /**
@@ -8689,24 +8651,24 @@ export interface SingleRewardOrderWithoutLinkOrder {
8689
8651
  'rewards'?: Array<OrderWithoutLinkRewardsInner>;
8690
8652
  }
8691
8653
  export declare const SingleRewardOrderWithoutLinkOrderStatusEnum: {
8692
- readonly Canceled: "CANCELED";
8693
- readonly Open: "OPEN";
8694
- readonly Executed: "EXECUTED";
8695
- readonly Failed: "FAILED";
8696
- readonly PendingApproval: "PENDING APPROVAL";
8697
- readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
8698
- readonly PendingSettlement: "PENDING SETTLEMENT";
8654
+ readonly Canceled: 'CANCELED';
8655
+ readonly Open: 'OPEN';
8656
+ readonly Executed: 'EXECUTED';
8657
+ readonly Failed: 'FAILED';
8658
+ readonly PendingApproval: 'PENDING APPROVAL';
8659
+ readonly PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL';
8660
+ readonly PendingSettlement: 'PENDING SETTLEMENT';
8699
8661
  };
8700
8662
  export type SingleRewardOrderWithoutLinkOrderStatusEnum = typeof SingleRewardOrderWithoutLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithoutLinkOrderStatusEnum];
8701
8663
  export declare const SingleRewardOrderWithoutLinkOrderChannelEnum: {
8702
- readonly Ui: "UI";
8703
- readonly Api: "API";
8704
- readonly Embed: "EMBED";
8705
- readonly Decipher: "DECIPHER";
8706
- readonly Qualtrics: "QUALTRICS";
8707
- readonly Typeform: "TYPEFORM";
8708
- readonly SurveyMonkey: "SURVEY MONKEY";
8709
- readonly Yotpo: "YOTPO";
8664
+ readonly Ui: 'UI';
8665
+ readonly Api: 'API';
8666
+ readonly Embed: 'EMBED';
8667
+ readonly Decipher: 'DECIPHER';
8668
+ readonly Qualtrics: 'QUALTRICS';
8669
+ readonly Typeform: 'TYPEFORM';
8670
+ readonly SurveyMonkey: 'SURVEY MONKEY';
8671
+ readonly Yotpo: 'YOTPO';
8710
8672
  };
8711
8673
  export type SingleRewardOrderWithoutLinkOrderChannelEnum = typeof SingleRewardOrderWithoutLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithoutLinkOrderChannelEnum];
8712
8674
  /**
@@ -8887,8 +8849,8 @@ export interface UpdateCampaign {
8887
8849
  'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
8888
8850
  }
8889
8851
  export declare const UpdateCampaignFeeChargedToEnum: {
8890
- readonly Sender: "SENDER";
8891
- readonly Recipient: "RECIPIENT";
8852
+ readonly Sender: 'SENDER';
8853
+ readonly Recipient: 'RECIPIENT';
8892
8854
  };
8893
8855
  export type UpdateCampaignFeeChargedToEnum = typeof UpdateCampaignFeeChargedToEnum[keyof typeof UpdateCampaignFeeChargedToEnum];
8894
8856
  /**
@@ -8941,8 +8903,8 @@ export interface UpdateCampaignRequest {
8941
8903
  'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
8942
8904
  }
8943
8905
  export declare const UpdateCampaignRequestFeeChargedToEnum: {
8944
- readonly Sender: "SENDER";
8945
- readonly Recipient: "RECIPIENT";
8906
+ readonly Sender: 'SENDER';
8907
+ readonly Recipient: 'RECIPIENT';
8946
8908
  };
8947
8909
  export type UpdateCampaignRequestFeeChargedToEnum = typeof UpdateCampaignRequestFeeChargedToEnum[keyof typeof UpdateCampaignRequestFeeChargedToEnum];
8948
8910
  /**
@@ -8978,8 +8940,8 @@ export interface UpdateFraudRuleListRequest {
8978
8940
  'config': UpdateFraudRuleListRequestConfig;
8979
8941
  }
8980
8942
  export declare const UpdateFraudRuleListRequestOperationEnum: {
8981
- readonly Add: "add";
8982
- readonly Remove: "remove";
8943
+ readonly Add: 'add';
8944
+ readonly Remove: 'remove';
8983
8945
  };
8984
8946
  export type UpdateFraudRuleListRequestOperationEnum = typeof UpdateFraudRuleListRequestOperationEnum[keyof typeof UpdateFraudRuleListRequestOperationEnum];
8985
8947
  /**
@@ -9013,6 +8975,32 @@ export interface UpdateFraudRuleListRequestConfig {
9013
8975
  */
9014
8976
  'domains'?: Array<string>;
9015
8977
  }
8978
+ /**
8979
+ *
8980
+ * @export
8981
+ * @interface UpdateMember
8982
+ */
8983
+ export interface UpdateMember {
8984
+ /**
8985
+ * The role ID to assign to the member within the organization.
8986
+ * @type {string}
8987
+ * @memberof UpdateMember
8988
+ */
8989
+ 'role': string;
8990
+ }
8991
+ /**
8992
+ *
8993
+ * @export
8994
+ * @interface UpdateMemberRequest
8995
+ */
8996
+ export interface UpdateMemberRequest {
8997
+ /**
8998
+ * The role ID to assign to the member within the organization.
8999
+ * @type {string}
9000
+ * @memberof UpdateMemberRequest
9001
+ */
9002
+ 'role': string;
9003
+ }
9016
9004
  /**
9017
9005
  *
9018
9006
  * @export
@@ -9489,7 +9477,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
9489
9477
  */
9490
9478
  export declare const ConnectedOrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
9491
9479
  /**
9492
- * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
9480
+ * Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
9493
9481
  * @summary Create connected organization
9494
9482
  * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
9495
9483
  * @param {*} [options] Override http request option.
@@ -9528,7 +9516,7 @@ export declare const ConnectedOrganizationsApiAxiosParamCreator: (configuration?
9528
9516
  */
9529
9517
  export declare const ConnectedOrganizationsApiFp: (configuration?: Configuration) => {
9530
9518
  /**
9531
- * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
9519
+ * Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
9532
9520
  * @summary Create connected organization
9533
9521
  * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
9534
9522
  * @param {*} [options] Override http request option.
@@ -9567,7 +9555,7 @@ export declare const ConnectedOrganizationsApiFp: (configuration?: Configuration
9567
9555
  */
9568
9556
  export declare const ConnectedOrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9569
9557
  /**
9570
- * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
9558
+ * Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
9571
9559
  * @summary Create connected organization
9572
9560
  * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
9573
9561
  * @param {*} [options] Override http request option.
@@ -9608,7 +9596,7 @@ export declare const ConnectedOrganizationsApiFactory: (configuration?: Configur
9608
9596
  */
9609
9597
  export declare class ConnectedOrganizationsApi extends BaseAPI {
9610
9598
  /**
9611
- * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
9599
+ * Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
9612
9600
  * @summary Create connected organization
9613
9601
  * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
9614
9602
  * @param {*} [options] Override http request option.
@@ -9978,9 +9966,9 @@ export declare class FraudReviewsApi extends BaseAPI {
9978
9966
  * @export
9979
9967
  */
9980
9968
  export declare const ListFraudReviewsStatusEnum: {
9981
- readonly Flagged: "flagged";
9982
- readonly Blocked: "blocked";
9983
- readonly Released: "released";
9969
+ readonly Flagged: 'flagged';
9970
+ readonly Blocked: 'blocked';
9971
+ readonly Released: 'released';
9984
9972
  };
9985
9973
  export type ListFraudReviewsStatusEnum = typeof ListFraudReviewsStatusEnum[keyof typeof ListFraudReviewsStatusEnum];
9986
9974
  /**
@@ -10149,45 +10137,45 @@ export declare class FraudRulesApi extends BaseAPI {
10149
10137
  * @export
10150
10138
  */
10151
10139
  export declare const DeleteFraudRuleRuleTypeEnum: {
10152
- readonly ReviewCountry: "review_country";
10153
- readonly ReviewIp: "review_ip";
10154
- readonly ReviewEmail: "review_email";
10155
- readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
10156
- readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
10157
- readonly ReviewMultipleEmails: "review_multiple_emails";
10158
- readonly ReviewVpn: "review_vpn";
10159
- readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
10160
- readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
10161
- readonly AllowIp: "allow_ip";
10162
- readonly AllowEmail: "allow_email";
10140
+ readonly ReviewCountry: 'review_country';
10141
+ readonly ReviewIp: 'review_ip';
10142
+ readonly ReviewEmail: 'review_email';
10143
+ readonly ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count';
10144
+ readonly ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount';
10145
+ readonly ReviewMultipleEmails: 'review_multiple_emails';
10146
+ readonly ReviewVpn: 'review_vpn';
10147
+ readonly ReviewTremendousFlagList: 'review_tremendous_flag_list';
10148
+ readonly ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients';
10149
+ readonly AllowIp: 'allow_ip';
10150
+ readonly AllowEmail: 'allow_email';
10163
10151
  };
10164
10152
  export type DeleteFraudRuleRuleTypeEnum = typeof DeleteFraudRuleRuleTypeEnum[keyof typeof DeleteFraudRuleRuleTypeEnum];
10165
10153
  /**
10166
10154
  * @export
10167
10155
  */
10168
10156
  export declare const FraudRuleRuleTypeEnum: {
10169
- readonly ReviewCountry: "review_country";
10170
- readonly ReviewIp: "review_ip";
10171
- readonly ReviewEmail: "review_email";
10172
- readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count";
10173
- readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount";
10174
- readonly ReviewMultipleEmails: "review_multiple_emails";
10175
- readonly ReviewVpn: "review_vpn";
10176
- readonly ReviewTremendousFlagList: "review_tremendous_flag_list";
10177
- readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients";
10178
- readonly AllowIp: "allow_ip";
10179
- readonly AllowEmail: "allow_email";
10157
+ readonly ReviewCountry: 'review_country';
10158
+ readonly ReviewIp: 'review_ip';
10159
+ readonly ReviewEmail: 'review_email';
10160
+ readonly ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count';
10161
+ readonly ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount';
10162
+ readonly ReviewMultipleEmails: 'review_multiple_emails';
10163
+ readonly ReviewVpn: 'review_vpn';
10164
+ readonly ReviewTremendousFlagList: 'review_tremendous_flag_list';
10165
+ readonly ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients';
10166
+ readonly AllowIp: 'allow_ip';
10167
+ readonly AllowEmail: 'allow_email';
10180
10168
  };
10181
10169
  export type FraudRuleRuleTypeEnum = typeof FraudRuleRuleTypeEnum[keyof typeof FraudRuleRuleTypeEnum];
10182
10170
  /**
10183
10171
  * @export
10184
10172
  */
10185
10173
  export declare const UpdateFraudRuleListRuleTypeEnum: {
10186
- readonly ReviewCountry: "review_country";
10187
- readonly ReviewIp: "review_ip";
10188
- readonly ReviewEmail: "review_email";
10189
- readonly AllowIp: "allow_ip";
10190
- readonly AllowEmail: "allow_email";
10174
+ readonly ReviewCountry: 'review_country';
10175
+ readonly ReviewIp: 'review_ip';
10176
+ readonly ReviewEmail: 'review_email';
10177
+ readonly AllowIp: 'allow_ip';
10178
+ readonly AllowEmail: 'allow_email';
10191
10179
  };
10192
10180
  export type UpdateFraudRuleListRuleTypeEnum = typeof UpdateFraudRuleListRuleTypeEnum[keyof typeof UpdateFraudRuleListRuleTypeEnum];
10193
10181
  /**
@@ -10519,6 +10507,14 @@ export declare const MembersApiAxiosParamCreator: (configuration?: Configuration
10519
10507
  * @throws {RequiredError}
10520
10508
  */
10521
10509
  createMember: (createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10510
+ /**
10511
+ * Removes an existing member from the organization, identified by the given `id` in the URL. The member loses access to the organization and a `MEMBERS.DELETED` webhook event is emitted.
10512
+ * @summary Delete member
10513
+ * @param {string} id ID of the member to delete
10514
+ * @param {*} [options] Override http request option.
10515
+ * @throws {RequiredError}
10516
+ */
10517
+ deleteMember: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10522
10518
  /**
10523
10519
  *
10524
10520
  * @summary Retrieve member
@@ -10534,6 +10530,15 @@ export declare const MembersApiAxiosParamCreator: (configuration?: Configuration
10534
10530
  * @throws {RequiredError}
10535
10531
  */
10536
10532
  listMembers: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10533
+ /**
10534
+ * Updates the role of an existing member, identified by the given `id` in the URL. Check the Roles API for the roles available within the organization.
10535
+ * @summary Update member
10536
+ * @param {string} id ID of the member to update
10537
+ * @param {UpdateMemberRequest} updateMemberRequest Attributes to update on the member
10538
+ * @param {*} [options] Override http request option.
10539
+ * @throws {RequiredError}
10540
+ */
10541
+ updateMember: (id: string, updateMemberRequest: UpdateMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10537
10542
  };
10538
10543
  /**
10539
10544
  * MembersApi - functional programming interface
@@ -10548,6 +10553,14 @@ export declare const MembersApiFp: (configuration?: Configuration) => {
10548
10553
  * @throws {RequiredError}
10549
10554
  */
10550
10555
  createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMember200Response>>;
10556
+ /**
10557
+ * Removes an existing member from the organization, identified by the given `id` in the URL. The member loses access to the organization and a `MEMBERS.DELETED` webhook event is emitted.
10558
+ * @summary Delete member
10559
+ * @param {string} id ID of the member to delete
10560
+ * @param {*} [options] Override http request option.
10561
+ * @throws {RequiredError}
10562
+ */
10563
+ deleteMember(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10551
10564
  /**
10552
10565
  *
10553
10566
  * @summary Retrieve member
@@ -10563,6 +10576,15 @@ export declare const MembersApiFp: (configuration?: Configuration) => {
10563
10576
  * @throws {RequiredError}
10564
10577
  */
10565
10578
  listMembers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMembers200Response>>;
10579
+ /**
10580
+ * Updates the role of an existing member, identified by the given `id` in the URL. Check the Roles API for the roles available within the organization.
10581
+ * @summary Update member
10582
+ * @param {string} id ID of the member to update
10583
+ * @param {UpdateMemberRequest} updateMemberRequest Attributes to update on the member
10584
+ * @param {*} [options] Override http request option.
10585
+ * @throws {RequiredError}
10586
+ */
10587
+ updateMember(id: string, updateMemberRequest: UpdateMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMember200Response>>;
10566
10588
  };
10567
10589
  /**
10568
10590
  * MembersApi - factory interface
@@ -10577,6 +10599,14 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
10577
10599
  * @throws {RequiredError}
10578
10600
  */
10579
10601
  createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateMember200Response>;
10602
+ /**
10603
+ * Removes an existing member from the organization, identified by the given `id` in the URL. The member loses access to the organization and a `MEMBERS.DELETED` webhook event is emitted.
10604
+ * @summary Delete member
10605
+ * @param {string} id ID of the member to delete
10606
+ * @param {*} [options] Override http request option.
10607
+ * @throws {RequiredError}
10608
+ */
10609
+ deleteMember(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10580
10610
  /**
10581
10611
  *
10582
10612
  * @summary Retrieve member
@@ -10592,6 +10622,15 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
10592
10622
  * @throws {RequiredError}
10593
10623
  */
10594
10624
  listMembers(options?: RawAxiosRequestConfig): AxiosPromise<ListMembers200Response>;
10625
+ /**
10626
+ * Updates the role of an existing member, identified by the given `id` in the URL. Check the Roles API for the roles available within the organization.
10627
+ * @summary Update member
10628
+ * @param {string} id ID of the member to update
10629
+ * @param {UpdateMemberRequest} updateMemberRequest Attributes to update on the member
10630
+ * @param {*} [options] Override http request option.
10631
+ * @throws {RequiredError}
10632
+ */
10633
+ updateMember(id: string, updateMemberRequest: UpdateMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateMember200Response>;
10595
10634
  };
10596
10635
  /**
10597
10636
  * MembersApi - object-oriented interface
@@ -10609,6 +10648,15 @@ export declare class MembersApi extends BaseAPI {
10609
10648
  * @memberof MembersApi
10610
10649
  */
10611
10650
  createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateMember200Response, any, {}>>;
10651
+ /**
10652
+ * Removes an existing member from the organization, identified by the given `id` in the URL. The member loses access to the organization and a `MEMBERS.DELETED` webhook event is emitted.
10653
+ * @summary Delete member
10654
+ * @param {string} id ID of the member to delete
10655
+ * @param {*} [options] Override http request option.
10656
+ * @throws {RequiredError}
10657
+ * @memberof MembersApi
10658
+ */
10659
+ deleteMember(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
10612
10660
  /**
10613
10661
  *
10614
10662
  * @summary Retrieve member
@@ -10626,6 +10674,16 @@ export declare class MembersApi extends BaseAPI {
10626
10674
  * @memberof MembersApi
10627
10675
  */
10628
10676
  listMembers(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListMembers200Response, any, {}>>;
10677
+ /**
10678
+ * Updates the role of an existing member, identified by the given `id` in the URL. Check the Roles API for the roles available within the organization.
10679
+ * @summary Update member
10680
+ * @param {string} id ID of the member to update
10681
+ * @param {UpdateMemberRequest} updateMemberRequest Attributes to update on the member
10682
+ * @param {*} [options] Override http request option.
10683
+ * @throws {RequiredError}
10684
+ * @memberof MembersApi
10685
+ */
10686
+ updateMember(id: string, updateMemberRequest: UpdateMemberRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateMember200Response, any, {}>>;
10629
10687
  }
10630
10688
  /**
10631
10689
  * OrdersApi - axios parameter creator
@@ -10641,7 +10699,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
10641
10699
  */
10642
10700
  approveOrder: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10643
10701
  /**
10644
- * 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-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</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. Defaults to the organization&#39;s currency if not provided.</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 initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</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\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </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://developers.tremendous.com/reference/list-funding-sources). 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://developers.tremendous.com/docs/sandbox-environment). 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 not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
10702
+ * 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-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</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. Defaults to the organization&#39;s currency if not provided.</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 initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</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\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </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://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). 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 not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
10645
10703
  * @summary Create order
10646
10704
  * @param {CreateOrderRequest} createOrderRequest Order to create
10647
10705
  * @param {*} [options] Override http request option.
@@ -10692,7 +10750,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
10692
10750
  */
10693
10751
  approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrder200Response>>;
10694
10752
  /**
10695
- * 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-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</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. Defaults to the organization&#39;s currency if not provided.</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 initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</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\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </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://developers.tremendous.com/reference/list-funding-sources). 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://developers.tremendous.com/docs/sandbox-environment). 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 not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
10753
+ * 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-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</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. Defaults to the organization&#39;s currency if not provided.</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 initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</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\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </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://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). 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 not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
10696
10754
  * @summary Create order
10697
10755
  * @param {CreateOrderRequest} createOrderRequest Order to create
10698
10756
  * @param {*} [options] Override http request option.
@@ -10743,7 +10801,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
10743
10801
  */
10744
10802
  approveOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrder200Response>;
10745
10803
  /**
10746
- * 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-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</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. Defaults to the organization&#39;s currency if not provided.</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 initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</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\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </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://developers.tremendous.com/reference/list-funding-sources). 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://developers.tremendous.com/docs/sandbox-environment). 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 not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
10804
+ * 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-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</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. Defaults to the organization&#39;s currency if not provided.</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 initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</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\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </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://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). 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 not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
10747
10805
  * @summary Create order
10748
10806
  * @param {CreateOrderRequest} createOrderRequest Order to create
10749
10807
  * @param {*} [options] Override http request option.
@@ -10797,7 +10855,7 @@ export declare class OrdersApi extends BaseAPI {
10797
10855
  */
10798
10856
  approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrder200Response, any, {}>>;
10799
10857
  /**
10800
- * 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-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</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. Defaults to the organization&#39;s currency if not provided.</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 initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</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\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </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://developers.tremendous.com/reference/list-funding-sources). 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://developers.tremendous.com/docs/sandbox-environment). 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 not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
10858
+ * 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-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</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. Defaults to the organization&#39;s currency if not provided.</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 initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</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\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </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://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). 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 not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
10801
10859
  * @summary Create order
10802
10860
  * @param {CreateOrderRequest} createOrderRequest Order to create
10803
10861
  * @param {*} [options] Override http request option.
@@ -10846,10 +10904,11 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
10846
10904
  /**
10847
10905
  * Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.**
10848
10906
  * @summary Create API key
10907
+ * @param {CreateApiKeyRequest} [createApiKeyRequest] Optional settings for the new API key
10849
10908
  * @param {*} [options] Override http request option.
10850
10909
  * @throws {RequiredError}
10851
10910
  */
10852
- createApiKey: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10911
+ createApiKey: (createApiKeyRequest?: CreateApiKeyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10853
10912
  /**
10854
10913
  * Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard.
10855
10914
  * @summary Create organization
@@ -10882,10 +10941,11 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
10882
10941
  /**
10883
10942
  * Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.**
10884
10943
  * @summary Create API key
10944
+ * @param {CreateApiKeyRequest} [createApiKeyRequest] Optional settings for the new API key
10885
10945
  * @param {*} [options] Override http request option.
10886
10946
  * @throws {RequiredError}
10887
10947
  */
10888
- createApiKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateApiKey200Response>>;
10948
+ createApiKey(createApiKeyRequest?: CreateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateApiKey200Response>>;
10889
10949
  /**
10890
10950
  * Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard.
10891
10951
  * @summary Create organization
@@ -10918,10 +10978,11 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
10918
10978
  /**
10919
10979
  * Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.**
10920
10980
  * @summary Create API key
10981
+ * @param {CreateApiKeyRequest} [createApiKeyRequest] Optional settings for the new API key
10921
10982
  * @param {*} [options] Override http request option.
10922
10983
  * @throws {RequiredError}
10923
10984
  */
10924
- createApiKey(options?: RawAxiosRequestConfig): AxiosPromise<CreateApiKey200Response>;
10985
+ createApiKey(createApiKeyRequest?: CreateApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateApiKey200Response>;
10925
10986
  /**
10926
10987
  * Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard.
10927
10988
  * @summary Create organization
@@ -10956,11 +11017,12 @@ export declare class OrganizationsApi extends BaseAPI {
10956
11017
  /**
10957
11018
  * Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.**
10958
11019
  * @summary Create API key
11020
+ * @param {CreateApiKeyRequest} [createApiKeyRequest] Optional settings for the new API key
10959
11021
  * @param {*} [options] Override http request option.
10960
11022
  * @throws {RequiredError}
10961
11023
  * @memberof OrganizationsApi
10962
11024
  */
10963
- createApiKey(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateApiKey200Response, any, {}>>;
11025
+ createApiKey(createApiKeyRequest?: CreateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateApiKey200Response, any, {}>>;
10964
11026
  /**
10965
11027
  * Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard.
10966
11028
  * @summary Create organization
@@ -11186,7 +11248,7 @@ export declare class ReportsApi extends BaseAPI {
11186
11248
  */
11187
11249
  export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration) => {
11188
11250
  /**
11189
- * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled.
11251
+ * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled. Rewards that have already been redeemed cannot be canceled: the request fails with a `422` error and the reward is left unchanged.
11190
11252
  * @summary Cancel reward
11191
11253
  * @param {string} id ID of the reward that should be canceled
11192
11254
  * @param {*} [options] Override http request option.
@@ -11234,7 +11296,7 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
11234
11296
  */
11235
11297
  export declare const RewardsApiFp: (configuration?: Configuration) => {
11236
11298
  /**
11237
- * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled.
11299
+ * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled. Rewards that have already been redeemed cannot be canceled: the request fails with a `422` error and the reward is left unchanged.
11238
11300
  * @summary Cancel reward
11239
11301
  * @param {string} id ID of the reward that should be canceled
11240
11302
  * @param {*} [options] Override http request option.
@@ -11282,7 +11344,7 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
11282
11344
  */
11283
11345
  export declare const RewardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
11284
11346
  /**
11285
- * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled.
11347
+ * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled. Rewards that have already been redeemed cannot be canceled: the request fails with a `422` error and the reward is left unchanged.
11286
11348
  * @summary Cancel reward
11287
11349
  * @param {string} id ID of the reward that should be canceled
11288
11350
  * @param {*} [options] Override http request option.
@@ -11332,7 +11394,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
11332
11394
  */
11333
11395
  export declare class RewardsApi extends BaseAPI {
11334
11396
  /**
11335
- * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled.
11397
+ * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled. Rewards that have already been redeemed cannot be canceled: the request fails with a `422` error and the reward is left unchanged.
11336
11398
  * @summary Cancel reward
11337
11399
  * @param {string} id ID of the reward that should be canceled
11338
11400
  * @param {*} [options] Override http request option.