tremendous 4.12.0 → 4.14.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 +23 -0
- package/dist/api.d.ts +131 -18
- package/dist/api.js +19 -11
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.14.0](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.13.0...tremendous-v4.14.0) (2026-07-03)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* rename `kyb` to `kyb_prefill` in connected org create ([8d71686](https://github.com/tremendous-rewards/tremendous-node/commit/8d716864eebb712ad0516743fef9017bfbe51152))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* remove `prefilled_kyb_details` from connected org responses ([8d71686](https://github.com/tremendous-rewards/tremendous-node/commit/8d716864eebb712ad0516743fef9017bfbe51152))
|
|
14
|
+
|
|
15
|
+
## [4.13.0](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.12.0...tremendous-v4.13.0) (2026-06-09)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Features
|
|
19
|
+
|
|
20
|
+
* add `Apple Private Relay` fraud review reason ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
|
|
21
|
+
* add `prefilled_kyb_details` to connected org response ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
|
|
22
|
+
* add `skip_apple_private_relay` to VPN fraud rule ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
|
|
23
|
+
* add `wallet` product category ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
|
|
24
|
+
* add optional `kyb` prefill to connected orgs ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
|
|
25
|
+
|
|
3
26
|
## [4.12.0](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.11.0...tremendous-v4.12.0) (2026-05-12)
|
|
4
27
|
|
|
5
28
|
|
package/dist/api.d.ts
CHANGED
|
@@ -770,6 +770,79 @@ export interface CreateConnectedOrganizationRequest {
|
|
|
770
770
|
* @memberof CreateConnectedOrganizationRequest
|
|
771
771
|
*/
|
|
772
772
|
'client_id': string;
|
|
773
|
+
/**
|
|
774
|
+
*
|
|
775
|
+
* @type {CreateConnectedOrganizationRequestKybPrefill}
|
|
776
|
+
* @memberof CreateConnectedOrganizationRequest
|
|
777
|
+
*/
|
|
778
|
+
'kyb_prefill'?: CreateConnectedOrganizationRequestKybPrefill;
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* Optional KYB details to forward for the end client. When provided, these values prefill the end client\'s onboarding form. Every field is optional.
|
|
782
|
+
* @export
|
|
783
|
+
* @interface CreateConnectedOrganizationRequestKybPrefill
|
|
784
|
+
*/
|
|
785
|
+
export interface CreateConnectedOrganizationRequestKybPrefill {
|
|
786
|
+
/**
|
|
787
|
+
* The registered legal name of the company.
|
|
788
|
+
* @type {string}
|
|
789
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
790
|
+
*/
|
|
791
|
+
'company_name'?: string;
|
|
792
|
+
/**
|
|
793
|
+
* The trade name (DBA) the company operates under, if different from its legal name.
|
|
794
|
+
* @type {string}
|
|
795
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
796
|
+
*/
|
|
797
|
+
'doing_business_as'?: string;
|
|
798
|
+
/**
|
|
799
|
+
* The company\'s legal entity type. Free-form text; any value is accepted. Common values include `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`.
|
|
800
|
+
* @type {string}
|
|
801
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
802
|
+
*/
|
|
803
|
+
'company_structure'?: string;
|
|
804
|
+
/**
|
|
805
|
+
* The company\'s tax ID or registration number.
|
|
806
|
+
* @type {string}
|
|
807
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
808
|
+
*/
|
|
809
|
+
'company_registration_number'?: string;
|
|
810
|
+
/**
|
|
811
|
+
* The ISO 3166-1 alpha-2 country code of the company. Must be a supported country.
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
814
|
+
*/
|
|
815
|
+
'country_code'?: string;
|
|
816
|
+
/**
|
|
817
|
+
* The company\'s website URL. Must be a well-formed URL.
|
|
818
|
+
* @type {string}
|
|
819
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
820
|
+
*/
|
|
821
|
+
'website_url'?: string;
|
|
822
|
+
/**
|
|
823
|
+
* The company\'s street address.
|
|
824
|
+
* @type {string}
|
|
825
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
826
|
+
*/
|
|
827
|
+
'address_1'?: string;
|
|
828
|
+
/**
|
|
829
|
+
* The company\'s city.
|
|
830
|
+
* @type {string}
|
|
831
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
832
|
+
*/
|
|
833
|
+
'city'?: string;
|
|
834
|
+
/**
|
|
835
|
+
* The company\'s state or province.
|
|
836
|
+
* @type {string}
|
|
837
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
838
|
+
*/
|
|
839
|
+
'state'?: string;
|
|
840
|
+
/**
|
|
841
|
+
* The company\'s ZIP or postal code.
|
|
842
|
+
* @type {string}
|
|
843
|
+
* @memberof CreateConnectedOrganizationRequestKybPrefill
|
|
844
|
+
*/
|
|
845
|
+
'postal_code'?: string;
|
|
773
846
|
}
|
|
774
847
|
/**
|
|
775
848
|
*
|
|
@@ -2323,6 +2396,19 @@ export interface FraudConfigReviewEmail {
|
|
|
2323
2396
|
*/
|
|
2324
2397
|
'domains'?: Array<string>;
|
|
2325
2398
|
}
|
|
2399
|
+
/**
|
|
2400
|
+
*
|
|
2401
|
+
* @export
|
|
2402
|
+
* @interface FraudConfigReviewVpn
|
|
2403
|
+
*/
|
|
2404
|
+
export interface FraudConfigReviewVpn {
|
|
2405
|
+
/**
|
|
2406
|
+
* Whether Apple Private Relay traffic should be excluded from VPN fraud review. When omitted or false, Apple Private Relay traffic is flagged with other VPN and proxy traffic.
|
|
2407
|
+
* @type {boolean}
|
|
2408
|
+
* @memberof FraudConfigReviewVpn
|
|
2409
|
+
*/
|
|
2410
|
+
'skip_apple_private_relay'?: boolean;
|
|
2411
|
+
}
|
|
2326
2412
|
/**
|
|
2327
2413
|
*
|
|
2328
2414
|
* @export
|
|
@@ -2349,7 +2435,7 @@ export interface FraudReview {
|
|
|
2349
2435
|
*/
|
|
2350
2436
|
'status'?: FraudReviewStatusEnum;
|
|
2351
2437
|
/**
|
|
2352
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
2438
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
2353
2439
|
* @type {Array<string>}
|
|
2354
2440
|
* @memberof FraudReview
|
|
2355
2441
|
*/
|
|
@@ -2428,6 +2514,7 @@ export declare const FraudReviewReasonsEnum: {
|
|
|
2428
2514
|
readonly OverRewardAmountLimit: "Over reward amount limit";
|
|
2429
2515
|
readonly OverRewardCountLimit: "Over reward count limit";
|
|
2430
2516
|
readonly VpnDetected: "VPN detected";
|
|
2517
|
+
readonly ApplePrivateRelay: "Apple Private Relay";
|
|
2431
2518
|
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
2432
2519
|
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
2433
2520
|
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
@@ -2477,7 +2564,7 @@ export interface FraudReviewBase {
|
|
|
2477
2564
|
*/
|
|
2478
2565
|
'status'?: FraudReviewBaseStatusEnum;
|
|
2479
2566
|
/**
|
|
2480
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
2567
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
2481
2568
|
* @type {Array<string>}
|
|
2482
2569
|
* @memberof FraudReviewBase
|
|
2483
2570
|
*/
|
|
@@ -2544,6 +2631,7 @@ export declare const FraudReviewBaseReasonsEnum: {
|
|
|
2544
2631
|
readonly OverRewardAmountLimit: "Over reward amount limit";
|
|
2545
2632
|
readonly OverRewardCountLimit: "Over reward count limit";
|
|
2546
2633
|
readonly VpnDetected: "VPN detected";
|
|
2634
|
+
readonly ApplePrivateRelay: "Apple Private Relay";
|
|
2547
2635
|
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
2548
2636
|
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
2549
2637
|
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
@@ -2612,7 +2700,7 @@ export interface FraudReviewListItem {
|
|
|
2612
2700
|
*/
|
|
2613
2701
|
'status'?: FraudReviewListItemStatusEnum;
|
|
2614
2702
|
/**
|
|
2615
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
2703
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
2616
2704
|
* @type {Array<string>}
|
|
2617
2705
|
* @memberof FraudReviewListItem
|
|
2618
2706
|
*/
|
|
@@ -2679,6 +2767,7 @@ export declare const FraudReviewListItemReasonsEnum: {
|
|
|
2679
2767
|
readonly OverRewardAmountLimit: "Over reward amount limit";
|
|
2680
2768
|
readonly OverRewardCountLimit: "Over reward count limit";
|
|
2681
2769
|
readonly VpnDetected: "VPN detected";
|
|
2770
|
+
readonly ApplePrivateRelay: "Apple Private Relay";
|
|
2682
2771
|
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
2683
2772
|
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
2684
2773
|
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
@@ -2721,6 +2810,7 @@ export declare const FraudReviewReason: {
|
|
|
2721
2810
|
readonly OverRewardAmountLimit: "Over reward amount limit";
|
|
2722
2811
|
readonly OverRewardCountLimit: "Over reward count limit";
|
|
2723
2812
|
readonly VpnDetected: "VPN detected";
|
|
2813
|
+
readonly ApplePrivateRelay: "Apple Private Relay";
|
|
2724
2814
|
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
2725
2815
|
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
2726
2816
|
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
@@ -2927,6 +3017,12 @@ export interface FraudRuleRequestConfig {
|
|
|
2927
3017
|
* @memberof FraudRuleRequestConfig
|
|
2928
3018
|
*/
|
|
2929
3019
|
'period': FraudRuleRequestConfigPeriodEnum;
|
|
3020
|
+
/**
|
|
3021
|
+
* Whether Apple Private Relay traffic should be excluded from VPN fraud review. When omitted or false, Apple Private Relay traffic is flagged with other VPN and proxy traffic.
|
|
3022
|
+
* @type {boolean}
|
|
3023
|
+
* @memberof FraudRuleRequestConfig
|
|
3024
|
+
*/
|
|
3025
|
+
'skip_apple_private_relay'?: boolean;
|
|
2930
3026
|
}
|
|
2931
3027
|
export declare const FraudRuleRequestConfigTypeEnum: {
|
|
2932
3028
|
readonly Whitelist: "whitelist";
|
|
@@ -2943,7 +3039,7 @@ export declare const FraudRuleRequestConfigPeriodEnum: {
|
|
|
2943
3039
|
};
|
|
2944
3040
|
export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeriodEnum[keyof typeof FraudRuleRequestConfigPeriodEnum];
|
|
2945
3041
|
/**
|
|
2946
|
-
* * `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
|
|
3042
|
+
* * `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 or proxy use is suspected. Can be configured to exclude Apple Private Relay. * `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
|
|
2947
3043
|
* @export
|
|
2948
3044
|
* @enum {string}
|
|
2949
3045
|
*/
|
|
@@ -2968,7 +3064,7 @@ export type FraudRuleType = typeof FraudRuleType[keyof typeof FraudRuleType];
|
|
|
2968
3064
|
*/
|
|
2969
3065
|
export interface FraudRulesListItem {
|
|
2970
3066
|
/**
|
|
2971
|
-
* * `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
|
|
3067
|
+
* * `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 or proxy use is suspected. Can be configured to exclude Apple Private Relay. * `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
|
|
2972
3068
|
* @type {string}
|
|
2973
3069
|
* @memberof FraudRulesListItem
|
|
2974
3070
|
*/
|
|
@@ -3141,7 +3237,7 @@ export interface GetFraudReview200ResponseFraudReview {
|
|
|
3141
3237
|
*/
|
|
3142
3238
|
'status'?: GetFraudReview200ResponseFraudReviewStatusEnum;
|
|
3143
3239
|
/**
|
|
3144
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
3240
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
3145
3241
|
* @type {Array<string>}
|
|
3146
3242
|
* @memberof GetFraudReview200ResponseFraudReview
|
|
3147
3243
|
*/
|
|
@@ -3220,6 +3316,7 @@ export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
|
|
|
3220
3316
|
readonly OverRewardAmountLimit: "Over reward amount limit";
|
|
3221
3317
|
readonly OverRewardCountLimit: "Over reward count limit";
|
|
3222
3318
|
readonly VpnDetected: "VPN detected";
|
|
3319
|
+
readonly ApplePrivateRelay: "Apple Private Relay";
|
|
3223
3320
|
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
3224
3321
|
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
3225
3322
|
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
@@ -4271,7 +4368,7 @@ export interface ListFraudReviews200ResponseFraudReviewsInner {
|
|
|
4271
4368
|
*/
|
|
4272
4369
|
'status'?: ListFraudReviews200ResponseFraudReviewsInnerStatusEnum;
|
|
4273
4370
|
/**
|
|
4274
|
-
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
4371
|
+
* The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country`
|
|
4275
4372
|
* @type {Array<string>}
|
|
4276
4373
|
* @memberof ListFraudReviews200ResponseFraudReviewsInner
|
|
4277
4374
|
*/
|
|
@@ -4338,6 +4435,7 @@ export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: {
|
|
|
4338
4435
|
readonly OverRewardAmountLimit: "Over reward amount limit";
|
|
4339
4436
|
readonly OverRewardCountLimit: "Over reward count limit";
|
|
4340
4437
|
readonly VpnDetected: "VPN detected";
|
|
4438
|
+
readonly ApplePrivateRelay: "Apple Private Relay";
|
|
4341
4439
|
readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
|
|
4342
4440
|
readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
|
|
4343
4441
|
readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
|
|
@@ -4413,7 +4511,7 @@ export interface ListFraudRules200Response {
|
|
|
4413
4511
|
*/
|
|
4414
4512
|
export interface ListFraudRules200ResponseFraudRulesInner {
|
|
4415
4513
|
/**
|
|
4416
|
-
* * `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
|
|
4514
|
+
* * `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 or proxy use is suspected. Can be configured to exclude Apple Private Relay. * `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
|
|
4417
4515
|
* @type {string}
|
|
4418
4516
|
* @memberof ListFraudRules200ResponseFraudRulesInner
|
|
4419
4517
|
*/
|
|
@@ -5209,7 +5307,7 @@ export interface ListProductsResponseProductsInner {
|
|
|
5209
5307
|
*/
|
|
5210
5308
|
'description': string;
|
|
5211
5309
|
/**
|
|
5212
|
-
* The category of the product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>instant_debit_transfer</code></td> <td>Instant debit transfer to the recipient</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> <tr> <td><code>cash_app</code></td> <td>Payout via Cash App</td> </tr> <tr> <td><code>international_bank</code></td> <td>Bank transfer to recipients outside of the US</td> </tr> </tbody> </table>
|
|
5310
|
+
* The category of the product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>instant_debit_transfer</code></td> <td>Instant debit transfer to the recipient</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> <tr> <td><code>cash_app</code></td> <td>Payout via Cash App</td> </tr> <tr> <td><code>international_bank</code></td> <td>Bank transfer to recipients outside of the US</td> </tr> <tr> <td><code>wallet</code></td> <td>Payout to a digital wallet (e.g. GCash, MoMo)</td> </tr> </tbody> </table>
|
|
5213
5311
|
* @type {string}
|
|
5214
5312
|
* @memberof ListProductsResponseProductsInner
|
|
5215
5313
|
*/
|
|
@@ -5273,6 +5371,7 @@ export declare const ListProductsResponseProductsInnerCategoryEnum: {
|
|
|
5273
5371
|
readonly VisaCard: "visa_card";
|
|
5274
5372
|
readonly CashApp: "cash_app";
|
|
5275
5373
|
readonly InternationalBank: "international_bank";
|
|
5374
|
+
readonly Wallet: "wallet";
|
|
5276
5375
|
};
|
|
5277
5376
|
export type ListProductsResponseProductsInnerCategoryEnum = typeof ListProductsResponseProductsInnerCategoryEnum[keyof typeof ListProductsResponseProductsInnerCategoryEnum];
|
|
5278
5377
|
export declare const ListProductsResponseProductsInnerSubcategoryEnum: {
|
|
@@ -6992,7 +7091,7 @@ export interface Product {
|
|
|
6992
7091
|
*/
|
|
6993
7092
|
'description': string;
|
|
6994
7093
|
/**
|
|
6995
|
-
* The category of the product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>instant_debit_transfer</code></td> <td>Instant debit transfer to the recipient</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> <tr> <td><code>cash_app</code></td> <td>Payout via Cash App</td> </tr> <tr> <td><code>international_bank</code></td> <td>Bank transfer to recipients outside of the US</td> </tr> </tbody> </table>
|
|
7094
|
+
* The category of the product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>instant_debit_transfer</code></td> <td>Instant debit transfer to the recipient</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> <tr> <td><code>cash_app</code></td> <td>Payout via Cash App</td> </tr> <tr> <td><code>international_bank</code></td> <td>Bank transfer to recipients outside of the US</td> </tr> <tr> <td><code>wallet</code></td> <td>Payout to a digital wallet (e.g. GCash, MoMo)</td> </tr> </tbody> </table>
|
|
6996
7095
|
* @type {string}
|
|
6997
7096
|
* @memberof Product
|
|
6998
7097
|
*/
|
|
@@ -7056,6 +7155,7 @@ export declare const ProductCategoryEnum: {
|
|
|
7056
7155
|
readonly VisaCard: "visa_card";
|
|
7057
7156
|
readonly CashApp: "cash_app";
|
|
7058
7157
|
readonly InternationalBank: "international_bank";
|
|
7158
|
+
readonly Wallet: "wallet";
|
|
7059
7159
|
};
|
|
7060
7160
|
export type ProductCategoryEnum = typeof ProductCategoryEnum[keyof typeof ProductCategoryEnum];
|
|
7061
7161
|
export declare const ProductSubcategoryEnum: {
|
|
@@ -7495,6 +7595,19 @@ export declare const ReviewRedeemedRewardsCountPeriodEnum: {
|
|
|
7495
7595
|
readonly AllTime: "all_time";
|
|
7496
7596
|
};
|
|
7497
7597
|
export type ReviewRedeemedRewardsCountPeriodEnum = typeof ReviewRedeemedRewardsCountPeriodEnum[keyof typeof ReviewRedeemedRewardsCountPeriodEnum];
|
|
7598
|
+
/**
|
|
7599
|
+
* Flag rewards redeemed through VPN or proxy traffic. By default, Apple Private Relay traffic is flagged; set `skip_apple_private_relay` to true to exclude it.
|
|
7600
|
+
* @export
|
|
7601
|
+
* @interface ReviewVpn
|
|
7602
|
+
*/
|
|
7603
|
+
export interface ReviewVpn {
|
|
7604
|
+
/**
|
|
7605
|
+
* Whether Apple Private Relay traffic should be excluded from VPN fraud review. When omitted or false, Apple Private Relay traffic is flagged with other VPN and proxy traffic.
|
|
7606
|
+
* @type {boolean}
|
|
7607
|
+
* @memberof ReviewVpn
|
|
7608
|
+
*/
|
|
7609
|
+
'skip_apple_private_relay'?: boolean;
|
|
7610
|
+
}
|
|
7498
7611
|
/**
|
|
7499
7612
|
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
7500
7613
|
* @export
|
|
@@ -9302,7 +9415,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
9302
9415
|
*/
|
|
9303
9416
|
export declare const ConnectedOrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9304
9417
|
/**
|
|
9305
|
-
* Create a connected organization.
|
|
9418
|
+
* Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
9306
9419
|
* @summary Create connected organization
|
|
9307
9420
|
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
9308
9421
|
* @param {*} [options] Override http request option.
|
|
@@ -9341,7 +9454,7 @@ export declare const ConnectedOrganizationsApiAxiosParamCreator: (configuration?
|
|
|
9341
9454
|
*/
|
|
9342
9455
|
export declare const ConnectedOrganizationsApiFp: (configuration?: Configuration) => {
|
|
9343
9456
|
/**
|
|
9344
|
-
* Create a connected organization.
|
|
9457
|
+
* Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
9345
9458
|
* @summary Create connected organization
|
|
9346
9459
|
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
9347
9460
|
* @param {*} [options] Override http request option.
|
|
@@ -9380,7 +9493,7 @@ export declare const ConnectedOrganizationsApiFp: (configuration?: Configuration
|
|
|
9380
9493
|
*/
|
|
9381
9494
|
export declare const ConnectedOrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9382
9495
|
/**
|
|
9383
|
-
* Create a connected organization.
|
|
9496
|
+
* Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
9384
9497
|
* @summary Create connected organization
|
|
9385
9498
|
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
9386
9499
|
* @param {*} [options] Override http request option.
|
|
@@ -9421,7 +9534,7 @@ export declare const ConnectedOrganizationsApiFactory: (configuration?: Configur
|
|
|
9421
9534
|
*/
|
|
9422
9535
|
export declare class ConnectedOrganizationsApi extends BaseAPI {
|
|
9423
9536
|
/**
|
|
9424
|
-
* Create a connected organization.
|
|
9537
|
+
* Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
9425
9538
|
* @summary Create connected organization
|
|
9426
9539
|
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
9427
9540
|
* @param {*} [options] Override http request option.
|
|
@@ -9813,7 +9926,7 @@ export declare const FraudRulesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
9813
9926
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
9814
9927
|
* @summary Configure fraud rule
|
|
9815
9928
|
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
9816
|
-
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `
|
|
9929
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged.
|
|
9817
9930
|
* @param {*} [options] Override http request option.
|
|
9818
9931
|
* @throws {RequiredError}
|
|
9819
9932
|
*/
|
|
@@ -9852,7 +9965,7 @@ export declare const FraudRulesApiFp: (configuration?: Configuration) => {
|
|
|
9852
9965
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
9853
9966
|
* @summary Configure fraud rule
|
|
9854
9967
|
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
9855
|
-
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `
|
|
9968
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged.
|
|
9856
9969
|
* @param {*} [options] Override http request option.
|
|
9857
9970
|
* @throws {RequiredError}
|
|
9858
9971
|
*/
|
|
@@ -9891,7 +10004,7 @@ export declare const FraudRulesApiFactory: (configuration?: Configuration, baseP
|
|
|
9891
10004
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
9892
10005
|
* @summary Configure fraud rule
|
|
9893
10006
|
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
9894
|
-
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `
|
|
10007
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged.
|
|
9895
10008
|
* @param {*} [options] Override http request option.
|
|
9896
10009
|
* @throws {RequiredError}
|
|
9897
10010
|
*/
|
|
@@ -9933,7 +10046,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9933
10046
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
9934
10047
|
* @summary Configure fraud rule
|
|
9935
10048
|
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
9936
|
-
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `
|
|
10049
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged.
|
|
9937
10050
|
* @param {*} [options] Override http request option.
|
|
9938
10051
|
* @throws {RequiredError}
|
|
9939
10052
|
* @memberof FraudRulesApi
|
package/dist/api.js
CHANGED
|
@@ -372,6 +372,7 @@ exports.FraudReviewReasonsEnum = {
|
|
|
372
372
|
OverRewardAmountLimit: 'Over reward amount limit',
|
|
373
373
|
OverRewardCountLimit: 'Over reward count limit',
|
|
374
374
|
VpnDetected: 'VPN detected',
|
|
375
|
+
ApplePrivateRelay: 'Apple Private Relay',
|
|
375
376
|
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
376
377
|
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
377
378
|
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
@@ -417,6 +418,7 @@ exports.FraudReviewBaseReasonsEnum = {
|
|
|
417
418
|
OverRewardAmountLimit: 'Over reward amount limit',
|
|
418
419
|
OverRewardCountLimit: 'Over reward count limit',
|
|
419
420
|
VpnDetected: 'VPN detected',
|
|
421
|
+
ApplePrivateRelay: 'Apple Private Relay',
|
|
420
422
|
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
421
423
|
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
422
424
|
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
@@ -457,6 +459,7 @@ exports.FraudReviewListItemReasonsEnum = {
|
|
|
457
459
|
OverRewardAmountLimit: 'Over reward amount limit',
|
|
458
460
|
OverRewardCountLimit: 'Over reward count limit',
|
|
459
461
|
VpnDetected: 'VPN detected',
|
|
462
|
+
ApplePrivateRelay: 'Apple Private Relay',
|
|
460
463
|
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
461
464
|
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
462
465
|
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
@@ -497,6 +500,7 @@ exports.FraudReviewReason = {
|
|
|
497
500
|
OverRewardAmountLimit: 'Over reward amount limit',
|
|
498
501
|
OverRewardCountLimit: 'Over reward count limit',
|
|
499
502
|
VpnDetected: 'VPN detected',
|
|
503
|
+
ApplePrivateRelay: 'Apple Private Relay',
|
|
500
504
|
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
501
505
|
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
502
506
|
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
@@ -563,7 +567,7 @@ exports.FraudRuleRequestConfigPeriodEnum = {
|
|
|
563
567
|
AllTime: 'all_time'
|
|
564
568
|
};
|
|
565
569
|
/**
|
|
566
|
-
* * `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
|
|
570
|
+
* * `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 or proxy use is suspected. Can be configured to exclude Apple Private Relay. * `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
|
|
567
571
|
* @export
|
|
568
572
|
* @enum {string}
|
|
569
573
|
*/
|
|
@@ -626,6 +630,7 @@ exports.GetFraudReview200ResponseFraudReviewReasonsEnum = {
|
|
|
626
630
|
OverRewardAmountLimit: 'Over reward amount limit',
|
|
627
631
|
OverRewardCountLimit: 'Over reward count limit',
|
|
628
632
|
VpnDetected: 'VPN detected',
|
|
633
|
+
ApplePrivateRelay: 'Apple Private Relay',
|
|
629
634
|
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
630
635
|
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
631
636
|
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
@@ -720,6 +725,7 @@ exports.ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = {
|
|
|
720
725
|
OverRewardAmountLimit: 'Over reward amount limit',
|
|
721
726
|
OverRewardCountLimit: 'Over reward count limit',
|
|
722
727
|
VpnDetected: 'VPN detected',
|
|
728
|
+
ApplePrivateRelay: 'Apple Private Relay',
|
|
723
729
|
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
724
730
|
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
725
731
|
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
@@ -851,7 +857,8 @@ exports.ListProductsResponseProductsInnerCategoryEnum = {
|
|
|
851
857
|
Venmo: 'venmo',
|
|
852
858
|
VisaCard: 'visa_card',
|
|
853
859
|
CashApp: 'cash_app',
|
|
854
|
-
InternationalBank: 'international_bank'
|
|
860
|
+
InternationalBank: 'international_bank',
|
|
861
|
+
Wallet: 'wallet'
|
|
855
862
|
};
|
|
856
863
|
exports.ListProductsResponseProductsInnerSubcategoryEnum = {
|
|
857
864
|
BeautyAndHealth: 'beauty_and_health',
|
|
@@ -1236,7 +1243,8 @@ exports.ProductCategoryEnum = {
|
|
|
1236
1243
|
Venmo: 'venmo',
|
|
1237
1244
|
VisaCard: 'visa_card',
|
|
1238
1245
|
CashApp: 'cash_app',
|
|
1239
|
-
InternationalBank: 'international_bank'
|
|
1246
|
+
InternationalBank: 'international_bank',
|
|
1247
|
+
Wallet: 'wallet'
|
|
1240
1248
|
};
|
|
1241
1249
|
exports.ProductSubcategoryEnum = {
|
|
1242
1250
|
BeautyAndHealth: 'beauty_and_health',
|
|
@@ -2440,7 +2448,7 @@ exports.ConnectedOrganizationMembersApi = ConnectedOrganizationMembersApi;
|
|
|
2440
2448
|
const ConnectedOrganizationsApiAxiosParamCreator = function (configuration) {
|
|
2441
2449
|
return {
|
|
2442
2450
|
/**
|
|
2443
|
-
* Create a connected organization.
|
|
2451
|
+
* Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
2444
2452
|
* @summary Create connected organization
|
|
2445
2453
|
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
2446
2454
|
* @param {*} [options] Override http request option.
|
|
@@ -2583,7 +2591,7 @@ const ConnectedOrganizationsApiFp = function (configuration) {
|
|
|
2583
2591
|
const localVarAxiosParamCreator = (0, exports.ConnectedOrganizationsApiAxiosParamCreator)(configuration);
|
|
2584
2592
|
return {
|
|
2585
2593
|
/**
|
|
2586
|
-
* Create a connected organization.
|
|
2594
|
+
* Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
2587
2595
|
* @summary Create connected organization
|
|
2588
2596
|
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
2589
2597
|
* @param {*} [options] Override http request option.
|
|
@@ -2658,7 +2666,7 @@ const ConnectedOrganizationsApiFactory = function (configuration, basePath, axio
|
|
|
2658
2666
|
const localVarFp = (0, exports.ConnectedOrganizationsApiFp)(configuration);
|
|
2659
2667
|
return {
|
|
2660
2668
|
/**
|
|
2661
|
-
* Create a connected organization.
|
|
2669
|
+
* Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
2662
2670
|
* @summary Create connected organization
|
|
2663
2671
|
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
2664
2672
|
* @param {*} [options] Override http request option.
|
|
@@ -2709,7 +2717,7 @@ exports.ConnectedOrganizationsApiFactory = ConnectedOrganizationsApiFactory;
|
|
|
2709
2717
|
*/
|
|
2710
2718
|
class ConnectedOrganizationsApi extends base_1.BaseAPI {
|
|
2711
2719
|
/**
|
|
2712
|
-
* Create a connected organization.
|
|
2720
|
+
* Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
2713
2721
|
* @summary Create connected organization
|
|
2714
2722
|
* @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
|
|
2715
2723
|
* @param {*} [options] Override http request option.
|
|
@@ -3438,7 +3446,7 @@ const FraudRulesApiAxiosParamCreator = function (configuration) {
|
|
|
3438
3446
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
3439
3447
|
* @summary Configure fraud rule
|
|
3440
3448
|
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
3441
|
-
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `
|
|
3449
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged.
|
|
3442
3450
|
* @param {*} [options] Override http request option.
|
|
3443
3451
|
* @throws {RequiredError}
|
|
3444
3452
|
*/
|
|
@@ -3564,7 +3572,7 @@ const FraudRulesApiFp = function (configuration) {
|
|
|
3564
3572
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
3565
3573
|
* @summary Configure fraud rule
|
|
3566
3574
|
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
3567
|
-
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `
|
|
3575
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged.
|
|
3568
3576
|
* @param {*} [options] Override http request option.
|
|
3569
3577
|
* @throws {RequiredError}
|
|
3570
3578
|
*/
|
|
@@ -3633,7 +3641,7 @@ const FraudRulesApiFactory = function (configuration, basePath, axios) {
|
|
|
3633
3641
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
3634
3642
|
* @summary Configure fraud rule
|
|
3635
3643
|
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
3636
|
-
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `
|
|
3644
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged.
|
|
3637
3645
|
* @param {*} [options] Override http request option.
|
|
3638
3646
|
* @throws {RequiredError}
|
|
3639
3647
|
*/
|
|
@@ -3685,7 +3693,7 @@ class FraudRulesApi extends base_1.BaseAPI {
|
|
|
3685
3693
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
3686
3694
|
* @summary Configure fraud rule
|
|
3687
3695
|
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
3688
|
-
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `
|
|
3696
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged.
|
|
3689
3697
|
* @param {*} [options] Override http request option.
|
|
3690
3698
|
* @throws {RequiredError}
|
|
3691
3699
|
* @memberof FraudRulesApi
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tremendous",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.14.0",
|
|
4
4
|
"description": "A node.js client for the Tremendous API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"tremendous",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"axios": "^1.6.1"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@types/node": "^
|
|
32
|
+
"@types/node": "^26.0.1",
|
|
33
33
|
"typescript": "^6.0.2",
|
|
34
34
|
"vitest": "^4.0.6"
|
|
35
35
|
},
|