tremendous 4.0.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -683,6 +683,132 @@ export interface CreateConnectedOrganizationRequest {
683
683
  */
684
684
  'client_id': string;
685
685
  }
686
+ /**
687
+ *
688
+ * @export
689
+ * @interface CreateField
690
+ */
691
+ export interface CreateField {
692
+ /**
693
+ * A human-readable name for the field. Can contain letters, numbers, spaces, and underscores. The field\'s `label` (a reference name used in API requests) will be automatically derived from this value.
694
+ * @type {string}
695
+ * @memberof CreateField
696
+ */
697
+ 'display_name': string;
698
+ /**
699
+ * Type of the values of the field <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>Checkbox</code></td> <td>A boolean value (true/false)</td> </tr> <tr> <td><code>Currency</code></td> <td>A monetary value</td> </tr> <tr> <td><code>Date</code></td> <td>A date value</td> </tr> <tr> <td><code>Dropdown</code></td> <td>A single selection from predefined options (see <code>data.options</code>)</td> </tr> <tr> <td><code>Email</code></td> <td>An email address</td> </tr> <tr> <td><code>List</code></td> <td>Multiple selections from predefined options (see <code>data.options</code>)</td> </tr> <tr> <td><code>Number</code></td> <td>A numeric value</td> </tr> <tr> <td><code>Phone</code></td> <td>A phone number</td> </tr> <tr> <td><code>Text</code></td> <td>A single-line text value</td> </tr> <tr> <td><code>TextArea</code></td> <td>A multi-line text value</td> </tr> </tbody> </table>
700
+ * @type {string}
701
+ * @memberof CreateField
702
+ */
703
+ 'data_type': CreateFieldDataTypeEnum;
704
+ /**
705
+ *
706
+ * @type {CreateFieldRequestData}
707
+ * @memberof CreateField
708
+ */
709
+ 'data'?: CreateFieldRequestData;
710
+ /**
711
+ * Is this field required (true) or optional (false). Defaults to false.
712
+ * @type {boolean}
713
+ * @memberof CreateField
714
+ */
715
+ 'required'?: boolean;
716
+ /**
717
+ * A description of the field\'s purpose
718
+ * @type {string}
719
+ * @memberof CreateField
720
+ */
721
+ 'description'?: string;
722
+ }
723
+ export declare const CreateFieldDataTypeEnum: {
724
+ readonly Checkbox: "Checkbox";
725
+ readonly Currency: "Currency";
726
+ readonly Date: "Date";
727
+ readonly Dropdown: "Dropdown";
728
+ readonly Email: "Email";
729
+ readonly List: "List";
730
+ readonly Number: "Number";
731
+ readonly Phone: "Phone";
732
+ readonly Text: "Text";
733
+ readonly TextArea: "TextArea";
734
+ };
735
+ export type CreateFieldDataTypeEnum = typeof CreateFieldDataTypeEnum[keyof typeof CreateFieldDataTypeEnum];
736
+ /**
737
+ *
738
+ * @export
739
+ * @interface CreateField200Response
740
+ */
741
+ export interface CreateField200Response {
742
+ /**
743
+ *
744
+ * @type {ListFields200ResponseFieldsInner}
745
+ * @memberof CreateField200Response
746
+ */
747
+ 'field': ListFields200ResponseFieldsInner;
748
+ }
749
+ /**
750
+ *
751
+ * @export
752
+ * @interface CreateFieldRequest
753
+ */
754
+ export interface CreateFieldRequest {
755
+ /**
756
+ * A human-readable name for the field. Can contain letters, numbers, spaces, and underscores. The field\'s `label` (a reference name used in API requests) will be automatically derived from this value.
757
+ * @type {string}
758
+ * @memberof CreateFieldRequest
759
+ */
760
+ 'display_name': string;
761
+ /**
762
+ * Type of the values of the field <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>Checkbox</code></td> <td>A boolean value (true/false)</td> </tr> <tr> <td><code>Currency</code></td> <td>A monetary value</td> </tr> <tr> <td><code>Date</code></td> <td>A date value</td> </tr> <tr> <td><code>Dropdown</code></td> <td>A single selection from predefined options (see <code>data.options</code>)</td> </tr> <tr> <td><code>Email</code></td> <td>An email address</td> </tr> <tr> <td><code>List</code></td> <td>Multiple selections from predefined options (see <code>data.options</code>)</td> </tr> <tr> <td><code>Number</code></td> <td>A numeric value</td> </tr> <tr> <td><code>Phone</code></td> <td>A phone number</td> </tr> <tr> <td><code>Text</code></td> <td>A single-line text value</td> </tr> <tr> <td><code>TextArea</code></td> <td>A multi-line text value</td> </tr> </tbody> </table>
763
+ * @type {string}
764
+ * @memberof CreateFieldRequest
765
+ */
766
+ 'data_type': CreateFieldRequestDataTypeEnum;
767
+ /**
768
+ *
769
+ * @type {CreateFieldRequestData}
770
+ * @memberof CreateFieldRequest
771
+ */
772
+ 'data'?: CreateFieldRequestData;
773
+ /**
774
+ * Is this field required (true) or optional (false). Defaults to false.
775
+ * @type {boolean}
776
+ * @memberof CreateFieldRequest
777
+ */
778
+ 'required'?: boolean;
779
+ /**
780
+ * A description of the field\'s purpose
781
+ * @type {string}
782
+ * @memberof CreateFieldRequest
783
+ */
784
+ 'description'?: string;
785
+ }
786
+ export declare const CreateFieldRequestDataTypeEnum: {
787
+ readonly Checkbox: "Checkbox";
788
+ readonly Currency: "Currency";
789
+ readonly Date: "Date";
790
+ readonly Dropdown: "Dropdown";
791
+ readonly Email: "Email";
792
+ readonly List: "List";
793
+ readonly Number: "Number";
794
+ readonly Phone: "Phone";
795
+ readonly Text: "Text";
796
+ readonly TextArea: "TextArea";
797
+ };
798
+ export type CreateFieldRequestDataTypeEnum = typeof CreateFieldRequestDataTypeEnum[keyof typeof CreateFieldRequestDataTypeEnum];
799
+ /**
800
+ * Additional configuration for the field. Required for `Dropdown` and `List` data types.
801
+ * @export
802
+ * @interface CreateFieldRequestData
803
+ */
804
+ export interface CreateFieldRequestData {
805
+ /**
806
+ * List of valid options for `Dropdown` and `List` field types.
807
+ * @type {Array<string>}
808
+ * @memberof CreateFieldRequestData
809
+ */
810
+ 'options'?: Array<string>;
811
+ }
686
812
  /**
687
813
  *
688
814
  * @export
@@ -709,11 +835,17 @@ export interface CreateInvoiceRequest {
709
835
  */
710
836
  'po_number'?: string | null;
711
837
  /**
712
- * Amount of the invoice in USD
838
+ * Amount of the invoice
713
839
  * @type {number}
714
840
  * @memberof CreateInvoiceRequest
715
841
  */
716
842
  'amount': number;
843
+ /**
844
+ * Currency of the invoice
845
+ * @type {string}
846
+ * @memberof CreateInvoiceRequest
847
+ */
848
+ 'currency'?: CreateInvoiceRequestCurrencyEnum;
717
849
  /**
718
850
  * A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.
719
851
  * @type {string}
@@ -721,6 +853,12 @@ export interface CreateInvoiceRequest {
721
853
  */
722
854
  'memo'?: string | null;
723
855
  }
856
+ export declare const CreateInvoiceRequestCurrencyEnum: {
857
+ readonly Usd: "USD";
858
+ readonly Eur: "EUR";
859
+ readonly Gbp: "GBP";
860
+ };
861
+ export type CreateInvoiceRequestCurrencyEnum = typeof CreateInvoiceRequestCurrencyEnum[keyof typeof CreateInvoiceRequestCurrencyEnum];
724
862
  /**
725
863
  *
726
864
  * @export
@@ -1495,6 +1633,44 @@ export interface CreateReportRequestFiltersDigitalRewardsCreatedAt {
1495
1633
  */
1496
1634
  'lte'?: string;
1497
1635
  }
1636
+ /**
1637
+ *
1638
+ * @export
1639
+ * @interface CreateTopup200Response
1640
+ */
1641
+ export interface CreateTopup200Response {
1642
+ /**
1643
+ *
1644
+ * @type {ListTopups200ResponseTopupsInner}
1645
+ * @memberof CreateTopup200Response
1646
+ */
1647
+ 'topup'?: ListTopups200ResponseTopupsInner;
1648
+ }
1649
+ /**
1650
+ *
1651
+ * @export
1652
+ * @interface CreateTopupRequest
1653
+ */
1654
+ export interface CreateTopupRequest {
1655
+ /**
1656
+ * The ID of the funding source to top up.
1657
+ * @type {string}
1658
+ * @memberof CreateTopupRequest
1659
+ */
1660
+ 'funding_source_id': string;
1661
+ /**
1662
+ * Unique key that ensures this request is only processed once.
1663
+ * @type {string}
1664
+ * @memberof CreateTopupRequest
1665
+ */
1666
+ 'idempotency_key': string;
1667
+ /**
1668
+ * Amount in USD intended to be added to your organization’s balance.
1669
+ * @type {number}
1670
+ * @memberof CreateTopupRequest
1671
+ */
1672
+ 'amount': number;
1673
+ }
1498
1674
  /**
1499
1675
  *
1500
1676
  * @export
@@ -1839,19 +2015,17 @@ export interface Field {
1839
2015
  */
