tremendous 4.12.0 → 4.13.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.
@@ -1,3 +1,3 @@
1
1
  {
2
- ".": "4.12.0"
2
+ ".": "4.13.0"
3
3
  }
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.13.0](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.12.0...tremendous-v4.13.0) (2026-06-09)
4
+
5
+
6
+ ### Features
7
+
8
+ * add `Apple Private Relay` fraud review reason ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
9
+ * add `prefilled_kyb_details` to connected org response ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
10
+ * add `skip_apple_private_relay` to VPN fraud rule ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
11
+ * add `wallet` product category ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
12
+ * add optional `kyb` prefill to connected orgs ([d15d5ae](https://github.com/tremendous-rewards/tremendous-node/commit/d15d5aedfb4e107978cea0c45708493b9f023af0))
13
+
3
14
  ## [4.12.0](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.11.0...tremendous-v4.12.0) (2026-05-12)
4
15
 
5
16
 
package/dist/api.d.ts CHANGED
@@ -368,6 +368,12 @@ export interface ConnectedOrganization {
368
368
  * @memberof ConnectedOrganization
369
369
  */
370
370
  'organization'?: ConnectedOrganizationOrganization | null;
371
+ /**
372
+ *
373
+ * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails}
374
+ * @memberof ConnectedOrganization
375
+ */
376
+ 'prefilled_kyb_details'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails | null;
371
377
  }
372
378
  /**
373
379
  *
@@ -770,6 +776,61 @@ export interface CreateConnectedOrganizationRequest {
770
776
  * @memberof CreateConnectedOrganizationRequest
771
777
  */
772
778
  'client_id': string;
779
+ /**
780
+ *
781
+ * @type {CreateConnectedOrganizationRequestKyb}
782
+ * @memberof CreateConnectedOrganizationRequest
783
+ */
784
+ 'kyb'?: CreateConnectedOrganizationRequestKyb;
785
+ }
786
+ /**
787
+ * Optional KYB details to forward for the end client. When provided, these values pre-fill the end client\'s onboarding form and remain fully editable; the end client still reviews and submits. Every field is optional.
788
+ * @export
789
+ * @interface CreateConnectedOrganizationRequestKyb
790
+ */
791
+ export interface CreateConnectedOrganizationRequestKyb {
792
+ /**
793
+ * The registered legal name of the company.
794
+ * @type {string}
795
+ * @memberof CreateConnectedOrganizationRequestKyb
796
+ */
797
+ 'company_name'?: string;
798
+ /**
799
+ * The trade name (DBA) the company operates under, if different from its legal name.
800
+ * @type {string}
801
+ * @memberof CreateConnectedOrganizationRequestKyb
802
+ */
803
+ 'doing_business_as'?: string;
804
+ /**
805
+ * The company\'s legal entity type. Free-form text — any value is accepted to support entity types outside the common presets. Common values are `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`.
806
+ * @type {string}
807
+ * @memberof CreateConnectedOrganizationRequestKyb
808
+ */
809
+ 'company_structure'?: string;
810
+ /**
811
+ * The company\'s tax ID or registration number.
812
+ * @type {string}
813
+ * @memberof CreateConnectedOrganizationRequestKyb
814
+ */
815
+ 'company_registration_number'?: string;
816
+ /**
817
+ * The ISO 3166-1 alpha-2 country code of the company. Must be a supported country.
818
+ * @type {string}
819
+ * @memberof CreateConnectedOrganizationRequestKyb
820
+ */
821
+ 'country_code'?: string;
822
+ /**
823
+ * The company\'s website URL. Must be a well-formed URL.
824
+ * @type {string}
825
+ * @memberof CreateConnectedOrganizationRequestKyb
826
+ */
827
+ 'website_url'?: string;
828
+ /**
829
+ *
830
+ * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress}
831
+ * @memberof CreateConnectedOrganizationRequestKyb
832
+ */
833
+ 'address'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress;
773
834
  }
774
835
  /**
775
836
  *
@@ -2323,6 +2384,19 @@ export interface FraudConfigReviewEmail {
2323
2384
  */
2324
2385
  'domains'?: Array<string>;
2325
2386
  }
