tremendous 4.14.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/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +11 -0
- package/dist/api.d.ts +1431 -1295
- package/dist/api.js +434 -212
- package/package.json +2 -2
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:
|
|
262
|
-
readonly 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:
|
|
322
|
-
readonly 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:
|
|
332
|
-
readonly Api:
|
|
333
|
-
readonly Embed:
|
|
334
|
-
readonly Decipher:
|
|
335
|
-
readonly Qualtrics:
|
|
336
|
-
readonly Typeform:
|
|
337
|
-
readonly SurveyMonkey:
|
|
338
|
-
readonly 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
|
/**
|
|
@@ -468,8 +468,8 @@ export interface ConnectedOrganizationMemberMember {
|
|
|
468
468
|
'last_login_at'?: string | null;
|
|
469
469
|
}
|
|
470
470
|
export declare const ConnectedOrganizationMemberMemberStatusEnum: {
|
|
471
|
-
readonly Registered:
|
|
472
|
-
readonly Invited:
|
|
471
|
+
readonly Registered: 'REGISTERED';
|
|
472
|
+
readonly Invited: 'INVITED';
|
|
473
473
|
};
|
|
474
474
|
export type ConnectedOrganizationMemberMemberStatusEnum = typeof ConnectedOrganizationMemberMemberStatusEnum[keyof typeof ConnectedOrganizationMemberMemberStatusEnum];
|
|
475
475
|
/**
|
|
@@ -496,6 +496,12 @@ export interface ConnectedOrganizationMemberSession {
|
|
|
496
496
|
* @memberof ConnectedOrganizationMemberSession
|
|
497
497
|
*/
|
|
498
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;
|
|
499
505
|
/**
|
|
500
506
|
* Timestamp of when the session will expire.
|
|
501
507
|
* @type {string}
|
|
@@ -553,9 +559,9 @@ export interface ConnectedOrganizationOrganization {
|
|
|
553
559
|
'created_at'?: string;
|
|
554
560
|
}
|
|
555
561
|
export declare const ConnectedOrganizationOrganizationStatusEnum: {
|
|
556
|
-
readonly Pending:
|
|
557
|
-
readonly Approved:
|
|
558
|
-
readonly Rejected:
|
|
562
|
+
readonly Pending: 'PENDING';
|
|
563
|
+
readonly Approved: 'APPROVED';
|
|
564
|
+
readonly Rejected: 'REJECTED';
|
|
559
565
|
};
|
|
560
566
|
export type ConnectedOrganizationOrganizationStatusEnum = typeof ConnectedOrganizationOrganizationStatusEnum[keyof typeof ConnectedOrganizationOrganizationStatusEnum];
|
|
561
567
|
/**
|
|
@@ -571,6 +577,24 @@ export interface CreateApiKey200Response {
|
|
|
571
577
|
*/
|
|
572
578
|
'api_key'?: string;
|
|
573
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];
|
|
574
598
|
/**
|
|
575
599
|
*
|
|
576
600
|
* @export
|
|
@@ -634,8 +658,8 @@ export interface CreateCampaignRequest {
|
|
|
634
658
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
635
659
|
}
|
|
636
660
|
export declare const CreateCampaignRequestFeeChargedToEnum: {
|
|
637
|
-
readonly Sender:
|
|
638
|
-
readonly Recipient:
|
|
661
|
+
readonly Sender: 'SENDER';
|
|
662
|
+
readonly Recipient: 'RECIPIENT';
|
|
639
663
|
};
|
|
640
664
|
export type CreateCampaignRequestFeeChargedToEnum = typeof CreateCampaignRequestFeeChargedToEnum[keyof typeof CreateCampaignRequestFeeChargedToEnum];
|
|
641
665
|
/**
|
|
@@ -732,6 +756,12 @@ export interface CreateConnectedOrganizationMemberSession200ResponseConnectedOrg
|
|
|
732
756
|
* @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
|
|
733
757
|
*/
|
|
734
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;
|
|
735
765
|
/**
|
|
736
766
|
* Timestamp of when the session will expire.
|
|
737
767
|
* @type {string}
|
|
@@ -757,6 +787,12 @@ export interface CreateConnectedOrganizationMemberSessionRequest {
|
|
|
757
787
|
* @memberof CreateConnectedOrganizationMemberSessionRequest
|
|
758
788
|
*/
|
|
759
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;
|
|
760
796
|
}
|
|
761
797
|
/**
|
|
762
798
|
*
|
|
@@ -882,16 +918,16 @@ export interface CreateField {
|
|
|
882
918
|
'description'?: string;
|
|
883
919
|
}
|
|
884
920
|
export declare const CreateFieldDataTypeEnum: {
|
|
885
|
-
readonly Checkbox:
|
|
886
|
-
readonly Currency:
|
|
887
|
-
readonly Date:
|
|
888
|
-
readonly Dropdown:
|
|
889
|
-
readonly Email:
|
|
890
|
-
readonly List:
|
|
891
|
-
readonly Number:
|
|
892
|
-
readonly Phone:
|
|
893
|
-
readonly Text:
|
|
894
|
-
readonly 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';
|
|
895
931
|
};
|
|
896
932
|
export type CreateFieldDataTypeEnum = typeof CreateFieldDataTypeEnum[keyof typeof CreateFieldDataTypeEnum];
|
|
897
933
|
/**
|
|
@@ -945,16 +981,16 @@ export interface CreateFieldRequest {
|
|
|
945
981
|
'description'?: string;
|
|
946
982
|
}
|
|
947
983
|
export declare const CreateFieldRequestDataTypeEnum: {
|
|
948
|
-
readonly Checkbox:
|
|
949
|
-
readonly Currency:
|
|
950
|
-
readonly Date:
|
|
951
|
-
readonly Dropdown:
|
|
952
|
-
readonly Email:
|
|
953
|
-
readonly List:
|
|
954
|
-
readonly Number:
|
|
955
|
-
readonly Phone:
|
|
956
|
-
readonly Text:
|
|
957
|
-
readonly 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';
|
|
958
994
|
};
|
|
959
995
|
export type CreateFieldRequestDataTypeEnum = typeof CreateFieldRequestDataTypeEnum[keyof typeof CreateFieldRequestDataTypeEnum];
|
|
960
996
|
/**
|
|
@@ -1022,15 +1058,15 @@ export interface CreateInvoiceRequest {
|
|
|
1022
1058
|
'memo'?: string | null;
|
|
1023
1059
|
}
|
|
1024
1060
|
export declare const CreateInvoiceRequestCurrencyCodeEnum: {
|
|
1025
|
-
readonly Usd:
|
|
1026
|
-
readonly Eur:
|
|
1027
|
-
readonly Gbp:
|
|
1061
|
+
readonly Usd: 'USD';
|
|
1062
|
+
readonly Eur: 'EUR';
|
|
1063
|
+
readonly Gbp: 'GBP';
|
|
1028
1064
|
};
|
|
1029
1065
|
export type CreateInvoiceRequestCurrencyCodeEnum = typeof CreateInvoiceRequestCurrencyCodeEnum[keyof typeof CreateInvoiceRequestCurrencyCodeEnum];
|
|
1030
1066
|
export declare const CreateInvoiceRequestCurrencyEnum: {
|
|
1031
|
-
readonly Usd:
|
|
1032
|
-
readonly Eur:
|
|
1033
|
-
readonly Gbp:
|
|
1067
|
+
readonly Usd: 'USD';
|
|
1068
|
+
readonly Eur: 'EUR';
|
|
1069
|
+
readonly Gbp: 'GBP';
|
|
1034
1070
|
};
|
|
1035
1071
|
export type CreateInvoiceRequestCurrencyEnum = typeof CreateInvoiceRequestCurrencyEnum[keyof typeof CreateInvoiceRequestCurrencyEnum];
|
|
1036
1072
|
/**
|
|
@@ -1159,24 +1195,24 @@ export interface CreateOrder200ResponseOrder {
|
|
|
1159
1195
|
'rewards'?: Array<CreateOrder200ResponseOrderRewardsInner>;
|
|
1160
1196
|
}
|
|
1161
1197
|
export declare const CreateOrder200ResponseOrderStatusEnum: {
|
|
1162
|
-
readonly Canceled:
|
|
1163
|
-
readonly Open:
|
|
1164
|
-
readonly Executed:
|
|
1165
|
-
readonly Failed:
|
|
1166
|
-
readonly PendingApproval:
|
|
1167
|
-
readonly PendingInternalPaymentApproval:
|
|
1168
|
-
readonly PendingSettlement:
|
|
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';
|
|
1169
1205
|
};
|
|
1170
1206
|
export type CreateOrder200ResponseOrderStatusEnum = typeof CreateOrder200ResponseOrderStatusEnum[keyof typeof CreateOrder200ResponseOrderStatusEnum];
|
|
1171
1207
|
export declare const CreateOrder200ResponseOrderChannelEnum: {
|
|
1172
|
-
readonly Ui:
|
|
1173
|
-
readonly Api:
|
|
1174
|
-
readonly Embed:
|
|
1175
|
-
readonly Decipher:
|
|
1176
|
-
readonly Qualtrics:
|
|
1177
|
-
readonly Typeform:
|
|
1178
|
-
readonly SurveyMonkey:
|
|
1179
|
-
readonly 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';
|
|
1180
1216
|
};
|
|
1181
1217
|
export type CreateOrder200ResponseOrderChannelEnum = typeof CreateOrder200ResponseOrderChannelEnum[keyof typeof CreateOrder200ResponseOrderChannelEnum];
|
|
1182
1218
|
/**
|
|
@@ -1266,16 +1302,16 @@ export interface CreateOrder200ResponseOrderRewardsInnerDelivery {
|
|
|
1266
1302
|
'link'?: string;
|
|
1267
1303
|
}
|
|
1268
1304
|
export declare const CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum: {
|
|
1269
|
-
readonly Email:
|
|
1270
|
-
readonly Link:
|
|
1271
|
-
readonly Phone:
|
|
1305
|
+
readonly Email: 'EMAIL';
|
|
1306
|
+
readonly Link: 'LINK';
|
|
1307
|
+
readonly Phone: 'PHONE';
|
|
1272
1308
|
};
|
|
1273
1309
|
export type CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum = typeof CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum[keyof typeof CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum];
|
|
1274
1310
|
export declare const CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum: {
|
|
1275
|
-
readonly Scheduled:
|
|
1276
|
-
readonly Failed:
|
|
1277
|
-
readonly Succeeded:
|
|
1278
|
-
readonly Pending:
|
|
1311
|
+
readonly Scheduled: 'SCHEDULED';
|
|
1312
|
+
readonly Failed: 'FAILED';
|
|
1313
|
+
readonly Succeeded: 'SUCCEEDED';
|
|
1314
|
+
readonly Pending: 'PENDING';
|
|
1279
1315
|
};
|
|
1280
1316
|
export type CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum = typeof CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum[keyof typeof CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum];
|
|
1281
1317
|
/**
|
|
@@ -1677,10 +1713,10 @@ export interface CreateReport200ResponseReport {
|
|
|
1677
1713
|
'url'?: string | null;
|
|
1678
1714
|
}
|
|
1679
1715
|
export declare const CreateReport200ResponseReportStatusEnum: {
|
|
1680
|
-
readonly Created:
|
|
1681
|
-
readonly Processing:
|
|
1682
|
-
readonly ReadyForDownload:
|
|
1683
|
-
readonly Failed:
|
|
1716
|
+
readonly Created: 'CREATED';
|
|
1717
|
+
readonly Processing: 'PROCESSING';
|
|
1718
|
+
readonly ReadyForDownload: 'READY_FOR_DOWNLOAD';
|
|
1719
|
+
readonly Failed: 'FAILED';
|
|
1684
1720
|
};
|
|
1685
1721
|
export type CreateReport200ResponseReportStatusEnum = typeof CreateReport200ResponseReportStatusEnum[keyof typeof CreateReport200ResponseReportStatusEnum];
|
|
1686
1722
|
/**
|
|
@@ -1709,11 +1745,11 @@ export interface CreateReportRequest {
|
|
|
1709
1745
|
'filters'?: CreateReportRequestFilters | null;
|
|
1710
1746
|
}
|
|
1711
1747
|
export declare const CreateReportRequestReportTypeEnum: {
|
|
1712
|
-
readonly DigitalRewards:
|
|
1748
|
+
readonly DigitalRewards: 'digital_rewards';
|
|
1713
1749
|
};
|
|
1714
1750
|
export type CreateReportRequestReportTypeEnum = typeof CreateReportRequestReportTypeEnum[keyof typeof CreateReportRequestReportTypeEnum];
|
|
1715
1751
|
export declare const CreateReportRequestFormatEnum: {
|
|
1716
|
-
readonly Csv:
|
|
1752
|
+
readonly Csv: 'csv';
|
|
1717
1753
|
};
|
|
1718
1754
|
export type CreateReportRequestFormatEnum = typeof CreateReportRequestFormatEnum[keyof typeof CreateReportRequestFormatEnum];
|
|
1719
1755
|
/**
|
|
@@ -1785,25 +1821,25 @@ export interface CreateReportRequestFiltersDigitalRewards {
|
|
|
1785
1821
|
'status'?: Array<CreateReportRequestFiltersDigitalRewardsStatusEnum> | null;
|
|
1786
1822
|
}
|
|
1787
1823
|
export declare const CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum: {
|
|
1788
|
-
readonly Phone:
|
|
1789
|
-
readonly Email:
|
|
1790
|
-
readonly Link:
|
|
1791
|
-
readonly Mail:
|
|
1792
|
-
readonly Direct:
|
|
1824
|
+
readonly Phone: 'phone';
|
|
1825
|
+
readonly Email: 'email';
|
|
1826
|
+
readonly Link: 'link';
|
|
1827
|
+
readonly Mail: 'mail';
|
|
1828
|
+
readonly Direct: 'direct';
|
|
1793
1829
|
};
|
|
1794
1830
|
export type CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum = typeof CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum];
|
|
1795
1831
|
export declare const CreateReportRequestFiltersDigitalRewardsOrderStatusEnum: {
|
|
1796
|
-
readonly Executed:
|
|
1797
|
-
readonly Canceled:
|
|
1798
|
-
readonly Failed:
|
|
1799
|
-
readonly PendingApproval:
|
|
1832
|
+
readonly Executed: 'executed';
|
|
1833
|
+
readonly Canceled: 'canceled';
|
|
1834
|
+
readonly Failed: 'failed';
|
|
1835
|
+
readonly PendingApproval: 'pending_approval';
|
|
1800
1836
|
};
|
|
1801
1837
|
export type CreateReportRequestFiltersDigitalRewardsOrderStatusEnum = typeof CreateReportRequestFiltersDigitalRewardsOrderStatusEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsOrderStatusEnum];
|
|
1802
1838
|
export declare const CreateReportRequestFiltersDigitalRewardsStatusEnum: {
|
|
1803
|
-
readonly Delivered:
|
|
1804
|
-
readonly Canceled:
|
|
1805
|
-
readonly DeliveryFailed:
|
|
1806
|
-
readonly PendingReview:
|
|
1839
|
+
readonly Delivered: 'delivered';
|
|
1840
|
+
readonly Canceled: 'canceled';
|
|
1841
|
+
readonly DeliveryFailed: 'delivery_failed';
|
|
1842
|
+
readonly PendingReview: 'pending_review';
|
|
1807
1843
|
};
|
|
1808
1844
|
export type CreateReportRequestFiltersDigitalRewardsStatusEnum = typeof CreateReportRequestFiltersDigitalRewardsStatusEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsStatusEnum];
|
|
1809
1845
|
/**
|
|
@@ -1914,117 +1950,117 @@ export interface CreateWebhookRequest {
|
|
|
1914
1950
|
* @enum {string}
|
|
1915
1951
|
*/
|
|
1916
1952
|
export declare const CurrencyCodes: {
|
|
1917
|
-
readonly Usd:
|
|
1918
|
-
readonly Cad:
|
|
1919
|
-
readonly Eur:
|
|
1920
|
-
readonly Aed:
|
|
1921
|
-
readonly Afn:
|
|
1922
|
-
readonly All:
|
|
1923
|
-
readonly Amd:
|
|
1924
|
-
readonly Ars:
|
|
1925
|
-
readonly Aud:
|
|
1926
|
-
readonly Azn:
|
|
1927
|
-
readonly Bam:
|
|
1928
|
-
readonly Bdt:
|
|
1929
|
-
readonly Bhd:
|
|
1930
|
-
readonly Bif:
|
|
1931
|
-
readonly Bnd:
|
|
1932
|
-
readonly Bob:
|
|
1933
|
-
readonly Brl:
|
|
1934
|
-
readonly Bwp:
|
|
1935
|
-
readonly Byn:
|
|
1936
|
-
readonly Bzd:
|
|
1937
|
-
readonly Cdf:
|
|
1938
|
-
readonly Chf:
|
|
1939
|
-
readonly Clp:
|
|
1940
|
-
readonly Cny:
|
|
1941
|
-
readonly Cop:
|
|
1942
|
-
readonly Crc:
|
|
1943
|
-
readonly Cve:
|
|
1944
|
-
readonly Czk:
|
|
1945
|
-
readonly Djf:
|
|
1946
|
-
readonly Dkk:
|
|
1947
|
-
readonly Dop:
|
|
1948
|
-
readonly Dzd:
|
|
1949
|
-
readonly Egp:
|
|
1950
|
-
readonly Ern:
|
|
1951
|
-
readonly Etb:
|
|
1952
|
-
readonly Gbp:
|
|
1953
|
-
readonly Gel:
|
|
1954
|
-
readonly Ghs:
|
|
1955
|
-
readonly Gnf:
|
|
1956
|
-
readonly Gtq:
|
|
1957
|
-
readonly Hkd:
|
|
1958
|
-
readonly Hnl:
|
|
1959
|
-
readonly Hrk:
|
|
1960
|
-
readonly Huf:
|
|
1961
|
-
readonly Idr:
|
|
1962
|
-
readonly Ils:
|
|
1963
|
-
readonly Inr:
|
|
1964
|
-
readonly Iqd:
|
|
1965
|
-
readonly Irr:
|
|
1966
|
-
readonly Isk:
|
|
1967
|
-
readonly Jmd:
|
|
1968
|
-
readonly Jod:
|
|
1969
|
-
readonly Jpy:
|
|
1970
|
-
readonly Kes:
|
|
1971
|
-
readonly Khr:
|
|
1972
|
-
readonly Krw:
|
|
1973
|
-
readonly Kwd:
|
|
1974
|
-
readonly Kzt:
|
|
1975
|
-
readonly Lbp:
|
|
1976
|
-
readonly Lkr:
|
|
1977
|
-
readonly Mad:
|
|
1978
|
-
readonly Mdl:
|
|
1979
|
-
readonly Mga:
|
|
1980
|
-
readonly Mkd:
|
|
1981
|
-
readonly Mmk:
|
|
1982
|
-
readonly Mop:
|
|
1983
|
-
readonly Mur:
|
|
1984
|
-
readonly Mxn:
|
|
1985
|
-
readonly Myr:
|
|
1986
|
-
readonly Mzn:
|
|
1987
|
-
readonly Nad:
|
|
1988
|
-
readonly Ngn:
|
|
1989
|
-
readonly Nio:
|
|
1990
|
-
readonly Nok:
|
|
1991
|
-
readonly Npr:
|
|
1992
|
-
readonly Nzd:
|
|
1993
|
-
readonly Omr:
|
|
1994
|
-
readonly Pab:
|
|
1995
|
-
readonly Pen:
|
|
1996
|
-
readonly Php:
|
|
1997
|
-
readonly Pkr:
|
|
1998
|
-
readonly Pln:
|
|
1999
|
-
readonly Pyg:
|
|
2000
|
-
readonly Qar:
|
|
2001
|
-
readonly Ron:
|
|
2002
|
-
readonly Rsd:
|
|
2003
|
-
readonly Rub:
|
|
2004
|
-
readonly Rwf:
|
|
2005
|
-
readonly Sar:
|
|
2006
|
-
readonly Sdg:
|
|
2007
|
-
readonly Sek:
|
|
2008
|
-
readonly Sgd:
|
|
2009
|
-
readonly Sos:
|
|
2010
|
-
readonly Syp:
|
|
2011
|
-
readonly Thb:
|
|
2012
|
-
readonly Tnd:
|
|
2013
|
-
readonly Top:
|
|
2014
|
-
readonly Try:
|
|
2015
|
-
readonly Ttd:
|
|
2016
|
-
readonly Twd:
|
|
2017
|
-
readonly Tzs:
|
|
2018
|
-
readonly Uah:
|
|
2019
|
-
readonly Ugx:
|
|
2020
|
-
readonly Uyu:
|
|
2021
|
-
readonly Uzs:
|
|
2022
|
-
readonly Vef:
|
|
2023
|
-
readonly Vnd:
|
|
2024
|
-
readonly Xaf:
|
|
2025
|
-
readonly Xof:
|
|
2026
|
-
readonly Yer:
|
|
2027
|
-
readonly 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';
|
|
2028
2064
|
};
|
|
2029
2065
|
export type CurrencyCodes = typeof CurrencyCodes[keyof typeof CurrencyCodes];
|
|
2030
2066
|
/**
|
|
@@ -2085,16 +2121,16 @@ export interface DeliveryDetails {
|
|
|
2085
2121
|
'status'?: DeliveryDetailsStatusEnum;
|
|
2086
2122
|
}
|
|
2087
2123
|
export declare const DeliveryDetailsMethodEnum: {
|
|
2088
|
-
readonly Email:
|
|
2089
|
-
readonly Link:
|
|
2090
|
-
readonly Phone:
|
|
2124
|
+
readonly Email: 'EMAIL';
|
|
2125
|
+
readonly Link: 'LINK';
|
|
2126
|
+
readonly Phone: 'PHONE';
|
|
2091
2127
|
};
|
|
2092
2128
|
export type DeliveryDetailsMethodEnum = typeof DeliveryDetailsMethodEnum[keyof typeof DeliveryDetailsMethodEnum];
|
|
2093
2129
|
export declare const DeliveryDetailsStatusEnum: {
|
|
2094
|
-
readonly Scheduled:
|
|
2095
|
-
readonly Failed:
|
|
2096
|
-
readonly Succeeded:
|
|
2097
|
-
readonly Pending:
|
|
2130
|
+
readonly Scheduled: 'SCHEDULED';
|
|
2131
|
+
readonly Failed: 'FAILED';
|
|
2132
|
+
readonly Succeeded: 'SUCCEEDED';
|
|
2133
|
+
readonly Pending: 'PENDING';
|
|
2098
2134
|
};
|
|
2099
2135
|
export type DeliveryDetailsStatusEnum = typeof DeliveryDetailsStatusEnum[keyof typeof DeliveryDetailsStatusEnum];
|
|
2100
2136
|
/**
|
|
@@ -2123,16 +2159,16 @@ export interface DeliveryDetailsWithLink {
|
|
|
2123
2159
|
'link'?: string;
|
|
2124
2160
|
}
|
|
2125
2161
|
export declare const DeliveryDetailsWithLinkMethodEnum: {
|
|
2126
|
-
readonly Email:
|
|
2127
|
-
readonly Link:
|
|
2128
|
-
readonly Phone:
|
|
2162
|
+
readonly Email: 'EMAIL';
|
|
2163
|
+
readonly Link: 'LINK';
|
|
2164
|
+
readonly Phone: 'PHONE';
|
|
2129
2165
|
};
|
|
2130
2166
|
export type DeliveryDetailsWithLinkMethodEnum = typeof DeliveryDetailsWithLinkMethodEnum[keyof typeof DeliveryDetailsWithLinkMethodEnum];
|
|
2131
2167
|
export declare const DeliveryDetailsWithLinkStatusEnum: {
|
|
2132
|
-
readonly Scheduled:
|
|
2133
|
-
readonly Failed:
|
|
2134
|
-
readonly Succeeded:
|
|
2135
|
-
readonly Pending:
|
|
2168
|
+
readonly Scheduled: 'SCHEDULED';
|
|
2169
|
+
readonly Failed: 'FAILED';
|
|
2170
|
+
readonly Succeeded: 'SUCCEEDED';
|
|
2171
|
+
readonly Pending: 'PENDING';
|
|
2136
2172
|
};
|
|
2137
2173
|
export type DeliveryDetailsWithLinkStatusEnum = typeof DeliveryDetailsWithLinkStatusEnum[keyof typeof DeliveryDetailsWithLinkStatusEnum];
|
|
2138
2174
|
/**
|
|
@@ -2166,9 +2202,9 @@ export interface DeliveryMetadata {
|
|
|
2166
2202
|
* @enum {string}
|
|
2167
2203
|
*/
|
|
2168
2204
|
export declare const DeliveryMethod: {
|
|
2169
|
-
readonly Email:
|
|
2170
|
-
readonly Link:
|
|
2171
|
-
readonly Phone:
|
|
2205
|
+
readonly Email: 'EMAIL';
|
|
2206
|
+
readonly Link: 'LINK';
|
|
2207
|
+
readonly Phone: 'PHONE';
|
|
2172
2208
|
};
|
|
2173
2209
|
export type DeliveryMethod = typeof DeliveryMethod[keyof typeof DeliveryMethod];
|
|
2174
2210
|
/**
|
|
@@ -2177,10 +2213,10 @@ export type DeliveryMethod = typeof DeliveryMethod[keyof typeof DeliveryMethod];
|
|
|
2177
2213
|
* @enum {string}
|
|
2178
2214
|
*/
|
|
2179
2215
|
export declare const DeliveryStatus: {
|
|
2180
|
-
readonly Scheduled:
|
|
2181
|
-
readonly Failed:
|
|
2182
|
-
readonly Succeeded:
|
|
2183
|
-
readonly Pending:
|
|
2216
|
+
readonly Scheduled: 'SCHEDULED';
|
|
2217
|
+
readonly Failed: 'FAILED';
|
|
2218
|
+
readonly Succeeded: 'SUCCEEDED';
|
|
2219
|
+
readonly Pending: 'PENDING';
|
|
2184
2220
|
};
|
|
2185
2221
|
export type DeliveryStatus = typeof DeliveryStatus[keyof typeof DeliveryStatus];
|
|
2186
2222
|
/**
|
|
@@ -2246,16 +2282,16 @@ export interface Field {
|
|
|
2246
2282
|
'scope'?: string;
|
|
2247
2283
|
}
|
|
2248
2284
|
export declare const FieldDataTypeEnum: {
|
|
2249
|
-
readonly Checkbox:
|
|
2250
|
-
readonly Currency:
|
|
2251
|
-
readonly Date:
|
|
2252
|
-
readonly Dropdown:
|
|
2253
|
-
readonly Email:
|
|
2254
|
-
readonly List:
|
|
2255
|
-
readonly Number:
|
|
2256
|
-
readonly Phone:
|
|
2257
|
-
readonly Text:
|
|
2258
|
-
readonly 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';
|
|
2259
2295
|
};
|
|
2260
2296
|
export type FieldDataTypeEnum = typeof FieldDataTypeEnum[keyof typeof FieldDataTypeEnum];
|
|
2261
2297
|
/**
|
|
@@ -2291,8 +2327,8 @@ export interface FraudConfigCountry {
|
|
|
2291
2327
|
'countries': Array<string>;
|
|
2292
2328
|
}
|
|
2293
2329
|
export declare const FraudConfigCountryTypeEnum: {
|
|
2294
|
-
readonly Whitelist:
|
|
2295
|
-
readonly Blacklist:
|
|
2330
|
+
readonly Whitelist: 'whitelist';
|
|
2331
|
+
readonly Blacklist: 'blacklist';
|
|
2296
2332
|
};
|
|
2297
2333
|
export type FraudConfigCountryTypeEnum = typeof FraudConfigCountryTypeEnum[keyof typeof FraudConfigCountryTypeEnum];
|
|
2298
2334
|
/**
|
|
@@ -2341,12 +2377,12 @@ export interface FraudConfigRedeemedRewardsAmount {
|
|
|
2341
2377
|
'period': FraudConfigRedeemedRewardsAmountPeriodEnum;
|
|
2342
2378
|
}
|
|
2343
2379
|
export declare const FraudConfigRedeemedRewardsAmountPeriodEnum: {
|
|
2344
|
-
readonly _7:
|
|
2345
|
-
readonly _30:
|
|
2346
|
-
readonly _90:
|
|
2347
|
-
readonly _120:
|
|
2348
|
-
readonly _365:
|
|
2349
|
-
readonly AllTime:
|
|
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';
|
|
2350
2386
|
};
|
|
2351
2387
|
export type FraudConfigRedeemedRewardsAmountPeriodEnum = typeof FraudConfigRedeemedRewardsAmountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsAmountPeriodEnum];
|
|
2352
2388
|
/**
|
|
@@ -2369,12 +2405,12 @@ export interface FraudConfigRedeemedRewardsCount {
|
|
|
2369
2405
|
'period': FraudConfigRedeemedRewardsCountPeriodEnum;
|
|
2370
2406
|
}
|
|
2371
2407
|
export declare const FraudConfigRedeemedRewardsCountPeriodEnum: {
|
|
2372
|
-
readonly _7:
|
|
2373
|
-
readonly _30:
|
|
2374
|
-
readonly _90:
|
|
2375
|
-
readonly _120:
|
|
2376
|
-
readonly _365:
|
|
2377
|
-
readonly AllTime:
|
|
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';
|
|
2378
2414
|
};
|
|
2379
2415
|
export type FraudConfigRedeemedRewardsCountPeriodEnum = typeof FraudConfigRedeemedRewardsCountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsCountPeriodEnum];
|
|
2380
2416
|
/**
|
|
@@ -2502,53 +2538,53 @@ export interface FraudReview {
|
|
|
2502
2538
|
'related_rewards'?: FraudReviewRelatedRewards;
|
|
2503
2539
|
}
|
|
2504
2540
|
export declare const FraudReviewStatusEnum: {
|
|
2505
|
-
readonly Flagged:
|
|
2506
|
-
readonly Blocked:
|
|
2507
|
-
readonly Released:
|
|
2541
|
+
readonly Flagged: 'flagged';
|
|
2542
|
+
readonly Blocked: 'blocked';
|
|
2543
|
+
readonly Released: 'released';
|
|
2508
2544
|
};
|
|
2509
2545
|
export type FraudReviewStatusEnum = typeof FraudReviewStatusEnum[keyof typeof FraudReviewStatusEnum];
|
|
2510
2546
|
export declare const FraudReviewReasonsEnum: {
|
|
2511
|
-
readonly DisallowedIp:
|
|
2512
|
-
readonly DisallowedEmail:
|
|
2513
|
-
readonly DisallowedCountry:
|
|
2514
|
-
readonly OverRewardAmountLimit:
|
|
2515
|
-
readonly OverRewardCountLimit:
|
|
2516
|
-
readonly VpnDetected:
|
|
2517
|
-
readonly ApplePrivateRelay:
|
|
2518
|
-
readonly DeviceRelatedToMultipleEmails:
|
|
2519
|
-
readonly DeviceOrAccountRelatedToMultipleEmails:
|
|
2520
|
-
readonly IpOnATremendousFraudList:
|
|
2521
|
-
readonly BankAccountOnATremendousFraudList:
|
|
2522
|
-
readonly FingerprintOnATremendousFraudList:
|
|
2523
|
-
readonly EmailOnATremendousFraudList:
|
|
2524
|
-
readonly PhoneOnATremendousFraudList:
|
|
2525
|
-
readonly DeviceOnATremendousFraudList:
|
|
2526
|
-
readonly IpRelatedToABlockedReward:
|
|
2527
|
-
readonly DeviceRelatedToABlockedReward:
|
|
2528
|
-
readonly BankAccountRelatedToABlockedReward:
|
|
2529
|
-
readonly FingerprintRelatedToABlockedReward:
|
|
2530
|
-
readonly EmailRelatedToABlockedReward:
|
|
2531
|
-
readonly PhoneRelatedToABlockedReward:
|
|
2532
|
-
readonly AllowedIp:
|
|
2533
|
-
readonly AllowedEmail:
|
|
2534
|
-
readonly AllowedCountry:
|
|
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';
|
|
2535
2571
|
};
|
|
2536
2572
|
export type FraudReviewReasonsEnum = typeof FraudReviewReasonsEnum[keyof typeof FraudReviewReasonsEnum];
|
|
2537
2573
|
export declare const FraudReviewRedemptionMethodEnum: {
|
|
2538
|
-
readonly BankTransfer:
|
|
2539
|
-
readonly Charity:
|
|
2540
|
-
readonly InstantDebitTransfer:
|
|
2541
|
-
readonly InternationalBankTransfer:
|
|
2542
|
-
readonly MerchantCard:
|
|
2543
|
-
readonly Paypal:
|
|
2544
|
-
readonly Venmo:
|
|
2545
|
-
readonly VisaCard:
|
|
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';
|
|
2546
2582
|
};
|
|
2547
2583
|
export type FraudReviewRedemptionMethodEnum = typeof FraudReviewRedemptionMethodEnum[keyof typeof FraudReviewRedemptionMethodEnum];
|
|
2548
2584
|
export declare const FraudReviewRiskEnum: {
|
|
2549
|
-
readonly High:
|
|
2550
|
-
readonly Medium:
|
|
2551
|
-
readonly Low:
|
|
2585
|
+
readonly High: 'high';
|
|
2586
|
+
readonly Medium: 'medium';
|
|
2587
|
+
readonly Low: 'low';
|
|
2552
2588
|
};
|
|
2553
2589
|
export type FraudReviewRiskEnum = typeof FraudReviewRiskEnum[keyof typeof FraudReviewRiskEnum];
|
|
2554
2590
|
/**
|
|
@@ -2619,47 +2655,47 @@ export interface FraudReviewBase {
|
|
|
2619
2655
|
'redemption_method_account_hash'?: string;
|
|
2620
2656
|
}
|
|
2621
2657
|
export declare const FraudReviewBaseStatusEnum: {
|
|
2622
|
-
readonly Flagged:
|
|
2623
|
-
readonly Blocked:
|
|
2624
|
-
readonly Released:
|
|
2658
|
+
readonly Flagged: 'flagged';
|
|
2659
|
+
readonly Blocked: 'blocked';
|
|
2660
|
+
readonly Released: 'released';
|
|
2625
2661
|
};
|
|
2626
2662
|
export type FraudReviewBaseStatusEnum = typeof FraudReviewBaseStatusEnum[keyof typeof FraudReviewBaseStatusEnum];
|
|
2627
2663
|
export declare const FraudReviewBaseReasonsEnum: {
|
|
2628
|
-
readonly DisallowedIp:
|
|
2629
|
-
readonly DisallowedEmail:
|
|
2630
|
-
readonly DisallowedCountry:
|
|
2631
|
-
readonly OverRewardAmountLimit:
|
|
2632
|
-
readonly OverRewardCountLimit:
|
|
2633
|
-
readonly VpnDetected:
|
|
2634
|
-
readonly ApplePrivateRelay:
|
|
2635
|
-
readonly DeviceRelatedToMultipleEmails:
|
|
2636
|
-
readonly DeviceOrAccountRelatedToMultipleEmails:
|
|
2637
|
-
readonly IpOnATremendousFraudList:
|
|
2638
|
-
readonly BankAccountOnATremendousFraudList:
|
|
2639
|
-
readonly FingerprintOnATremendousFraudList:
|
|
2640
|
-
readonly EmailOnATremendousFraudList:
|
|
2641
|
-
readonly PhoneOnATremendousFraudList:
|
|
2642
|
-
readonly DeviceOnATremendousFraudList:
|
|
2643
|
-
readonly IpRelatedToABlockedReward:
|
|
2644
|
-
readonly DeviceRelatedToABlockedReward:
|
|
2645
|
-
readonly BankAccountRelatedToABlockedReward:
|
|
2646
|
-
readonly FingerprintRelatedToABlockedReward:
|
|
2647
|
-
readonly EmailRelatedToABlockedReward:
|
|
2648
|
-
readonly PhoneRelatedToABlockedReward:
|
|
2649
|
-
readonly AllowedIp:
|
|
2650
|
-
readonly AllowedEmail:
|
|
2651
|
-
readonly AllowedCountry:
|
|
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';
|
|
2652
2688
|
};
|
|
2653
2689
|
export type FraudReviewBaseReasonsEnum = typeof FraudReviewBaseReasonsEnum[keyof typeof FraudReviewBaseReasonsEnum];
|
|
2654
2690
|
export declare const FraudReviewBaseRedemptionMethodEnum: {
|
|
2655
|
-
readonly BankTransfer:
|
|
2656
|
-
readonly Charity:
|
|
2657
|
-
readonly InstantDebitTransfer:
|
|
2658
|
-
readonly InternationalBankTransfer:
|
|
2659
|
-
readonly MerchantCard:
|
|
2660
|
-
readonly Paypal:
|
|
2661
|
-
readonly Venmo:
|
|
2662
|
-
readonly VisaCard:
|
|
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';
|
|
2663
2699
|
};
|
|
2664
2700
|
export type FraudReviewBaseRedemptionMethodEnum = typeof FraudReviewBaseRedemptionMethodEnum[keyof typeof FraudReviewBaseRedemptionMethodEnum];
|
|
2665
2701
|
/**
|
|
@@ -2755,47 +2791,47 @@ export interface FraudReviewListItem {
|
|
|
2755
2791
|
'redemption_method_account_hash'?: string;
|
|
2756
2792
|
}
|
|
2757
2793
|
export declare const FraudReviewListItemStatusEnum: {
|
|
2758
|
-
readonly Flagged:
|
|
2759
|
-
readonly Blocked:
|
|
2760
|
-
readonly Released:
|
|
2794
|
+
readonly Flagged: 'flagged';
|
|
2795
|
+
readonly Blocked: 'blocked';
|
|
2796
|
+
readonly Released: 'released';
|
|
2761
2797
|
};
|
|
2762
2798
|
export type FraudReviewListItemStatusEnum = typeof FraudReviewListItemStatusEnum[keyof typeof FraudReviewListItemStatusEnum];
|
|
2763
2799
|
export declare const FraudReviewListItemReasonsEnum: {
|
|
2764
|
-
readonly DisallowedIp:
|
|
2765
|
-
readonly DisallowedEmail:
|
|
2766
|
-
readonly DisallowedCountry:
|
|
2767
|
-
readonly OverRewardAmountLimit:
|
|
2768
|
-
readonly OverRewardCountLimit:
|
|
2769
|
-
readonly VpnDetected:
|
|
2770
|
-
readonly ApplePrivateRelay:
|
|
2771
|
-
readonly DeviceRelatedToMultipleEmails:
|
|
2772
|
-
readonly DeviceOrAccountRelatedToMultipleEmails:
|
|
2773
|
-
readonly IpOnATremendousFraudList:
|
|
2774
|
-
readonly BankAccountOnATremendousFraudList:
|
|
2775
|
-
readonly FingerprintOnATremendousFraudList:
|
|
2776
|
-
readonly EmailOnATremendousFraudList:
|
|
2777
|
-
readonly PhoneOnATremendousFraudList:
|
|
2778
|
-
readonly DeviceOnATremendousFraudList:
|
|
2779
|
-
readonly IpRelatedToABlockedReward:
|
|
2780
|
-
readonly DeviceRelatedToABlockedReward:
|
|
2781
|
-
readonly BankAccountRelatedToABlockedReward:
|
|
2782
|
-
readonly FingerprintRelatedToABlockedReward:
|
|
2783
|
-
readonly EmailRelatedToABlockedReward:
|
|
2784
|
-
readonly PhoneRelatedToABlockedReward:
|
|
2785
|
-
readonly AllowedIp:
|
|
2786
|
-
readonly AllowedEmail:
|
|
2787
|
-
readonly AllowedCountry:
|
|
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';
|
|
2788
2824
|
};
|
|
2789
2825
|
export type FraudReviewListItemReasonsEnum = typeof FraudReviewListItemReasonsEnum[keyof typeof FraudReviewListItemReasonsEnum];
|
|
2790
2826
|
export declare const FraudReviewListItemRedemptionMethodEnum: {
|
|
2791
|
-
readonly BankTransfer:
|
|
2792
|
-
readonly Charity:
|
|
2793
|
-
readonly InstantDebitTransfer:
|
|
2794
|
-
readonly InternationalBankTransfer:
|
|
2795
|
-
readonly MerchantCard:
|
|
2796
|
-
readonly Paypal:
|
|
2797
|
-
readonly Venmo:
|
|
2798
|
-
readonly VisaCard:
|
|
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';
|
|
2799
2835
|
};
|
|
2800
2836
|
export type FraudReviewListItemRedemptionMethodEnum = typeof FraudReviewListItemRedemptionMethodEnum[keyof typeof FraudReviewListItemRedemptionMethodEnum];
|
|
2801
2837
|
/**
|
|
@@ -2804,30 +2840,30 @@ export type FraudReviewListItemRedemptionMethodEnum = typeof FraudReviewListItem
|
|
|
2804
2840
|
* @enum {string}
|
|
2805
2841
|
*/
|
|
2806
2842
|
export declare const FraudReviewReason: {
|
|
2807
|
-
readonly DisallowedIp:
|
|
2808
|
-
readonly DisallowedEmail:
|
|
2809
|
-
readonly DisallowedCountry:
|
|
2810
|
-
readonly OverRewardAmountLimit:
|
|
2811
|
-
readonly OverRewardCountLimit:
|
|
2812
|
-
readonly VpnDetected:
|
|
2813
|
-
readonly ApplePrivateRelay:
|
|
2814
|
-
readonly DeviceRelatedToMultipleEmails:
|
|
2815
|
-
readonly DeviceOrAccountRelatedToMultipleEmails:
|
|
2816
|
-
readonly IpOnATremendousFraudList:
|
|
2817
|
-
readonly BankAccountOnATremendousFraudList:
|
|
2818
|
-
readonly FingerprintOnATremendousFraudList:
|
|
2819
|
-
readonly EmailOnATremendousFraudList:
|
|
2820
|
-
readonly PhoneOnATremendousFraudList:
|
|
2821
|
-
readonly DeviceOnATremendousFraudList:
|
|
2822
|
-
readonly IpRelatedToABlockedReward:
|
|
2823
|
-
readonly DeviceRelatedToABlockedReward:
|
|
2824
|
-
readonly BankAccountRelatedToABlockedReward:
|
|
2825
|
-
readonly FingerprintRelatedToABlockedReward:
|
|
2826
|
-
readonly EmailRelatedToABlockedReward:
|
|
2827
|
-
readonly PhoneRelatedToABlockedReward:
|
|
2828
|
-
readonly AllowedIp:
|
|
2829
|
-
readonly AllowedEmail:
|
|
2830
|
-
readonly AllowedCountry:
|
|
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';
|
|
2831
2867
|
};
|
|
2832
2868
|
export type FraudReviewReason = typeof FraudReviewReason[keyof typeof FraudReviewReason];
|
|
2833
2869
|
/**
|
|
@@ -2836,14 +2872,14 @@ export type FraudReviewReason = typeof FraudReviewReason[keyof typeof FraudRevie
|
|
|
2836
2872
|
* @enum {string}
|
|
2837
2873
|
*/
|
|
2838
2874
|
export declare const FraudReviewRedemptionMethod: {
|
|
2839
|
-
readonly BankTransfer:
|
|
2840
|
-
readonly Charity:
|
|
2841
|
-
readonly InstantDebitTransfer:
|
|
2842
|
-
readonly InternationalBankTransfer:
|
|
2843
|
-
readonly MerchantCard:
|
|
2844
|
-
readonly Paypal:
|
|
2845
|
-
readonly Venmo:
|
|
2846
|
-
readonly VisaCard:
|
|
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';
|
|
2847
2883
|
};
|
|
2848
2884
|
export type FraudReviewRedemptionMethod = typeof FraudReviewRedemptionMethod[keyof typeof FraudReviewRedemptionMethod];
|
|
2849
2885
|
/**
|
|
@@ -2889,9 +2925,9 @@ export interface FraudReviewRelatedRewards {
|
|
|
2889
2925
|
* @enum {string}
|
|
2890
2926
|
*/
|
|
2891
2927
|
export declare const FraudReviewRisk: {
|
|
2892
|
-
readonly High:
|
|
2893
|
-
readonly Medium:
|
|
2894
|
-
readonly Low:
|
|
2928
|
+
readonly High: 'high';
|
|
2929
|
+
readonly Medium: 'medium';
|
|
2930
|
+
readonly Low: 'low';
|
|
2895
2931
|
};
|
|
2896
2932
|
export type FraudReviewRisk = typeof FraudReviewRisk[keyof typeof FraudReviewRisk];
|
|
2897
2933
|
/**
|
|
@@ -2900,9 +2936,9 @@ export type FraudReviewRisk = typeof FraudReviewRisk[keyof typeof FraudReviewRis
|
|
|
2900
2936
|
* @enum {string}
|
|
2901
2937
|
*/
|
|
2902
2938
|
export declare const FraudReviewStatus: {
|
|
2903
|
-
readonly Flagged:
|
|
2904
|
-
readonly Blocked:
|
|
2905
|
-
readonly Released:
|
|
2939
|
+
readonly Flagged: 'flagged';
|
|
2940
|
+
readonly Blocked: 'blocked';
|
|
2941
|
+
readonly Released: 'released';
|
|
2906
2942
|
};
|
|
2907
2943
|
export type FraudReviewStatus = typeof FraudReviewStatus[keyof typeof FraudReviewStatus];
|
|
2908
2944
|
/**
|
|
@@ -3025,17 +3061,17 @@ export interface FraudRuleRequestConfig {
|
|
|
3025
3061
|
'skip_apple_private_relay'?: boolean;
|
|
3026
3062
|
}
|
|
3027
3063
|
export declare const FraudRuleRequestConfigTypeEnum: {
|
|
3028
|
-
readonly Whitelist:
|
|
3029
|
-
readonly Blacklist:
|
|
3064
|
+
readonly Whitelist: 'whitelist';
|
|
3065
|
+
readonly Blacklist: 'blacklist';
|
|
3030
3066
|
};
|
|
3031
3067
|
export type FraudRuleRequestConfigTypeEnum = typeof FraudRuleRequestConfigTypeEnum[keyof typeof FraudRuleRequestConfigTypeEnum];
|
|
3032
3068
|
export declare const FraudRuleRequestConfigPeriodEnum: {
|
|
3033
|
-
readonly _7:
|
|
3034
|
-
readonly _30:
|
|
3035
|
-
readonly _90:
|
|
3036
|
-
readonly _120:
|
|
3037
|
-
readonly _365:
|
|
3038
|
-
readonly AllTime:
|
|
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';
|
|
3039
3075
|
};
|
|
3040
3076
|
export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeriodEnum[keyof typeof FraudRuleRequestConfigPeriodEnum];
|
|
3041
3077
|
/**
|
|
@@ -3044,17 +3080,17 @@ export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeri
|
|
|
3044
3080
|
* @enum {string}
|
|
3045
3081
|
*/
|
|
3046
3082
|
export declare const FraudRuleType: {
|
|
3047
|
-
readonly ReviewCountry:
|
|
3048
|
-
readonly ReviewIp:
|
|
3049
|
-
readonly ReviewEmail:
|
|
3050
|
-
readonly ReviewRedeemedRewardsCount:
|
|
3051
|
-
readonly ReviewRedeemedRewardsAmount:
|
|
3052
|
-
readonly ReviewMultipleEmails:
|
|
3053
|
-
readonly ReviewVpn:
|
|
3054
|
-
readonly ReviewTremendousFlagList:
|
|
3055
|
-
readonly ReviewPreviouslyBlockedRecipients:
|
|
3056
|
-
readonly AllowIp:
|
|
3057
|
-
readonly AllowEmail:
|
|
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';
|
|
3058
3094
|
};
|
|
3059
3095
|
export type FraudRuleType = typeof FraudRuleType[keyof typeof FraudRuleType];
|
|
3060
3096
|
/**
|
|
@@ -3079,17 +3115,17 @@ export interface FraudRulesListItem {
|
|
|
3079
3115
|
} | null;
|
|
3080
3116
|
}
|
|
3081
3117
|
export declare const FraudRulesListItemRuleTypeEnum: {
|
|
3082
|
-
readonly ReviewCountry:
|
|
3083
|
-
readonly ReviewIp:
|
|
3084
|
-
readonly ReviewEmail:
|
|
3085
|
-
readonly ReviewRedeemedRewardsCount:
|
|
3086
|
-
readonly ReviewRedeemedRewardsAmount:
|
|
3087
|
-
readonly ReviewMultipleEmails:
|
|
3088
|
-
readonly ReviewVpn:
|
|
3089
|
-
readonly ReviewTremendousFlagList:
|
|
3090
|
-
readonly ReviewPreviouslyBlockedRecipients:
|
|
3091
|
-
readonly AllowIp:
|
|
3092
|
-
readonly AllowEmail:
|
|
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';
|
|
3093
3129
|
};
|
|
3094
3130
|
export type FraudRulesListItemRuleTypeEnum = typeof FraudRulesListItemRuleTypeEnum[keyof typeof FraudRulesListItemRuleTypeEnum];
|
|
3095
3131
|
/**
|
|
@@ -3136,28 +3172,28 @@ export interface FundingSource {
|
|
|
3136
3172
|
'meta': ListFundingSources200ResponseFundingSourcesInnerMeta;
|
|
3137
3173
|
}
|
|
3138
3174
|
export declare const FundingSourceMethodEnum: {
|
|
3139
|
-
readonly Balance:
|
|
3140
|
-
readonly BankAccount:
|
|
3141
|
-
readonly CreditCard:
|
|
3142
|
-
readonly Invoice:
|
|
3175
|
+
readonly Balance: 'balance';
|
|
3176
|
+
readonly BankAccount: 'bank_account';
|
|
3177
|
+
readonly CreditCard: 'credit_card';
|
|
3178
|
+
readonly Invoice: 'invoice';
|
|
3143
3179
|
};
|
|
3144
3180
|
export type FundingSourceMethodEnum = typeof FundingSourceMethodEnum[keyof typeof FundingSourceMethodEnum];
|
|
3145
3181
|
export declare const FundingSourceUsagePermissionsEnum: {
|
|
3146
|
-
readonly ApiOrders:
|
|
3147
|
-
readonly DashboardOrders:
|
|
3148
|
-
readonly BalanceFunding:
|
|
3182
|
+
readonly ApiOrders: 'api_orders';
|
|
3183
|
+
readonly DashboardOrders: 'dashboard_orders';
|
|
3184
|
+
readonly BalanceFunding: 'balance_funding';
|
|
3149
3185
|
};
|
|
3150
3186
|
export type FundingSourceUsagePermissionsEnum = typeof FundingSourceUsagePermissionsEnum[keyof typeof FundingSourceUsagePermissionsEnum];
|
|
3151
3187
|
export declare const FundingSourceStatusEnum: {
|
|
3152
|
-
readonly Active:
|
|
3153
|
-
readonly Deleted:
|
|
3154
|
-
readonly Failed:
|
|
3188
|
+
readonly Active: 'active';
|
|
3189
|
+
readonly Deleted: 'deleted';
|
|
3190
|
+
readonly Failed: 'failed';
|
|
3155
3191
|
};
|
|
3156
3192
|
export type FundingSourceStatusEnum = typeof FundingSourceStatusEnum[keyof typeof FundingSourceStatusEnum];
|
|
3157
3193
|
export declare const FundingSourceTypeEnum: {
|
|
3158
|
-
readonly Commercial:
|
|
3159
|
-
readonly ProForma:
|
|
3160
|
-
readonly PrefundingOnly:
|
|
3194
|
+
readonly Commercial: 'COMMERCIAL';
|
|
3195
|
+
readonly ProForma: 'PRO_FORMA';
|
|
3196
|
+
readonly PrefundingOnly: 'PREFUNDING_ONLY';
|
|
3161
3197
|
};
|
|
3162
3198
|
export type FundingSourceTypeEnum = typeof FundingSourceTypeEnum[keyof typeof FundingSourceTypeEnum];
|
|
3163
3199
|
/**
|
|
@@ -3304,53 +3340,53 @@ export interface GetFraudReview200ResponseFraudReview {
|
|
|
3304
3340
|
'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
|
|
3305
3341
|
}
|
|
3306
3342
|
export declare const GetFraudReview200ResponseFraudReviewStatusEnum: {
|
|
3307
|
-
readonly Flagged:
|
|
3308
|
-
readonly Blocked:
|
|
3309
|
-
readonly Released:
|
|
3343
|
+
readonly Flagged: 'flagged';
|
|
3344
|
+
readonly Blocked: 'blocked';
|
|
3345
|
+
readonly Released: 'released';
|
|
3310
3346
|
};
|
|
3311
3347
|
export type GetFraudReview200ResponseFraudReviewStatusEnum = typeof GetFraudReview200ResponseFraudReviewStatusEnum[keyof typeof GetFraudReview200ResponseFraudReviewStatusEnum];
|
|
3312
3348
|
export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
|
|
3313
|
-
readonly DisallowedIp:
|
|
3314
|
-
readonly DisallowedEmail:
|
|
3315
|
-
readonly DisallowedCountry:
|
|
3316
|
-
readonly OverRewardAmountLimit:
|
|
3317
|
-
readonly OverRewardCountLimit:
|
|
3318
|
-
readonly VpnDetected:
|
|
3319
|
-
readonly ApplePrivateRelay:
|
|
3320
|
-
readonly DeviceRelatedToMultipleEmails:
|
|
3321
|
-
readonly DeviceOrAccountRelatedToMultipleEmails:
|
|
3322
|
-
readonly IpOnATremendousFraudList:
|
|
3323
|
-
readonly BankAccountOnATremendousFraudList:
|
|
3324
|
-
readonly FingerprintOnATremendousFraudList:
|
|
3325
|
-
readonly EmailOnATremendousFraudList:
|
|
3326
|
-
readonly PhoneOnATremendousFraudList:
|
|
3327
|
-
readonly DeviceOnATremendousFraudList:
|
|
3328
|
-
readonly IpRelatedToABlockedReward:
|
|
3329
|
-
readonly DeviceRelatedToABlockedReward:
|
|
3330
|
-
readonly BankAccountRelatedToABlockedReward:
|
|
3331
|
-
readonly FingerprintRelatedToABlockedReward:
|
|
3332
|
-
readonly EmailRelatedToABlockedReward:
|
|
3333
|
-
readonly PhoneRelatedToABlockedReward:
|
|
3334
|
-
readonly AllowedIp:
|
|
3335
|
-
readonly AllowedEmail:
|
|
3336
|
-
readonly AllowedCountry:
|
|
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';
|
|
3337
3373
|
};
|
|
3338
3374
|
export type GetFraudReview200ResponseFraudReviewReasonsEnum = typeof GetFraudReview200ResponseFraudReviewReasonsEnum[keyof typeof GetFraudReview200ResponseFraudReviewReasonsEnum];
|
|
3339
3375
|
export declare const GetFraudReview200ResponseFraudReviewRedemptionMethodEnum: {
|
|
3340
|
-
readonly BankTransfer:
|
|
3341
|
-
readonly Charity:
|
|
3342
|
-
readonly InstantDebitTransfer:
|
|
3343
|
-
readonly InternationalBankTransfer:
|
|
3344
|
-
readonly MerchantCard:
|
|
3345
|
-
readonly Paypal:
|
|
3346
|
-
readonly Venmo:
|
|
3347
|
-
readonly VisaCard:
|
|
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';
|
|
3348
3384
|
};
|
|
3349
3385
|
export type GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum[keyof typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum];
|
|
3350
3386
|
export declare const GetFraudReview200ResponseFraudReviewRiskEnum: {
|
|
3351
|
-
readonly High:
|
|
3352
|
-
readonly Medium:
|
|
3353
|
-
readonly Low:
|
|
3387
|
+
readonly High: 'high';
|
|
3388
|
+
readonly Medium: 'medium';
|
|
3389
|
+
readonly Low: 'low';
|
|
3354
3390
|
};
|
|
3355
3391
|
export type GetFraudReview200ResponseFraudReviewRiskEnum = typeof GetFraudReview200ResponseFraudReviewRiskEnum[keyof typeof GetFraudReview200ResponseFraudReviewRiskEnum];
|
|
3356
3392
|
/**
|
|
@@ -3466,8 +3502,8 @@ export interface GetMember200ResponseMember {
|
|
|
3466
3502
|
'events'?: Array<GetMember200ResponseMemberEventsInner>;
|
|
3467
3503
|
}
|
|
3468
3504
|
export declare const GetMember200ResponseMemberStatusEnum: {
|
|
3469
|
-
readonly Registered:
|
|
3470
|
-
readonly Invited:
|
|
3505
|
+
readonly Registered: 'REGISTERED';
|
|
3506
|
+
readonly Invited: 'INVITED';
|
|
3471
3507
|
};
|
|
3472
3508
|
export type GetMember200ResponseMemberStatusEnum = typeof GetMember200ResponseMemberStatusEnum[keyof typeof GetMember200ResponseMemberStatusEnum];
|
|
3473
3509
|
/**
|
|
@@ -3490,8 +3526,8 @@ export interface GetMember200ResponseMemberEventsInner {
|
|
|
3490
3526
|
'date_utc'?: string | null;
|
|
3491
3527
|
}
|
|
3492
3528
|
export declare const GetMember200ResponseMemberEventsInnerTypeEnum: {
|
|
3493
|
-
readonly Created:
|
|
3494
|
-
readonly LastLogin:
|
|
3529
|
+
readonly Created: 'created';
|
|
3530
|
+
readonly LastLogin: 'last_login';
|
|
3495
3531
|
};
|
|
3496
3532
|
export type GetMember200ResponseMemberEventsInnerTypeEnum = typeof GetMember200ResponseMemberEventsInnerTypeEnum[keyof typeof GetMember200ResponseMemberEventsInnerTypeEnum];
|
|
3497
3533
|
/**
|
|
@@ -3678,22 +3714,22 @@ export interface Invoice {
|
|
|
3678
3714
|
'paid_at': string | null;
|
|
3679
3715
|
}
|
|
3680
3716
|
export declare const InvoiceCurrencyCodeEnum: {
|
|
3681
|
-
readonly Usd:
|
|
3682
|
-
readonly Eur:
|
|
3683
|
-
readonly Gbp:
|
|
3717
|
+
readonly Usd: 'USD';
|
|
3718
|
+
readonly Eur: 'EUR';
|
|
3719
|
+
readonly Gbp: 'GBP';
|
|
3684
3720
|
};
|
|
3685
3721
|
export type InvoiceCurrencyCodeEnum = typeof InvoiceCurrencyCodeEnum[keyof typeof InvoiceCurrencyCodeEnum];
|
|
3686
3722
|
export declare const InvoiceCurrencyEnum: {
|
|
3687
|
-
readonly Usd:
|
|
3688
|
-
readonly Eur:
|
|
3689
|
-
readonly Gbp:
|
|
3723
|
+
readonly Usd: 'USD';
|
|
3724
|
+
readonly Eur: 'EUR';
|
|
3725
|
+
readonly Gbp: 'GBP';
|
|
3690
3726
|
};
|
|
3691
3727
|
export type InvoiceCurrencyEnum = typeof InvoiceCurrencyEnum[keyof typeof InvoiceCurrencyEnum];
|
|
3692
3728
|
export declare const InvoiceStatusEnum: {
|
|
3693
|
-
readonly Deleted:
|
|
3694
|
-
readonly Paid:
|
|
3695
|
-
readonly Open:
|
|
3696
|
-
readonly MarkedAsPaid:
|
|
3729
|
+
readonly Deleted: 'DELETED';
|
|
3730
|
+
readonly Paid: 'PAID';
|
|
3731
|
+
readonly Open: 'OPEN';
|
|
3732
|
+
readonly MarkedAsPaid: 'MARKED_AS_PAID';
|
|
3697
3733
|
};
|
|
3698
3734
|
export type InvoiceStatusEnum = typeof InvoiceStatusEnum[keyof typeof InvoiceStatusEnum];
|
|
3699
3735
|
/**
|
|
@@ -3895,8 +3931,8 @@ export interface ListCampaigns200ResponseCampaignsInner {
|
|
|
3895
3931
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
3896
3932
|
}
|
|
3897
3933
|
export declare const ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum: {
|
|
3898
|
-
readonly Sender:
|
|
3899
|
-
readonly Recipient:
|
|
3934
|
+
readonly Sender: 'SENDER';
|
|
3935
|
+
readonly Recipient: 'RECIPIENT';
|
|
3900
3936
|
};
|
|
3901
3937
|
export type ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum = typeof ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum[keyof typeof ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum];
|
|
3902
3938
|
/**
|
|
@@ -4128,8 +4164,8 @@ export interface ListConnectedOrganizationMembers200ResponseConnectedOrganizatio
|
|
|
4128
4164
|
'last_login_at'?: string | null;
|
|
4129
4165
|
}
|
|
4130
4166
|
export declare const ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum: {
|
|
4131
|
-
readonly Registered:
|
|
4132
|
-
readonly Invited:
|
|
4167
|
+
readonly Registered: 'REGISTERED';
|
|
4168
|
+
readonly Invited: 'INVITED';
|
|
4133
4169
|
};
|
|
4134
4170
|
export type ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum = typeof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum[keyof typeof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum];
|
|
4135
4171
|
/**
|
|
@@ -4226,9 +4262,9 @@ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInne
|
|
|
4226
4262
|
'created_at'?: string;
|
|
4227
4263
|
}
|
|
4228
4264
|
export declare const ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum: {
|
|
4229
|
-
readonly Pending:
|
|
4230
|
-
readonly Approved:
|
|
4231
|
-
readonly Rejected:
|
|
4265
|
+
readonly Pending: 'PENDING';
|
|
4266
|
+
readonly Approved: 'APPROVED';
|
|
4267
|
+
readonly Rejected: 'REJECTED';
|
|
4232
4268
|
};
|
|
4233
4269
|
export type ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum = typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum[keyof typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum];
|
|
4234
4270
|
/**
|
|
@@ -4288,16 +4324,16 @@ export interface ListFields200ResponseFieldsInner {
|
|
|
4288
4324
|
'scope'?: string;
|
|
4289
4325
|
}
|
|
4290
4326
|
export declare const ListFields200ResponseFieldsInnerDataTypeEnum: {
|
|
4291
|
-
readonly Checkbox:
|
|
4292
|
-
readonly Currency:
|
|
4293
|
-
readonly Date:
|
|
4294
|
-
readonly Dropdown:
|
|
4295
|
-
readonly Email:
|
|
4296
|
-
readonly List:
|
|
4297
|
-
readonly Number:
|
|
4298
|
-
readonly Phone:
|
|
4299
|
-
readonly Text:
|
|
4300
|
-
readonly 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';
|
|
4301
4337
|
};
|
|
4302
4338
|
export type ListFields200ResponseFieldsInnerDataTypeEnum = typeof ListFields200ResponseFieldsInnerDataTypeEnum[keyof typeof ListFields200ResponseFieldsInnerDataTypeEnum];
|
|
4303
4339
|
/**
|
|
@@ -4423,47 +4459,47 @@ export interface ListFraudReviews200ResponseFraudReviewsInner {
|
|
|
4423
4459
|
'redemption_method_account_hash'?: string;
|
|
4424
4460
|
}
|
|
4425
4461
|
export declare const ListFraudReviews200ResponseFraudReviewsInnerStatusEnum: {
|
|
4426
|
-
readonly Flagged:
|
|
4427
|
-
readonly Blocked:
|
|
4428
|
-
readonly Released:
|
|
4462
|
+
readonly Flagged: 'flagged';
|
|
4463
|
+
readonly Blocked: 'blocked';
|
|
4464
|
+
readonly Released: 'released';
|
|
4429
4465
|
};
|
|
4430
4466
|
export type ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum];
|
|
4431
4467
|
export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: {
|
|
4432
|
-
readonly DisallowedIp:
|
|
4433
|
-
readonly DisallowedEmail:
|
|
4434
|
-
readonly DisallowedCountry:
|
|
4435
|
-
readonly OverRewardAmountLimit:
|
|
4436
|
-
readonly OverRewardCountLimit:
|
|
4437
|
-
readonly VpnDetected:
|
|
4438
|
-
readonly ApplePrivateRelay:
|
|
4439
|
-
readonly DeviceRelatedToMultipleEmails:
|
|
4440
|
-
readonly DeviceOrAccountRelatedToMultipleEmails:
|
|
4441
|
-
readonly IpOnATremendousFraudList:
|
|
4442
|
-
readonly BankAccountOnATremendousFraudList:
|
|
4443
|
-
readonly FingerprintOnATremendousFraudList:
|
|
4444
|
-
readonly EmailOnATremendousFraudList:
|
|
4445
|
-
readonly PhoneOnATremendousFraudList:
|
|
4446
|
-
readonly DeviceOnATremendousFraudList:
|
|
4447
|
-
readonly IpRelatedToABlockedReward:
|
|
4448
|
-
readonly DeviceRelatedToABlockedReward:
|
|
4449
|
-
readonly BankAccountRelatedToABlockedReward:
|
|
4450
|
-
readonly FingerprintRelatedToABlockedReward:
|
|
4451
|
-
readonly EmailRelatedToABlockedReward:
|
|
4452
|
-
readonly PhoneRelatedToABlockedReward:
|
|
4453
|
-
readonly AllowedIp:
|
|
4454
|
-
readonly AllowedEmail:
|
|
4455
|
-
readonly AllowedCountry:
|
|
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';
|
|
4456
4492
|
};
|
|
4457
4493
|
export type ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum];
|
|
4458
4494
|
export declare const ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum: {
|
|
4459
|
-
readonly BankTransfer:
|
|
4460
|
-
readonly Charity:
|
|
4461
|
-
readonly InstantDebitTransfer:
|
|
4462
|
-
readonly InternationalBankTransfer:
|
|
4463
|
-
readonly MerchantCard:
|
|
4464
|
-
readonly Paypal:
|
|
4465
|
-
readonly Venmo:
|
|
4466
|
-
readonly VisaCard:
|
|
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';
|
|
4467
4503
|
};
|
|
4468
4504
|
export type ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum];
|
|
4469
4505
|
/**
|
|
@@ -4526,17 +4562,17 @@ export interface ListFraudRules200ResponseFraudRulesInner {
|
|
|
4526
4562
|
} | null;
|
|
4527
4563
|
}
|
|
4528
4564
|
export declare const ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum: {
|
|
4529
|
-
readonly ReviewCountry:
|
|
4530
|
-
readonly ReviewIp:
|
|
4531
|
-
readonly ReviewEmail:
|
|
4532
|
-
readonly ReviewRedeemedRewardsCount:
|
|
4533
|
-
readonly ReviewRedeemedRewardsAmount:
|
|
4534
|
-
readonly ReviewMultipleEmails:
|
|
4535
|
-
readonly ReviewVpn:
|
|
4536
|
-
readonly ReviewTremendousFlagList:
|
|
4537
|
-
readonly ReviewPreviouslyBlockedRecipients:
|
|
4538
|
-
readonly AllowIp:
|
|
4539
|
-
readonly AllowEmail:
|
|
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';
|
|
4540
4576
|
};
|
|
4541
4577
|
export type ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum[keyof typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum];
|
|
4542
4578
|
/**
|
|
@@ -4596,28 +4632,28 @@ export interface ListFundingSources200ResponseFundingSourcesInner {
|
|
|
4596
4632
|
'meta': ListFundingSources200ResponseFundingSourcesInnerMeta;
|
|
4597
4633
|
}
|
|
4598
4634
|
export declare const ListFundingSources200ResponseFundingSourcesInnerMethodEnum: {
|
|
4599
|
-
readonly Balance:
|
|
4600
|
-
readonly BankAccount:
|
|
4601
|
-
readonly CreditCard:
|
|
4602
|
-
readonly Invoice:
|
|
4635
|
+
readonly Balance: 'balance';
|
|
4636
|
+
readonly BankAccount: 'bank_account';
|
|
4637
|
+
readonly CreditCard: 'credit_card';
|
|
4638
|
+
readonly Invoice: 'invoice';
|
|
4603
4639
|
};
|
|
4604
4640
|
export type ListFundingSources200ResponseFundingSourcesInnerMethodEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMethodEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMethodEnum];
|
|
4605
4641
|
export declare const ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum: {
|
|
4606
|
-
readonly ApiOrders:
|
|
4607
|
-
readonly DashboardOrders:
|
|
4608
|
-
readonly BalanceFunding:
|
|
4642
|
+
readonly ApiOrders: 'api_orders';
|
|
4643
|
+
readonly DashboardOrders: 'dashboard_orders';
|
|
4644
|
+
readonly BalanceFunding: 'balance_funding';
|
|
4609
4645
|
};
|
|
4610
4646
|
export type ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum = typeof ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum];
|
|
4611
4647
|
export declare const ListFundingSources200ResponseFundingSourcesInnerStatusEnum: {
|
|
4612
|
-
readonly Active:
|
|
4613
|
-
readonly Deleted:
|
|
4614
|
-
readonly Failed:
|
|
4648
|
+
readonly Active: 'active';
|
|
4649
|
+
readonly Deleted: 'deleted';
|
|
4650
|
+
readonly Failed: 'failed';
|
|
4615
4651
|
};
|
|
4616
4652
|
export type ListFundingSources200ResponseFundingSourcesInnerStatusEnum = typeof ListFundingSources200ResponseFundingSourcesInnerStatusEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerStatusEnum];
|
|
4617
4653
|
export declare const ListFundingSources200ResponseFundingSourcesInnerTypeEnum: {
|
|
4618
|
-
readonly Commercial:
|
|
4619
|
-
readonly ProForma:
|
|
4620
|
-
readonly PrefundingOnly:
|
|
4654
|
+
readonly Commercial: 'COMMERCIAL';
|
|
4655
|
+
readonly ProForma: 'PRO_FORMA';
|
|
4656
|
+
readonly PrefundingOnly: 'PREFUNDING_ONLY';
|
|
4621
4657
|
};
|
|
4622
4658
|
export type ListFundingSources200ResponseFundingSourcesInnerTypeEnum = typeof ListFundingSources200ResponseFundingSourcesInnerTypeEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerTypeEnum];
|
|
4623
4659
|
/**
|
|
@@ -4823,21 +4859,21 @@ export interface ListFundingSources200ResponseFundingSourcesInnerMeta {
|
|
|
4823
4859
|
'failure_details'?: ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails | null;
|
|
4824
4860
|
}
|
|
4825
4861
|
export declare const ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum: {
|
|
4826
|
-
readonly Checking:
|
|
4827
|
-
readonly Savings:
|
|
4862
|
+
readonly Checking: 'checking';
|
|
4863
|
+
readonly Savings: 'savings';
|
|
4828
4864
|
};
|
|
4829
4865
|
export type ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum];
|
|
4830
4866
|
export declare const ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum: {
|
|
4831
|
-
readonly MasterCard:
|
|
4832
|
-
readonly Amex:
|
|
4833
|
-
readonly Jcb:
|
|
4834
|
-
readonly DinersClub:
|
|
4835
|
-
readonly Visa:
|
|
4836
|
-
readonly Discover:
|
|
4837
|
-
readonly Laser:
|
|
4838
|
-
readonly Elo:
|
|
4839
|
-
readonly Maestro:
|
|
4840
|
-
readonly 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';
|
|
4841
4877
|
};
|
|
4842
4878
|
export type ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum];
|
|
4843
4879
|
/**
|
|
@@ -4953,22 +4989,22 @@ export interface ListInvoices200ResponseInvoicesInner {
|
|
|
4953
4989
|
'paid_at': string | null;
|
|
4954
4990
|
}
|
|
4955
4991
|
export declare const ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum: {
|
|
4956
|
-
readonly Usd:
|
|
4957
|
-
readonly Eur:
|
|
4958
|
-
readonly Gbp:
|
|
4992
|
+
readonly Usd: 'USD';
|
|
4993
|
+
readonly Eur: 'EUR';
|
|
4994
|
+
readonly Gbp: 'GBP';
|
|
4959
4995
|
};
|
|
4960
4996
|
export type ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum = typeof ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum[keyof typeof ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum];
|
|
4961
4997
|
export declare const ListInvoices200ResponseInvoicesInnerCurrencyEnum: {
|
|
4962
|
-
readonly Usd:
|
|
4963
|
-
readonly Eur:
|
|
4964
|
-
readonly Gbp:
|
|
4998
|
+
readonly Usd: 'USD';
|
|
4999
|
+
readonly Eur: 'EUR';
|
|
5000
|
+
readonly Gbp: 'GBP';
|
|
4965
5001
|
};
|
|
4966
5002
|
export type ListInvoices200ResponseInvoicesInnerCurrencyEnum = typeof ListInvoices200ResponseInvoicesInnerCurrencyEnum[keyof typeof ListInvoices200ResponseInvoicesInnerCurrencyEnum];
|
|
4967
5003
|
export declare const ListInvoices200ResponseInvoicesInnerStatusEnum: {
|
|
4968
|
-
readonly Deleted:
|
|
4969
|
-
readonly Paid:
|
|
4970
|
-
readonly Open:
|
|
4971
|
-
readonly MarkedAsPaid:
|
|
5004
|
+
readonly Deleted: 'DELETED';
|
|
5005
|
+
readonly Paid: 'PAID';
|
|
5006
|
+
readonly Open: 'OPEN';
|
|
5007
|
+
readonly MarkedAsPaid: 'MARKED_AS_PAID';
|
|
4972
5008
|
};
|
|
4973
5009
|
export type ListInvoices200ResponseInvoicesInnerStatusEnum = typeof ListInvoices200ResponseInvoicesInnerStatusEnum[keyof typeof ListInvoices200ResponseInvoicesInnerStatusEnum];
|
|
4974
5010
|
/**
|
|
@@ -5040,8 +5076,8 @@ export interface ListMembers200ResponseMembersInner {
|
|
|
5040
5076
|
'last_login_at'?: string | null;
|
|
5041
5077
|
}
|
|
5042
5078
|
export declare const ListMembers200ResponseMembersInnerStatusEnum: {
|
|
5043
|
-
readonly Registered:
|
|
5044
|
-
readonly Invited:
|
|
5079
|
+
readonly Registered: 'REGISTERED';
|
|
5080
|
+
readonly Invited: 'INVITED';
|
|
5045
5081
|
};
|
|
5046
5082
|
export type ListMembers200ResponseMembersInnerStatusEnum = typeof ListMembers200ResponseMembersInnerStatusEnum[keyof typeof ListMembers200ResponseMembersInnerStatusEnum];
|
|
5047
5083
|
/**
|
|
@@ -5125,24 +5161,24 @@ export interface ListOrders200ResponseOrdersInner {
|
|
|
5125
5161
|
'rewards'?: Array<ListRewards200ResponseRewardsInner>;
|
|
5126
5162
|
}
|
|
5127
5163
|
export declare const ListOrders200ResponseOrdersInnerStatusEnum: {
|
|
5128
|
-
readonly Canceled:
|
|
5129
|
-
readonly Open:
|
|
5130
|
-
readonly Executed:
|
|
5131
|
-
readonly Failed:
|
|
5132
|
-
readonly PendingApproval:
|
|
5133
|
-
readonly PendingInternalPaymentApproval:
|
|
5134
|
-
readonly PendingSettlement:
|
|
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';
|
|
5135
5171
|
};
|
|
5136
5172
|
export type ListOrders200ResponseOrdersInnerStatusEnum = typeof ListOrders200ResponseOrdersInnerStatusEnum[keyof typeof ListOrders200ResponseOrdersInnerStatusEnum];
|
|
5137
5173
|
export declare const ListOrders200ResponseOrdersInnerChannelEnum: {
|
|
5138
|
-
readonly Ui:
|
|
5139
|
-
readonly Api:
|
|
5140
|
-
readonly Embed:
|
|
5141
|
-
readonly Decipher:
|
|
5142
|
-
readonly Qualtrics:
|
|
5143
|
-
readonly Typeform:
|
|
5144
|
-
readonly SurveyMonkey:
|
|
5145
|
-
readonly 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';
|
|
5146
5182
|
};
|
|
5147
5183
|
export type ListOrders200ResponseOrdersInnerChannelEnum = typeof ListOrders200ResponseOrdersInnerChannelEnum[keyof typeof ListOrders200ResponseOrdersInnerChannelEnum];
|
|
5148
5184
|
/**
|
|
@@ -5264,9 +5300,9 @@ export interface ListOrganizations200ResponseOrganizationsInner {
|
|
|
5264
5300
|
'created_at'?: string;
|
|
5265
5301
|
}
|
|
5266
5302
|
export declare const ListOrganizations200ResponseOrganizationsInnerStatusEnum: {
|
|
5267
|
-
readonly Pending:
|
|
5268
|
-
readonly Approved:
|
|
5269
|
-
readonly Rejected:
|
|
5303
|
+
readonly Pending: 'PENDING';
|
|
5304
|
+
readonly Approved: 'APPROVED';
|
|
5305
|
+
readonly Rejected: 'REJECTED';
|
|
5270
5306
|
};
|
|
5271
5307
|
export type ListOrganizations200ResponseOrganizationsInnerStatusEnum = typeof ListOrganizations200ResponseOrganizationsInnerStatusEnum[keyof typeof ListOrganizations200ResponseOrganizationsInnerStatusEnum];
|
|
5272
5308
|
/**
|
|
@@ -5362,145 +5398,145 @@ export interface ListProductsResponseProductsInner {
|
|
|
5362
5398
|
'documents'?: ListProductsResponseProductsInnerDocuments | null;
|
|
5363
5399
|
}
|
|
5364
5400
|
export declare const ListProductsResponseProductsInnerCategoryEnum: {
|
|
5365
|
-
readonly Ach:
|
|
5366
|
-
readonly Charity:
|
|
5367
|
-
readonly InstantDebitTransfer:
|
|
5368
|
-
readonly MerchantCard:
|
|
5369
|
-
readonly Paypal:
|
|
5370
|
-
readonly Venmo:
|
|
5371
|
-
readonly VisaCard:
|
|
5372
|
-
readonly CashApp:
|
|
5373
|
-
readonly InternationalBank:
|
|
5374
|
-
readonly 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';
|
|
5375
5411
|
};
|
|
5376
5412
|
export type ListProductsResponseProductsInnerCategoryEnum = typeof ListProductsResponseProductsInnerCategoryEnum[keyof typeof ListProductsResponseProductsInnerCategoryEnum];
|
|
5377
5413
|
export declare const ListProductsResponseProductsInnerSubcategoryEnum: {
|
|
5378
|
-
readonly BeautyAndHealth:
|
|
5379
|
-
readonly DigitalFinancialServices:
|
|
5380
|
-
readonly Electronics:
|
|
5381
|
-
readonly Entertainment:
|
|
5382
|
-
readonly Fashion:
|
|
5383
|
-
readonly FoodAndDrink:
|
|
5384
|
-
readonly GeneralMerchandise:
|
|
5385
|
-
readonly GroceryAndSupermarkets:
|
|
5386
|
-
readonly HomeAndLiving:
|
|
5387
|
-
readonly MobilityAndFuel:
|
|
5388
|
-
readonly SportsAndOutdoorGear:
|
|
5389
|
-
readonly TravelAndHospitality:
|
|
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';
|
|
5390
5426
|
};
|
|
5391
5427
|
export type ListProductsResponseProductsInnerSubcategoryEnum = typeof ListProductsResponseProductsInnerSubcategoryEnum[keyof typeof ListProductsResponseProductsInnerSubcategoryEnum];
|
|
5392
5428
|
export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
5393
|
-
readonly Usd:
|
|
5394
|
-
readonly Cad:
|
|
5395
|
-
readonly Eur:
|
|
5396
|
-
readonly Aed:
|
|
5397
|
-
readonly Afn:
|
|
5398
|
-
readonly All:
|
|
5399
|
-
readonly Amd:
|
|
5400
|
-
readonly Ars:
|
|
5401
|
-
readonly Aud:
|
|
5402
|
-
readonly Azn:
|
|
5403
|
-
readonly Bam:
|
|
5404
|
-
readonly Bdt:
|
|
5405
|
-
readonly Bhd:
|
|
5406
|
-
readonly Bif:
|
|
5407
|
-
readonly Bnd:
|
|
5408
|
-
readonly Bob:
|
|
5409
|
-
readonly Brl:
|
|
5410
|
-
readonly Bwp:
|
|
5411
|
-
readonly Byn:
|
|
5412
|
-
readonly Bzd:
|
|
5413
|
-
readonly Cdf:
|
|
5414
|
-
readonly Chf:
|
|
5415
|
-
readonly Clp:
|
|
5416
|
-
readonly Cny:
|
|
5417
|
-
readonly Cop:
|
|
5418
|
-
readonly Crc:
|
|
5419
|
-
readonly Cve:
|
|
5420
|
-
readonly Czk:
|
|
5421
|
-
readonly Djf:
|
|
5422
|
-
readonly Dkk:
|
|
5423
|
-
readonly Dop:
|
|
5424
|
-
readonly Dzd:
|
|
5425
|
-
readonly Egp:
|
|
5426
|
-
readonly Ern:
|
|
5427
|
-
readonly Etb:
|
|
5428
|
-
readonly Gbp:
|
|
5429
|
-
readonly Gel:
|
|
5430
|
-
readonly Ghs:
|
|
5431
|
-
readonly Gnf:
|
|
5432
|
-
readonly Gtq:
|
|
5433
|
-
readonly Hkd:
|
|
5434
|
-
readonly Hnl:
|
|
5435
|
-
readonly Hrk:
|
|
5436
|
-
readonly Huf:
|
|
5437
|
-
readonly Idr:
|
|
5438
|
-
readonly Ils:
|
|
5439
|
-
readonly Inr:
|
|
5440
|
-
readonly Iqd:
|
|
5441
|
-
readonly Irr:
|
|
5442
|
-
readonly Isk:
|
|
5443
|
-
readonly Jmd:
|
|
5444
|
-
readonly Jod:
|
|
5445
|
-
readonly Jpy:
|
|
5446
|
-
readonly Kes:
|
|
5447
|
-
readonly Khr:
|
|
5448
|
-
readonly Krw:
|
|
5449
|
-
readonly Kwd:
|
|
5450
|
-
readonly Kzt:
|
|
5451
|
-
readonly Lbp:
|
|
5452
|
-
readonly Lkr:
|
|
5453
|
-
readonly Mad:
|
|
5454
|
-
readonly Mdl:
|
|
5455
|
-
readonly Mga:
|
|
5456
|
-
readonly Mkd:
|
|
5457
|
-
readonly Mmk:
|
|
5458
|
-
readonly Mop:
|
|
5459
|
-
readonly Mur:
|
|
5460
|
-
readonly Mxn:
|
|
5461
|
-
readonly Myr:
|
|
5462
|
-
readonly Mzn:
|
|
5463
|
-
readonly Nad:
|
|
5464
|
-
readonly Ngn:
|
|
5465
|
-
readonly Nio:
|
|
5466
|
-
readonly Nok:
|
|
5467
|
-
readonly Npr:
|
|
5468
|
-
readonly Nzd:
|
|
5469
|
-
readonly Omr:
|
|
5470
|
-
readonly Pab:
|
|
5471
|
-
readonly Pen:
|
|
5472
|
-
readonly Php:
|
|
5473
|
-
readonly Pkr:
|
|
5474
|
-
readonly Pln:
|
|
5475
|
-
readonly Pyg:
|
|
5476
|
-
readonly Qar:
|
|
5477
|
-
readonly Ron:
|
|
5478
|
-
readonly Rsd:
|
|
5479
|
-
readonly Rub:
|
|
5480
|
-
readonly Rwf:
|
|
5481
|
-
readonly Sar:
|
|
5482
|
-
readonly Sdg:
|
|
5483
|
-
readonly Sek:
|
|
5484
|
-
readonly Sgd:
|
|
5485
|
-
readonly Sos:
|
|
5486
|
-
readonly Syp:
|
|
5487
|
-
readonly Thb:
|
|
5488
|
-
readonly Tnd:
|
|
5489
|
-
readonly Top:
|
|
5490
|
-
readonly Try:
|
|
5491
|
-
readonly Ttd:
|
|
5492
|
-
readonly Twd:
|
|
5493
|
-
readonly Tzs:
|
|
5494
|
-
readonly Uah:
|
|
5495
|
-
readonly Ugx:
|
|
5496
|
-
readonly Uyu:
|
|
5497
|
-
readonly Uzs:
|
|
5498
|
-
readonly Vef:
|
|
5499
|
-
readonly Vnd:
|
|
5500
|
-
readonly Xaf:
|
|
5501
|
-
readonly Xof:
|
|
5502
|
-
readonly Yer:
|
|
5503
|
-
readonly 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';
|
|
5504
5540
|
};
|
|
5505
5541
|
export type ListProductsResponseProductsInnerCurrencyCodesEnum = typeof ListProductsResponseProductsInnerCurrencyCodesEnum[keyof typeof ListProductsResponseProductsInnerCurrencyCodesEnum];
|
|
5506
5542
|
/**
|
|
@@ -5567,8 +5603,8 @@ export interface ListProductsResponseProductsInnerImagesInner {
|
|
|
5567
5603
|
'content_type'?: string | null;
|
|
5568
5604
|
}
|
|
5569
5605
|
export declare const ListProductsResponseProductsInnerImagesInnerTypeEnum: {
|
|
5570
|
-
readonly Card:
|
|
5571
|
-
readonly Logo:
|
|
5606
|
+
readonly Card: 'card';
|
|
5607
|
+
readonly Logo: 'logo';
|
|
5572
5608
|
};
|
|
5573
5609
|
export type ListProductsResponseProductsInnerImagesInnerTypeEnum = typeof ListProductsResponseProductsInnerImagesInnerTypeEnum[keyof typeof ListProductsResponseProductsInnerImagesInnerTypeEnum];
|
|
5574
5610
|
/**
|
|
@@ -5715,16 +5751,16 @@ export interface ListRewards200ResponseRewardsInnerDelivery {
|
|
|
5715
5751
|
'status'?: ListRewards200ResponseRewardsInnerDeliveryStatusEnum;
|
|
5716
5752
|
}
|
|
5717
5753
|
export declare const ListRewards200ResponseRewardsInnerDeliveryMethodEnum: {
|
|
5718
|
-
readonly Email:
|
|
5719
|
-
readonly Link:
|
|
5720
|
-
readonly Phone:
|
|
5754
|
+
readonly Email: 'EMAIL';
|
|
5755
|
+
readonly Link: 'LINK';
|
|
5756
|
+
readonly Phone: 'PHONE';
|
|
5721
5757
|
};
|
|
5722
5758
|
export type ListRewards200ResponseRewardsInnerDeliveryMethodEnum = typeof ListRewards200ResponseRewardsInnerDeliveryMethodEnum[keyof typeof ListRewards200ResponseRewardsInnerDeliveryMethodEnum];
|
|
5723
5759
|
export declare const ListRewards200ResponseRewardsInnerDeliveryStatusEnum: {
|
|
5724
|
-
readonly Scheduled:
|
|
5725
|
-
readonly Failed:
|
|
5726
|
-
readonly Succeeded:
|
|
5727
|
-
readonly Pending:
|
|
5760
|
+
readonly Scheduled: 'SCHEDULED';
|
|
5761
|
+
readonly Failed: 'FAILED';
|
|
5762
|
+
readonly Succeeded: 'SUCCEEDED';
|
|
5763
|
+
readonly Pending: 'PENDING';
|
|
5728
5764
|
};
|
|
5729
5765
|
export type ListRewards200ResponseRewardsInnerDeliveryStatusEnum = typeof ListRewards200ResponseRewardsInnerDeliveryStatusEnum[keyof typeof ListRewards200ResponseRewardsInnerDeliveryStatusEnum];
|
|
5730
5766
|
/**
|
|
@@ -5772,117 +5808,117 @@ export interface ListRewards200ResponseRewardsInnerValue {
|
|
|
5772
5808
|
'currency_code'?: ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum;
|
|
5773
5809
|
}
|
|
5774
5810
|
export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
5775
|
-
readonly Usd:
|
|
5776
|
-
readonly Cad:
|
|
5777
|
-
readonly Eur:
|
|
5778
|
-
readonly Aed:
|
|
5779
|
-
readonly Afn:
|
|
5780
|
-
readonly All:
|
|
5781
|
-
readonly Amd:
|
|
5782
|
-
readonly Ars:
|
|
5783
|
-
readonly Aud:
|
|
5784
|
-
readonly Azn:
|
|
5785
|
-
readonly Bam:
|
|
5786
|
-
readonly Bdt:
|
|
5787
|
-
readonly Bhd:
|
|
5788
|
-
readonly Bif:
|
|
5789
|
-
readonly Bnd:
|
|
5790
|
-
readonly Bob:
|
|
5791
|
-
readonly Brl:
|
|
5792
|
-
readonly Bwp:
|
|
5793
|
-
readonly Byn:
|
|
5794
|
-
readonly Bzd:
|
|
5795
|
-
readonly Cdf:
|
|
5796
|
-
readonly Chf:
|
|
5797
|
-
readonly Clp:
|
|
5798
|
-
readonly Cny:
|
|
5799
|
-
readonly Cop:
|
|
5800
|
-
readonly Crc:
|
|
5801
|
-
readonly Cve:
|
|
5802
|
-
readonly Czk:
|
|
5803
|
-
readonly Djf:
|
|
5804
|
-
readonly Dkk:
|
|
5805
|
-
readonly Dop:
|
|
5806
|
-
readonly Dzd:
|
|
5807
|
-
readonly Egp:
|
|
5808
|
-
readonly Ern:
|
|
5809
|
-
readonly Etb:
|
|
5810
|
-
readonly Gbp:
|
|
5811
|
-
readonly Gel:
|
|
5812
|
-
readonly Ghs:
|
|
5813
|
-
readonly Gnf:
|
|
5814
|
-
readonly Gtq:
|
|
5815
|
-
readonly Hkd:
|
|
5816
|
-
readonly Hnl:
|
|
5817
|
-
readonly Hrk:
|
|
5818
|
-
readonly Huf:
|
|
5819
|
-
readonly Idr:
|
|
5820
|
-
readonly Ils:
|
|
5821
|
-
readonly Inr:
|
|
5822
|
-
readonly Iqd:
|
|
5823
|
-
readonly Irr:
|
|
5824
|
-
readonly Isk:
|
|
5825
|
-
readonly Jmd:
|
|
5826
|
-
readonly Jod:
|
|
5827
|
-
readonly Jpy:
|
|
5828
|
-
readonly Kes:
|
|
5829
|
-
readonly Khr:
|
|
5830
|
-
readonly Krw:
|
|
5831
|
-
readonly Kwd:
|
|
5832
|
-
readonly Kzt:
|
|
5833
|
-
readonly Lbp:
|
|
5834
|
-
readonly Lkr:
|
|
5835
|
-
readonly Mad:
|
|
5836
|
-
readonly Mdl:
|
|
5837
|
-
readonly Mga:
|
|
5838
|
-
readonly Mkd:
|
|
5839
|
-
readonly Mmk:
|
|
5840
|
-
readonly Mop:
|
|
5841
|
-
readonly Mur:
|
|
5842
|
-
readonly Mxn:
|
|
5843
|
-
readonly Myr:
|
|
5844
|
-
readonly Mzn:
|
|
5845
|
-
readonly Nad:
|
|
5846
|
-
readonly Ngn:
|
|
5847
|
-
readonly Nio:
|
|
5848
|
-
readonly Nok:
|
|
5849
|
-
readonly Npr:
|
|
5850
|
-
readonly Nzd:
|
|
5851
|
-
readonly Omr:
|
|
5852
|
-
readonly Pab:
|
|
5853
|
-
readonly Pen:
|
|
5854
|
-
readonly Php:
|
|
5855
|
-
readonly Pkr:
|
|
5856
|
-
readonly Pln:
|
|
5857
|
-
readonly Pyg:
|
|
5858
|
-
readonly Qar:
|
|
5859
|
-
readonly Ron:
|
|
5860
|
-
readonly Rsd:
|
|
5861
|
-
readonly Rub:
|
|
5862
|
-
readonly Rwf:
|
|
5863
|
-
readonly Sar:
|
|
5864
|
-
readonly Sdg:
|
|
5865
|
-
readonly Sek:
|
|
5866
|
-
readonly Sgd:
|
|
5867
|
-
readonly Sos:
|
|
5868
|
-
readonly Syp:
|
|
5869
|
-
readonly Thb:
|
|
5870
|
-
readonly Tnd:
|
|
5871
|
-
readonly Top:
|
|
5872
|
-
readonly Try:
|
|
5873
|
-
readonly Ttd:
|
|
5874
|
-
readonly Twd:
|
|
5875
|
-
readonly Tzs:
|
|
5876
|
-
readonly Uah:
|
|
5877
|
-
readonly Ugx:
|
|
5878
|
-
readonly Uyu:
|
|
5879
|
-
readonly Uzs:
|
|
5880
|
-
readonly Vef:
|
|
5881
|
-
readonly Vnd:
|
|
5882
|
-
readonly Xaf:
|
|
5883
|
-
readonly Xof:
|
|
5884
|
-
readonly Yer:
|
|
5885
|
-
readonly 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';
|
|
5886
5922
|
};
|
|
5887
5923
|
export type ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum[keyof typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum];
|
|
5888
5924
|
/**
|
|
@@ -6205,8 +6241,8 @@ export interface Member {
|
|
|
6205
6241
|
'last_login_at'?: string | null;
|
|
6206
6242
|
}
|
|
6207
6243
|
export declare const MemberStatusEnum: {
|
|
6208
|
-
readonly Registered:
|
|
6209
|
-
readonly Invited:
|
|
6244
|
+
readonly Registered: 'REGISTERED';
|
|
6245
|
+
readonly Invited: 'INVITED';
|
|
6210
6246
|
};
|
|
6211
6247
|
export type MemberStatusEnum = typeof MemberStatusEnum[keyof typeof MemberStatusEnum];
|
|
6212
6248
|
/**
|
|
@@ -6253,8 +6289,8 @@ export interface MemberBase {
|
|
|
6253
6289
|
'status': MemberBaseStatusEnum;
|
|
6254
6290
|
}
|
|
6255
6291
|
export declare const MemberBaseStatusEnum: {
|
|
6256
|
-
readonly Registered:
|
|
6257
|
-
readonly Invited:
|
|
6292
|
+
readonly Registered: 'REGISTERED';
|
|
6293
|
+
readonly Invited: 'INVITED';
|
|
6258
6294
|
};
|
|
6259
6295
|
export type MemberBaseStatusEnum = typeof MemberBaseStatusEnum[keyof typeof MemberBaseStatusEnum];
|
|
6260
6296
|
/**
|
|
@@ -6307,8 +6343,8 @@ export interface MemberWithEvents {
|
|
|
6307
6343
|
'events'?: Array<GetMember200ResponseMemberEventsInner>;
|
|
6308
6344
|
}
|
|
6309
6345
|
export declare const MemberWithEventsStatusEnum: {
|
|
6310
|
-
readonly Registered:
|
|
6311
|
-
readonly Invited:
|
|
6346
|
+
readonly Registered: 'REGISTERED';
|
|
6347
|
+
readonly Invited: 'INVITED';
|
|
6312
6348
|
};
|
|
6313
6349
|
export type MemberWithEventsStatusEnum = typeof MemberWithEventsStatusEnum[keyof typeof MemberWithEventsStatusEnum];
|
|
6314
6350
|
/**
|
|
@@ -6367,8 +6403,8 @@ export interface MemberWithoutEvents {
|
|
|
6367
6403
|
'last_login_at'?: string | null;
|
|
6368
6404
|
}
|
|
6369
6405
|
export declare const MemberWithoutEventsStatusEnum: {
|
|
6370
|
-
readonly Registered:
|
|
6371
|
-
readonly Invited:
|
|
6406
|
+
readonly Registered: 'REGISTERED';
|
|
6407
|
+
readonly Invited: 'INVITED';
|
|
6372
6408
|
};
|
|
6373
6409
|
export type MemberWithoutEventsStatusEnum = typeof MemberWithoutEventsStatusEnum[keyof typeof MemberWithoutEventsStatusEnum];
|
|
6374
6410
|
/**
|
|
@@ -6433,24 +6469,24 @@ export interface Order {
|
|
|
6433
6469
|
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
6434
6470
|
}
|
|
6435
6471
|
export declare const OrderStatusEnum: {
|
|
6436
|
-
readonly Canceled:
|
|
6437
|
-
readonly Open:
|
|
6438
|
-
readonly Executed:
|
|
6439
|
-
readonly Failed:
|
|
6440
|
-
readonly PendingApproval:
|
|
6441
|
-
readonly PendingInternalPaymentApproval:
|
|
6442
|
-
readonly PendingSettlement:
|
|
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';
|
|
6443
6479
|
};
|
|
6444
6480
|
export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
|
|
6445
6481
|
export declare const OrderChannelEnum: {
|
|
6446
|
-
readonly Ui:
|
|
6447
|
-
readonly Api:
|
|
6448
|
-
readonly Embed:
|
|
6449
|
-
readonly Decipher:
|
|
6450
|
-
readonly Qualtrics:
|
|
6451
|
-
readonly Typeform:
|
|
6452
|
-
readonly SurveyMonkey:
|
|
6453
|
-
readonly 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';
|
|
6454
6490
|
};
|
|
6455
6491
|
export type OrderChannelEnum = typeof OrderChannelEnum[keyof typeof OrderChannelEnum];
|
|
6456
6492
|
/**
|
|
@@ -6509,24 +6545,24 @@ export interface OrderBase {
|
|
|
6509
6545
|
'invoice_id'?: string;
|
|
6510
6546
|
}
|
|
6511
6547
|
export declare const OrderBaseStatusEnum: {
|
|
6512
|
-
readonly Canceled:
|
|
6513
|
-
readonly Open:
|
|
6514
|
-
readonly Executed:
|
|
6515
|
-
readonly Failed:
|
|
6516
|
-
readonly PendingApproval:
|
|
6517
|
-
readonly PendingInternalPaymentApproval:
|
|
6518
|
-
readonly PendingSettlement:
|
|
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';
|
|
6519
6555
|
};
|
|
6520
6556
|
export type OrderBaseStatusEnum = typeof OrderBaseStatusEnum[keyof typeof OrderBaseStatusEnum];
|
|
6521
6557
|
export declare const OrderBaseChannelEnum: {
|
|
6522
|
-
readonly Ui:
|
|
6523
|
-
readonly Api:
|
|
6524
|
-
readonly Embed:
|
|
6525
|
-
readonly Decipher:
|
|
6526
|
-
readonly Qualtrics:
|
|
6527
|
-
readonly Typeform:
|
|
6528
|
-
readonly SurveyMonkey:
|
|
6529
|
-
readonly 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';
|
|
6530
6566
|
};
|
|
6531
6567
|
export type OrderBaseChannelEnum = typeof OrderBaseChannelEnum[keyof typeof OrderBaseChannelEnum];
|
|
6532
6568
|
/**
|
|
@@ -6578,13 +6614,13 @@ export interface OrderBasePayment {
|
|
|
6578
6614
|
* @enum {string}
|
|
6579
6615
|
*/
|
|
6580
6616
|
export declare const OrderStatus: {
|
|
6581
|
-
readonly Canceled:
|
|
6582
|
-
readonly Open:
|
|
6583
|
-
readonly Executed:
|
|
6584
|
-
readonly Failed:
|
|
6585
|
-
readonly PendingApproval:
|
|
6586
|
-
readonly PendingInternalPaymentApproval:
|
|
6587
|
-
readonly PendingSettlement:
|
|
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';
|
|
6588
6624
|
};
|
|
6589
6625
|
export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
|
|
6590
6626
|
/**
|
|
@@ -6649,24 +6685,24 @@ export interface OrderWithLink {
|
|
|
6649
6685
|
'rewards'?: Array<OrderWithLinkRewardsInner>;
|
|
6650
6686
|
}
|
|
6651
6687
|
export declare const OrderWithLinkStatusEnum: {
|
|
6652
|
-
readonly Canceled:
|
|
6653
|
-
readonly Open:
|
|
6654
|
-
readonly Executed:
|
|
6655
|
-
readonly Failed:
|
|
6656
|
-
readonly PendingApproval:
|
|
6657
|
-
readonly PendingInternalPaymentApproval:
|
|
6658
|
-
readonly PendingSettlement:
|
|
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';
|
|
6659
6695
|
};
|
|
6660
6696
|
export type OrderWithLinkStatusEnum = typeof OrderWithLinkStatusEnum[keyof typeof OrderWithLinkStatusEnum];
|
|
6661
6697
|
export declare const OrderWithLinkChannelEnum: {
|
|
6662
|
-
readonly Ui:
|
|
6663
|
-
readonly Api:
|
|
6664
|
-
readonly Embed:
|
|
6665
|
-
readonly Decipher:
|
|
6666
|
-
readonly Qualtrics:
|
|
6667
|
-
readonly Typeform:
|
|
6668
|
-
readonly SurveyMonkey:
|
|
6669
|
-
readonly 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';
|
|
6670
6706
|
};
|
|
6671
6707
|
export type OrderWithLinkChannelEnum = typeof OrderWithLinkChannelEnum[keyof typeof OrderWithLinkChannelEnum];
|
|
6672
6708
|
/**
|
|
@@ -6804,24 +6840,24 @@ export interface OrderWithoutLink {
|
|
|
6804
6840
|
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
6805
6841
|
}
|
|
6806
6842
|
export declare const OrderWithoutLinkStatusEnum: {
|
|
6807
|
-
readonly Canceled:
|
|
6808
|
-
readonly Open:
|
|
6809
|
-
readonly Executed:
|
|
6810
|
-
readonly Failed:
|
|
6811
|
-
readonly PendingApproval:
|
|
6812
|
-
readonly PendingInternalPaymentApproval:
|
|
6813
|
-
readonly PendingSettlement:
|
|
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';
|
|
6814
6850
|
};
|
|
6815
6851
|
export type OrderWithoutLinkStatusEnum = typeof OrderWithoutLinkStatusEnum[keyof typeof OrderWithoutLinkStatusEnum];
|
|
6816
6852
|
export declare const OrderWithoutLinkChannelEnum: {
|
|
6817
|
-
readonly Ui:
|
|
6818
|
-
readonly Api:
|
|
6819
|
-
readonly Embed:
|
|
6820
|
-
readonly Decipher:
|
|
6821
|
-
readonly Qualtrics:
|
|
6822
|
-
readonly Typeform:
|
|
6823
|
-
readonly SurveyMonkey:
|
|
6824
|
-
readonly 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';
|
|
6825
6861
|
};
|
|
6826
6862
|
export type OrderWithoutLinkChannelEnum = typeof OrderWithoutLinkChannelEnum[keyof typeof OrderWithoutLinkChannelEnum];
|
|
6827
6863
|
/**
|
|
@@ -6941,9 +6977,9 @@ export interface Organization {
|
|
|
6941
6977
|
'created_at'?: string;
|
|
6942
6978
|
}
|
|
6943
6979
|
export declare const OrganizationStatusEnum: {
|
|
6944
|
-
readonly Pending:
|
|
6945
|
-
readonly Approved:
|
|
6946
|
-
readonly Rejected:
|
|
6980
|
+
readonly Pending: 'PENDING';
|
|
6981
|
+
readonly Approved: 'APPROVED';
|
|
6982
|
+
readonly Rejected: 'REJECTED';
|
|
6947
6983
|
};
|
|
6948
6984
|
export type OrganizationStatusEnum = typeof OrganizationStatusEnum[keyof typeof OrganizationStatusEnum];
|
|
6949
6985
|
/**
|
|
@@ -7058,12 +7094,12 @@ export interface Payout {
|
|
|
7058
7094
|
'defer_execution_until'?: string | null;
|
|
7059
7095
|
}
|
|
7060
7096
|
export declare const PayoutStatusEnum: {
|
|
7061
|
-
readonly Unexecuted:
|
|
7062
|
-
readonly Completed:
|
|
7063
|
-
readonly Failed:
|
|
7064
|
-
readonly Canceled:
|
|
7065
|
-
readonly OrganizationReview:
|
|
7066
|
-
readonly AdminHeld:
|
|
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';
|
|
7067
7103
|
};
|
|
7068
7104
|
export type PayoutStatusEnum = typeof PayoutStatusEnum[keyof typeof PayoutStatusEnum];
|
|
7069
7105
|
/**
|
|
@@ -7146,145 +7182,145 @@ export interface Product {
|
|
|
7146
7182
|
'documents'?: ListProductsResponseProductsInnerDocuments | null;
|
|
7147
7183
|
}
|
|
7148
7184
|
export declare const ProductCategoryEnum: {
|
|
7149
|
-
readonly Ach:
|
|
7150
|
-
readonly Charity:
|
|
7151
|
-
readonly InstantDebitTransfer:
|
|
7152
|
-
readonly MerchantCard:
|
|
7153
|
-
readonly Paypal:
|
|
7154
|
-
readonly Venmo:
|
|
7155
|
-
readonly VisaCard:
|
|
7156
|
-
readonly CashApp:
|
|
7157
|
-
readonly InternationalBank:
|
|
7158
|
-
readonly 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';
|
|
7159
7195
|
};
|
|
7160
7196
|
export type ProductCategoryEnum = typeof ProductCategoryEnum[keyof typeof ProductCategoryEnum];
|
|
7161
7197
|
export declare const ProductSubcategoryEnum: {
|
|
7162
|
-
readonly BeautyAndHealth:
|
|
7163
|
-
readonly DigitalFinancialServices:
|
|
7164
|
-
readonly Electronics:
|
|
7165
|
-
readonly Entertainment:
|
|
7166
|
-
readonly Fashion:
|
|
7167
|
-
readonly FoodAndDrink:
|
|
7168
|
-
readonly GeneralMerchandise:
|
|
7169
|
-
readonly GroceryAndSupermarkets:
|
|
7170
|
-
readonly HomeAndLiving:
|
|
7171
|
-
readonly MobilityAndFuel:
|
|
7172
|
-
readonly SportsAndOutdoorGear:
|
|
7173
|
-
readonly TravelAndHospitality:
|
|
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';
|
|
7174
7210
|
};
|
|
7175
7211
|
export type ProductSubcategoryEnum = typeof ProductSubcategoryEnum[keyof typeof ProductSubcategoryEnum];
|
|
7176
7212
|
export declare const ProductCurrencyCodesEnum: {
|
|
7177
|
-
readonly Usd:
|
|
7178
|
-
readonly Cad:
|
|
7179
|
-
readonly Eur:
|
|
7180
|
-
readonly Aed:
|
|
7181
|
-
readonly Afn:
|
|
7182
|
-
readonly All:
|
|
7183
|
-
readonly Amd:
|
|
7184
|
-
readonly Ars:
|
|
7185
|
-
readonly Aud:
|
|
7186
|
-
readonly Azn:
|
|
7187
|
-
readonly Bam:
|
|
7188
|
-
readonly Bdt:
|
|
7189
|
-
readonly Bhd:
|
|
7190
|
-
readonly Bif:
|
|
7191
|
-
readonly Bnd:
|
|
7192
|
-
readonly Bob:
|
|
7193
|
-
readonly Brl:
|
|
7194
|
-
readonly Bwp:
|
|
7195
|
-
readonly Byn:
|
|
7196
|
-
readonly Bzd:
|
|
7197
|
-
readonly Cdf:
|
|
7198
|
-
readonly Chf:
|
|
7199
|
-
readonly Clp:
|
|
7200
|
-
readonly Cny:
|
|
7201
|
-
readonly Cop:
|
|
7202
|
-
readonly Crc:
|
|
7203
|
-
readonly Cve:
|
|
7204
|
-
readonly Czk:
|
|
7205
|
-
readonly Djf:
|
|
7206
|
-
readonly Dkk:
|
|
7207
|
-
readonly Dop:
|
|
7208
|
-
readonly Dzd:
|
|
7209
|
-
readonly Egp:
|
|
7210
|
-
readonly Ern:
|
|
7211
|
-
readonly Etb:
|
|
7212
|
-
readonly Gbp:
|
|
7213
|
-
readonly Gel:
|
|
7214
|
-
readonly Ghs:
|
|
7215
|
-
readonly Gnf:
|
|
7216
|
-
readonly Gtq:
|
|
7217
|
-
readonly Hkd:
|
|
7218
|
-
readonly Hnl:
|
|
7219
|
-
readonly Hrk:
|
|
7220
|
-
readonly Huf:
|
|
7221
|
-
readonly Idr:
|
|
7222
|
-
readonly Ils:
|
|
7223
|
-
readonly Inr:
|
|
7224
|
-
readonly Iqd:
|
|
7225
|
-
readonly Irr:
|
|
7226
|
-
readonly Isk:
|
|
7227
|
-
readonly Jmd:
|
|
7228
|
-
readonly Jod:
|
|
7229
|
-
readonly Jpy:
|
|
7230
|
-
readonly Kes:
|
|
7231
|
-
readonly Khr:
|
|
7232
|
-
readonly Krw:
|
|
7233
|
-
readonly Kwd:
|
|
7234
|
-
readonly Kzt:
|
|
7235
|
-
readonly Lbp:
|
|
7236
|
-
readonly Lkr:
|
|
7237
|
-
readonly Mad:
|
|
7238
|
-
readonly Mdl:
|
|
7239
|
-
readonly Mga:
|
|
7240
|
-
readonly Mkd:
|
|
7241
|
-
readonly Mmk:
|
|
7242
|
-
readonly Mop:
|
|
7243
|
-
readonly Mur:
|
|
7244
|
-
readonly Mxn:
|
|
7245
|
-
readonly Myr:
|
|
7246
|
-
readonly Mzn:
|
|
7247
|
-
readonly Nad:
|
|
7248
|
-
readonly Ngn:
|
|
7249
|
-
readonly Nio:
|
|
7250
|
-
readonly Nok:
|
|
7251
|
-
readonly Npr:
|
|
7252
|
-
readonly Nzd:
|
|
7253
|
-
readonly Omr:
|
|
7254
|
-
readonly Pab:
|
|
7255
|
-
readonly Pen:
|
|
7256
|
-
readonly Php:
|
|
7257
|
-
readonly Pkr:
|
|
7258
|
-
readonly Pln:
|
|
7259
|
-
readonly Pyg:
|
|
7260
|
-
readonly Qar:
|
|
7261
|
-
readonly Ron:
|
|
7262
|
-
readonly Rsd:
|
|
7263
|
-
readonly Rub:
|
|
7264
|
-
readonly Rwf:
|
|
7265
|
-
readonly Sar:
|
|
7266
|
-
readonly Sdg:
|
|
7267
|
-
readonly Sek:
|
|
7268
|
-
readonly Sgd:
|
|
7269
|
-
readonly Sos:
|
|
7270
|
-
readonly Syp:
|
|
7271
|
-
readonly Thb:
|
|
7272
|
-
readonly Tnd:
|
|
7273
|
-
readonly Top:
|
|
7274
|
-
readonly Try:
|
|
7275
|
-
readonly Ttd:
|
|
7276
|
-
readonly Twd:
|
|
7277
|
-
readonly Tzs:
|
|
7278
|
-
readonly Uah:
|
|
7279
|
-
readonly Ugx:
|
|
7280
|
-
readonly Uyu:
|
|
7281
|
-
readonly Uzs:
|
|
7282
|
-
readonly Vef:
|
|
7283
|
-
readonly Vnd:
|
|
7284
|
-
readonly Xaf:
|
|
7285
|
-
readonly Xof:
|
|
7286
|
-
readonly Yer:
|
|
7287
|
-
readonly 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';
|
|
7288
7324
|
};
|
|
7289
7325
|
export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum];
|
|
7290
7326
|
/**
|
|
@@ -7394,10 +7430,10 @@ export interface Report {
|
|
|
7394
7430
|
'url'?: string | null;
|
|
7395
7431
|
}
|
|
7396
7432
|
export declare const ReportStatusEnum: {
|
|
7397
|
-
readonly Created:
|
|
7398
|
-
readonly Processing:
|
|
7399
|
-
readonly ReadyForDownload:
|
|
7400
|
-
readonly Failed:
|
|
7433
|
+
readonly Created: 'CREATED';
|
|
7434
|
+
readonly Processing: 'PROCESSING';
|
|
7435
|
+
readonly ReadyForDownload: 'READY_FOR_DOWNLOAD';
|
|
7436
|
+
readonly Failed: 'FAILED';
|
|
7401
7437
|
};
|
|
7402
7438
|
export type ReportStatusEnum = typeof ReportStatusEnum[keyof typeof ReportStatusEnum];
|
|
7403
7439
|
/**
|
|
@@ -7458,8 +7494,8 @@ export interface ReviewCountry {
|
|
|
7458
7494
|
'countries': Array<string>;
|
|
7459
7495
|
}
|
|
7460
7496
|
export declare const ReviewCountryTypeEnum: {
|
|
7461
|
-
readonly Whitelist:
|
|
7462
|
-
readonly Blacklist:
|
|
7497
|
+
readonly Whitelist: 'whitelist';
|
|
7498
|
+
readonly Blacklist: 'blacklist';
|
|
7463
7499
|
};
|
|
7464
7500
|
export type ReviewCountryTypeEnum = typeof ReviewCountryTypeEnum[keyof typeof ReviewCountryTypeEnum];
|
|
7465
7501
|
/**
|
|
@@ -7559,12 +7595,12 @@ export interface ReviewRedeemedRewardsAmount {
|
|
|
7559
7595
|
'period': ReviewRedeemedRewardsAmountPeriodEnum;
|
|
7560
7596
|
}
|
|
7561
7597
|
export declare const ReviewRedeemedRewardsAmountPeriodEnum: {
|
|
7562
|
-
readonly _7:
|
|
7563
|
-
readonly _30:
|
|
7564
|
-
readonly _90:
|
|
7565
|
-
readonly _120:
|
|
7566
|
-
readonly _365:
|
|
7567
|
-
readonly AllTime:
|
|
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';
|
|
7568
7604
|
};
|
|
7569
7605
|
export type ReviewRedeemedRewardsAmountPeriodEnum = typeof ReviewRedeemedRewardsAmountPeriodEnum[keyof typeof ReviewRedeemedRewardsAmountPeriodEnum];
|
|
7570
7606
|
/**
|
|
@@ -7587,12 +7623,12 @@ export interface ReviewRedeemedRewardsCount {
|
|
|
7587
7623
|
'period': ReviewRedeemedRewardsCountPeriodEnum;
|
|
7588
7624
|
}
|
|
7589
7625
|
export declare const ReviewRedeemedRewardsCountPeriodEnum: {
|
|
7590
|
-
readonly _7:
|
|
7591
|
-
readonly _30:
|
|
7592
|
-
readonly _90:
|
|
7593
|
-
readonly _120:
|
|
7594
|
-
readonly _365:
|
|
7595
|
-
readonly AllTime:
|
|
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';
|
|
7596
7632
|
};
|
|
7597
7633
|
export type ReviewRedeemedRewardsCountPeriodEnum = typeof ReviewRedeemedRewardsCountPeriodEnum[keyof typeof ReviewRedeemedRewardsCountPeriodEnum];
|
|
7598
7634
|
/**
|
|
@@ -7916,117 +7952,117 @@ export interface RewardValue {
|
|
|
7916
7952
|
'currency_code'?: RewardValueCurrencyCodeEnum;
|
|
7917
7953
|
}
|
|
7918
7954
|
export declare const RewardValueCurrencyCodeEnum: {
|
|
7919
|
-
readonly Usd:
|
|
7920
|
-
readonly Cad:
|
|
7921
|
-
readonly Eur:
|
|
7922
|
-
readonly Aed:
|
|
7923
|
-
readonly Afn:
|
|
7924
|
-
readonly All:
|
|
7925
|
-
readonly Amd:
|
|
7926
|
-
readonly Ars:
|
|
7927
|
-
readonly Aud:
|
|
7928
|
-
readonly Azn:
|
|
7929
|
-
readonly Bam:
|
|
7930
|
-
readonly Bdt:
|
|
7931
|
-
readonly Bhd:
|
|
7932
|
-
readonly Bif:
|
|
7933
|
-
readonly Bnd:
|
|
7934
|
-
readonly Bob:
|
|
7935
|
-
readonly Brl:
|
|
7936
|
-
readonly Bwp:
|
|
7937
|
-
readonly Byn:
|
|
7938
|
-
readonly Bzd:
|
|
7939
|
-
readonly Cdf:
|
|
7940
|
-
readonly Chf:
|
|
7941
|
-
readonly Clp:
|
|
7942
|
-
readonly Cny:
|
|
7943
|
-
readonly Cop:
|
|
7944
|
-
readonly Crc:
|
|
7945
|
-
readonly Cve:
|
|
7946
|
-
readonly Czk:
|
|
7947
|
-
readonly Djf:
|
|
7948
|
-
readonly Dkk:
|
|
7949
|
-
readonly Dop:
|
|
7950
|
-
readonly Dzd:
|
|
7951
|
-
readonly Egp:
|
|
7952
|
-
readonly Ern:
|
|
7953
|
-
readonly Etb:
|
|
7954
|
-
readonly Gbp:
|
|
7955
|
-
readonly Gel:
|
|
7956
|
-
readonly Ghs:
|
|
7957
|
-
readonly Gnf:
|
|
7958
|
-
readonly Gtq:
|
|
7959
|
-
readonly Hkd:
|
|
7960
|
-
readonly Hnl:
|
|
7961
|
-
readonly Hrk:
|
|
7962
|
-
readonly Huf:
|
|
7963
|
-
readonly Idr:
|
|
7964
|
-
readonly Ils:
|
|
7965
|
-
readonly Inr:
|
|
7966
|
-
readonly Iqd:
|
|
7967
|
-
readonly Irr:
|
|
7968
|
-
readonly Isk:
|
|
7969
|
-
readonly Jmd:
|
|
7970
|
-
readonly Jod:
|
|
7971
|
-
readonly Jpy:
|
|
7972
|
-
readonly Kes:
|
|
7973
|
-
readonly Khr:
|
|
7974
|
-
readonly Krw:
|
|
7975
|
-
readonly Kwd:
|
|
7976
|
-
readonly Kzt:
|
|
7977
|
-
readonly Lbp:
|
|
7978
|
-
readonly Lkr:
|
|
7979
|
-
readonly Mad:
|
|
7980
|
-
readonly Mdl:
|
|
7981
|
-
readonly Mga:
|
|
7982
|
-
readonly Mkd:
|
|
7983
|
-
readonly Mmk:
|
|
7984
|
-
readonly Mop:
|
|
7985
|
-
readonly Mur:
|
|
7986
|
-
readonly Mxn:
|
|
7987
|
-
readonly Myr:
|
|
7988
|
-
readonly Mzn:
|
|
7989
|
-
readonly Nad:
|
|
7990
|
-
readonly Ngn:
|
|
7991
|
-
readonly Nio:
|
|
7992
|
-
readonly Nok:
|
|
7993
|
-
readonly Npr:
|
|
7994
|
-
readonly Nzd:
|
|
7995
|
-
readonly Omr:
|
|
7996
|
-
readonly Pab:
|
|
7997
|
-
readonly Pen:
|
|
7998
|
-
readonly Php:
|
|
7999
|
-
readonly Pkr:
|
|
8000
|
-
readonly Pln:
|
|
8001
|
-
readonly Pyg:
|
|
8002
|
-
readonly Qar:
|
|
8003
|
-
readonly Ron:
|
|
8004
|
-
readonly Rsd:
|
|
8005
|
-
readonly Rub:
|
|
8006
|
-
readonly Rwf:
|
|
8007
|
-
readonly Sar:
|
|
8008
|
-
readonly Sdg:
|
|
8009
|
-
readonly Sek:
|
|
8010
|
-
readonly Sgd:
|
|
8011
|
-
readonly Sos:
|
|
8012
|
-
readonly Syp:
|
|
8013
|
-
readonly Thb:
|
|
8014
|
-
readonly Tnd:
|
|
8015
|
-
readonly Top:
|
|
8016
|
-
readonly Try:
|
|
8017
|
-
readonly Ttd:
|
|
8018
|
-
readonly Twd:
|
|
8019
|
-
readonly Tzs:
|
|
8020
|
-
readonly Uah:
|
|
8021
|
-
readonly Ugx:
|
|
8022
|
-
readonly Uyu:
|
|
8023
|
-
readonly Uzs:
|
|
8024
|
-
readonly Vef:
|
|
8025
|
-
readonly Vnd:
|
|
8026
|
-
readonly Xaf:
|
|
8027
|
-
readonly Xof:
|
|
8028
|
-
readonly Yer:
|
|
8029
|
-
readonly 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';
|
|
8030
8066
|
};
|
|
8031
8067
|
export type RewardValueCurrencyCodeEnum = typeof RewardValueCurrencyCodeEnum[keyof typeof RewardValueCurrencyCodeEnum];
|
|
8032
8068
|
/**
|
|
@@ -8128,16 +8164,16 @@ export interface RewardWithLinkDelivery {
|
|
|
8128
8164
|
'link'?: string;
|
|
8129
8165
|
}
|
|
8130
8166
|
export declare const RewardWithLinkDeliveryMethodEnum: {
|
|
8131
|
-
readonly Email:
|
|
8132
|
-
readonly Link:
|
|
8133
|
-
readonly Phone:
|
|
8167
|
+
readonly Email: 'EMAIL';
|
|
8168
|
+
readonly Link: 'LINK';
|
|
8169
|
+
readonly Phone: 'PHONE';
|
|
8134
8170
|
};
|
|
8135
8171
|
export type RewardWithLinkDeliveryMethodEnum = typeof RewardWithLinkDeliveryMethodEnum[keyof typeof RewardWithLinkDeliveryMethodEnum];
|
|
8136
8172
|
export declare const RewardWithLinkDeliveryStatusEnum: {
|
|
8137
|
-
readonly Scheduled:
|
|
8138
|
-
readonly Failed:
|
|
8139
|
-
readonly Succeeded:
|
|
8140
|
-
readonly Pending:
|
|
8173
|
+
readonly Scheduled: 'SCHEDULED';
|
|
8174
|
+
readonly Failed: 'FAILED';
|
|
8175
|
+
readonly Succeeded: 'SUCCEEDED';
|
|
8176
|
+
readonly Pending: 'PENDING';
|
|
8141
8177
|
};
|
|
8142
8178
|
export type RewardWithLinkDeliveryStatusEnum = typeof RewardWithLinkDeliveryStatusEnum[keyof typeof RewardWithLinkDeliveryStatusEnum];
|
|
8143
8179
|
/**
|
|
@@ -8233,16 +8269,16 @@ export interface RewardWithoutLinkDelivery {
|
|
|
8233
8269
|
'status'?: RewardWithoutLinkDeliveryStatusEnum;
|
|
8234
8270
|
}
|
|
8235
8271
|
export declare const RewardWithoutLinkDeliveryMethodEnum: {
|
|
8236
|
-
readonly Email:
|
|
8237
|
-
readonly Link:
|
|
8238
|
-
readonly Phone:
|
|
8272
|
+
readonly Email: 'EMAIL';
|
|
8273
|
+
readonly Link: 'LINK';
|
|
8274
|
+
readonly Phone: 'PHONE';
|
|
8239
8275
|
};
|
|
8240
8276
|
export type RewardWithoutLinkDeliveryMethodEnum = typeof RewardWithoutLinkDeliveryMethodEnum[keyof typeof RewardWithoutLinkDeliveryMethodEnum];
|
|
8241
8277
|
export declare const RewardWithoutLinkDeliveryStatusEnum: {
|
|
8242
|
-
readonly Scheduled:
|
|
8243
|
-
readonly Failed:
|
|
8244
|
-
readonly Succeeded:
|
|
8245
|
-
readonly Pending:
|
|
8278
|
+
readonly Scheduled: 'SCHEDULED';
|
|
8279
|
+
readonly Failed: 'FAILED';
|
|
8280
|
+
readonly Succeeded: 'SUCCEEDED';
|
|
8281
|
+
readonly Pending: 'PENDING';
|
|
8246
8282
|
};
|
|
8247
8283
|
export type RewardWithoutLinkDeliveryStatusEnum = typeof RewardWithoutLinkDeliveryStatusEnum[keyof typeof RewardWithoutLinkDeliveryStatusEnum];
|
|
8248
8284
|
/**
|
|
@@ -8415,9 +8451,9 @@ export interface SingleRewardOrderRewardDelivery {
|
|
|
8415
8451
|
'meta'?: SingleRewardOrderRewardDeliveryMeta;
|
|
8416
8452
|
}
|
|
8417
8453
|
export declare const SingleRewardOrderRewardDeliveryMethodEnum: {
|
|
8418
|
-
readonly Email:
|
|
8419
|
-
readonly Link:
|
|
8420
|
-
readonly Phone:
|
|
8454
|
+
readonly Email: 'EMAIL';
|
|
8455
|
+
readonly Link: 'LINK';
|
|
8456
|
+
readonly Phone: 'PHONE';
|
|
8421
8457
|
};
|
|
8422
8458
|
export type SingleRewardOrderRewardDeliveryMethodEnum = typeof SingleRewardOrderRewardDeliveryMethodEnum[keyof typeof SingleRewardOrderRewardDeliveryMethodEnum];
|
|
8423
8459
|
/**
|
|
@@ -8520,24 +8556,24 @@ export interface SingleRewardOrderWithLinkOrder {
|
|
|
8520
8556
|
'rewards'?: Array<OrderWithLinkRewardsInner>;
|
|
8521
8557
|
}
|
|
8522
8558
|
export declare const SingleRewardOrderWithLinkOrderStatusEnum: {
|
|
8523
|
-
readonly Canceled:
|
|
8524
|
-
readonly Open:
|
|
8525
|
-
readonly Executed:
|
|
8526
|
-
readonly Failed:
|
|
8527
|
-
readonly PendingApproval:
|
|
8528
|
-
readonly PendingInternalPaymentApproval:
|
|
8529
|
-
readonly PendingSettlement:
|
|
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';
|
|
8530
8566
|
};
|
|
8531
8567
|
export type SingleRewardOrderWithLinkOrderStatusEnum = typeof SingleRewardOrderWithLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithLinkOrderStatusEnum];
|
|
8532
8568
|
export declare const SingleRewardOrderWithLinkOrderChannelEnum: {
|
|
8533
|
-
readonly Ui:
|
|
8534
|
-
readonly Api:
|
|
8535
|
-
readonly Embed:
|
|
8536
|
-
readonly Decipher:
|
|
8537
|
-
readonly Qualtrics:
|
|
8538
|
-
readonly Typeform:
|
|
8539
|
-
readonly SurveyMonkey:
|
|
8540
|
-
readonly 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';
|
|
8541
8577
|
};
|
|
8542
8578
|
export type SingleRewardOrderWithLinkOrderChannelEnum = typeof SingleRewardOrderWithLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithLinkOrderChannelEnum];
|
|
8543
8579
|
/**
|
|
@@ -8615,24 +8651,24 @@ export interface SingleRewardOrderWithoutLinkOrder {
|
|
|
8615
8651
|
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
8616
8652
|
}
|
|
8617
8653
|
export declare const SingleRewardOrderWithoutLinkOrderStatusEnum: {
|
|
8618
|
-
readonly Canceled:
|
|
8619
|
-
readonly Open:
|
|
8620
|
-
readonly Executed:
|
|
8621
|
-
readonly Failed:
|
|
8622
|
-
readonly PendingApproval:
|
|
8623
|
-
readonly PendingInternalPaymentApproval:
|
|
8624
|
-
readonly PendingSettlement:
|
|
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';
|
|
8625
8661
|
};
|
|
8626
8662
|
export type SingleRewardOrderWithoutLinkOrderStatusEnum = typeof SingleRewardOrderWithoutLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithoutLinkOrderStatusEnum];
|
|
8627
8663
|
export declare const SingleRewardOrderWithoutLinkOrderChannelEnum: {
|
|
8628
|
-
readonly Ui:
|
|
8629
|
-
readonly Api:
|
|
8630
|
-
readonly Embed:
|
|
8631
|
-
readonly Decipher:
|
|
8632
|
-
readonly Qualtrics:
|
|
8633
|
-
readonly Typeform:
|
|
8634
|
-
readonly SurveyMonkey:
|
|
8635
|
-
readonly 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';
|
|
8636
8672
|
};
|
|
8637
8673
|
export type SingleRewardOrderWithoutLinkOrderChannelEnum = typeof SingleRewardOrderWithoutLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithoutLinkOrderChannelEnum];
|
|
8638
8674
|
/**
|
|
@@ -8813,8 +8849,8 @@ export interface UpdateCampaign {
|
|
|
8813
8849
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
8814
8850
|
}
|
|
8815
8851
|
export declare const UpdateCampaignFeeChargedToEnum: {
|
|
8816
|
-
readonly Sender:
|
|
8817
|
-
readonly Recipient:
|
|
8852
|
+
readonly Sender: 'SENDER';
|
|
8853
|
+
readonly Recipient: 'RECIPIENT';
|
|
8818
8854
|
};
|
|
8819
8855
|
export type UpdateCampaignFeeChargedToEnum = typeof UpdateCampaignFeeChargedToEnum[keyof typeof UpdateCampaignFeeChargedToEnum];
|
|
8820
8856
|
/**
|
|
@@ -8867,8 +8903,8 @@ export interface UpdateCampaignRequest {
|
|
|
8867
8903
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
8868
8904
|
}
|
|
8869
8905
|
export declare const UpdateCampaignRequestFeeChargedToEnum: {
|
|
8870
|
-
readonly Sender:
|
|
8871
|
-
readonly Recipient:
|
|
8906
|
+
readonly Sender: 'SENDER';
|
|
8907
|
+
readonly Recipient: 'RECIPIENT';
|
|
8872
8908
|
};
|
|
8873
8909
|
export type UpdateCampaignRequestFeeChargedToEnum = typeof UpdateCampaignRequestFeeChargedToEnum[keyof typeof UpdateCampaignRequestFeeChargedToEnum];
|
|
8874
8910
|
/**
|
|
@@ -8904,8 +8940,8 @@ export interface UpdateFraudRuleListRequest {
|
|
|
8904
8940
|
'config': UpdateFraudRuleListRequestConfig;
|
|
8905
8941
|
}
|
|
8906
8942
|
export declare const UpdateFraudRuleListRequestOperationEnum: {
|
|
8907
|
-
readonly Add:
|
|
8908
|
-
readonly Remove:
|
|
8943
|
+
readonly Add: 'add';
|
|
8944
|
+
readonly Remove: 'remove';
|
|
8909
8945
|
};
|
|
8910
8946
|
export type UpdateFraudRuleListRequestOperationEnum = typeof UpdateFraudRuleListRequestOperationEnum[keyof typeof UpdateFraudRuleListRequestOperationEnum];
|
|
8911
8947
|
/**
|
|
@@ -8939,6 +8975,32 @@ export interface UpdateFraudRuleListRequestConfig {
|
|
|
8939
8975
|
*/
|
|
8940
8976
|
'domains'?: Array<string>;
|
|
8941
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
|
+
}
|
|
8942
9004
|
/**
|
|
8943
9005
|
*
|
|
8944
9006
|
* @export
|
|
@@ -9904,9 +9966,9 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9904
9966
|
* @export
|
|
9905
9967
|
*/
|
|
9906
9968
|
export declare const ListFraudReviewsStatusEnum: {
|
|
9907
|
-
readonly Flagged:
|
|
9908
|
-
readonly Blocked:
|
|
9909
|
-
readonly Released:
|
|
9969
|
+
readonly Flagged: 'flagged';
|
|
9970
|
+
readonly Blocked: 'blocked';
|
|
9971
|
+
readonly Released: 'released';
|
|
9910
9972
|
};
|
|
9911
9973
|
export type ListFraudReviewsStatusEnum = typeof ListFraudReviewsStatusEnum[keyof typeof ListFraudReviewsStatusEnum];
|
|
9912
9974
|
/**
|
|
@@ -10075,45 +10137,45 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
10075
10137
|
* @export
|
|
10076
10138
|
*/
|
|
10077
10139
|
export declare const DeleteFraudRuleRuleTypeEnum: {
|
|
10078
|
-
readonly ReviewCountry:
|
|
10079
|
-
readonly ReviewIp:
|
|
10080
|
-
readonly ReviewEmail:
|
|
10081
|
-
readonly ReviewRedeemedRewardsCount:
|
|
10082
|
-
readonly ReviewRedeemedRewardsAmount:
|
|
10083
|
-
readonly ReviewMultipleEmails:
|
|
10084
|
-
readonly ReviewVpn:
|
|
10085
|
-
readonly ReviewTremendousFlagList:
|
|
10086
|
-
readonly ReviewPreviouslyBlockedRecipients:
|
|
10087
|
-
readonly AllowIp:
|
|
10088
|
-
readonly AllowEmail:
|
|
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';
|
|
10089
10151
|
};
|
|
10090
10152
|
export type DeleteFraudRuleRuleTypeEnum = typeof DeleteFraudRuleRuleTypeEnum[keyof typeof DeleteFraudRuleRuleTypeEnum];
|
|
10091
10153
|
/**
|
|
10092
10154
|
* @export
|
|
10093
10155
|
*/
|
|
10094
10156
|
export declare const FraudRuleRuleTypeEnum: {
|
|
10095
|
-
readonly ReviewCountry:
|
|
10096
|
-
readonly ReviewIp:
|
|
10097
|
-
readonly ReviewEmail:
|
|
10098
|
-
readonly ReviewRedeemedRewardsCount:
|
|
10099
|
-
readonly ReviewRedeemedRewardsAmount:
|
|
10100
|
-
readonly ReviewMultipleEmails:
|
|
10101
|
-
readonly ReviewVpn:
|
|
10102
|
-
readonly ReviewTremendousFlagList:
|
|
10103
|
-
readonly ReviewPreviouslyBlockedRecipients:
|
|
10104
|
-
readonly AllowIp:
|
|
10105
|
-
readonly AllowEmail:
|
|
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';
|
|
10106
10168
|
};
|
|
10107
10169
|
export type FraudRuleRuleTypeEnum = typeof FraudRuleRuleTypeEnum[keyof typeof FraudRuleRuleTypeEnum];
|
|
10108
10170
|
/**
|
|
10109
10171
|
* @export
|
|
10110
10172
|
*/
|
|
10111
10173
|
export declare const UpdateFraudRuleListRuleTypeEnum: {
|
|
10112
|
-
readonly ReviewCountry:
|
|
10113
|
-
readonly ReviewIp:
|
|
10114
|
-
readonly ReviewEmail:
|
|
10115
|
-
readonly AllowIp:
|
|
10116
|
-
readonly AllowEmail:
|
|
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';
|
|
10117
10179
|
};
|
|
10118
10180
|
export type UpdateFraudRuleListRuleTypeEnum = typeof UpdateFraudRuleListRuleTypeEnum[keyof typeof UpdateFraudRuleListRuleTypeEnum];
|
|
10119
10181
|
/**
|
|
@@ -10445,6 +10507,14 @@ export declare const MembersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
10445
10507
|
* @throws {RequiredError}
|
|
10446
10508
|
*/
|
|
10447
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>;
|
|
10448
10518
|
/**
|
|
10449
10519
|
*
|
|
10450
10520
|
* @summary Retrieve member
|
|
@@ -10460,6 +10530,15 @@ export declare const MembersApiAxiosParamCreator: (configuration?: Configuration
|
|
|
10460
10530
|
* @throws {RequiredError}
|
|
10461
10531
|
*/
|
|
10462
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>;
|
|
10463
10542
|
};
|
|
10464
10543
|
/**
|
|
10465
10544
|
* MembersApi - functional programming interface
|
|
@@ -10474,6 +10553,14 @@ export declare const MembersApiFp: (configuration?: Configuration) => {
|
|
|
10474
10553
|
* @throws {RequiredError}
|
|
10475
10554
|
*/
|
|
10476
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>>;
|
|
10477
10564
|
/**
|
|
10478
10565
|
*
|
|
10479
10566
|
* @summary Retrieve member
|
|
@@ -10489,6 +10576,15 @@ export declare const MembersApiFp: (configuration?: Configuration) => {
|
|
|
10489
10576
|
* @throws {RequiredError}
|
|
10490
10577
|
*/
|
|
10491
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>>;
|
|
10492
10588
|
};
|
|
10493
10589
|
/**
|
|
10494
10590
|
* MembersApi - factory interface
|
|
@@ -10503,6 +10599,14 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
|
|
|
10503
10599
|
* @throws {RequiredError}
|
|
10504
10600
|
*/
|
|
10505
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>;
|
|
10506
10610
|
/**
|
|
10507
10611
|
*
|
|
10508
10612
|
* @summary Retrieve member
|
|
@@ -10518,6 +10622,15 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
|
|
|
10518
10622
|
* @throws {RequiredError}
|
|
10519
10623
|
*/
|
|
10520
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>;
|
|
10521
10634
|
};
|
|
10522
10635
|
/**
|
|
10523
10636
|
* MembersApi - object-oriented interface
|
|
@@ -10535,6 +10648,15 @@ export declare class MembersApi extends BaseAPI {
|
|
|
10535
10648
|
* @memberof MembersApi
|
|
10536
10649
|
*/
|
|
10537
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, {}>>;
|
|
10538
10660
|
/**
|
|
10539
10661
|
*
|
|
10540
10662
|
* @summary Retrieve member
|
|
@@ -10552,6 +10674,16 @@ export declare class MembersApi extends BaseAPI {
|
|
|
10552
10674
|
* @memberof MembersApi
|
|
10553
10675
|
*/
|
|
10554
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, {}>>;
|
|
10555
10687
|
}
|
|
10556
10688
|
/**
|
|
10557
10689
|
* OrdersApi - axios parameter creator
|
|
@@ -10567,7 +10699,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
10567
10699
|
*/
|
|
10568
10700
|
approveOrder: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10569
10701
|
/**
|
|
10570
|
-
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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'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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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.
|
|
10571
10703
|
* @summary Create order
|
|
10572
10704
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
10573
10705
|
* @param {*} [options] Override http request option.
|
|
@@ -10618,7 +10750,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
10618
10750
|
*/
|
|
10619
10751
|
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrder200Response>>;
|
|
10620
10752
|
/**
|
|
10621
|
-
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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'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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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.
|
|
10622
10754
|
* @summary Create order
|
|
10623
10755
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
10624
10756
|
* @param {*} [options] Override http request option.
|
|
@@ -10669,7 +10801,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
10669
10801
|
*/
|
|
10670
10802
|
approveOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrder200Response>;
|
|
10671
10803
|
/**
|
|
10672
|
-
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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'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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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.
|
|
10673
10805
|
* @summary Create order
|
|
10674
10806
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
10675
10807
|
* @param {*} [options] Override http request option.
|
|
@@ -10723,7 +10855,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10723
10855
|
*/
|
|
10724
10856
|
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrder200Response, any, {}>>;
|
|
10725
10857
|
/**
|
|
10726
|
-
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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'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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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.
|
|
10727
10859
|
* @summary Create order
|
|
10728
10860
|
* @param {CreateOrderRequest} createOrderRequest Order to create
|
|
10729
10861
|
* @param {*} [options] Override http request option.
|
|
@@ -10772,10 +10904,11 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
10772
10904
|
/**
|
|
10773
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.**
|
|
10774
10906
|
* @summary Create API key
|
|
10907
|
+
* @param {CreateApiKeyRequest} [createApiKeyRequest] Optional settings for the new API key
|
|
10775
10908
|
* @param {*} [options] Override http request option.
|
|
10776
10909
|
* @throws {RequiredError}
|
|
10777
10910
|
*/
|
|
10778
|
-
createApiKey: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10911
|
+
createApiKey: (createApiKeyRequest?: CreateApiKeyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10779
10912
|
/**
|
|
10780
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.
|
|
10781
10914
|
* @summary Create organization
|
|
@@ -10808,10 +10941,11 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
10808
10941
|
/**
|
|
10809
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.**
|
|
10810
10943
|
* @summary Create API key
|
|
10944
|
+
* @param {CreateApiKeyRequest} [createApiKeyRequest] Optional settings for the new API key
|
|
10811
10945
|
* @param {*} [options] Override http request option.
|
|
10812
10946
|
* @throws {RequiredError}
|
|
10813
10947
|
*/
|
|
10814
|
-
createApiKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateApiKey200Response>>;
|
|
10948
|
+
createApiKey(createApiKeyRequest?: CreateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateApiKey200Response>>;
|
|
10815
10949
|
/**
|
|
10816
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.
|
|
10817
10951
|
* @summary Create organization
|
|
@@ -10844,10 +10978,11 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
10844
10978
|
/**
|
|
10845
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.**
|
|
10846
10980
|
* @summary Create API key
|
|
10981
|
+
* @param {CreateApiKeyRequest} [createApiKeyRequest] Optional settings for the new API key
|
|
10847
10982
|
* @param {*} [options] Override http request option.
|
|
10848
10983
|
* @throws {RequiredError}
|
|
10849
10984
|
*/
|
|
10850
|
-
createApiKey(options?: RawAxiosRequestConfig): AxiosPromise<CreateApiKey200Response>;
|
|
10985
|
+
createApiKey(createApiKeyRequest?: CreateApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateApiKey200Response>;
|
|
10851
10986
|
/**
|
|
10852
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.
|
|
10853
10988
|
* @summary Create organization
|
|
@@ -10882,11 +11017,12 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10882
11017
|
/**
|
|
10883
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.**
|
|
10884
11019
|
* @summary Create API key
|
|
11020
|
+
* @param {CreateApiKeyRequest} [createApiKeyRequest] Optional settings for the new API key
|
|
10885
11021
|
* @param {*} [options] Override http request option.
|
|
10886
11022
|
* @throws {RequiredError}
|
|
10887
11023
|
* @memberof OrganizationsApi
|
|
10888
11024
|
*/
|
|
10889
|
-
createApiKey(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateApiKey200Response, any, {}>>;
|
|
11025
|
+
createApiKey(createApiKeyRequest?: CreateApiKeyRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateApiKey200Response, any, {}>>;
|
|
10890
11026
|
/**
|
|
10891
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.
|
|
10892
11028
|
* @summary Create organization
|
|
@@ -11112,7 +11248,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
11112
11248
|
*/
|
|
11113
11249
|
export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11114
11250
|
/**
|
|
11115
|
-
* 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.
|
|
11116
11252
|
* @summary Cancel reward
|
|
11117
11253
|
* @param {string} id ID of the reward that should be canceled
|
|
11118
11254
|
* @param {*} [options] Override http request option.
|
|
@@ -11160,7 +11296,7 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
11160
11296
|
*/
|
|
11161
11297
|
export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
11162
11298
|
/**
|
|
11163
|
-
* 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.
|
|
11164
11300
|
* @summary Cancel reward
|
|
11165
11301
|
* @param {string} id ID of the reward that should be canceled
|
|
11166
11302
|
* @param {*} [options] Override http request option.
|
|
@@ -11208,7 +11344,7 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
|
11208
11344
|
*/
|
|
11209
11345
|
export declare const RewardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11210
11346
|
/**
|
|
11211
|
-
* 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.
|
|
11212
11348
|
* @summary Cancel reward
|
|
11213
11349
|
* @param {string} id ID of the reward that should be canceled
|
|
11214
11350
|
* @param {*} [options] Override http request option.
|
|
@@ -11258,7 +11394,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
11258
11394
|
*/
|
|
11259
11395
|
export declare class RewardsApi extends BaseAPI {
|
|
11260
11396
|
/**
|
|
11261
|
-
* 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.
|
|
11262
11398
|
* @summary Cancel reward
|
|
11263
11399
|
* @param {string} id ID of the reward that should be canceled
|
|
11264
11400
|
* @param {*} [options] Override http request option.
|