1840
2016
  'label'?: string;
1841
2017
  /**
1842
- * Type of the values of the field
2018
+ * Type of the values of the field <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>Checkbox</code></td> <td>A boolean value (true/false)</td> </tr> <tr> <td><code>Currency</code></td> <td>A monetary value</td> </tr> <tr> <td><code>Date</code></td> <td>A date value</td> </tr> <tr> <td><code>Dropdown</code></td> <td>A single selection from predefined options (see <code>data.options</code>)</td> </tr> <tr> <td><code>Email</code></td> <td>An email address</td> </tr> <tr> <td><code>List</code></td> <td>Multiple selections from predefined options (see <code>data.options</code>)</td> </tr> <tr> <td><code>Number</code></td> <td>A numeric value</td> </tr> <tr> <td><code>Phone</code></td> <td>A phone number</td> </tr> <tr> <td><code>Text</code></td> <td>A single-line text value</td> </tr> <tr> <td><code>TextArea</code></td> <td>A multi-line text value</td> </tr> </tbody> </table>
1843
2019
  * @type {string}
1844
2020
  * @memberof Field
1845
2021
  */
1846
- 'data_type'?: string;
2022
+ 'data_type'?: FieldDataTypeEnum;
1847
2023
  /**
1848
2024
  *
1849
- * @type {{ [key: string]: any; }}
2025
+ * @type {ListFields200ResponseFieldsInnerData}
1850
2026
  * @memberof Field
1851
2027
  */
1852
- 'data'?: {
1853
- [key: string]: any;
1854
- };
2028
+ 'data'?: ListFields200ResponseFieldsInnerData;
1855
2029
  /**
1856
2030
  * Is this field required (true) or optional (false)
1857
2031
  * @type {boolean}
@@ -1865,6 +2039,19 @@ export interface Field {
1865
2039
  */
1866
2040
  'scope'?: string;
1867
2041
  }
2042
+ export declare const FieldDataTypeEnum: {
2043
+ readonly Checkbox: "Checkbox";
2044
+ readonly Currency: "Currency";
2045
+ readonly Date: "Date";
2046
+ readonly Dropdown: "Dropdown";
2047
+ readonly Email: "Email";
2048
+ readonly List: "List";
2049
+ readonly Number: "Number";
2050
+ readonly Phone: "Phone";
2051
+ readonly Text: "Text";
2052
+ readonly TextArea: "TextArea";
2053
+ };
2054
+ export type FieldDataTypeEnum = typeof FieldDataTypeEnum[keyof typeof FieldDataTypeEnum];
1868
2055
  /**
1869
2056
  *
1870
2057
  * @export
@@ -2029,17 +2216,41 @@ export interface FraudReview {
2029
2216
  */
2030
2217
  'status'?: FraudReviewStatusEnum;
2031
2218
  /**
2032
- * The fraud risk associated with the reward.
2219
+ * 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 dollar 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` * `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`
2220
+ * @type {Array<string>}
2221
+ * @memberof FraudReview
2222
+ */
2223
+ 'reasons'?: Array<FraudReviewReasonsEnum>;
2224
+ /**
2225
+ * The device fingerprint, if known.
2033
2226
  * @type {string}
2034
2227
  * @memberof FraudReview
2035
2228
  */
2036
- 'risk'?: FraudReviewRiskEnum;
2229
+ 'device_id'?: string;
2037
2230
  /**
2038
- * 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 dollar 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` * `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`
2039
- * @type {Array<string>}
2231
+ * The product selected to claim the reward
2232
+ * @type {string}
2040
2233
  * @memberof FraudReview
2041
2234
  */
2042
- 'reasons'?: Array<FraudReviewReasonsEnum>;
2235
+ 'redemption_method'?: FraudReviewRedemptionMethodEnum;
2236
+ /**
2237
+ * Date the reward was redeemed
2238
+ * @type {string}
2239
+ * @memberof FraudReview
2240
+ */
2241
+ 'redeemed_at'?: string;
2242
+ /**
2243
+ *
2244
+ * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo}
2245
+ * @memberof FraudReview
2246
+ */
2247
+ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo;
2248
+ /**
2249
+ *
2250
+ * @type {OrderWithoutLinkRewardsInner}
2251
+ * @memberof FraudReview
2252
+ */
2253
+ 'reward'?: OrderWithoutLinkRewardsInner;
2043
2254
  /**
2044
2255
  * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`.
2045
2256
  * @type {string}
@@ -2052,56 +2263,146 @@ export interface FraudReview {
2052
2263
  * @memberof FraudReview
2053
2264
  */
2054
2265
  'reviewed_at'?: string;
2266
+ /**
2267
+ * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.).
2268
+ * @type {string}
2269
+ * @memberof FraudReview
2270
+ */
2271
+ 'redemption_method_account_hash'?: string;
2272
+ /**
2273
+ * The fraud risk associated with the reward.
2274
+ * @type {string}
2275
+ * @memberof FraudReview
2276
+ */
2277
+ 'risk'?: FraudReviewRiskEnum;
2055
2278
  /**
2056
2279
  *
2057
2280
  * @type {GetFraudReview200ResponseFraudReviewRelatedRewards}
2058
2281
  * @memberof FraudReview
2059
2282
  */
2060
2283
  'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
2284
+ }
2285
+ export declare const FraudReviewStatusEnum: {
2286
+ readonly Flagged: "flagged";
2287
+ readonly Blocked: "blocked";
2288
+ readonly Released: "released";
2289
+ };
2290
+ export type FraudReviewStatusEnum = typeof FraudReviewStatusEnum[keyof typeof FraudReviewStatusEnum];
2291
+ export declare const FraudReviewReasonsEnum: {
2292
+ readonly DisallowedIp: "Disallowed IP";
2293
+ readonly DisallowedEmail: "Disallowed email";
2294
+ readonly DisallowedCountry: "Disallowed country";
2295
+ readonly OverRewardDollarLimit: "Over reward dollar limit";
2296
+ readonly OverRewardCountLimit: "Over reward count limit";
2297
+ readonly VpnDetected: "VPN detected";
2298
+ readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails";
2299
+ readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails";
2300
+ readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list";
2301
+ readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list";
2302
+ readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list";
2303
+ readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list";
2304
+ readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list";
2305
+ readonly IpRelatedToABlockedReward: "IP related to a blocked reward";
2306
+ readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward";
2307
+ readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward";
2308
+ readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward";
2309
+ readonly EmailRelatedToABlockedReward: "Email related to a blocked reward";
2310
+ readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward";
2311
+ readonly AllowedIp: "Allowed IP";
2312
+ readonly AllowedEmail: "Allowed email";
2313
+ };
2314
+ export type FraudReviewReasonsEnum = typeof FraudReviewReasonsEnum[keyof typeof FraudReviewReasonsEnum];
2315
+ export declare const FraudReviewRedemptionMethodEnum: {
2316
+ readonly BankTransfer: "bank transfer";
2317
+ readonly Charity: "charity";
2318
+ readonly InstantDebitTransfer: "instant debit transfer";
2319
+ readonly InternationalBankTransfer: "international bank transfer";
2320
+ readonly MerchantCard: "merchant card";
2321
+ readonly Paypal: "paypal";
2322
+ readonly Venmo: "venmo";
2323
+ readonly VisaCard: "visa card";
2324
+ };
2325
+ export type FraudReviewRedemptionMethodEnum = typeof FraudReviewRedemptionMethodEnum[keyof typeof FraudReviewRedemptionMethodEnum];
2326
+ export declare const FraudReviewRiskEnum: {
2327
+ readonly High: "high";
2328
+ readonly Medium: "medium";
2329
+ readonly Low: "low";
2330
+ };
2331
+ export type FraudReviewRiskEnum = typeof FraudReviewRiskEnum[keyof typeof FraudReviewRiskEnum];
2332
+ /**
2333
+ * The fraud review associated with a reward.
2334
+ * @export
2335
+ * @interface FraudReviewBase
2336
+ */
2337
+ export interface FraudReviewBase {
2338
+ /**
2339
+ * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
2340
+ * @type {string}
2341
+ * @memberof FraudReviewBase
2342
+ */
2343
+ 'status'?: FraudReviewBaseStatusEnum;
2344
+ /**
2345
+ * 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 dollar 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` * `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`
2346
+ * @type {Array<string>}
2347
+ * @memberof FraudReviewBase
2348
+ */
2349
+ 'reasons'?: Array<FraudReviewBaseReasonsEnum>;
2061
2350
  /**
2062
2351
  * The device fingerprint, if known.
2063
2352
  * @type {string}
2064
- * @memberof FraudReview
2353
+ * @memberof FraudReviewBase
2065
2354
  */
2066
2355
  'device_id'?: string;
2067
2356
  /**
2068
2357
  * The product selected to claim the reward
2069
2358
  * @type {string}
2070
- * @memberof FraudReview
2359
+ * @memberof FraudReviewBase
2071
2360
  */
2072
- 'redemption_method'?: FraudReviewRedemptionMethodEnum;
2361
+ 'redemption_method'?: FraudReviewBaseRedemptionMethodEnum;
2073
2362
  /**
2074
2363
  * Date the reward was redeemed
2075
2364
  * @type {string}
2076
- * @memberof FraudReview
2365
+ * @memberof FraudReviewBase
2077
2366
  */
2078
2367
  'redeemed_at'?: string;
2079
2368
  /**
2080
2369
  *
2081
- * @type {GetFraudReview200ResponseFraudReviewGeo}
2082
- * @memberof FraudReview
2370
+ * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo}
2371
+ * @memberof FraudReviewBase
2083
2372
  */
2084
- 'geo'?: GetFraudReview200ResponseFraudReviewGeo;
2373
+ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo;
2085
2374
  /**
2086
2375
  *
2087
2376
  * @type {OrderWithoutLinkRewardsInner}
2088
- * @memberof FraudReview
2377
+ * @memberof FraudReviewBase
2089
2378
  */
2090
2379
  'reward'?: OrderWithoutLinkRewardsInner;
2380
+ /**
2381
+ * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`.
2382
+ * @type {string}
2383
+ * @memberof FraudReviewBase
2384
+ */
2385
+ 'reviewed_by'?: string;
2386
+ /**
2387
+ * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
2388
+ * @type {string}
2389
+ * @memberof FraudReviewBase
2390
+ */
2391
+ 'reviewed_at'?: string;
2392
+ /**
2393
+ * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.).
2394
+ * @type {string}
2395
+ * @memberof FraudReviewBase
2396
+ */
2397
+ 'redemption_method_account_hash'?: string;
2091
2398
  }