2387
+ /**
2388
+ *
2389
+ * @export
2390
+ * @interface FraudConfigReviewVpn
2391
+ */
2392
+ export interface FraudConfigReviewVpn {
2393
+ /**
2394
+ * 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.
2395
+ * @type {boolean}
2396
+ * @memberof FraudConfigReviewVpn
2397
+ */
2398
+ 'skip_apple_private_relay'?: boolean;
2399
+ }
2326
2400
  /**
2327
2401
  *
2328
2402
  * @export
@@ -2349,7 +2423,7 @@ export interface FraudReview {
2349
2423
  */
2350
2424
  'status'?: FraudReviewStatusEnum;
2351
2425
  /**
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`
2426
+ * 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
2427
  * @type {Array<string>}
2354
2428
  * @memberof FraudReview
2355
2429
  */
@@ -2428,6 +2502,7 @@ export declare const FraudReviewReasonsEnum: {
2428
2502
  readonly OverRewardAmountLimit: "Over reward amount limit";
2429
2503
  readonly OverRewardCountLimit: "Over reward count limit";
2430
2504
  readonly VpnDetected: "VPN detected";
2505
+ readonly ApplePrivateRelay: "Apple Private Relay";
2431
2506
  readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2432
2507
  readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2433
2508
  readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
@@ -2477,7 +2552,7 @@ export interface FraudReviewBase {
2477
2552
  */
2478
2553
  'status'?: FraudReviewBaseStatusEnum;
2479
2554
  /**
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`
2555
+ * 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
2556
  * @type {Array<string>}
2482
2557
  * @memberof FraudReviewBase
2483
2558
  */
@@ -2544,6 +2619,7 @@ export declare const FraudReviewBaseReasonsEnum: {
2544
2619
  readonly OverRewardAmountLimit: "Over reward amount limit";
2545
2620
  readonly OverRewardCountLimit: "Over reward count limit";
2546
2621
  readonly VpnDetected: "VPN detected";
2622
+ readonly ApplePrivateRelay: "Apple Private Relay";
2547
2623
  readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2548
2624
  readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2549
2625
  readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
@@ -2612,7 +2688,7 @@ export interface FraudReviewListItem {
2612
2688
  */
2613
2689
  'status'?: FraudReviewListItemStatusEnum;
2614
2690
  /**
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`
2691
+ * 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
2692
  * @type {Array<string>}
2617
2693
  * @memberof FraudReviewListItem
2618
2694
  */
@@ -2679,6 +2755,7 @@ export declare const FraudReviewListItemReasonsEnum: {
2679
2755
  readonly OverRewardAmountLimit: "Over reward amount limit";
2680
2756
  readonly OverRewardCountLimit: "Over reward count limit";
2681
2757
  readonly VpnDetected: "VPN detected";
2758
+ readonly ApplePrivateRelay: "Apple Private Relay";
2682
2759
  readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2683
2760
  readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2684
2761
  readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
@@ -2721,6 +2798,7 @@ export declare const FraudReviewReason: {
2721
2798
  readonly OverRewardAmountLimit: "Over reward amount limit";
2722
2799
  readonly OverRewardCountLimit: "Over reward count limit";
2723
2800
  readonly VpnDetected: "VPN detected";
2801
+ readonly ApplePrivateRelay: "Apple Private Relay";
2724
2802
  readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2725
2803
  readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2726
2804
  readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
@@ -2927,6 +3005,12 @@ export interface FraudRuleRequestConfig {
2927
3005
  * @memberof FraudRuleRequestConfig
2928
3006
  */
2929
3007
  'period': FraudRuleRequestConfigPeriodEnum;
3008
+ /**
3009
+ * 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.
3010
+ * @type {boolean}
3011
+ * @memberof FraudRuleRequestConfig
3012
+ */
3013
+ 'skip_apple_private_relay'?: boolean;
2930
3014
  }
2931
3015
  export declare const FraudRuleRequestConfigTypeEnum: {
2932
3016
  readonly Whitelist: "whitelist";
@@ -2943,7 +3027,7 @@ export declare const FraudRuleRequestConfigPeriodEnum: {
2943
3027
  };
2944
3028
  export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeriodEnum[keyof typeof FraudRuleRequestConfigPeriodEnum];
2945
3029
  /**
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
3030
+ * * `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
3031
  * @export
2948
3032
  * @enum {string}
2949
3033
  */
@@ -2968,7 +3052,7 @@ export type FraudRuleType = typeof FraudRuleType[keyof typeof FraudRuleType];
2968
3052
  */
2969
3053
  export interface FraudRulesListItem {
2970
3054
  /**
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
3055
+ * * `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
3056
  * @type {string}
2973
3057
  * @memberof FraudRulesListItem
2974
3058
  */
@@ -3141,7 +3225,7 @@ export interface GetFraudReview200ResponseFraudReview {
3141
3225
  */
3142
3226
  'status'?: GetFraudReview200ResponseFraudReviewStatusEnum;
3143
3227
  /**
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`
3228
+ * 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
3229
  * @type {Array<string>}
3146
3230
  * @memberof GetFraudReview200ResponseFraudReview
3147
3231
  */
@@ -3220,6 +3304,7 @@ export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
3220
3304
  readonly OverRewardAmountLimit: "Over reward amount limit";
3221
3305
  readonly OverRewardCountLimit: "Over reward count limit";
3222
3306
  readonly VpnDetected: "VPN detected";
3307
+ readonly ApplePrivateRelay: "Apple Private Relay";
3223
3308
  readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
3224
3309
  readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
3225
3310
  readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
@@ -4084,6 +4169,12 @@ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInne
4084
4169
  * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner
4085
4170
  */
4086
4171
  'organization'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization | null;
4172
+ /**
4173
+ *
4174
+ * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails}
4175
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner
4176
+ */
4177
+ 'prefilled_kyb_details'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails | null;
4087
4178
  }
4088
4179
  /**
4089
4180
  * Associated `organization` resource. `null` until the registration flow for the connected organization has been completed.
@@ -4134,6 +4225,86 @@ export declare const ListConnectedOrganizations200ResponseConnectedOrganizations
4134
4225
  readonly Rejected: "REJECTED";
4135
4226
  };
4136
4227
  export type ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum = typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum[keyof typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum];
4228
+ /**
4229
+ * The optional KYB details forwarded when the connected organization was created (see the `kyb` request object), stored to pre-fill the end client\'s onboarding form. Only returned on the create response — it is omitted from the list, retrieve, and delete responses and from webhook payloads. `null` when no KYB details were provided.
4230
+ * @export
4231
+ * @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4232
+ */
4233
+ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails {
4234
+ /**
4235
+ * The registered legal name of the company.
4236
+ * @type {string}
4237
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4238
+ */
4239
+ 'company_name'?: string;
4240
+ /**
4241
+ * The trade name (DBA) the company operates under, if different from its legal name.
4242
+ * @type {string}
4243
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4244
+ */
4245
+ 'doing_business_as'?: string;
4246
+ /**
4247
+ * The company\'s legal entity type. Free-form text — any value is accepted to support entity types outside the common presets. Common values are `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`.
4248
+ * @type {string}
4249
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4250
+ */
4251
+ 'company_structure'?: string;
4252
+ /**
4253
+ * The company\'s tax ID or registration number.
4254
+ * @type {string}
4255
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4256
+ */
4257
+ 'company_registration_number'?: string;
4258
+ /**
4259
+ * The ISO 3166-1 alpha-2 country code of the company.
4260
+ * @type {string}
4261
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4262
+ */
4263
+ 'country_code'?: string;
4264
+ /**
4265
+ * The company\'s website URL.
4266
+ * @type {string}
4267
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4268
+ */
4269
+ 'website_url'?: string;
4270
+ /**
4271
+ *
4272
+ * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress}
4273
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
4274
+ */
4275
+ 'address'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress;
4276
+ }
4277
+ /**
4278
+ * The company\'s address.
4279
+ * @export
4280
+ * @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4281
+ */
4282
+ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress {
4283
+ /**
4284
+ * Street address.
4285
+ * @type {string}
4286
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4287
+ */
4288
+ 'line1'?: string;
4289
+ /**
4290
+ * City.
4291
+ * @type {string}
4292
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4293
+ */
4294
+ 'city'?: string;
4295
+ /**
4296
+ * State, province, or region.
4297
+ * @type {string}
4298
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4299
+ */
4300
+ 'state'?: string;
4301
+ /**
4302
+ * ZIP or postal code.
4303
+ * @type {string}
4304
+ * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
4305
+ */
4306
+ 'zip'?: string;
4307
+ }
4137
4308
  /**
4138
4309
  *
4139
4310
  * @export
@@ -4271,7 +4442,7 @@ export interface ListFraudReviews200ResponseFraudReviewsInner {
4271
4442
  */
4272
4443
  'status'?: ListFraudReviews200ResponseFraudReviewsInnerStatusEnum;
4273
4444
  /**
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`
4445
+ * 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
4446
  * @type {Array<string>}
4276
4447
  * @memberof ListFraudReviews200ResponseFraudReviewsInner
4277
4448
  */
@@ -4338,6 +4509,7 @@ export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: {
4338
4509
  readonly OverRewardAmountLimit: "Over reward amount limit";
4339
4510
  readonly OverRewardCountLimit: "Over reward count limit";
4340
4511
  readonly VpnDetected: "VPN detected";
4512
+ readonly ApplePrivateRelay: "Apple Private Relay";
4341
4513
  readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
4342
4514
  readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
4343
4515
  readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
@@ -4413,7 +4585,7 @@ export interface ListFraudRules200Response {
4413
4585
  */
4414
4586
  export interface ListFraudRules200ResponseFraudRulesInner {
4415
4587
  /**
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
4588
+ * * `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
4589
  * @type {string}
4418
4590
  * @memberof ListFraudRules200ResponseFraudRulesInner
4419
4591
  */
@@ -5209,7 +5381,7 @@ export interface ListProductsResponseProductsInner {
5209
5381
  */
5210
5382
  'description': string;
5211
5383
  /**
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>
5384
+ * 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
5385
  * @type {string}
5214
5386
  * @memberof ListProductsResponseProductsInner
5215
5387
  */
@@ -5273,6 +5445,7 @@ export declare const ListProductsResponseProductsInnerCategoryEnum: {
5273
5445
  readonly VisaCard: "visa_card";
5274
5446
  readonly CashApp: "cash_app";
5275
5447
  readonly InternationalBank: "international_bank";
5448
+ readonly Wallet: "wallet";
5276
5449
  };
5277
5450
  export type ListProductsResponseProductsInnerCategoryEnum = typeof ListProductsResponseProductsInnerCategoryEnum[keyof typeof ListProductsResponseProductsInnerCategoryEnum];
5278
5451
  export declare const ListProductsResponseProductsInnerSubcategoryEnum: {
@@ -6992,7 +7165,7 @@ export interface Product {
6992
7165
  */
6993
7166
  'description': string;
6994
7167
  /**
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>
7168
+ * 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
7169
  * @type {string}
6997
7170
  * @memberof Product
6998
7171
  */
@@ -7056,6 +7229,7 @@ export declare const ProductCategoryEnum: {
7056
7229
  readonly VisaCard: "visa_card";
7057
7230
  readonly CashApp: "cash_app";
7058
7231
  readonly InternationalBank: "international_bank";
7232
+ readonly Wallet: "wallet";
7059
7233
  };
7060
7234
  export type ProductCategoryEnum = typeof ProductCategoryEnum[keyof typeof ProductCategoryEnum];
7061
7235
  export declare const ProductSubcategoryEnum: {
@@ -7495,6 +7669,19 @@ export declare const ReviewRedeemedRewardsCountPeriodEnum: {
7495
7669
  readonly AllTime: "all_time";
7496
7670
  };
7497
7671
  export type ReviewRedeemedRewardsCountPeriodEnum = typeof ReviewRedeemedRewardsCountPeriodEnum[keyof typeof ReviewRedeemedRewardsCountPeriodEnum];
7672
+ /**
7673
+ * 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.
7674
+ * @export
7675
+ * @interface ReviewVpn
7676
+ */
7677
+ export interface ReviewVpn {
7678
+ /**
7679
+ * 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.
7680
+ * @type {boolean}
7681
+ * @memberof ReviewVpn
7682
+ */
7683
+ 'skip_apple_private_relay'?: boolean;
7684
+ }
7498
7685
  /**
7499
7686
  * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
7500
7687
  * @export
@@ -9302,7 +9489,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
9302
9489
  */
9303
9490
  export declare const ConnectedOrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
9304
9491
  /**
9305
- * Create a connected organization.
9492
+ * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
9306
9493
  * @summary Create connected organization
9307
9494
  * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
9308
9495
  * @param {*} [options] Override http request option.
@@ -9341,7 +9528,7 @@ export declare const ConnectedOrganizationsApiAxiosParamCreator: (configuration?
9341
9528
  */
9342
9529
  export declare const ConnectedOrganizationsApiFp: (configuration?: Configuration) => {
9343
9530
  /**
9344
- * Create a connected organization.
9531
+ * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
9345
9532
  * @summary Create connected organization
9346
9533
  * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
9347
9534
  * @param {*} [options] Override http request option.
@@ -9380,7 +9567,7 @@ export declare const ConnectedOrganizationsApiFp: (configuration?: Configuration
9380
9567
  */
9381
9568
  export declare const ConnectedOrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9382
9569
  /**
9383
- * Create a connected organization.
9570
+ * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
9384
9571
  * @summary Create connected organization
9385
9572
  * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
9386
9573
  * @param {*} [options] Override http request option.
@@ -9421,7 +9608,7 @@ export declare const ConnectedOrganizationsApiFactory: (configuration?: Configur
9421
9608
  */
9422
9609
  export declare class ConnectedOrganizationsApi extends BaseAPI {
9423
9610
  /**
9424
- * Create a connected organization.
9611
+ * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
9425
9612
  * @summary Create connected organization
9426
9613
  * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create
9427
9614
  * @param {*} [options] Override http request option.
@@ -9813,7 +10000,7 @@ export declare const FraudRulesApiAxiosParamCreator: (configuration?: Configurat
9813
10000
  * 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
10001
  * @summary Configure fraud rule
9815
10002
  * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
9816
- * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
10003
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body. &#x60;review_vpn&#x60; also accepts no body for the default behavior. Pass &#x60;config.skip_apple_private_relay&#x60; only to override whether Apple Private Relay traffic is flagged.
9817
10004
  * @param {*} [options] Override http request option.
9818
10005
  * @throws {RequiredError}
9819
10006
  */
@@ -9852,7 +10039,7 @@ export declare const FraudRulesApiFp: (configuration?: Configuration) => {
9852
10039
  * 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
10040
  * @summary Configure fraud rule
9854
10041
  * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
9855
- * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
10042
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body. &#x60;review_vpn&#x60; also accepts no body for the default behavior. Pass &#x60;config.skip_apple_private_relay&#x60; only to override whether Apple Private Relay traffic is flagged.
9856
10043
  * @param {*} [options] Override http request option.
9857
10044
  * @throws {RequiredError}
9858
10045
  */
@@ -9891,7 +10078,7 @@ export declare const FraudRulesApiFactory: (configuration?: Configuration, baseP
9891
10078
  * 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
10079
  * @summary Configure fraud rule
9893
10080
  * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
9894
- * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
10081
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body. &#x60;review_vpn&#x60; also accepts no body for the default behavior. Pass &#x60;config.skip_apple_private_relay&#x60; only to override whether Apple Private Relay traffic is flagged.
9895
10082
  * @param {*} [options] Override http request option.
9896
10083
  * @throws {RequiredError}
9897
10084
  */
@@ -9933,7 +10120,7 @@ export declare class FraudRulesApi extends BaseAPI {
9933
10120
  * 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
10121
  * @summary Configure fraud rule
9935
10122
  * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
9936
- * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
10123
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body. &#x60;review_vpn&#x60; also accepts no body for the default behavior. Pass &#x60;config.skip_apple_private_relay&#x60; only to override whether Apple Private Relay traffic is flagged.
9937
10124
  * @param {*} [options] Override http request option.
9938
10125
  * @throws {RequiredError}
9939
10126
  * @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` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
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` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
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` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
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` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only.
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 &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
3449
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body. &#x60;review_vpn&#x60; also accepts no body for the default behavior. Pass &#x60;config.skip_apple_private_relay&#x60; 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 &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
3575
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body. &#x60;review_vpn&#x60; also accepts no body for the default behavior. Pass &#x60;config.skip_apple_private_relay&#x60; 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 &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
3644
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body. &#x60;review_vpn&#x60; also accepts no body for the default behavior. Pass &#x60;config.skip_apple_private_relay&#x60; 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 &#x60;review_multiple_emails&#x60;, &#x60;review_vpn&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body.
3696
+ * @param {FraudRuleRequest} [fraudRuleRequest] Rules &#x60;review_multiple_emails&#x60;, &#x60;review_tremendous_flaglist&#x60;, and &#x60;review_previously_blocked_recipients&#x60; require no body. &#x60;review_vpn&#x60; also accepts no body for the default behavior. Pass &#x60;config.skip_apple_private_relay&#x60; 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.12.0",
3
+ "version": "4.13.0",
4
4
  "description": "A node.js client for the Tremendous API",
5
5
  "keywords": [
6
6
  "tremendous",