tremendous 4.8.0 → 4.9.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 +22 -0
- package/dist/api.d.ts +325 -61
- package/dist/api.js +30 -5
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.9.0](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.8.0...tremendous-v4.9.0) (2026-04-22)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add `currency_code` to balance transactions ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
9
|
+
* add `currency_code` to order payment details ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
10
|
+
* add `currency_code` to payment refund details ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
11
|
+
* add `currency_code` to organizations ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
12
|
+
* add `currency_code` to create organization request ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
13
|
+
* add `currency_code` to funding source meta ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
14
|
+
* add `currency_code` to topups ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
15
|
+
* add `currency_code` to fraud review related rewards ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
16
|
+
* add `fee_charged_to` enum to campaigns ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
17
|
+
* add `available_amount`, `pending_amount`, `credit_limit_amount` to funding source meta ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
18
|
+
* add `instant_credit_amount`, `settled_amount`, `expected_settlement_at` to topups ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
19
|
+
* add `partially_credited` topup status ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Bug Fixes
|
|
23
|
+
|
|
24
|
+
* make recipient `name` field nullable ([cd04278](https://github.com/tremendous-rewards/tremendous-node/commit/cd0427864062399b49efb808fdd18a798ac35171))
|
|
3
25
|
## [4.8.0](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.7.0...tremendous-v4.8.0) (2026-04-17)
|
|
4
26
|
|
|
5
27
|
|
package/dist/api.d.ts
CHANGED
|
@@ -79,13 +79,19 @@ export interface BalanceTransaction {
|
|
|
79
79
|
*/
|
|
80
80
|
'created_at': string;
|
|
81
81
|
/**
|
|
82
|
-
* Amount of the transaction in
|
|
82
|
+
* Amount of the transaction, denominated in `currency_code`.
|
|
83
83
|
* @type {number}
|
|
84
84
|
* @memberof BalanceTransaction
|
|
85
85
|
*/
|
|
86
86
|
'amount': number;
|
|
87
87
|
/**
|
|
88
|
-
*
|
|
88
|
+
* Currency of the transaction amount and running balance. Always matches the organization\'s currency.
|
|
89
|
+
* @type {string}
|
|
90
|
+
* @memberof BalanceTransaction
|
|
91
|
+
*/
|
|
92
|
+
'currency_code': string;
|
|
93
|
+
/**
|
|
94
|
+
* The updated total after the transaction, denominated in `currency_code`. Note that this running balance may be delayed and contain `null`.
|
|
89
95
|
* @type {number}
|
|
90
96
|
* @memberof BalanceTransaction
|
|
91
97
|
*/
|
|
@@ -141,29 +147,35 @@ export interface BalanceTransactionOrder {
|
|
|
141
147
|
*/
|
|
142
148
|
export interface BalanceTransactionOrderPayment {
|
|
143
149
|
/**
|
|
144
|
-
* Total price of the order before fees
|
|
150
|
+
* Total price of the order before fees, denominated in `currency_code`.
|
|
145
151
|
* @type {number}
|
|
146
152
|
* @memberof BalanceTransactionOrderPayment
|
|
147
153
|
*/
|
|
148
154
|
'subtotal': number;
|
|
149
155
|
/**
|
|
150
|
-
* Total price of the order including fees
|
|
156
|
+
* Total price of the order including fees, denominated in `currency_code`.
|
|
151
157
|
* @type {number}
|
|
152
158
|
* @memberof BalanceTransactionOrderPayment
|
|
153
159
|
*/
|
|
154
160
|
'total': number;
|
|
155
161
|
/**
|
|
156
|
-
* Fees for the order
|
|
162
|
+
* Fees for the order, denominated in `currency_code`.
|
|
157
163
|
* @type {number}
|
|
158
164
|
* @memberof BalanceTransactionOrderPayment
|
|
159
165
|
*/
|
|
160
166
|
'fees': number;
|
|
161
167
|
/**
|
|
162
|
-
* Discount for the order
|
|
168
|
+
* Discount for the order, denominated in `currency_code`.
|
|
163
169
|
* @type {number}
|
|
164
170
|
* @memberof BalanceTransactionOrderPayment
|
|
165
171
|
*/
|
|
166
172
|
'discount': number;
|
|
173
|
+
/**
|
|
174
|
+
* Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency.
|
|
175
|
+
* @type {string}
|
|
176
|
+
* @memberof BalanceTransactionOrderPayment
|
|
177
|
+
*/
|
|
178
|
+
'currency_code': string;
|
|
167
179
|
/**
|
|
168
180
|
*
|
|
169
181
|
* @type {PaymentDetailsRefund}
|
|
@@ -220,6 +232,12 @@ export interface Campaign {
|
|
|
220
232
|
* @memberof Campaign
|
|
221
233
|
*/
|
|
222
234
|
'products': Array<string>;
|
|
235
|
+
/**
|
|
236
|
+
* Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product.
|
|
237
|
+
* @type {string}
|
|
238
|
+
* @memberof Campaign
|
|
239
|
+
*/
|
|
240
|
+
'fee_charged_to'?: CampaignFeeChargedToEnum | null;
|
|
223
241
|
/**
|
|
224
242
|
*
|
|
225
243
|
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
@@ -233,6 +251,11 @@ export interface Campaign {
|
|
|
233
251
|
*/
|
|
234
252
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
235
253
|
}
|
|
254
|
+
export declare const CampaignFeeChargedToEnum: {
|
|
255
|
+
readonly Sender: "SENDER";
|
|
256
|
+
readonly Recipient: "RECIPIENT";
|
|
257
|
+
};
|
|
258
|
+
export type CampaignFeeChargedToEnum = typeof CampaignFeeChargedToEnum[keyof typeof CampaignFeeChargedToEnum];
|
|
236
259
|
/**
|
|
237
260
|
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
238
261
|
* @export
|
|
@@ -263,6 +286,12 @@ export interface CampaignBase {
|
|
|
263
286
|
* @memberof CampaignBase
|
|
264
287
|
*/
|
|
265
288
|
'products'?: Array<string>;
|
|
289
|
+
/**
|
|
290
|
+
* Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product.
|
|
291
|
+
* @type {string}
|
|
292
|
+
* @memberof CampaignBase
|
|
293
|
+
*/
|
|
294
|
+
'fee_charged_to'?: CampaignBaseFeeChargedToEnum | null;
|
|
266
295
|
/**
|
|
267
296
|
*
|
|
268
297
|
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
@@ -276,6 +305,11 @@ export interface CampaignBase {
|
|
|
276
305
|
*/
|
|
277
306
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
278
307
|
}
|
|
308
|
+
export declare const CampaignBaseFeeChargedToEnum: {
|
|
309
|
+
readonly Sender: "SENDER";
|
|
310
|
+
readonly Recipient: "RECIPIENT";
|
|
311
|
+
};
|
|
312
|
+
export type CampaignBaseFeeChargedToEnum = typeof CampaignBaseFeeChargedToEnum[keyof typeof CampaignBaseFeeChargedToEnum];
|
|
279
313
|
/**
|
|
280
314
|
* Name of the channel in which the order was created
|
|
281
315
|
* @export
|
|
@@ -487,6 +521,12 @@ export interface ConnectedOrganizationOrganization {
|
|
|
487
521
|
* @memberof ConnectedOrganizationOrganization
|
|
488
522
|
*/
|
|
489
523
|
'website': string;
|
|
524
|
+
/**
|
|
525
|
+
* Currency used for this organization\'s balances, orders, and transactions.
|
|
526
|
+
* @type {string}
|
|
527
|
+
* @memberof ConnectedOrganizationOrganization
|
|
528
|
+
*/
|
|
529
|
+
'currency_code'?: string;
|
|
490
530
|
/**
|
|
491
531
|
* Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
492
532
|
* @type {string}
|
|
@@ -556,6 +596,12 @@ export interface CreateCampaignRequest {
|
|
|
556
596
|
* @memberof CreateCampaignRequest
|
|
557
597
|
*/
|
|
558
598
|
'products': Array<string>;
|
|
599
|
+
/**
|
|
600
|
+
* Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product.
|
|
601
|
+
* @type {string}
|
|
602
|
+
* @memberof CreateCampaignRequest
|
|
603
|
+
*/
|
|
604
|
+
'fee_charged_to'?: CreateCampaignRequestFeeChargedToEnum | null;
|
|
559
605
|
/**
|
|
560
606
|
*
|
|
561
607
|
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
@@ -569,6 +615,11 @@ export interface CreateCampaignRequest {
|
|
|
569
615
|
*/
|
|
570
616
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
571
617
|
}
|
|
618
|
+
export declare const CreateCampaignRequestFeeChargedToEnum: {
|
|
619
|
+
readonly Sender: "SENDER";
|
|
620
|
+
readonly Recipient: "RECIPIENT";
|
|
621
|
+
};
|
|
622
|
+
export type CreateCampaignRequestFeeChargedToEnum = typeof CreateCampaignRequestFeeChargedToEnum[keyof typeof CreateCampaignRequestFeeChargedToEnum];
|
|
572
623
|
/**
|
|
573
624
|
*
|
|
574
625
|
* @export
|
|
@@ -962,7 +1013,7 @@ export interface CreateOrder200ResponseOrder {
|
|
|
962
1013
|
*/
|
|
963
1014
|
'campaign_id'?: string | null;
|
|
964
1015
|
/**
|
|
965
|
-
* Date the order
|
|
1016
|
+
* Date the order was created
|
|
966
1017
|
* @type {string}
|
|
967
1018
|
* @memberof CreateOrder200ResponseOrder
|
|
968
1019
|
*/
|
|
@@ -1165,6 +1216,12 @@ export interface CreateOrganization {
|
|
|
1165
1216
|
* @memberof CreateOrganization
|
|
1166
1217
|
*/
|
|
1167
1218
|
'phone'?: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* Currency code for the new organization. Defaults to the current organization\'s currency if not provided.
|
|
1221
|
+
* @type {string}
|
|
1222
|
+
* @memberof CreateOrganization
|
|
1223
|
+
*/
|
|
1224
|
+
'currency_code'?: string;
|
|
1168
1225
|
/**
|
|
1169
1226
|
* Timestamp of when the organization has been created.
|
|
1170
1227
|
* @type {string}
|
|
@@ -1221,6 +1278,12 @@ export interface CreateOrganization200ResponseOrganization {
|
|
|
1221
1278
|
* @memberof CreateOrganization200ResponseOrganization
|
|
1222
1279
|
*/
|
|
1223
1280
|
'phone'?: string | null;
|
|
1281
|
+
/**
|
|
1282
|
+
* Currency code for the new organization. Defaults to the current organization\'s currency if not provided.
|
|
1283
|
+
* @type {string}
|
|
1284
|
+
* @memberof CreateOrganization200ResponseOrganization
|
|
1285
|
+
*/
|
|
1286
|
+
'currency_code'?: string;
|
|
1224
1287
|
/**
|
|
1225
1288
|
* Timestamp of when the organization has been created.
|
|
1226
1289
|
* @type {string}
|
|
@@ -1276,6 +1339,12 @@ export interface CreateOrganizationForResponse {
|
|
|
1276
1339
|
* @memberof CreateOrganizationForResponse
|
|
1277
1340
|
*/
|
|
1278
1341
|
'phone'?: string | null;
|
|
1342
|
+
/**
|
|
1343
|
+
* Currency code for the new organization. Defaults to the current organization\'s currency if not provided.
|
|
1344
|
+
* @type {string}
|
|
1345
|
+
* @memberof CreateOrganizationForResponse
|
|
1346
|
+
*/
|
|
1347
|
+
'currency_code'?: string;
|
|
1279
1348
|
/**
|
|
1280
1349
|
* Timestamp of when the organization has been created.
|
|
1281
1350
|
* @type {string}
|
|
@@ -1325,6 +1394,12 @@ export interface CreateOrganizationProperties {
|
|
|
1325
1394
|
* @memberof CreateOrganizationProperties
|
|
1326
1395
|
*/
|
|
1327
1396
|
'phone'?: string;
|
|
1397
|
+
/**
|
|
1398
|
+
* Currency code for the new organization. Defaults to the current organization\'s currency if not provided.
|
|
1399
|
+
* @type {string}
|
|
1400
|
+
* @memberof CreateOrganizationProperties
|
|
1401
|
+
*/
|
|
1402
|
+
'currency_code'?: string;
|
|
1328
1403
|
/**
|
|
1329
1404
|
* Timestamp of when the organization has been created.
|
|
1330
1405
|
* @type {string}
|
|
@@ -1368,6 +1443,12 @@ export interface CreateOrganizationRequest {
|
|
|
1368
1443
|
* @memberof CreateOrganizationRequest
|
|
1369
1444
|
*/
|
|
1370
1445
|
'phone'?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* Currency code for the new organization. Defaults to the current organization\'s currency if not provided.
|
|
1448
|
+
* @type {string}
|
|
1449
|
+
* @memberof CreateOrganizationRequest
|
|
1450
|
+
*/
|
|
1451
|
+
'currency_code'?: string;
|
|
1371
1452
|
}
|
|
1372
1453
|
/**
|
|
1373
1454
|
* A list of the settings that you wish to copy over to the new organization.
|
|
@@ -1686,7 +1767,7 @@ export interface CreateTopupRequest {
|
|
|
1686
1767
|
*/
|
|
1687
1768
|
'idempotency_key': string;
|
|
1688
1769
|
/**
|
|
1689
|
-
* Amount
|
|
1770
|
+
* Amount to add to your organization\'s balance, denominated in `currency_code`.
|
|
1690
1771
|
* @type {number}
|
|
1691
1772
|
* @memberof CreateTopupRequest
|
|
1692
1773
|
*/
|
|
@@ -2138,7 +2219,7 @@ export interface FraudConfigIP {
|
|
|
2138
2219
|
*/
|
|
2139
2220
|
export interface FraudConfigRedeemedRewardsAmount {
|
|
2140
2221
|
/**
|
|
2141
|
-
* The total amount
|
|
2222
|
+
* The total amount of redeemed rewards to use as a threshold. The amount is denominated in the organization\'s currency.
|
|
2142
2223
|
* @type {number}
|
|
2143
2224
|
* @memberof FraudConfigRedeemedRewardsAmount
|
|
2144
2225
|
*/
|
|
@@ -2293,10 +2374,10 @@ export interface FraudReview {
|
|
|
2293
2374
|
'risk'?: FraudReviewRiskEnum;
|
|
2294
2375
|
/**
|
|
2295
2376
|
*
|
|
2296
|
-
* @type {
|
|
2377
|
+
* @type {FraudReviewRelatedRewards}
|
|
2297
2378
|
* @memberof FraudReview
|
|
2298
2379
|
*/
|
|
2299
|
-
'related_rewards'?:
|
|
2380
|
+
'related_rewards'?: FraudReviewRelatedRewards;
|
|
2300
2381
|
}
|
|
2301
2382
|
export declare const FraudReviewStatusEnum: {
|
|
2302
2383
|
readonly Flagged: "flagged";
|
|
@@ -2632,7 +2713,7 @@ export declare const FraudReviewRedemptionMethod: {
|
|
|
2632
2713
|
};
|
|
2633
2714
|
export type FraudReviewRedemptionMethod = typeof FraudReviewRedemptionMethod[keyof typeof FraudReviewRedemptionMethod];
|
|
2634
2715
|
/**
|
|
2635
|
-
*
|
|
2716
|
+
* The related rewards associated with the fraud review.
|
|
2636
2717
|
* @export
|
|
2637
2718
|
* @interface FraudReviewRelatedRewards
|
|
2638
2719
|
*/
|
|
@@ -2656,11 +2737,17 @@ export interface FraudReviewRelatedRewards {
|
|
|
2656
2737
|
*/
|
|
2657
2738
|
'blocked_count'?: number;
|
|
2658
2739
|
/**
|
|
2659
|
-
* Total amount claimed by the related rewards
|
|
2740
|
+
* Total amount claimed by the related rewards, denominated in `currency_code`.
|
|
2660
2741
|
* @type {number}
|
|
2661
2742
|
* @memberof FraudReviewRelatedRewards
|
|
2662
2743
|
*/
|
|
2663
2744
|
'aggregated_value'?: number;
|
|
2745
|
+
/**
|
|
2746
|
+
* Currency of the aggregated value. Always matches the organization\'s currency.
|
|
2747
|
+
* @type {string}
|
|
2748
|
+
* @memberof FraudReviewRelatedRewards
|
|
2749
|
+
*/
|
|
2750
|
+
'currency_code'?: string;
|
|
2664
2751
|
}
|
|
2665
2752
|
/**
|
|
2666
2753
|
* The fraud risk associated with the reward.
|
|
@@ -2785,7 +2872,7 @@ export interface FraudRuleRequestConfig {
|
|
|
2785
2872
|
*/
|
|
2786
2873
|
'domains'?: Array<string>;
|
|
2787
2874
|
/**
|
|
2788
|
-
* The total amount
|
|
2875
|
+
* The total amount of redeemed rewards to use as a threshold. The amount is denominated in the organization\'s currency.
|
|
2789
2876
|
* @type {number}
|
|
2790
2877
|
* @memberof FraudRuleRequestConfig
|
|
2791
2878
|
*/
|
|
@@ -2812,7 +2899,7 @@ export declare const FraudRuleRequestConfigPeriodEnum: {
|
|
|
2812
2899
|
};
|
|
2813
2900
|
export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeriodEnum[keyof typeof FraudRuleRequestConfigPeriodEnum];
|
|
2814
2901
|
/**
|
|
2815
|
-
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
2902
|
+
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization\'s currency. * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
2816
2903
|
* @export
|
|
2817
2904
|
* @enum {string}
|
|
2818
2905
|
*/
|
|
@@ -2837,7 +2924,7 @@ export type FraudRuleType = typeof FraudRuleType[keyof typeof FraudRuleType];
|
|
|
2837
2924
|
*/
|
|
2838
2925
|
export interface FraudRulesListItem {
|
|
2839
2926
|
/**
|
|
2840
|
-
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
2927
|
+
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization\'s currency. * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
2841
2928
|
* @type {string}
|
|
2842
2929
|
* @memberof FraudRulesListItem
|
|
2843
2930
|
*/
|
|
@@ -3148,11 +3235,17 @@ export interface GetFraudReview200ResponseFraudReviewRelatedRewards {
|
|
|
3148
3235
|
*/
|
|
3149
3236
|
'blocked_count'?: number;
|
|
3150
3237
|
/**
|
|
3151
|
-
* Total amount claimed by the related rewards
|
|
3238
|
+
* Total amount claimed by the related rewards, denominated in `currency_code`.
|
|
3152
3239
|
* @type {number}
|
|
3153
3240
|
* @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
|
|
3154
3241
|
*/
|
|
3155
3242
|
'aggregated_value'?: number;
|
|
3243
|
+
/**
|
|
3244
|
+
* Currency of the aggregated value. Always matches the organization\'s currency.
|
|
3245
|
+
* @type {string}
|
|
3246
|
+
* @memberof GetFraudReview200ResponseFraudReviewRelatedRewards
|
|
3247
|
+
*/
|
|
3248
|
+
'currency_code'?: string;
|
|
3156
3249
|
}
|
|
3157
3250
|
/**
|
|
3158
3251
|
*
|
|
@@ -3486,13 +3579,19 @@ export interface ListBalanceTransactions200ResponseTransactionsInner {
|
|
|
3486
3579
|
*/
|
|
3487
3580
|
'created_at': string;
|
|
3488
3581
|
/**
|
|
3489
|
-
* Amount of the transaction in
|
|
3582
|
+
* Amount of the transaction, denominated in `currency_code`.
|
|
3490
3583
|
* @type {number}
|
|
3491
3584
|
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
3492
3585
|
*/
|
|
3493
3586
|
'amount': number;
|
|
3494
3587
|
/**
|
|
3495
|
-
*
|
|
3588
|
+
* Currency of the transaction amount and running balance. Always matches the organization\'s currency.
|
|
3589
|
+
* @type {string}
|
|
3590
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
3591
|
+
*/
|
|
3592
|
+
'currency_code': string;
|
|
3593
|
+
/**
|
|
3594
|
+
* The updated total after the transaction, denominated in `currency_code`. Note that this running balance may be delayed and contain `null`.
|
|
3496
3595
|
* @type {number}
|
|
3497
3596
|
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
3498
3597
|
*/
|
|
@@ -3548,29 +3647,35 @@ export interface ListBalanceTransactions200ResponseTransactionsInnerOrder {
|
|
|
3548
3647
|
*/
|
|
3549
3648
|
export interface ListBalanceTransactions200ResponseTransactionsInnerOrderPayment {
|
|
3550
3649
|
/**
|
|
3551
|
-
* Total price of the order before fees
|
|
3650
|
+
* Total price of the order before fees, denominated in `currency_code`.
|
|
3552
3651
|
* @type {number}
|
|
3553
3652
|
* @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment
|
|
3554
3653
|
*/
|
|
3555
3654
|
'subtotal': number;
|
|
3556
3655
|
/**
|
|
3557
|
-
* Total price of the order including fees
|
|
3656
|
+
* Total price of the order including fees, denominated in `currency_code`.
|
|
3558
3657
|
* @type {number}
|
|
3559
3658
|
* @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment
|
|
3560
3659
|
*/
|
|
3561
3660
|
'total': number;
|
|
3562
3661
|
/**
|
|
3563
|
-
* Fees for the order
|
|
3662
|
+
* Fees for the order, denominated in `currency_code`.
|
|
3564
3663
|
* @type {number}
|
|
3565
3664
|
* @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment
|
|
3566
3665
|
*/
|
|
3567
3666
|
'fees': number;
|
|
3568
3667
|
/**
|
|
3569
|
-
* Discount for the order
|
|
3668
|
+
* Discount for the order, denominated in `currency_code`.
|
|
3570
3669
|
* @type {number}
|
|
3571
3670
|
* @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment
|
|
3572
3671
|
*/
|
|
3573
3672
|
'discount': number;
|
|
3673
|
+
/**
|
|
3674
|
+
* Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency.
|
|
3675
|
+
* @type {string}
|
|
3676
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment
|
|
3677
|
+
*/
|
|
3678
|
+
'currency_code': string;
|
|
3574
3679
|
/**
|
|
3575
3680
|
*
|
|
3576
3681
|
* @type {ListOrders200ResponseOrdersInnerPaymentRefund}
|
|
@@ -3621,6 +3726,12 @@ export interface ListCampaigns200ResponseCampaignsInner {
|
|
|
3621
3726
|
* @memberof ListCampaigns200ResponseCampaignsInner
|
|
3622
3727
|
*/
|
|
3623
3728
|
'products': Array<string>;
|
|
3729
|
+
/**
|
|
3730
|
+
* Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product.
|
|
3731
|
+
* @type {string}
|
|
3732
|
+
* @memberof ListCampaigns200ResponseCampaignsInner
|
|
3733
|
+
*/
|
|
3734
|
+
'fee_charged_to'?: ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum | null;
|
|
3624
3735
|
/**
|
|
3625
3736
|
*
|
|
3626
3737
|
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
@@ -3634,6 +3745,11 @@ export interface ListCampaigns200ResponseCampaignsInner {
|
|
|
3634
3745
|
*/
|
|
3635
3746
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
3636
3747
|
}
|
|
3748
|
+
export declare const ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum: {
|
|
3749
|
+
readonly Sender: "SENDER";
|
|
3750
|
+
readonly Recipient: "RECIPIENT";
|
|
3751
|
+
};
|
|
3752
|
+
export type ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum = typeof ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum[keyof typeof ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum];
|
|
3637
3753
|
/**
|
|
3638
3754
|
* Definition of the email style
|
|
3639
3755
|
* @export
|
|
@@ -3916,6 +4032,12 @@ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInne
|
|
|
3916
4032
|
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
|
|
3917
4033
|
*/
|
|
3918
4034
|
'website': string;
|
|
4035
|
+
/**
|
|
4036
|
+
* Currency used for this organization\'s balances, orders, and transactions.
|
|
4037
|
+
* @type {string}
|
|
4038
|
+
* @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
|
|
4039
|
+
*/
|
|
4040
|
+
'currency_code'?: string;
|
|
3919
4041
|
/**
|
|
3920
4042
|
* Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
3921
4043
|
* @type {string}
|
|
@@ -4212,7 +4334,7 @@ export interface ListFraudRules200Response {
|
|
|
4212
4334
|
*/
|
|
4213
4335
|
export interface ListFraudRules200ResponseFraudRulesInner {
|
|
4214
4336
|
/**
|
|
4215
|
-
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
4337
|
+
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization\'s currency. * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
4216
4338
|
* @type {string}
|
|
4217
4339
|
* @memberof ListFraudRules200ResponseFraudRulesInner
|
|
4218
4340
|
*/
|
|
@@ -4328,19 +4450,43 @@ export type ListFundingSources200ResponseFundingSourcesInnerTypeEnum = typeof Li
|
|
|
4328
4450
|
*/
|
|
4329
4451
|
export interface ListFundingSources200ResponseFundingSourcesInnerMeta {
|
|
4330
4452
|
/**
|
|
4331
|
-
* **Only exists for balance and commercial invoicing.** For balance: available amount
|
|
4453
|
+
* **Only exists for balance and commercial invoicing.** For balance: available amount denominated in `currency_code`. For commercial invoicing: available credit amount denominated in `currency_code`, calculated as (credit limit - outstanding balance). *Caution: In the \"list funding sources\" endpoint this value is cached and may not be up to date. Use the \"get funding source\" endpoint to get the most up to date value.*
|
|
4454
|
+
* @type {number}
|
|
4455
|
+
* @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
|
|
4456
|
+
*/
|
|
4457
|
+
'available_amount'?: number;
|
|
4458
|
+
/**
|
|
4459
|
+
* Same as `available_amount`, but in cents.
|
|
4332
4460
|
* @type {number}
|
|
4333
4461
|
* @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
|
|
4334
4462
|
*/
|
|
4335
4463
|
'available_cents'?: number;
|
|
4336
4464
|
/**
|
|
4337
|
-
* **Only
|
|
4465
|
+
* **Only exists for balance and commercial invoicing.** The currency of the balance or credit amounts (e.g. `available_amount`, `pending_amount`, `credit_limit_amount`). Always matches the organization\'s currency.
|
|
4466
|
+
* @type {string}
|
|
4467
|
+
* @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
|
|
4468
|
+
*/
|
|
4469
|
+
'currency_code'?: string;
|
|
4470
|
+
/**
|
|
4471
|
+
* **Only available when `method` is set to `balance`.** Funds registered on your Tremendous account but not yet deposited in your account (e.g. payments that need to be manually reviewed by our ops team). Denominated in `currency_code`.
|
|
4472
|
+
* @type {number}
|
|
4473
|
+
* @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
|
|
4474
|
+
*/
|
|
4475
|
+
'pending_amount'?: number;
|
|
4476
|
+
/**
|
|
4477
|
+
* Same as `pending_amount`, but in cents.
|
|
4338
4478
|
* @type {number}
|
|
4339
4479
|
* @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
|
|
4340
4480
|
*/
|
|
4341
4481
|
'pending_cents'?: number;
|
|
4342
4482
|
/**
|
|
4343
|
-
* **Only exists for commercial invoicing.** Available credit limit
|
|
4483
|
+
* **Only exists for commercial invoicing.** Available credit limit denominated in `currency_code`.
|
|
4484
|
+
* @type {number}
|
|
4485
|
+
* @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
|
|
4486
|
+
*/
|
|
4487
|
+
'credit_limit_amount'?: number;
|
|
4488
|
+
/**
|
|
4489
|
+
* Same as `credit_limit_amount`, but in cents.
|
|
4344
4490
|
* @type {number}
|
|
4345
4491
|
* @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
|
|
4346
4492
|
*/
|
|
@@ -4762,7 +4908,7 @@ export interface ListOrders200ResponseOrdersInner {
|
|
|
4762
4908
|
*/
|
|
4763
4909
|
'campaign_id'?: string | null;
|
|
4764
4910
|
/**
|
|
4765
|
-
* Date the order
|
|
4911
|
+
* Date the order was created
|
|
4766
4912
|
* @type {string}
|
|
4767
4913
|
* @memberof ListOrders200ResponseOrdersInner
|
|
4768
4914
|
*/
|
|
@@ -4820,35 +4966,41 @@ export declare const ListOrders200ResponseOrdersInnerChannelEnum: {
|
|
|
4820
4966
|
};
|
|
4821
4967
|
export type ListOrders200ResponseOrdersInnerChannelEnum = typeof ListOrders200ResponseOrdersInnerChannelEnum[keyof typeof ListOrders200ResponseOrdersInnerChannelEnum];
|
|
4822
4968
|
/**
|
|
4823
|
-
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are
|
|
4969
|
+
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are denominated in the organization\'s currency (see payment `currency_code`), independent of the ordered rewards\' currency. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
|
|
4824
4970
|
* @export
|
|
4825
4971
|
* @interface ListOrders200ResponseOrdersInnerPayment
|
|
4826
4972
|
*/
|
|
4827
4973
|
export interface ListOrders200ResponseOrdersInnerPayment {
|
|
4828
4974
|
/**
|
|
4829
|
-
* Total price of the order before fees
|
|
4975
|
+
* Total price of the order before fees, denominated in `currency_code`.
|
|
4830
4976
|
* @type {number}
|
|
4831
4977
|
* @memberof ListOrders200ResponseOrdersInnerPayment
|
|
4832
4978
|
*/
|
|
4833
4979
|
'subtotal': number;
|
|
4834
4980
|
/**
|
|
4835
|
-
* Total price of the order including fees
|
|
4981
|
+
* Total price of the order including fees, denominated in `currency_code`.
|
|
4836
4982
|
* @type {number}
|
|
4837
4983
|
* @memberof ListOrders200ResponseOrdersInnerPayment
|
|
4838
4984
|
*/
|
|
4839
4985
|
'total': number;
|
|
4840
4986
|
/**
|
|
4841
|
-
* Fees for the order
|
|
4987
|
+
* Fees for the order, denominated in `currency_code`.
|
|
4842
4988
|
* @type {number}
|
|
4843
4989
|
* @memberof ListOrders200ResponseOrdersInnerPayment
|
|
4844
4990
|
*/
|
|
4845
4991
|
'fees': number;
|
|
4846
4992
|
/**
|
|
4847
|
-
* Discount for the order
|
|
4993
|
+
* Discount for the order, denominated in `currency_code`.
|
|
4848
4994
|
* @type {number}
|
|
4849
4995
|
* @memberof ListOrders200ResponseOrdersInnerPayment
|
|
4850
4996
|
*/
|
|
4851
4997
|
'discount': number;
|
|
4998
|
+
/**
|
|
4999
|
+
* Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency.
|
|
5000
|
+
* @type {string}
|
|
5001
|
+
* @memberof ListOrders200ResponseOrdersInnerPayment
|
|
5002
|
+
*/
|
|
5003
|
+
'currency_code': string;
|
|
4852
5004
|
/**
|
|
4853
5005
|
*
|
|
4854
5006
|
* @type {ListOrders200ResponseOrdersInnerPaymentRefund}
|
|
@@ -4857,17 +5009,23 @@ export interface ListOrders200ResponseOrdersInnerPayment {
|
|
|
4857
5009
|
'refund'?: ListOrders200ResponseOrdersInnerPaymentRefund;
|
|
4858
5010
|
}
|
|
4859
5011
|
/**
|
|
4860
|
-
* Breakdown of the order refunds (total
|
|
5012
|
+
* Breakdown of the order refunds (total denominated in `currency_code`, independent of the ordered rewards\' currency). Note that this property will only appear for canceled orders or orders with canceled rewards.
|
|
4861
5013
|
* @export
|
|
4862
5014
|
* @interface ListOrders200ResponseOrdersInnerPaymentRefund
|
|
4863
5015
|
*/
|
|
4864
5016
|
export interface ListOrders200ResponseOrdersInnerPaymentRefund {
|
|
4865
5017
|
/**
|
|
4866
|
-
* Total amount of the order refunds
|
|
5018
|
+
* Total amount of the order refunds, denominated in `currency_code`.
|
|
4867
5019
|
* @type {number}
|
|
4868
5020
|
* @memberof ListOrders200ResponseOrdersInnerPaymentRefund
|
|
4869
5021
|
*/
|
|
4870
5022
|
'total': number;
|
|
5023
|
+
/**
|
|
5024
|
+
* Currency of the refund. Always matches the organization\'s currency.
|
|
5025
|
+
* @type {string}
|
|
5026
|
+
* @memberof ListOrders200ResponseOrdersInnerPaymentRefund
|
|
5027
|
+
*/
|
|
5028
|
+
'currency_code': string;
|
|
4871
5029
|
}
|
|
4872
5030
|
/**
|
|
4873
5031
|
*
|
|
@@ -4906,6 +5064,12 @@ export interface ListOrganizations200ResponseOrganizationsInner {
|
|
|
4906
5064
|
* @memberof ListOrganizations200ResponseOrganizationsInner
|
|
4907
5065
|
*/
|
|
4908
5066
|
'website': string;
|
|
5067
|
+
/**
|
|
5068
|
+
* Currency used for this organization\'s balances, orders, and transactions.
|
|
5069
|
+
* @type {string}
|
|
5070
|
+
* @memberof ListOrganizations200ResponseOrganizationsInner
|
|
5071
|
+
*/
|
|
5072
|
+
'currency_code'?: string;
|
|
4909
5073
|
/**
|
|
4910
5074
|
* Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
4911
5075
|
* @type {string}
|
|
@@ -5393,7 +5557,7 @@ export interface ListRewards200ResponseRewardsInnerRecipient {
|
|
|
5393
5557
|
* @type {string}
|
|
5394
5558
|
* @memberof ListRewards200ResponseRewardsInnerRecipient
|
|
5395
5559
|
*/
|
|
5396
|
-
'name'?: string;
|
|
5560
|
+
'name'?: string | null;
|
|
5397
5561
|
/**
|
|
5398
5562
|
* Email address of the recipient
|
|
5399
5563
|
* @type {string}
|
|
@@ -5669,11 +5833,17 @@ export interface ListTopups200ResponseTopupsInner {
|
|
|
5669
5833
|
*/
|
|
5670
5834
|
'id'?: string;
|
|
5671
5835
|
/**
|
|
5672
|
-
* Amount
|
|
5836
|
+
* Amount to add to your organization\'s balance, denominated in `currency_code`.
|
|
5673
5837
|
* @type {number}
|
|
5674
5838
|
* @memberof ListTopups200ResponseTopupsInner
|
|
5675
5839
|
*/
|
|
5676
5840
|
'amount'?: number;
|
|
5841
|
+
/**
|
|
5842
|
+
* Currency of the topup amount. Always matches the organization\'s currency.
|
|
5843
|
+
* @type {string}
|
|
5844
|
+
* @memberof ListTopups200ResponseTopupsInner
|
|
5845
|
+
*/
|
|
5846
|
+
'currency_code'?: string;
|
|
5677
5847
|
/**
|
|
5678
5848
|
* Amount of the processing fee for the topup (typically reserved for credit card topups).
|
|
5679
5849
|
* @type {number}
|
|
@@ -5687,7 +5857,7 @@ export interface ListTopups200ResponseTopupsInner {
|
|
|
5687
5857
|
*/
|
|
5688
5858
|
'funding_source_id'?: string;
|
|
5689
5859
|
/**
|
|
5690
|
-
* Status of the topup <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> created </code> </td> <td> The topup is processing (and may be under review). </td> </tr> <tr> <td> <code>
|
|
5860
|
+
* Status of the topup <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> created </code> </td> <td> The topup is processing (and may be under review). </td> </tr> <tr> <td> <code> partially_credited </code> </td> <td> Some funds have been credited to the balance. The remainder will be credited by <code>expected_settlement_at</code>. </td> </tr> <tr> <td> <code> fully_credited </code> </td> <td> All funds have been added to the balance. </td> </tr> <tr> <td> <code> reversed </code> </td> <td> The topup was credited, but then reversed due to a chargeback or ACH return. </td> </tr> <tr> <td> <code> rejected </code> </td> <td> The topup was rejected by an admin. </td> </tr> </tbody> </table>
|
|
5691
5861
|
* @type {string}
|
|
5692
5862
|
* @memberof ListTopups200ResponseTopupsInner
|
|
5693
5863
|
*/
|
|
@@ -5728,6 +5898,24 @@ export interface ListTopups200ResponseTopupsInner {
|
|
|
5728
5898
|
* @memberof ListTopups200ResponseTopupsInner
|
|
5729
5899
|
*/
|
|
5730
5900
|
'idempotency_key'?: string | null;
|
|
5901
|
+
/**
|
|
5902
|
+
* Amount credited to the balance immediately. Equals `amount` for non-ACH topups or ACH debits fully within instant funding limits. Can be 0 if nothing was credited instantly.
|
|
5903
|
+
* @type {number}
|
|
5904
|
+
* @memberof ListTopups200ResponseTopupsInner
|
|
5905
|
+
*/
|
|
5906
|
+
'instant_credit_amount'?: number;
|
|
5907
|
+
/**
|
|
5908
|
+
* Amount that will be available once the settlement period elapses. 0 if nothing is settling.
|
|
5909
|
+
* @type {number}
|
|
5910
|
+
* @memberof ListTopups200ResponseTopupsInner
|
|
5911
|
+
*/
|
|
5912
|
+
'settled_amount'?: number;
|
|
5913
|
+
/**
|
|
5914
|
+
* Timestamp indicating when the pending amount will be credited to the balance. Null if the topup was fully credited immediately.
|
|
5915
|
+
* @type {string}
|
|
5916
|
+
* @memberof ListTopups200ResponseTopupsInner
|
|
5917
|
+
*/
|
|
5918
|
+
'expected_settlement_at'?: string | null;
|
|
5731
5919
|
}
|
|
5732
5920
|
/**
|
|
5733
5921
|
*
|
|
@@ -6027,7 +6215,7 @@ export interface Order {
|
|
|
6027
6215
|
*/
|
|
6028
6216
|
'campaign_id'?: string | null;
|
|
6029
6217
|
/**
|
|
6030
|
-
* Date the order
|
|
6218
|
+
* Date the order was created
|
|
6031
6219
|
* @type {string}
|
|
6032
6220
|
* @memberof Order
|
|
6033
6221
|
*/
|
|
@@ -6109,7 +6297,7 @@ export interface OrderBase {
|
|
|
6109
6297
|
*/
|
|
6110
6298
|
'campaign_id'?: string | null;
|
|
6111
6299
|
/**
|
|
6112
|
-
* Date the order
|
|
6300
|
+
* Date the order was created
|
|
6113
6301
|
* @type {string}
|
|
6114
6302
|
* @memberof OrderBase
|
|
6115
6303
|
*/
|
|
@@ -6161,35 +6349,41 @@ export declare const OrderBaseChannelEnum: {
|
|
|
6161
6349
|
};
|
|
6162
6350
|
export type OrderBaseChannelEnum = typeof OrderBaseChannelEnum[keyof typeof OrderBaseChannelEnum];
|
|
6163
6351
|
/**
|
|
6164
|
-
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are
|
|
6352
|
+
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are denominated in the organization\'s currency (see payment `currency_code`), independent of the ordered rewards\' currency. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
|
|
6165
6353
|
* @export
|
|
6166
6354
|
* @interface OrderBasePayment
|
|
6167
6355
|
*/
|
|
6168
6356
|
export interface OrderBasePayment {
|
|
6169
6357
|
/**
|
|
6170
|
-
* Total price of the order before fees
|
|
6358
|
+
* Total price of the order before fees, denominated in `currency_code`.
|
|
6171
6359
|
* @type {number}
|
|
6172
6360
|
* @memberof OrderBasePayment
|
|
6173
6361
|
*/
|
|
6174
6362
|
'subtotal': number;
|
|
6175
6363
|
/**
|
|
6176
|
-
* Total price of the order including fees
|
|
6364
|
+
* Total price of the order including fees, denominated in `currency_code`.
|
|
6177
6365
|
* @type {number}
|
|
6178
6366
|
* @memberof OrderBasePayment
|
|
6179
6367
|
*/
|
|
6180
6368
|
'total': number;
|
|
6181
6369
|
/**
|
|
6182
|
-
* Fees for the order
|
|
6370
|
+
* Fees for the order, denominated in `currency_code`.
|
|
6183
6371
|
* @type {number}
|
|
6184
6372
|
* @memberof OrderBasePayment
|
|
6185
6373
|
*/
|
|
6186
6374
|
'fees': number;
|
|
6187
6375
|
/**
|
|
6188
|
-
* Discount for the order
|
|
6376
|
+
* Discount for the order, denominated in `currency_code`.
|
|
6189
6377
|
* @type {number}
|
|
6190
6378
|
* @memberof OrderBasePayment
|
|
6191
6379
|
*/
|
|
6192
6380
|
'discount': number;
|
|
6381
|
+
/**
|
|
6382
|
+
* Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency.
|
|
6383
|
+
* @type {string}
|
|
6384
|
+
* @memberof OrderBasePayment
|
|
6385
|
+
*/
|
|
6386
|
+
'currency_code': string;
|
|
6193
6387
|
/**
|
|
6194
6388
|
*
|
|
6195
6389
|
* @type {PaymentDetailsRefund}
|
|
@@ -6237,7 +6431,7 @@ export interface OrderWithLink {
|
|
|
6237
6431
|
*/
|
|
6238
6432
|
'campaign_id'?: string | null;
|
|
6239
6433
|
/**
|
|
6240
|
-
* Date the order
|
|
6434
|
+
* Date the order was created
|
|
6241
6435
|
* @type {string}
|
|
6242
6436
|
* @memberof OrderWithLink
|
|
6243
6437
|
*/
|
|
@@ -6392,7 +6586,7 @@ export interface OrderWithoutLink {
|
|
|
6392
6586
|
*/
|
|
6393
6587
|
'campaign_id'?: string | null;
|
|
6394
6588
|
/**
|
|
6395
|
-
* Date the order
|
|
6589
|
+
* Date the order was created
|
|
6396
6590
|
* @type {string}
|
|
6397
6591
|
* @memberof OrderWithoutLink
|
|
6398
6592
|
*/
|
|
@@ -6546,6 +6740,12 @@ export interface Organization {
|
|
|
6546
6740
|
* @memberof Organization
|
|
6547
6741
|
*/
|
|
6548
6742
|
'website': string;
|
|
6743
|
+
/**
|
|
6744
|
+
* Currency used for this organization\'s balances, orders, and transactions.
|
|
6745
|
+
* @type {string}
|
|
6746
|
+
* @memberof Organization
|
|
6747
|
+
*/
|
|
6748
|
+
'currency_code'?: string;
|
|
6549
6749
|
/**
|
|
6550
6750
|
* Status of the organization. Organizations need to be approved to be able to use them to send out rewards.
|
|
6551
6751
|
* @type {string}
|
|
@@ -6572,29 +6772,35 @@ export type OrganizationStatusEnum = typeof OrganizationStatusEnum[keyof typeof
|
|
|
6572
6772
|
*/
|
|
6573
6773
|
export interface PaymentDetails {
|
|
6574
6774
|
/**
|
|
6575
|
-
* Total price of the order before fees
|
|
6775
|
+
* Total price of the order before fees, denominated in `currency_code`.
|
|
6576
6776
|
* @type {number}
|
|
6577
6777
|
* @memberof PaymentDetails
|
|
6578
6778
|
*/
|
|
6579
6779
|
'subtotal': number;
|
|
6580
6780
|
/**
|
|
6581
|
-
* Total price of the order including fees
|
|
6781
|
+
* Total price of the order including fees, denominated in `currency_code`.
|
|
6582
6782
|
* @type {number}
|
|
6583
6783
|
* @memberof PaymentDetails
|
|
6584
6784
|
*/
|
|
6585
6785
|
'total': number;
|
|
6586
6786
|
/**
|
|
6587
|
-
* Fees for the order
|
|
6787
|
+
* Fees for the order, denominated in `currency_code`.
|
|
6588
6788
|
* @type {number}
|
|
6589
6789
|
* @memberof PaymentDetails
|
|
6590
6790
|
*/
|
|
6591
6791
|
'fees': number;
|
|
6592
6792
|
/**
|
|
6593
|
-
* Discount for the order
|
|
6793
|
+
* Discount for the order, denominated in `currency_code`.
|
|
6594
6794
|
* @type {number}
|
|
6595
6795
|
* @memberof PaymentDetails
|
|
6596
6796
|
*/
|
|
6597
6797
|
'discount': number;
|
|
6798
|
+
/**
|
|
6799
|
+
* Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency.
|
|
6800
|
+
* @type {string}
|
|
6801
|
+
* @memberof PaymentDetails
|
|
6802
|
+
*/
|
|
6803
|
+
'currency_code': string;
|
|
6598
6804
|
/**
|
|
6599
6805
|
*
|
|
6600
6806
|
* @type {PaymentDetailsRefund}
|
|
@@ -6603,17 +6809,23 @@ export interface PaymentDetails {
|
|
|
6603
6809
|
'refund'?: PaymentDetailsRefund;
|
|
6604
6810
|
}
|
|
6605
6811
|
/**
|
|
6606
|
-
* Breakdown of the order refunds (total
|
|
6812
|
+
* Breakdown of the order refunds (total denominated in `currency_code`, independent of the ordered rewards\' currency). Note that this property will only appear for canceled orders or orders with canceled rewards.
|
|
6607
6813
|
* @export
|
|
6608
6814
|
* @interface PaymentDetailsRefund
|
|
6609
6815
|
*/
|
|
6610
6816
|
export interface PaymentDetailsRefund {
|
|
6611
6817
|
/**
|
|
6612
|
-
* Total amount of the order refunds
|
|
6818
|
+
* Total amount of the order refunds, denominated in `currency_code`.
|
|
6613
6819
|
* @type {number}
|
|
6614
6820
|
* @memberof PaymentDetailsRefund
|
|
6615
6821
|
*/
|
|
6616
6822
|
'total': number;
|
|
6823
|
+
/**
|
|
6824
|
+
* Currency of the refund. Always matches the organization\'s currency.
|
|
6825
|
+
* @type {string}
|
|
6826
|
+
* @memberof PaymentDetailsRefund
|
|
6827
|
+
*/
|
|
6828
|
+
'currency_code': string;
|
|
6617
6829
|
}
|
|
6618
6830
|
/**
|
|
6619
6831
|
*
|
|
@@ -6929,7 +7141,7 @@ export interface Recipient {
|
|
|
6929
7141
|
* @type {string}
|
|
6930
7142
|
* @memberof Recipient
|
|
6931
7143
|
*/
|
|
6932
|
-
'name'?: string;
|
|
7144
|
+
'name'?: string | null;
|
|
6933
7145
|
/**
|
|
6934
7146
|
* Email address of the recipient
|
|
6935
7147
|
* @type {string}
|
|
@@ -6950,11 +7162,17 @@ export interface Recipient {
|
|
|
6950
7162
|
*/
|
|
6951
7163
|
export interface RefundDetails {
|
|
6952
7164
|
/**
|
|
6953
|
-
* Total amount of the order refunds
|
|
7165
|
+
* Total amount of the order refunds, denominated in `currency_code`.
|
|
6954
7166
|
* @type {number}
|
|
6955
7167
|
* @memberof RefundDetails
|
|
6956
7168
|
*/
|
|
6957
7169
|
'total': number;
|
|
7170
|
+
/**
|
|
7171
|
+
* Currency of the refund. Always matches the organization\'s currency.
|
|
7172
|
+
* @type {string}
|
|
7173
|
+
* @memberof RefundDetails
|
|
7174
|
+
*/
|
|
7175
|
+
'currency_code': string;
|
|
6958
7176
|
}
|
|
6959
7177
|
/**
|
|
6960
7178
|
* Reports represent a collection of your Tremendous data that can be filtered and downloaded. The report object that is returned has a unique ID, a status, and an predicted time of report generation completion. When the report generation is complete, it will also contain an expiring url where you can retrieve your report.
|
|
@@ -7146,7 +7364,7 @@ export interface ReviewIp1 {
|
|
|
7146
7364
|
*/
|
|
7147
7365
|
export interface ReviewRedeemedRewardsAmount {
|
|
7148
7366
|
/**
|
|
7149
|
-
* The total amount
|
|
7367
|
+
* The total amount of redeemed rewards to use as a threshold. The amount is denominated in the organization\'s currency.
|
|
7150
7368
|
* @type {number}
|
|
7151
7369
|
* @memberof ReviewRedeemedRewardsAmount
|
|
7152
7370
|
*/
|
|
@@ -8070,7 +8288,7 @@ export interface SingleRewardOrderWithLinkOrder {
|
|
|
8070
8288
|
*/
|
|
8071
8289
|
'campaign_id'?: string | null;
|
|
8072
8290
|
/**
|
|
8073
|
-
* Date the order
|
|
8291
|
+
* Date the order was created
|
|
8074
8292
|
* @type {string}
|
|
8075
8293
|
* @memberof SingleRewardOrderWithLinkOrder
|
|
8076
8294
|
*/
|
|
@@ -8165,7 +8383,7 @@ export interface SingleRewardOrderWithoutLinkOrder {
|
|
|
8165
8383
|
*/
|
|
8166
8384
|
'campaign_id'?: string | null;
|
|
8167
8385
|
/**
|
|
8168
|
-
* Date the order
|
|
8386
|
+
* Date the order was created
|
|
8169
8387
|
* @type {string}
|
|
8170
8388
|
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
8171
8389
|
*/
|
|
@@ -8235,11 +8453,17 @@ export interface Topup {
|
|
|
8235
8453
|
*/
|
|
8236
8454
|
'id'?: string;
|
|
8237
8455
|
/**
|
|
8238
|
-
* Amount
|
|
8456
|
+
* Amount to add to your organization\'s balance, denominated in `currency_code`.
|
|
8239
8457
|
* @type {number}
|
|
8240
8458
|
* @memberof Topup
|
|
8241
8459
|
*/
|
|
8242
8460
|
'amount'?: number;
|
|
8461
|
+
/**
|
|
8462
|
+
* Currency of the topup amount. Always matches the organization\'s currency.
|
|
8463
|
+
* @type {string}
|
|
8464
|
+
* @memberof Topup
|
|
8465
|
+
*/
|
|
8466
|
+
'currency_code'?: string;
|
|
8243
8467
|
/**
|
|
8244
8468
|
* Amount of the processing fee for the topup (typically reserved for credit card topups).
|
|
8245
8469
|
* @type {number}
|
|
@@ -8253,7 +8477,7 @@ export interface Topup {
|
|
|
8253
8477
|
*/
|
|
8254
8478
|
'funding_source_id'?: string;
|
|
8255
8479
|
/**
|
|
8256
|
-
* Status of the topup <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> created </code> </td> <td> The topup is processing (and may be under review). </td> </tr> <tr> <td> <code>
|
|
8480
|
+
* Status of the topup <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> created </code> </td> <td> The topup is processing (and may be under review). </td> </tr> <tr> <td> <code> partially_credited </code> </td> <td> Some funds have been credited to the balance. The remainder will be credited by <code>expected_settlement_at</code>. </td> </tr> <tr> <td> <code> fully_credited </code> </td> <td> All funds have been added to the balance. </td> </tr> <tr> <td> <code> reversed </code> </td> <td> The topup was credited, but then reversed due to a chargeback or ACH return. </td> </tr> <tr> <td> <code> rejected </code> </td> <td> The topup was rejected by an admin. </td> </tr> </tbody> </table>
|
|
8257
8481
|
* @type {string}
|
|
8258
8482
|
* @memberof Topup
|
|
8259
8483
|
*/
|
|
@@ -8294,6 +8518,24 @@ export interface Topup {
|
|
|
8294
8518
|
* @memberof Topup
|
|
8295
8519
|
*/
|
|
8296
8520
|
'idempotency_key'?: string | null;
|
|
8521
|
+
/**
|
|
8522
|
+
* Amount credited to the balance immediately. Equals `amount` for non-ACH topups or ACH debits fully within instant funding limits. Can be 0 if nothing was credited instantly.
|
|
8523
|
+
* @type {number}
|
|
8524
|
+
* @memberof Topup
|
|
8525
|
+
*/
|
|
8526
|
+
'instant_credit_amount'?: number;
|
|
8527
|
+
/**
|
|
8528
|
+
* Amount that will be available once the settlement period elapses. 0 if nothing is settling.
|
|
8529
|
+
* @type {number}
|
|
8530
|
+
* @memberof Topup
|
|
8531
|
+
*/
|
|
8532
|
+
'settled_amount'?: number;
|
|
8533
|
+
/**
|
|
8534
|
+
* Timestamp indicating when the pending amount will be credited to the balance. Null if the topup was fully credited immediately.
|
|
8535
|
+
* @type {string}
|
|
8536
|
+
* @memberof Topup
|
|
8537
|
+
*/
|
|
8538
|
+
'expected_settlement_at'?: string | null;
|
|
8297
8539
|
}
|
|
8298
8540
|
/**
|
|
8299
8541
|
*
|
|
@@ -8314,7 +8556,7 @@ export interface TopupCreateRequest {
|
|
|
8314
8556
|
*/
|
|
8315
8557
|
'idempotency_key': string;
|
|
8316
8558
|
/**
|
|
8317
|
-
* Amount
|
|
8559
|
+
* Amount to add to your organization\'s balance, denominated in `currency_code`.
|
|
8318
8560
|
* @type {number}
|
|
8319
8561
|
* @memberof TopupCreateRequest
|
|
8320
8562
|
*/
|
|
@@ -8350,6 +8592,12 @@ export interface UpdateCampaign {
|
|
|
8350
8592
|
* @memberof UpdateCampaign
|
|
8351
8593
|
*/
|
|
8352
8594
|
'products'?: Array<string>;
|
|
8595
|
+
/**
|
|
8596
|
+
* Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product.
|
|
8597
|
+
* @type {string}
|
|
8598
|
+
* @memberof UpdateCampaign
|
|
8599
|
+
*/
|
|
8600
|
+
'fee_charged_to'?: UpdateCampaignFeeChargedToEnum | null;
|
|
8353
8601
|
/**
|
|
8354
8602
|
*
|
|
8355
8603
|
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
@@ -8363,6 +8611,11 @@ export interface UpdateCampaign {
|
|
|
8363
8611
|
*/
|
|
8364
8612
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
8365
8613
|
}
|
|
8614
|
+
export declare const UpdateCampaignFeeChargedToEnum: {
|
|
8615
|
+
readonly Sender: "SENDER";
|
|
8616
|
+
readonly Recipient: "RECIPIENT";
|
|
8617
|
+
};
|
|
8618
|
+
export type UpdateCampaignFeeChargedToEnum = typeof UpdateCampaignFeeChargedToEnum[keyof typeof UpdateCampaignFeeChargedToEnum];
|
|
8366
8619
|
/**
|
|
8367
8620
|
* With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
|
|
8368
8621
|
* @export
|
|
@@ -8387,6 +8640,12 @@ export interface UpdateCampaignRequest {
|
|
|
8387
8640
|
* @memberof UpdateCampaignRequest
|
|
8388
8641
|
*/
|
|
8389
8642
|
'products'?: Array<string>;
|
|
8643
|
+
/**
|
|
8644
|
+
* Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product.
|
|
8645
|
+
* @type {string}
|
|
8646
|
+
* @memberof UpdateCampaignRequest
|
|
8647
|
+
*/
|
|
8648
|
+
'fee_charged_to'?: UpdateCampaignRequestFeeChargedToEnum | null;
|
|
8390
8649
|
/**
|
|
8391
8650
|
*
|
|
8392
8651
|
* @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle}
|
|
@@ -8400,6 +8659,11 @@ export interface UpdateCampaignRequest {
|
|
|
8400
8659
|
*/
|
|
8401
8660
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
8402
8661
|
}
|
|
8662
|
+
export declare const UpdateCampaignRequestFeeChargedToEnum: {
|
|
8663
|
+
readonly Sender: "SENDER";
|
|
8664
|
+
readonly Recipient: "RECIPIENT";
|
|
8665
|
+
};
|
|
8666
|
+
export type UpdateCampaignRequestFeeChargedToEnum = typeof UpdateCampaignRequestFeeChargedToEnum[keyof typeof UpdateCampaignRequestFeeChargedToEnum];
|
|
8403
8667
|
/**
|
|
8404
8668
|
*
|
|
8405
8669
|
* @export
|
package/dist/api.js
CHANGED
|
@@ -25,16 +25,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
25
25
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
26
26
|
};
|
|
27
27
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
28
|
-
exports.
|
|
29
|
-
exports.
|
|
30
|
-
exports.
|
|
31
|
-
exports.
|
|
28
|
+
exports.FundingSourceMethodEnum = exports.FraudRulesListItemRuleTypeEnum = exports.FraudRuleType = exports.FraudRuleRequestConfigPeriodEnum = exports.FraudRuleRequestConfigTypeEnum = exports.FraudReviewStatus = exports.FraudReviewRisk = exports.FraudReviewRedemptionMethod = exports.FraudReviewReason = exports.FraudReviewListItemRedemptionMethodEnum = exports.FraudReviewListItemReasonsEnum = exports.FraudReviewListItemStatusEnum = exports.FraudReviewBaseRedemptionMethodEnum = exports.FraudReviewBaseReasonsEnum = exports.FraudReviewBaseStatusEnum = exports.FraudReviewRiskEnum = exports.FraudReviewRedemptionMethodEnum = exports.FraudReviewReasonsEnum = exports.FraudReviewStatusEnum = exports.FraudConfigRedeemedRewardsCountPeriodEnum = exports.FraudConfigRedeemedRewardsAmountPeriodEnum = exports.FraudConfigCountryTypeEnum = exports.FieldDataTypeEnum = exports.DeliveryStatus = exports.DeliveryMethod = exports.DeliveryDetailsWithLinkStatusEnum = exports.DeliveryDetailsWithLinkMethodEnum = exports.DeliveryDetailsStatusEnum = exports.DeliveryDetailsMethodEnum = exports.CurrencyCodes = exports.CreateReportRequestFiltersDigitalRewardsStatusEnum = exports.CreateReportRequestFiltersDigitalRewardsOrderStatusEnum = exports.CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum = exports.CreateReportRequestFormatEnum = exports.CreateReportRequestReportTypeEnum = exports.CreateReport200ResponseReportStatusEnum = exports.CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum = exports.CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum = exports.CreateOrder200ResponseOrderChannelEnum = exports.CreateOrder200ResponseOrderStatusEnum = exports.CreateInvoiceRequestCurrencyEnum = exports.CreateInvoiceRequestCurrencyCodeEnum = exports.CreateFieldRequestDataTypeEnum = exports.CreateFieldDataTypeEnum = exports.CreateCampaignRequestFeeChargedToEnum = exports.ConnectedOrganizationOrganizationStatusEnum = exports.ConnectedOrganizationMemberMemberStatusEnum = exports.Channel = exports.CampaignBaseFeeChargedToEnum = exports.CampaignFeeChargedToEnum = void 0;
|
|
29
|
+
exports.OrderWithLinkStatusEnum = exports.OrderStatus = exports.OrderBaseChannelEnum = exports.OrderBaseStatusEnum = exports.OrderChannelEnum = exports.OrderStatusEnum = exports.MemberWithoutEventsStatusEnum = exports.MemberWithEventsStatusEnum = exports.MemberBaseStatusEnum = exports.MemberStatusEnum = exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = exports.ListRewards200ResponseRewardsInnerDeliveryStatusEnum = exports.ListRewards200ResponseRewardsInnerDeliveryMethodEnum = exports.ListProductsResponseProductsInnerImagesInnerTypeEnum = exports.ListProductsResponseProductsInnerCurrencyCodesEnum = exports.ListProductsResponseProductsInnerSubcategoryEnum = exports.ListProductsResponseProductsInnerCategoryEnum = exports.ListOrganizations200ResponseOrganizationsInnerStatusEnum = exports.ListOrders200ResponseOrdersInnerChannelEnum = exports.ListOrders200ResponseOrdersInnerStatusEnum = exports.ListMembers200ResponseMembersInnerStatusEnum = exports.ListInvoices200ResponseInvoicesInnerStatusEnum = exports.ListInvoices200ResponseInvoicesInnerCurrencyEnum = exports.ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum = exports.ListFundingSources200ResponseFundingSourcesInnerTypeEnum = exports.ListFundingSources200ResponseFundingSourcesInnerStatusEnum = exports.ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMethodEnum = exports.ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = exports.ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum = exports.ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = exports.ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = exports.ListFields200ResponseFieldsInnerDataTypeEnum = exports.ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum = exports.ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum = exports.ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum = exports.InvoiceStatusEnum = exports.InvoiceCurrencyEnum = exports.InvoiceCurrencyCodeEnum = exports.GetMember200ResponseMemberEventsInnerTypeEnum = exports.GetMember200ResponseMemberStatusEnum = exports.GetFraudReview200ResponseFraudReviewRiskEnum = exports.GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = exports.GetFraudReview200ResponseFraudReviewReasonsEnum = exports.GetFraudReview200ResponseFraudReviewStatusEnum = exports.FundingSourceTypeEnum = exports.FundingSourceStatusEnum = exports.FundingSourceUsagePermissionsEnum = void 0;
|
|
30
|
+
exports.FraudReviewsApiAxiosParamCreator = exports.ForexApi = exports.ForexApiFactory = exports.ForexApiFp = exports.ForexApiAxiosParamCreator = exports.FieldsApi = exports.FieldsApiFactory = exports.FieldsApiFp = exports.FieldsApiAxiosParamCreator = exports.ConnectedOrganizationsApi = exports.ConnectedOrganizationsApiFactory = exports.ConnectedOrganizationsApiFp = exports.ConnectedOrganizationsApiAxiosParamCreator = exports.ConnectedOrganizationMembersApi = exports.ConnectedOrganizationMembersApiFactory = exports.ConnectedOrganizationMembersApiFp = exports.ConnectedOrganizationMembersApiAxiosParamCreator = exports.CampaignsApi = exports.CampaignsApiFactory = exports.CampaignsApiFp = exports.CampaignsApiAxiosParamCreator = exports.BalanceTransactionsApi = exports.BalanceTransactionsApiFactory = exports.BalanceTransactionsApiFp = exports.BalanceTransactionsApiAxiosParamCreator = exports.UpdateFraudRuleListRequestOperationEnum = exports.UpdateCampaignRequestFeeChargedToEnum = exports.UpdateCampaignFeeChargedToEnum = exports.SingleRewardOrderWithoutLinkOrderChannelEnum = exports.SingleRewardOrderWithoutLinkOrderStatusEnum = exports.SingleRewardOrderWithLinkOrderChannelEnum = exports.SingleRewardOrderWithLinkOrderStatusEnum = exports.SingleRewardOrderRewardDeliveryMethodEnum = exports.RewardWithoutLinkDeliveryStatusEnum = exports.RewardWithoutLinkDeliveryMethodEnum = exports.RewardWithLinkDeliveryStatusEnum = exports.RewardWithLinkDeliveryMethodEnum = exports.RewardValueCurrencyCodeEnum = exports.ReviewRedeemedRewardsCountPeriodEnum = exports.ReviewRedeemedRewardsAmountPeriodEnum = exports.ReviewCountryTypeEnum = exports.ReportStatusEnum = exports.ProductCurrencyCodesEnum = exports.ProductSubcategoryEnum = exports.ProductCategoryEnum = exports.PayoutStatusEnum = exports.OrganizationStatusEnum = exports.OrderWithoutLinkChannelEnum = exports.OrderWithoutLinkStatusEnum = exports.OrderWithLinkChannelEnum = void 0;
|
|
31
|
+
exports.TopupsApiFactory = exports.TopupsApiFp = exports.TopupsApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RewardsApi = exports.RewardsApiFactory = exports.RewardsApiFp = exports.RewardsApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.MembersApi = exports.MembersApiFactory = exports.MembersApiFp = exports.MembersApiAxiosParamCreator = exports.InvoicesApi = exports.InvoicesApiFactory = exports.InvoicesApiFp = exports.InvoicesApiAxiosParamCreator = exports.FundingSourcesApi = exports.FundingSourcesApiFactory = exports.FundingSourcesApiFp = exports.FundingSourcesApiAxiosParamCreator = exports.UpdateFraudRuleListRuleTypeEnum = exports.FraudRuleRuleTypeEnum = exports.DeleteFraudRuleRuleTypeEnum = exports.FraudRulesApi = exports.FraudRulesApiFactory = exports.FraudRulesApiFp = exports.FraudRulesApiAxiosParamCreator = exports.ListFraudReviewsStatusEnum = exports.FraudReviewsApi = exports.FraudReviewsApiFactory = exports.FraudReviewsApiFp = void 0;
|
|
32
|
+
exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TopupsApi = void 0;
|
|
32
33
|
const axios_1 = __importDefault(require("axios"));
|
|
33
34
|
// Some imports not used depending on template conditions
|
|
34
35
|
// @ts-ignore
|
|
35
36
|
const common_1 = require("./common");
|
|
36
37
|
// @ts-ignore
|
|
37
38
|
const base_1 = require("./base");
|
|
39
|
+
exports.CampaignFeeChargedToEnum = {
|
|
40
|
+
Sender: 'SENDER',
|
|
41
|
+
Recipient: 'RECIPIENT'
|
|
42
|
+
};
|
|
43
|
+
exports.CampaignBaseFeeChargedToEnum = {
|
|
44
|
+
Sender: 'SENDER',
|
|
45
|
+
Recipient: 'RECIPIENT'
|
|
46
|
+
};
|
|
38
47
|
/**
|
|
39
48
|
* Name of the channel in which the order was created
|
|
40
49
|
* @export
|
|
@@ -59,6 +68,10 @@ exports.ConnectedOrganizationOrganizationStatusEnum = {
|
|
|
59
68
|
Approved: 'APPROVED',
|
|
60
69
|
Rejected: 'REJECTED'
|
|
61
70
|
};
|
|
71
|
+
exports.CreateCampaignRequestFeeChargedToEnum = {
|
|
72
|
+
Sender: 'SENDER',
|
|
73
|
+
Recipient: 'RECIPIENT'
|
|
74
|
+
};
|
|
62
75
|
exports.CreateFieldDataTypeEnum = {
|
|
63
76
|
Checkbox: 'Checkbox',
|
|
64
77
|
Currency: 'Currency',
|
|
@@ -542,7 +555,7 @@ exports.FraudRuleRequestConfigPeriodEnum = {
|
|
|
542
555
|
AllTime: 'all_time'
|
|
543
556
|
};
|
|
544
557
|
/**
|
|
545
|
-
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
558
|
+
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization\'s currency. * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
546
559
|
* @export
|
|
547
560
|
* @enum {string}
|
|
548
561
|
*/
|
|
@@ -660,6 +673,10 @@ exports.InvoiceStatusEnum = {
|
|
|
660
673
|
Open: 'OPEN',
|
|
661
674
|
MarkedAsPaid: 'MARKED_AS_PAID'
|
|
662
675
|
};
|
|
676
|
+
exports.ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum = {
|
|
677
|
+
Sender: 'SENDER',
|
|
678
|
+
Recipient: 'RECIPIENT'
|
|
679
|
+
};
|
|
663
680
|
exports.ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum = {
|
|
664
681
|
Registered: 'REGISTERED',
|
|
665
682
|
Invited: 'INVITED'
|
|
@@ -1540,6 +1557,14 @@ exports.SingleRewardOrderWithoutLinkOrderChannelEnum = {
|
|
|
1540
1557
|
SurveyMonkey: 'SURVEY MONKEY',
|
|
1541
1558
|
Yotpo: 'YOTPO'
|
|
1542
1559
|
};
|
|
1560
|
+
exports.UpdateCampaignFeeChargedToEnum = {
|
|
1561
|
+
Sender: 'SENDER',
|
|
1562
|
+
Recipient: 'RECIPIENT'
|
|
1563
|
+
};
|
|
1564
|
+
exports.UpdateCampaignRequestFeeChargedToEnum = {
|
|
1565
|
+
Sender: 'SENDER',
|
|
1566
|
+
Recipient: 'RECIPIENT'
|
|
1567
|
+
};
|
|
1543
1568
|
exports.UpdateFraudRuleListRequestOperationEnum = {
|
|
1544
1569
|
Add: 'add',
|
|
1545
1570
|
Remove: 'remove'
|