2092
- export declare const FraudReviewStatusEnum: {
2399
+ export declare const FraudReviewBaseStatusEnum: {
2093
2400
  readonly Flagged: "flagged";
2094
2401
  readonly Blocked: "blocked";
2095
2402
  readonly Released: "released";
2096
2403
  };
2097
- export type FraudReviewStatusEnum = typeof FraudReviewStatusEnum[keyof typeof FraudReviewStatusEnum];
2098
- export declare const FraudReviewRiskEnum: {
2099
- readonly High: "high";
2100
- readonly Medium: "medium";
2101
- readonly Low: "low";
2102
- };
2103
- export type FraudReviewRiskEnum = typeof FraudReviewRiskEnum[keyof typeof FraudReviewRiskEnum];
2104
- export declare const FraudReviewReasonsEnum: {
2404
+ export type FraudReviewBaseStatusEnum = typeof FraudReviewBaseStatusEnum[keyof typeof FraudReviewBaseStatusEnum];
2405
+ export declare const FraudReviewBaseReasonsEnum: {
2105
2406
  readonly DisallowedIp: "Disallowed IP";
2106
2407
  readonly DisallowedEmail: "Disallowed email";
2107
2408
  readonly DisallowedCountry: "Disallowed country";
@@ -2124,16 +2425,18 @@ export declare const FraudReviewReasonsEnum: {
2124
2425
  readonly AllowedIp: "Allowed IP";
2125
2426
  readonly AllowedEmail: "Allowed email";
2126
2427
  };
2127
- export type FraudReviewReasonsEnum = typeof FraudReviewReasonsEnum[keyof typeof FraudReviewReasonsEnum];
2128
- export declare const FraudReviewRedemptionMethodEnum: {
2129
- readonly Paypal: "paypal";
2130
- readonly Bank: "bank";
2131
- readonly MerchantCard: "merchant card";
2132
- readonly VisaCard: "visa card";
2428
+ export type FraudReviewBaseReasonsEnum = typeof FraudReviewBaseReasonsEnum[keyof typeof FraudReviewBaseReasonsEnum];
2429
+ export declare const FraudReviewBaseRedemptionMethodEnum: {
2430
+ readonly BankTransfer: "bank transfer";
2133
2431
  readonly Charity: "charity";
2432
+ readonly InstantDebitTransfer: "instant debit transfer";
2433
+ readonly InternationalBankTransfer: "international bank transfer";
2434
+ readonly MerchantCard: "merchant card";
2435
+ readonly Paypal: "paypal";
2134
2436
  readonly Venmo: "venmo";
2437
+ readonly VisaCard: "visa card";
2135
2438
  };
2136
- export type FraudReviewRedemptionMethodEnum = typeof FraudReviewRedemptionMethodEnum[keyof typeof FraudReviewRedemptionMethodEnum];
2439
+ export type FraudReviewBaseRedemptionMethodEnum = typeof FraudReviewBaseRedemptionMethodEnum[keyof typeof FraudReviewBaseRedemptionMethodEnum];
2137
2440
  /**
2138
2441
  *
2139
2442
  * @export
@@ -2177,12 +2480,54 @@ export interface FraudReviewListItem {
2177
2480
  * @memberof FraudReviewListItem
2178
2481
  */
2179
2482
  'reasons'?: Array<FraudReviewListItemReasonsEnum>;
2483
+ /**
2484
+ * The device fingerprint, if known.
2485
+ * @type {string}
2486
+ * @memberof FraudReviewListItem
2487
+ */
2488
+ 'device_id'?: string;
2489
+ /**
2490
+ * The product selected to claim the reward
2491
+ * @type {string}
2492
+ * @memberof FraudReviewListItem
2493
+ */
2494
+ 'redemption_method'?: FraudReviewListItemRedemptionMethodEnum;
2495
+ /**
2496
+ * Date the reward was redeemed
2497
+ * @type {string}
2498
+ * @memberof FraudReviewListItem
2499
+ */
2500
+ 'redeemed_at'?: string;
2501
+ /**
2502
+ *
2503
+ * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo}
2504
+ * @memberof FraudReviewListItem
2505
+ */
2506
+ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo;
2180
2507
  /**
2181
2508
  *
2182
2509
  * @type {OrderWithoutLinkRewardsInner}
2183
2510
  * @memberof FraudReviewListItem
2184
2511
  */
2185
2512
  'reward'?: OrderWithoutLinkRewardsInner;
2513
+ /**
2514
+ * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`.
2515
+ * @type {string}
2516
+ * @memberof FraudReviewListItem
2517
+ */
2518
+ 'reviewed_by'?: string;
2519
+ /**
2520
+ * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
2521
+ * @type {string}
2522
+ * @memberof FraudReviewListItem
2523
+ */
2524
+ 'reviewed_at'?: string;
2525
+ /**
2526
+ * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.).
2527
+ * @type {string}
2528
+ * @memberof FraudReviewListItem
2529
+ */
2530
+ 'redemption_method_account_hash'?: string;
2186
2531
  }
2187
2532
  export declare const FraudReviewListItemStatusEnum: {
2188
2533
  readonly Flagged: "flagged";
@@ -2214,6 +2559,17 @@ export declare const FraudReviewListItemReasonsEnum: {
2214
2559
  readonly AllowedEmail: "Allowed email";
2215
2560
  };
2216
2561
  export type FraudReviewListItemReasonsEnum = typeof FraudReviewListItemReasonsEnum[keyof typeof FraudReviewListItemReasonsEnum];
2562
+ export declare const FraudReviewListItemRedemptionMethodEnum: {
2563
+ readonly BankTransfer: "bank transfer";
2564
+ readonly Charity: "charity";
2565
+ readonly InstantDebitTransfer: "instant debit transfer";
2566
+ readonly InternationalBankTransfer: "international bank transfer";
2567
+ readonly MerchantCard: "merchant card";
2568
+ readonly Paypal: "paypal";
2569
+ readonly Venmo: "venmo";
2570
+ readonly VisaCard: "visa card";
2571
+ };
2572
+ export type FraudReviewListItemRedemptionMethodEnum = typeof FraudReviewListItemRedemptionMethodEnum[keyof typeof FraudReviewListItemRedemptionMethodEnum];
2217
2573
  /**
2218
2574
  *
2219
2575
  * @export
@@ -2249,12 +2605,14 @@ export type FraudReviewReason = typeof FraudReviewReason[keyof typeof FraudRevie
2249
2605
  * @enum {string}
2250
2606
  */
2251
2607
  export declare const FraudReviewRedemptionMethod: {
2252
- readonly Paypal: "paypal";
2253
- readonly Bank: "bank";
2254
- readonly MerchantCard: "merchant card";
2255
- readonly VisaCard: "visa card";
2608
+ readonly BankTransfer: "bank transfer";
2256
2609
  readonly Charity: "charity";
2610
+ readonly InstantDebitTransfer: "instant debit transfer";
2611
+ readonly InternationalBankTransfer: "international bank transfer";
2612
+ readonly MerchantCard: "merchant card";
2613
+ readonly Paypal: "paypal";
2257
2614
  readonly Venmo: "venmo";
2615
+ readonly VisaCard: "visa card";
2258
2616
  };
2259
2617
  export type FraudReviewRedemptionMethod = typeof FraudReviewRedemptionMethod[keyof typeof FraudReviewRedemptionMethod];
2260
2618
  /**
@@ -2635,12 +2993,6 @@ export interface GetFraudReview200ResponseFraudReview {
2635
2993
  * @memberof GetFraudReview200ResponseFraudReview
2636
2994
  */
2637
2995
  'status'?: GetFraudReview200ResponseFraudReviewStatusEnum;
2638
- /**
2639
- * The fraud risk associated with the reward.
2640
- * @type {string}
2641
- * @memberof GetFraudReview200ResponseFraudReview
2642
- */
2643
- 'risk'?: GetFraudReview200ResponseFraudReviewRiskEnum;
2644
2996
  /**
2645
2997
  * 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 dollar 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` * `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`
2646
2998
  * @type {Array<string>}
@@ -2648,53 +3000,65 @@ export interface GetFraudReview200ResponseFraudReview {
2648
3000
  */
2649
3001
  'reasons'?: Array<GetFraudReview200ResponseFraudReviewReasonsEnum>;
2650
3002
  /**
2651
- * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`.
3003
+ * The device fingerprint, if known.
2652
3004
  * @type {string}
2653
3005
  * @memberof GetFraudReview200ResponseFraudReview
2654
3006
  */
2655
- 'reviewed_by'?: string;
3007
+ 'device_id'?: string;
2656
3008
  /**
2657
- * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
3009
+ * The product selected to claim the reward
2658
3010
  * @type {string}
2659
3011
  * @memberof GetFraudReview200ResponseFraudReview
2660
3012
  */
2661
- 'reviewed_at'?: string;
3013
+ 'redemption_method'?: GetFraudReview200ResponseFraudReviewRedemptionMethodEnum;
3014
+ /**
3015
+ * Date the reward was redeemed
3016
+ * @type {string}
3017
+ * @memberof GetFraudReview200ResponseFraudReview
3018
+ */
3019
+ 'redeemed_at'?: string;
2662
3020
  /**
2663
3021
  *
2664
- * @type {GetFraudReview200ResponseFraudReviewRelatedRewards}
3022
+ * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo}
2665
3023
  * @memberof GetFraudReview200ResponseFraudReview
2666
3024
  */
2667
- 'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
3025
+ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo;
2668
3026
  /**
2669
- * The device fingerprint, if known.
3027
+ *
3028
+ * @type {ListRewards200ResponseRewardsInner}
3029
+ * @memberof GetFraudReview200ResponseFraudReview
3030
+ */
3031
+ 'reward'?: ListRewards200ResponseRewardsInner;
3032
+ /**
3033
+ * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`.
2670
3034
  * @type {string}
2671
3035
  * @memberof GetFraudReview200ResponseFraudReview
2672
3036
  */
2673
- 'device_id'?: string;
3037
+ 'reviewed_by'?: string;
2674
3038
  /**
2675
- * The product selected to claim the reward
3039
+ * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
2676
3040
  * @type {string}
2677
3041
  * @memberof GetFraudReview200ResponseFraudReview
2678
3042
  */
2679
- 'redemption_method'?: GetFraudReview200ResponseFraudReviewRedemptionMethodEnum;
3043
+ 'reviewed_at'?: string;
2680
3044
  /**
2681
- * Date the reward was redeemed
3045
+ * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.).
2682
3046
  * @type {string}
2683
3047
  * @memberof GetFraudReview200ResponseFraudReview
2684
3048
  */
2685
- 'redeemed_at'?: string;
3049
+ 'redemption_method_account_hash'?: string;
2686
3050
  /**
2687
- *
2688
- * @type {GetFraudReview200ResponseFraudReviewGeo}
3051
+ * The fraud risk associated with the reward.
3052
+ * @type {string}
2689
3053
  * @memberof GetFraudReview200ResponseFraudReview
2690
3054
  */
2691
- 'geo'?: GetFraudReview200ResponseFraudReviewGeo;
3055
+ 'risk'?: GetFraudReview200ResponseFraudReviewRiskEnum;
2692
3056
  /**
2693
3057
  *
2694
- * @type {ListRewards200ResponseRewardsInner}
3058
+ * @type {GetFraudReview200ResponseFraudReviewRelatedRewards}
2695
3059
  * @memberof GetFraudReview200ResponseFraudReview
2696
3060
  */
2697
- 'reward'?: ListRewards200ResponseRewardsInner;
3061
+ 'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards;
2698
3062
  }
2699
3063
  export declare const GetFraudReview200ResponseFraudReviewStatusEnum: {
2700
3064
  readonly Flagged: "flagged";
@@ -2702,12 +3066,6 @@ export declare const GetFraudReview200ResponseFraudReviewStatusEnum: {
2702
3066
  readonly Released: "released";
2703
3067
  };
2704
3068
  export type GetFraudReview200ResponseFraudReviewStatusEnum = typeof GetFraudReview200ResponseFraudReviewStatusEnum[keyof typeof GetFraudReview200ResponseFraudReviewStatusEnum];
2705
- export declare const GetFraudReview200ResponseFraudReviewRiskEnum: {
2706
- readonly High: "high";
2707
- readonly Medium: "medium";
2708
- readonly Low: "low";
2709
- };
2710
- export type GetFraudReview200ResponseFraudReviewRiskEnum = typeof GetFraudReview200ResponseFraudReviewRiskEnum[keyof typeof GetFraudReview200ResponseFraudReviewRiskEnum];
2711
3069
  export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
2712
3070
  readonly DisallowedIp: "Disallowed IP";
2713
3071
  readonly DisallowedEmail: "Disallowed email";
@@ -2733,39 +3091,22 @@ export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: {
2733
3091
  };
2734
3092
  export type GetFraudReview200ResponseFraudReviewReasonsEnum = typeof GetFraudReview200ResponseFraudReviewReasonsEnum[keyof typeof GetFraudReview200ResponseFraudReviewReasonsEnum];
2735
3093
  export declare const GetFraudReview200ResponseFraudReviewRedemptionMethodEnum: {
2736
- readonly Paypal: "paypal";
2737
- readonly Bank: "bank";
2738
- readonly MerchantCard: "merchant card";
2739
- readonly VisaCard: "visa card";
3094
+ readonly BankTransfer: "bank transfer";
2740
3095
  readonly Charity: "charity";
3096
+ readonly InstantDebitTransfer: "instant debit transfer";
3097
+ readonly InternationalBankTransfer: "international bank transfer";
3098
+ readonly MerchantCard: "merchant card";
3099
+ readonly Paypal: "paypal";
2741
3100
  readonly Venmo: "venmo";
3101
+ readonly VisaCard: "visa card";
2742
3102
  };
2743
3103
  export type GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum[keyof typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum];
2744
- /**
2745
- * The Geo location, based on the recipient\'s IP.
2746
- * @export
2747
- * @interface GetFraudReview200ResponseFraudReviewGeo
2748
- */
2749
- export interface GetFraudReview200ResponseFraudReviewGeo {
2750
- /**
2751
- * The recipient\'s IP.
2752
- * @type {string}
2753
- * @memberof GetFraudReview200ResponseFraudReviewGeo
2754
- */
2755
- 'ip'?: string;
2756
- /**
2757
- * The country code (ISO-3166 alpha-2 character code) linked to the recipient\'s IP.
2758
- * @type {string}
2759
- * @memberof GetFraudReview200ResponseFraudReviewGeo
2760
- */
2761
- 'country'?: string;
2762
- /**
2763
- * The city associated with the recipient\'s IP.
2764
- * @type {string}
2765
- * @memberof GetFraudReview200ResponseFraudReviewGeo
2766
- */
2767
- 'city'?: string;
2768
- }
3104
+ export declare const GetFraudReview200ResponseFraudReviewRiskEnum: {
3105
+ readonly High: "high";
3106
+ readonly Medium: "medium";
3107
+ readonly Low: "low";
3108
+ };
3109
+ export type GetFraudReview200ResponseFraudReviewRiskEnum = typeof GetFraudReview200ResponseFraudReviewRiskEnum[keyof typeof GetFraudReview200ResponseFraudReviewRiskEnum];
2769
3110
  /**
2770
3111
  * The related rewards associated with the fraud review.
2771
3112
  * @export
@@ -3029,11 +3370,17 @@ export interface Invoice {
3029
3370
  */
3030
3371
  'po_number'?: string | null;
3031
3372
  /**
3032
- * Amount of the invoice in USD
3373
+ * Amount of the invoice
3033
3374
  * @type {number}
3034
3375
  * @memberof Invoice
3035
3376
  */
3036
3377
  'amount': number;
3378
+ /**
3379
+ * Currency of the invoice
3380
+ * @type {string}
3381
+ * @memberof Invoice
3382
+ */
3383
+ 'currency'?: InvoiceCurrencyEnum;
3037
3384
  /**
3038
3385
  *
3039
3386
  * @type {boolean}
@@ -3071,6 +3418,12 @@ export interface Invoice {
3071
3418
  */
3072
3419
  'paid_at': string | null;
3073
3420
  }
3421
+ export declare const InvoiceCurrencyEnum: {
3422
+ readonly Usd: "USD";
3423
+ readonly Eur: "EUR";
3424
+ readonly Gbp: "GBP";
3425
+ };
3426
+ export type InvoiceCurrencyEnum = typeof InvoiceCurrencyEnum[keyof typeof InvoiceCurrencyEnum];
3074
3427
  export declare const InvoiceStatusEnum: {
3075
3428
  readonly Deleted: "DELETED";
3076
3429
  readonly Paid: "PAID";
@@ -3585,19 +3938,17 @@ export interface ListFields200ResponseFieldsInner {
3585
3938
  */
3586
3939
  'label'?: string;
3587
3940
  /**
3588
- * Type of the values of the field
3941
+ * Type of the values of the field <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>Checkbox</code></td> <td>A boolean value (true/false)</td> </tr> <tr> <td><code>Currency</code></td> <td>A monetary value</td> </tr> <tr> <td><code>Date</code></td> <td>A date value</td> </tr> <tr> <td><code>Dropdown</code></td> <td>A single selection from predefined options (see <code>data.options</code>)</td> </tr> <tr> <td><code>Email</code></td> <td>An email address</td> </tr> <tr> <td><code>List</code></td> <td>Multiple selections from predefined options (see <code>data.options</code>)</td> </tr> <tr> <td><code>Number</code></td> <td>A numeric value</td> </tr> <tr> <td><code>Phone</code></td> <td>A phone number</td> </tr> <tr> <td><code>Text</code></td> <td>A single-line text value</td> </tr> <tr> <td><code>TextArea</code></td> <td>A multi-line text value</td> </tr> </tbody> </table>
3589
3942
  * @type {string}
3590
3943
  * @memberof ListFields200ResponseFieldsInner
3591
3944
  */
3592
- 'data_type'?: string;
3945
+ 'data_type'?: ListFields200ResponseFieldsInnerDataTypeEnum;
3593
3946
  /**
3594
3947
  *
3595
- * @type {{ [key: string]: any; }}
3948
+ * @type {ListFields200ResponseFieldsInnerData}
3596
3949
  * @memberof ListFields200ResponseFieldsInner
3597
3950
  */
3598
- 'data'?: {
3599
- [key: string]: any;
3600
- };
3951
+ 'data'?: ListFields200ResponseFieldsInnerData;
3601
3952
  /**
3602
3953
  * Is this field required (true) or optional (false)
3603
3954
  * @type {boolean}
@@ -3611,6 +3962,40 @@ export interface ListFields200ResponseFieldsInner {
3611
3962
  */
3612
3963
  'scope'?: string;
3613
3964
  }
3965
+ export declare const ListFields200ResponseFieldsInnerDataTypeEnum: {
3966
+ readonly Checkbox: "Checkbox";
3967
+ readonly Currency: "Currency";
3968
+ readonly Date: "Date";
3969
+ readonly Dropdown: "Dropdown";
3970
+ readonly Email: "Email";
3971
+ readonly List: "List";
3972
+ readonly Number: "Number";
3973
+ readonly Phone: "Phone";
3974
+ readonly Text: "Text";
3975
+ readonly TextArea: "TextArea";
3976
+ };
3977
+ export type ListFields200ResponseFieldsInnerDataTypeEnum = typeof ListFields200ResponseFieldsInnerDataTypeEnum[keyof typeof ListFields200ResponseFieldsInnerDataTypeEnum];
3978
+ /**
3979
+ * Additional configuration for the field. Only used for `Dropdown` and `List` data types.
3980
+ * @export
3981
+ * @interface ListFields200ResponseFieldsInnerData
3982
+ */
3983
+ export interface ListFields200ResponseFieldsInnerData {
3984
+ /**
3985
+ * List of valid options for `Dropdown` and `List` field types. For `Dropdown`, the user selects one option. For `List`, the user can select multiple options.
3986
+ * @type {Array<string>}
3987
+ * @memberof ListFields200ResponseFieldsInnerData
3988
+ */
3989
+ 'options'?: Array<string>;
3990
+ /**
3991
+ * Optional human-readable labels for each option. Keys are the option values, values are the display labels. If not provided, the option values are used as labels.
3992
+ * @type {{ [key: string]: string; }}
3993
+ * @memberof ListFields200ResponseFieldsInnerData
3994
+ */
3995
+ 'labels'?: {
3996
+ [key: string]: string;
3997
+ };
3998
+ }
3614
3999
  /**
3615
4000
  *
3616
4001
  * @export
@@ -3652,23 +4037,65 @@ export interface ListFraudReviews200Response {
3652
4037
  */
3653
4038
  export interface ListFraudReviews200ResponseFraudReviewsInner {
3654
4039
  /**
3655
- * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
4040
+ * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
4041
+ * @type {string}
4042
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
4043
+ */
4044
+ 'status'?: ListFraudReviews200ResponseFraudReviewsInnerStatusEnum;
4045
+ /**
4046
+ * 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 dollar 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` * `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`
4047
+ * @type {Array<string>}
4048
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
4049
+ */
4050
+ 'reasons'?: Array<ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum>;
4051
+ /**
4052
+ * The device fingerprint, if known.
4053
+ * @type {string}
4054
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
4055
+ */
4056
+ 'device_id'?: string;
4057
+ /**
4058
+ * The product selected to claim the reward
4059
+ * @type {string}
4060
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
4061
+ */
4062
+ 'redemption_method'?: ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum;
4063
+ /**
4064
+ * Date the reward was redeemed
3656
4065
  * @type {string}
3657
4066
  * @memberof ListFraudReviews200ResponseFraudReviewsInner
3658
4067
  */
3659
- 'status'?: ListFraudReviews200ResponseFraudReviewsInnerStatusEnum;
4068
+ 'redeemed_at'?: string;
3660
4069
  /**
3661
- * 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 dollar 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` * `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`
3662
- * @type {Array<string>}
4070
+ *
4071
+ * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo}
3663
4072
  * @memberof ListFraudReviews200ResponseFraudReviewsInner
3664
4073
  */
3665
- 'reasons'?: Array<ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum>;
4074
+ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo;
3666
4075
  /**
3667
4076
  *
3668
4077
  * @type {ListRewards200ResponseRewardsInner}
3669
4078
  * @memberof ListFraudReviews200ResponseFraudReviewsInner
3670
4079
  */
3671
4080
  'reward'?: ListRewards200ResponseRewardsInner;
4081
+ /**
4082
+ * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`.
4083
+ * @type {string}
4084
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
4085
+ */
4086
+ 'reviewed_by'?: string;
4087
+ /**
4088
+ * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`.
4089
+ * @type {string}
4090
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
4091
+ */
4092
+ 'reviewed_at'?: string;
4093
+ /**
4094
+ * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.).
4095
+ * @type {string}
4096
+ * @memberof ListFraudReviews200ResponseFraudReviewsInner
4097
+ */
4098
+ 'redemption_method_account_hash'?: string;
3672
4099
  }
3673
4100
  export declare const ListFraudReviews200ResponseFraudReviewsInnerStatusEnum: {
3674
4101
  readonly Flagged: "flagged";
@@ -3700,6 +4127,42 @@ export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: {
3700
4127
  readonly AllowedEmail: "Allowed email";
3701
4128
  };
3702
4129
  export type ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum];
4130
+ export declare const ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum: {
4131
+ readonly BankTransfer: "bank transfer";
4132
+ readonly Charity: "charity";
4133
+ readonly InstantDebitTransfer: "instant debit transfer";
4134
+ readonly InternationalBankTransfer: "international bank transfer";
4135
+ readonly MerchantCard: "merchant card";
4136
+ readonly Paypal: "paypal";
4137
+ readonly Venmo: "venmo";
4138
+ readonly VisaCard: "visa card";
4139
+ };
4140
+ export type ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum];
4141
+ /**
4142
+ * The Geo location, based on the recipient\'s IP.
4143
+ * @export
4144
+ * @interface ListFraudReviews200ResponseFraudReviewsInnerGeo
4145
+ */
4146
+ export interface ListFraudReviews200ResponseFraudReviewsInnerGeo {
4147
+ /**
4148
+ * The recipient\'s IP.
4149
+ * @type {string}
4150
+ * @memberof ListFraudReviews200ResponseFraudReviewsInnerGeo
4151
+ */
4152
+ 'ip'?: string;
4153
+ /**
4154
+ * The country code (ISO-3166 alpha-2 character code) linked to the recipient\'s IP.
4155
+ * @type {string}
4156
+ * @memberof ListFraudReviews200ResponseFraudReviewsInnerGeo
4157
+ */
4158
+ 'country'?: string;
4159
+ /**
4160
+ * The city associated with the recipient\'s IP.
4161
+ * @type {string}
4162
+ * @memberof ListFraudReviews200ResponseFraudReviewsInnerGeo
4163
+ */
4164
+ 'city'?: string;
4165
+ }
3703
4166
  /**
3704
4167
  *
3705
4168
  * @export
@@ -3972,31 +4435,31 @@ export interface ListFundingSources200ResponseFundingSourcesInnerMeta {
3972
4435
  * @type {string}
3973
4436
  * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
3974
4437
  */
3975
- 'city'?: string;
4438
+ 'city'?: string | null;
3976
4439
  /**
3977
4440
  * **Only available when `method` is set to `invoice`.** Billing address state or province
3978
4441
  * @type {string}
3979
4442
  * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
3980
4443
  */
3981
- 'state'?: string;
4444
+ 'state'?: string | null;
3982
4445
  /**
3983
4446
  * **Only available when `method` is set to `invoice`.** Billing address postal code
3984
4447
  * @type {string}
3985
4448
  * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
3986
4449
  */
3987
- 'zip'?: string;
4450
+ 'zip'?: string | null;
3988
4451
  /**
3989
4452
  * **Only available when `method` is set to `invoice`.** Contact phone number for billing
3990
4453
  * @type {string}
3991
4454
  * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
3992
4455
  */
3993
- 'phone'?: string;
4456
+ 'phone'?: string | null;
3994
4457
  /**
3995
4458
  * **Only available when `method` is set to `invoice`.** Email addresses for invoice delivery (comma-separated)
3996
4459
  * @type {string}
3997
4460
  * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
3998
4461
  */
3999
- 'emails'?: string;
4462
+ 'emails'?: string | null;
4000
4463
  /**
4001
4464
  *
4002
4465
  * @type {ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails}
@@ -4079,11 +4542,17 @@ export interface ListInvoices200ResponseInvoicesInner {
4079
4542
  */
4080
4543
  'po_number'?: string | null;
4081
4544
  /**
4082
- * Amount of the invoice in USD
4545
+ * Amount of the invoice
4083
4546
  * @type {number}
4084
4547
  * @memberof ListInvoices200ResponseInvoicesInner
4085
4548
  */
4086
4549
  'amount': number;
4550
+ /**
4551
+ * Currency of the invoice
4552
+ * @type {string}
4553
+ * @memberof ListInvoices200ResponseInvoicesInner
4554
+ */
4555
+ 'currency'?: ListInvoices200ResponseInvoicesInnerCurrencyEnum;
4087
4556
  /**
4088
4557
  *
4089
4558
  * @type {boolean}
@@ -4121,6 +4590,12 @@ export interface ListInvoices200ResponseInvoicesInner {
4121
4590
  */
4122
4591
  'paid_at': string | null;
4123
4592
  }
4593
+ export declare const ListInvoices200ResponseInvoicesInnerCurrencyEnum: {
4594
+ readonly Usd: "USD";
4595
+ readonly Eur: "EUR";
4596
+ readonly Gbp: "GBP";
4597
+ };
4598
+ export type ListInvoices200ResponseInvoicesInnerCurrencyEnum = typeof ListInvoices200ResponseInvoicesInnerCurrencyEnum[keyof typeof ListInvoices200ResponseInvoicesInnerCurrencyEnum];
4124
4599
  export declare const ListInvoices200ResponseInvoicesInnerStatusEnum: {
4125
4600
  readonly Deleted: "DELETED";
4126
4601
  readonly Paid: "PAID";
@@ -5122,6 +5597,98 @@ export interface ListRoles200ResponseRolesInner {
5122
5597
  */
5123
5598
  'description': string;
5124
5599
  }
5600
+ /**
5601
+ *
5602
+ * @export
5603
+ * @interface ListTopups200Response
5604
+ */
5605
+ export interface ListTopups200Response {
5606
+ /**
5607
+ *
5608
+ * @type {Array<ListTopups200ResponseTopupsInner>}
5609
+ * @memberof ListTopups200Response
5610
+ */
5611
+ 'topups'?: Array<ListTopups200ResponseTopupsInner>;
5612
+ /**
5613
+ * The total number of topups across all pages
5614
+ * @type {number}
5615
+ * @memberof ListTopups200Response
5616
+ */
5617
+ 'total_count'?: number;
5618
+ }
5619
+ /**
5620
+ *
5621
+ * @export
5622
+ * @interface ListTopups200ResponseTopupsInner
5623
+ */
5624
+ export interface ListTopups200ResponseTopupsInner {
5625
+ /**
5626
+ * Unique identifier for the topup request.
5627
+ * @type {string}
5628
+ * @memberof ListTopups200ResponseTopupsInner
5629
+ */
5630
+ 'id'?: string;
5631
+ /**
5632
+ * Amount in USD intended to be added to your organization’s balance.
5633
+ * @type {number}
5634
+ * @memberof ListTopups200ResponseTopupsInner
5635
+ */
5636
+ 'amount'?: number;
5637
+ /**
5638
+ * Amount of the processing fee for the topup (typically reserved for credit card topups).
5639
+ * @type {number}
5640
+ * @memberof ListTopups200ResponseTopupsInner
5641
+ */
5642
+ 'processing_fee'?: number;
5643
+ /**
5644
+ * ID of the funding_source object used for this topup.
5645
+ * @type {string}
5646
+ * @memberof ListTopups200ResponseTopupsInner
5647
+ */
5648
+ 'funding_source_id'?: string;
5649
+ /**
5650
+ * Status of the topup <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> created </code> </td> <td> The topup is processing (and may be under review). </td> </tr> <tr> <td> <code> fully_credited </code> </td> <td> The funds have been added to the balance. </td> </tr> <tr> <td> <code> reversed </code> </td> <td> The topup was credited, but then reversed due to a chargeback or ACH return. </td> </tr> <tr> <td> <code> rejected </code> </td> <td> The topup was rejected by an admin. </td> </tr> </tbody> </table>
5651
+ * @type {string}
5652
+ * @memberof ListTopups200ResponseTopupsInner
5653
+ */
5654
+ 'status'?: string;
5655
+ /**
5656
+ * Timestamp indicating when the topup object was created (when the request was made).
5657
+ * @type {string}
5658
+ * @memberof ListTopups200ResponseTopupsInner
5659
+ */
5660
+ 'created_at'?: string;
5661
+ /**
5662
+ * Timestamp indicating when the topup amount was fully credited to the balance.
5663
+ * @type {string}
5664
+ * @memberof ListTopups200ResponseTopupsInner
5665
+ */
5666
+ 'fully_credited_at'?: string | null;
5667
+ /**
5668
+ * Timestamp indicating when the topup was rejected.
5669
+ * @type {string}
5670
+ * @memberof ListTopups200ResponseTopupsInner
5671
+ */
5672
+ 'rejected_at'?: string | null;
5673
+ /**
5674
+ * Timestamp indicating when the topup was reversed.
5675
+ * @type {string}
5676
+ * @memberof ListTopups200ResponseTopupsInner
5677
+ */
5678
+ 'reversed_at'?: string | null;
5679
+ /**
5680
+ * A sentence explaining why the topup was reversed.
5681
+ * @type {string}
5682
+ * @memberof ListTopups200ResponseTopupsInner
5683
+ */
5684
+ 'reversed_reason'?: string | null;
5685
+ /**
5686
+ * Idempotency key to prevent duplicate requests.
5687
+ * @type {string}
5688
+ * @memberof ListTopups200ResponseTopupsInner
5689
+ */
5690
+ 'idempotency_key'?: string | null;
5691
+ }
5125
5692
  /**
5126
5693
  *
5127
5694
  * @export
@@ -7575,6 +8142,104 @@ export declare const SingleRewardOrderWithoutLinkOrderChannelEnum: {
7575
8142
  readonly Yotpo: "YOTPO";
7576
8143
  };
7577
8144
  export type SingleRewardOrderWithoutLinkOrderChannelEnum = typeof SingleRewardOrderWithoutLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithoutLinkOrderChannelEnum];
8145
+ /**
8146
+ *
8147
+ * @export
8148
+ * @interface Topup
8149
+ */
8150
+ export interface Topup {
8151
+ /**
8152
+ * Unique identifier for the topup request.
8153
+ * @type {string}
8154
+ * @memberof Topup
8155
+ */
8156
+ 'id'?: string;
8157
+ /**
8158
+ * Amount in USD intended to be added to your organization’s balance.
8159
+ * @type {number}
8160
+ * @memberof Topup
8161
+ */
8162
+ 'amount'?: number;
8163
+ /**
8164
+ * Amount of the processing fee for the topup (typically reserved for credit card topups).
8165
+ * @type {number}
8166
+ * @memberof Topup
8167
+ */
8168
+ 'processing_fee'?: number;
8169
+ /**
8170
+ * ID of the funding_source object used for this topup.
8171
+ * @type {string}
8172
+ * @memberof Topup
8173
+ */
8174
+ 'funding_source_id'?: string;
8175
+ /**
8176
+ * Status of the topup <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> created </code> </td> <td> The topup is processing (and may be under review). </td> </tr> <tr> <td> <code> fully_credited </code> </td> <td> The funds have been added to the balance. </td> </tr> <tr> <td> <code> reversed </code> </td> <td> The topup was credited, but then reversed due to a chargeback or ACH return. </td> </tr> <tr> <td> <code> rejected </code> </td> <td> The topup was rejected by an admin. </td> </tr> </tbody> </table>
8177
+ * @type {string}
8178
+ * @memberof Topup
8179
+ */
8180
+ 'status'?: string;
8181
+ /**
8182
+ * Timestamp indicating when the topup object was created (when the request was made).
8183
+ * @type {string}
8184
+ * @memberof Topup
8185
+ */
8186
+ 'created_at'?: string;
8187
+ /**
8188
+ * Timestamp indicating when the topup amount was fully credited to the balance.
8189
+ * @type {string}
8190
+ * @memberof Topup
8191
+ */
8192
+ 'fully_credited_at'?: string | null;
8193
+ /**
8194
+ * Timestamp indicating when the topup was rejected.
8195
+ * @type {string}
8196
+ * @memberof Topup
8197
+ */
8198
+ 'rejected_at'?: string | null;
8199
+ /**
8200
+ * Timestamp indicating when the topup was reversed.
8201
+ * @type {string}
8202
+ * @memberof Topup
8203
+ */
8204
+ 'reversed_at'?: string | null;
8205
+ /**
8206
+ * A sentence explaining why the topup was reversed.
8207
+ * @type {string}
8208
+ * @memberof Topup
8209
+ */
8210
+ 'reversed_reason'?: string | null;
8211
+ /**
8212
+ * Idempotency key to prevent duplicate requests.
8213
+ * @type {string}
8214
+ * @memberof Topup
8215
+ */
8216
+ 'idempotency_key'?: string | null;
8217
+ }
8218
+ /**
8219
+ *
8220
+ * @export
8221
+ * @interface TopupCreateRequest
8222
+ */
8223
+ export interface TopupCreateRequest {
8224
+ /**
8225
+ * The ID of the funding source to top up.
8226
+ * @type {string}
8227
+ * @memberof TopupCreateRequest
8228
+ */
8229
+ 'funding_source_id': string;
8230
+ /**
8231
+ * Unique key that ensures this request is only processed once.
8232
+ * @type {string}
8233
+ * @memberof TopupCreateRequest
8234
+ */
8235
+ 'idempotency_key': string;
8236
+ /**
8237
+ * Amount in USD intended to be added to your organization’s balance.
8238
+ * @type {number}
8239
+ * @memberof TopupCreateRequest
8240
+ */
8241
+ 'amount': number;
8242
+ }
7578
8243
  /**
7579
8244
  * With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from.
7580
8245
  * @export
@@ -8294,6 +8959,14 @@ export declare class ConnectedOrganizationsApi extends BaseAPI {
8294
8959
  * @export
8295
8960
  */
8296
8961
  export declare const FieldsApiAxiosParamCreator: (configuration?: Configuration) => {
8962
+ /**
8963
+ * Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes.
8964
+ * @summary Create field
8965
+ * @param {CreateFieldRequest} createFieldRequest Field details
8966
+ * @param {*} [options] Override http request option.
8967
+ * @throws {RequiredError}
8968
+ */
8969
+ createField: (createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8297
8970
  /**
8298
8971
  * For reporting and analytics purposes, custom fields can be associated with rewards generated through the API. Custom fields must be first added by members of your admin team through the Tremendous Dashboard.
8299
8972
  * @summary List fields
@@ -8307,6 +8980,14 @@ export declare const FieldsApiAxiosParamCreator: (configuration?: Configuration)
8307
8980
  * @export
8308
8981
  */
8309
8982
  export declare const FieldsApiFp: (configuration?: Configuration) => {
8983
+ /**
8984
+ * Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes.
8985
+ * @summary Create field
8986
+ * @param {CreateFieldRequest} createFieldRequest Field details
8987
+ * @param {*} [options] Override http request option.
8988
+ * @throws {RequiredError}
8989
+ */
8990
+ createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateField200Response>>;
8310
8991
  /**
8311
8992
  * For reporting and analytics purposes, custom fields can be associated with rewards generated through the API. Custom fields must be first added by members of your admin team through the Tremendous Dashboard.
8312
8993
  * @summary List fields
@@ -8320,6 +9001,14 @@ export declare const FieldsApiFp: (configuration?: Configuration) => {
8320
9001
  * @export
8321
9002
  */
8322
9003
  export declare const FieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9004
+ /**
9005
+ * Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes.
9006
+ * @summary Create field
9007
+ * @param {CreateFieldRequest} createFieldRequest Field details
9008
+ * @param {*} [options] Override http request option.
9009
+ * @throws {RequiredError}
9010
+ */
9011
+ createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateField200Response>;
8323
9012
  /**
8324
9013
  * For reporting and analytics purposes, custom fields can be associated with rewards generated through the API. Custom fields must be first added by members of your admin team through the Tremendous Dashboard.
8325
9014
  * @summary List fields
@@ -8335,6 +9024,15 @@ export declare const FieldsApiFactory: (configuration?: Configuration, basePath?
8335
9024
  * @extends {BaseAPI}
8336
9025
  */
8337
9026
  export declare class FieldsApi extends BaseAPI {
9027
+ /**
9028
+ * Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes.
9029
+ * @summary Create field
9030
+ * @param {CreateFieldRequest} createFieldRequest Field details
9031
+ * @param {*} [options] Override http request option.
9032
+ * @throws {RequiredError}
9033
+ * @memberof FieldsApi
9034
+ */
9035
+ createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateField200Response, any, {}>>;
8338
9036
  /**
8339
9037
  * For reporting and analytics purposes, custom fields can be associated with rewards generated through the API. Custom fields must be first added by members of your admin team through the Tremendous Dashboard.
8340
9038
  * @summary List fields
@@ -8807,9 +9505,9 @@ export type UpdateFraudRuleListRuleTypeEnum = typeof UpdateFraudRuleListRuleType
8807
9505
  */
8808
9506
  export declare const FundingSourcesApiAxiosParamCreator: (configuration?: Configuration) => {
8809
9507
  /**
8810
- * Retrieve a funding source, identified by the given `id` in the URL
9508
+ * Retrieve a funding source, identified by the given `id` in the URL. You can also use the special keyword `BALANCE` (case-insensitive) to retrieve the organization\'s balance funding source.
8811
9509
  * @summary Retrieve funding source
8812
- * @param {string} id ID of the funding source that should be retrieved
9510
+ * @param {string} id ID of the funding source that should be retrieved. Can also use \&quot;BALANCE\&quot; (case-insensitive) to retrieve the organization\&#39;s balance funding source.
8813
9511
  * @param {*} [options] Override http request option.
8814
9512
  * @throws {RequiredError}
8815
9513
  */
@@ -8828,9 +9526,9 @@ export declare const FundingSourcesApiAxiosParamCreator: (configuration?: Config
8828
9526
  */
8829
9527
  export declare const FundingSourcesApiFp: (configuration?: Configuration) => {
8830
9528
  /**
8831
- * Retrieve a funding source, identified by the given `id` in the URL
9529
+ * Retrieve a funding source, identified by the given `id` in the URL. You can also use the special keyword `BALANCE` (case-insensitive) to retrieve the organization\'s balance funding source.
8832
9530
  * @summary Retrieve funding source
8833
- * @param {string} id ID of the funding source that should be retrieved
9531
+ * @param {string} id ID of the funding source that should be retrieved. Can also use \&quot;BALANCE\&quot; (case-insensitive) to retrieve the organization\&#39;s balance funding source.
8834
9532
  * @param {*} [options] Override http request option.
8835
9533
  * @throws {RequiredError}
8836
9534
  */
@@ -8849,9 +9547,9 @@ export declare const FundingSourcesApiFp: (configuration?: Configuration) => {
8849
9547
  */
8850
9548
  export declare const FundingSourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8851
9549
  /**
8852
- * Retrieve a funding source, identified by the given `id` in the URL
9550
+ * Retrieve a funding source, identified by the given `id` in the URL. You can also use the special keyword `BALANCE` (case-insensitive) to retrieve the organization\'s balance funding source.
8853
9551
  * @summary Retrieve funding source
8854
- * @param {string} id ID of the funding source that should be retrieved
9552
+ * @param {string} id ID of the funding source that should be retrieved. Can also use \&quot;BALANCE\&quot; (case-insensitive) to retrieve the organization\&#39;s balance funding source.
8855
9553
  * @param {*} [options] Override http request option.
8856
9554
  * @throws {RequiredError}
8857
9555
  */
@@ -8872,9 +9570,9 @@ export declare const FundingSourcesApiFactory: (configuration?: Configuration, b
8872
9570
  */
8873
9571
  export declare class FundingSourcesApi extends BaseAPI {
8874
9572
  /**
8875
- * Retrieve a funding source, identified by the given `id` in the URL
9573
+ * Retrieve a funding source, identified by the given `id` in the URL. You can also use the special keyword `BALANCE` (case-insensitive) to retrieve the organization\'s balance funding source.
8876
9574
  * @summary Retrieve funding source
8877
- * @param {string} id ID of the funding source that should be retrieved
9575
+ * @param {string} id ID of the funding source that should be retrieved. Can also use \&quot;BALANCE\&quot; (case-insensitive) to retrieve the organization\&#39;s balance funding source.
8878
9576
  * @param {*} [options] Override http request option.
8879
9577
  * @throws {RequiredError}
8880
9578
  * @memberof FundingSourcesApi
@@ -8895,7 +9593,7 @@ export declare class FundingSourcesApi extends BaseAPI {
8895
9593
  */
8896
9594
  export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
8897
9595
  /**
8898
- * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice in USD</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
9596
+ * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the invoice</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
8899
9597
  * @summary Create invoice
8900
9598
  * @param {CreateInvoiceRequest} createInvoiceRequest Invoice details
8901
9599
  * @param {*} [options] Override http request option.
@@ -8950,7 +9648,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
8950
9648
  */
8951
9649
  export declare const InvoicesApiFp: (configuration?: Configuration) => {
8952
9650
  /**
8953
- * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice in USD</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
9651
+ * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the invoice</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
8954
9652
  * @summary Create invoice
8955
9653
  * @param {CreateInvoiceRequest} createInvoiceRequest Invoice details
8956
9654
  * @param {*} [options] Override http request option.
@@ -9005,7 +9703,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
9005
9703
  */
9006
9704
  export declare const InvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9007
9705
  /**
9008
- * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice in USD</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
9706
+ * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the invoice</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
9009
9707
  * @summary Create invoice
9010
9708
  * @param {CreateInvoiceRequest} createInvoiceRequest Invoice details
9011
9709
  * @param {*} [options] Override http request option.
@@ -9062,7 +9760,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
9062
9760
  */
9063
9761
  export declare class InvoicesApi extends BaseAPI {
9064
9762
  /**
9065
- * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice in USD</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
9763
+ * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the invoice</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
9066
9764
  * @summary Create invoice
9067
9765
  * @param {CreateInvoiceRequest} createInvoiceRequest Invoice details
9068
9766
  * @param {*} [options] Override http request option.
@@ -10045,6 +10743,131 @@ export declare class RolesApi extends BaseAPI {
10045
10743
  */
10046
10744
  listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRoles200Response, any, {}>>;
10047
10745
  }
10746
+ /**
10747
+ * TopupsApi - axios parameter creator
10748
+ * @export
10749
+ */
10750
+ export declare const TopupsApiAxiosParamCreator: (configuration?: Configuration) => {
10751
+ /**
10752
+ *
10753
+ * @summary Create a topup
10754
+ * @param {CreateTopupRequest} [createTopupRequest] Parameters required to create a new topup. The &#x60;idempotency_key&#x60; should be unique for each request.
10755
+ * @param {*} [options] Override http request option.
10756
+ * @throws {RequiredError}
10757
+ */
10758
+ createTopup: (createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10759
+ /**
10760
+ * Retrieve a topup, identified by the given `id` in the URL.
10761
+ * @summary Retrieve single topup
10762
+ * @param {string} id ID of the topup request that should be retrieved
10763
+ * @param {*} [options] Override http request option.
10764
+ * @throws {RequiredError}
10765
+ */
10766
+ getTopup: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10767
+ /**
10768
+ * Retrieve a list of all topup requests.
10769
+ * @summary List topups
10770
+ * @param {number} [offset] Offsets the returned list by the given number of topups. The returned topups are ordered and offset by their creation date (DESC).
10771
+ * @param {*} [options] Override http request option.
10772
+ * @throws {RequiredError}
10773
+ */
10774
+ listTopups: (offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10775
+ };
10776
+ /**
10777
+ * TopupsApi - functional programming interface
10778
+ * @export
10779
+ */
10780
+ export declare const TopupsApiFp: (configuration?: Configuration) => {
10781
+ /**
10782
+ *
10783
+ * @summary Create a topup
10784
+ * @param {CreateTopupRequest} [createTopupRequest] Parameters required to create a new topup. The &#x60;idempotency_key&#x60; should be unique for each request.
10785
+ * @param {*} [options] Override http request option.
10786
+ * @throws {RequiredError}
10787
+ */
10788
+ createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTopup200Response>>;
10789
+ /**
10790
+ * Retrieve a topup, identified by the given `id` in the URL.
10791
+ * @summary Retrieve single topup
10792
+ * @param {string} id ID of the topup request that should be retrieved
10793
+ * @param {*} [options] Override http request option.
10794
+ * @throws {RequiredError}
10795
+ */
10796
+ getTopup(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTopup200Response>>;
10797
+ /**
10798
+ * Retrieve a list of all topup requests.
10799
+ * @summary List topups
10800
+ * @param {number} [offset] Offsets the returned list by the given number of topups. The returned topups are ordered and offset by their creation date (DESC).
10801
+ * @param {*} [options] Override http request option.
10802
+ * @throws {RequiredError}
10803
+ */
10804
+ listTopups(offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTopups200Response>>;
10805
+ };
10806
+ /**
10807
+ * TopupsApi - factory interface
10808
+ * @export
10809
+ */
10810
+ export declare const TopupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
10811
+ /**
10812
+ *
10813
+ * @summary Create a topup
10814
+ * @param {CreateTopupRequest} [createTopupRequest] Parameters required to create a new topup. The &#x60;idempotency_key&#x60; should be unique for each request.
10815
+ * @param {*} [options] Override http request option.
10816
+ * @throws {RequiredError}
10817
+ */
10818
+ createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateTopup200Response>;
10819
+ /**
10820
+ * Retrieve a topup, identified by the given `id` in the URL.
10821
+ * @summary Retrieve single topup
10822
+ * @param {string} id ID of the topup request that should be retrieved
10823
+ * @param {*} [options] Override http request option.
10824
+ * @throws {RequiredError}
10825
+ */
10826
+ getTopup(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateTopup200Response>;
10827
+ /**
10828
+ * Retrieve a list of all topup requests.
10829
+ * @summary List topups
10830
+ * @param {number} [offset] Offsets the returned list by the given number of topups. The returned topups are ordered and offset by their creation date (DESC).
10831
+ * @param {*} [options] Override http request option.
10832
+ * @throws {RequiredError}
10833
+ */
10834
+ listTopups(offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListTopups200Response>;
10835
+ };
10836
+ /**
10837
+ * TopupsApi - object-oriented interface
10838
+ * @export
10839
+ * @class TopupsApi
10840
+ * @extends {BaseAPI}
10841
+ */
10842
+ export declare class TopupsApi extends BaseAPI {
10843
+ /**
10844
+ *
10845
+ * @summary Create a topup
10846
+ * @param {CreateTopupRequest} [createTopupRequest] Parameters required to create a new topup. The &#x60;idempotency_key&#x60; should be unique for each request.
10847
+ * @param {*} [options] Override http request option.
10848
+ * @throws {RequiredError}
10849
+ * @memberof TopupsApi
10850
+ */
10851
+ createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTopup200Response, any, {}>>;
10852
+ /**
10853
+ * Retrieve a topup, identified by the given `id` in the URL.
10854
+ * @summary Retrieve single topup
10855
+ * @param {string} id ID of the topup request that should be retrieved
10856
+ * @param {*} [options] Override http request option.
10857
+ * @throws {RequiredError}
10858
+ * @memberof TopupsApi
10859
+ */
10860
+ getTopup(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTopup200Response, any, {}>>;
10861
+ /**
10862
+ * Retrieve a list of all topup requests.
10863
+ * @summary List topups
10864
+ * @param {number} [offset] Offsets the returned list by the given number of topups. The returned topups are ordered and offset by their creation date (DESC).
10865
+ * @param {*} [options] Override http request option.
10866
+ * @throws {RequiredError}
10867
+ * @memberof TopupsApi
10868
+ */
10869
+ listTopups(offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTopups200Response, any, {}>>;
10870
+ }
10048
10871
  /**
10049
10872
  * WebhooksApi - axios parameter creator
10050
10873
  * @export