tremendous 4.4.0 → 4.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +16 -0
- package/dist/api.d.ts +90 -98
- package/dist/api.js +37 -43
- package/dist/base.js +4 -1
- package/package.json +2 -2
package/dist/api.d.ts
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
14
15
|
import type { RequestArgs } from './base';
|
|
15
16
|
import { BaseAPI } from './base';
|
|
16
17
|
/**
|
|
@@ -954,7 +955,7 @@ export interface CreateOrder200ResponseOrder {
|
|
|
954
955
|
*/
|
|
955
956
|
'created_at': string;
|
|
956
957
|
/**
|
|
957
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
958
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
958
959
|
* @type {string}
|
|
959
960
|
* @memberof CreateOrder200ResponseOrder
|
|
960
961
|
*/
|
|
@@ -991,6 +992,7 @@ export declare const CreateOrder200ResponseOrderStatusEnum: {
|
|
|
991
992
|
readonly Failed: "FAILED";
|
|
992
993
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
993
994
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
995
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
994
996
|
};
|
|
995
997
|
export type CreateOrder200ResponseOrderStatusEnum = typeof CreateOrder200ResponseOrderStatusEnum[keyof typeof CreateOrder200ResponseOrderStatusEnum];
|
|
996
998
|
export declare const CreateOrder200ResponseOrderChannelEnum: {
|
|
@@ -1727,7 +1729,7 @@ export declare const CurrencyCodes: {
|
|
|
1727
1729
|
readonly Bob: "BOB";
|
|
1728
1730
|
readonly Brl: "BRL";
|
|
1729
1731
|
readonly Bwp: "BWP";
|
|
1730
|
-
readonly
|
|
1732
|
+
readonly Byn: "BYN";
|
|
1731
1733
|
readonly Bzd: "BZD";
|
|
1732
1734
|
readonly Cdf: "CDF";
|
|
1733
1735
|
readonly Chf: "CHF";
|
|
@@ -1741,7 +1743,6 @@ export declare const CurrencyCodes: {
|
|
|
1741
1743
|
readonly Dkk: "DKK";
|
|
1742
1744
|
readonly Dop: "DOP";
|
|
1743
1745
|
readonly Dzd: "DZD";
|
|
1744
|
-
readonly Eek: "EEK";
|
|
1745
1746
|
readonly Egp: "EGP";
|
|
1746
1747
|
readonly Ern: "ERN";
|
|
1747
1748
|
readonly Etb: "ETB";
|
|
@@ -1770,8 +1771,6 @@ export declare const CurrencyCodes: {
|
|
|
1770
1771
|
readonly Kzt: "KZT";
|
|
1771
1772
|
readonly Lbp: "LBP";
|
|
1772
1773
|
readonly Lkr: "LKR";
|
|
1773
|
-
readonly Ltl: "LTL";
|
|
1774
|
-
readonly Lvl: "LVL";
|
|
1775
1774
|
readonly Mad: "MAD";
|
|
1776
1775
|
readonly Mdl: "MDL";
|
|
1777
1776
|
readonly Mga: "MGA";
|
|
@@ -1823,7 +1822,6 @@ export declare const CurrencyCodes: {
|
|
|
1823
1822
|
readonly Xof: "XOF";
|
|
1824
1823
|
readonly Yer: "YER";
|
|
1825
1824
|
readonly Zar: "ZAR";
|
|
1826
|
-
readonly Zmk: "ZMK";
|
|
1827
1825
|
};
|
|
1828
1826
|
export type CurrencyCodes = typeof CurrencyCodes[keyof typeof CurrencyCodes];
|
|
1829
1827
|
/**
|
|
@@ -4731,7 +4729,7 @@ export interface ListOrders200ResponseOrdersInner {
|
|
|
4731
4729
|
*/
|
|
4732
4730
|
'created_at': string;
|
|
4733
4731
|
/**
|
|
4734
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
4732
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
4735
4733
|
* @type {string}
|
|
4736
4734
|
* @memberof ListOrders200ResponseOrdersInner
|
|
4737
4735
|
*/
|
|
@@ -4768,6 +4766,7 @@ export declare const ListOrders200ResponseOrdersInnerStatusEnum: {
|
|
|
4768
4766
|
readonly Failed: "FAILED";
|
|
4769
4767
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
4770
4768
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
4769
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
4771
4770
|
};
|
|
4772
4771
|
export type ListOrders200ResponseOrdersInnerStatusEnum = typeof ListOrders200ResponseOrdersInnerStatusEnum[keyof typeof ListOrders200ResponseOrdersInnerStatusEnum];
|
|
4773
4772
|
export declare const ListOrders200ResponseOrdersInnerChannelEnum: {
|
|
@@ -4925,7 +4924,7 @@ export interface ListProductsResponseProductsInner {
|
|
|
4925
4924
|
*/
|
|
4926
4925
|
'description': string;
|
|
4927
4926
|
/**
|
|
4928
|
-
* 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> </tbody> </table>
|
|
4927
|
+
* 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>
|
|
4929
4928
|
* @type {string}
|
|
4930
4929
|
* @memberof ListProductsResponseProductsInner
|
|
4931
4930
|
*/
|
|
@@ -4988,6 +4987,7 @@ export declare const ListProductsResponseProductsInnerCategoryEnum: {
|
|
|
4988
4987
|
readonly Venmo: "venmo";
|
|
4989
4988
|
readonly VisaCard: "visa_card";
|
|
4990
4989
|
readonly CashApp: "cash_app";
|
|
4990
|
+
readonly InternationalBank: "international_bank";
|
|
4991
4991
|
};
|
|
4992
4992
|
export type ListProductsResponseProductsInnerCategoryEnum = typeof ListProductsResponseProductsInnerCategoryEnum[keyof typeof ListProductsResponseProductsInnerCategoryEnum];
|
|
4993
4993
|
export declare const ListProductsResponseProductsInnerSubcategoryEnum: {
|
|
@@ -5024,7 +5024,7 @@ export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
|
5024
5024
|
readonly Bob: "BOB";
|
|
5025
5025
|
readonly Brl: "BRL";
|
|
5026
5026
|
readonly Bwp: "BWP";
|
|
5027
|
-
readonly
|
|
5027
|
+
readonly Byn: "BYN";
|
|
5028
5028
|
readonly Bzd: "BZD";
|
|
5029
5029
|
readonly Cdf: "CDF";
|
|
5030
5030
|
readonly Chf: "CHF";
|
|
@@ -5038,7 +5038,6 @@ export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
|
5038
5038
|
readonly Dkk: "DKK";
|
|
5039
5039
|
readonly Dop: "DOP";
|
|
5040
5040
|
readonly Dzd: "DZD";
|
|
5041
|
-
readonly Eek: "EEK";
|
|
5042
5041
|
readonly Egp: "EGP";
|
|
5043
5042
|
readonly Ern: "ERN";
|
|
5044
5043
|
readonly Etb: "ETB";
|
|
@@ -5067,8 +5066,6 @@ export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
|
5067
5066
|
readonly Kzt: "KZT";
|
|
5068
5067
|
readonly Lbp: "LBP";
|
|
5069
5068
|
readonly Lkr: "LKR";
|
|
5070
|
-
readonly Ltl: "LTL";
|
|
5071
|
-
readonly Lvl: "LVL";
|
|
5072
5069
|
readonly Mad: "MAD";
|
|
5073
5070
|
readonly Mdl: "MDL";
|
|
5074
5071
|
readonly Mga: "MGA";
|
|
@@ -5120,7 +5117,6 @@ export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
|
5120
5117
|
readonly Xof: "XOF";
|
|
5121
5118
|
readonly Yer: "YER";
|
|
5122
5119
|
readonly Zar: "ZAR";
|
|
5123
|
-
readonly Zmk: "ZMK";
|
|
5124
5120
|
};
|
|
5125
5121
|
export type ListProductsResponseProductsInnerCurrencyCodesEnum = typeof ListProductsResponseProductsInnerCurrencyCodesEnum[keyof typeof ListProductsResponseProductsInnerCurrencyCodesEnum];
|
|
5126
5122
|
/**
|
|
@@ -5410,7 +5406,7 @@ export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
|
5410
5406
|
readonly Bob: "BOB";
|
|
5411
5407
|
readonly Brl: "BRL";
|
|
5412
5408
|
readonly Bwp: "BWP";
|
|
5413
|
-
readonly
|
|
5409
|
+
readonly Byn: "BYN";
|
|
5414
5410
|
readonly Bzd: "BZD";
|
|
5415
5411
|
readonly Cdf: "CDF";
|
|
5416
5412
|
readonly Chf: "CHF";
|
|
@@ -5424,7 +5420,6 @@ export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
|
5424
5420
|
readonly Dkk: "DKK";
|
|
5425
5421
|
readonly Dop: "DOP";
|
|
5426
5422
|
readonly Dzd: "DZD";
|
|
5427
|
-
readonly Eek: "EEK";
|
|
5428
5423
|
readonly Egp: "EGP";
|
|
5429
5424
|
readonly Ern: "ERN";
|
|
5430
5425
|
readonly Etb: "ETB";
|
|
@@ -5453,8 +5448,6 @@ export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
|
5453
5448
|
readonly Kzt: "KZT";
|
|
5454
5449
|
readonly Lbp: "LBP";
|
|
5455
5450
|
readonly Lkr: "LKR";
|
|
5456
|
-
readonly Ltl: "LTL";
|
|
5457
|
-
readonly Lvl: "LVL";
|
|
5458
5451
|
readonly Mad: "MAD";
|
|
5459
5452
|
readonly Mdl: "MDL";
|
|
5460
5453
|
readonly Mga: "MGA";
|
|
@@ -5506,7 +5499,6 @@ export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
|
5506
5499
|
readonly Xof: "XOF";
|
|
5507
5500
|
readonly Yer: "YER";
|
|
5508
5501
|
readonly Zar: "ZAR";
|
|
5509
|
-
readonly Zmk: "ZMK";
|
|
5510
5502
|
};
|
|
5511
5503
|
export type ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum[keyof typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum];
|
|
5512
5504
|
/**
|
|
@@ -6002,7 +5994,7 @@ export interface Order {
|
|
|
6002
5994
|
*/
|
|
6003
5995
|
'created_at': string;
|
|
6004
5996
|
/**
|
|
6005
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
5997
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
6006
5998
|
* @type {string}
|
|
6007
5999
|
* @memberof Order
|
|
6008
6000
|
*/
|
|
@@ -6039,6 +6031,7 @@ export declare const OrderStatusEnum: {
|
|
|
6039
6031
|
readonly Failed: "FAILED";
|
|
6040
6032
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
6041
6033
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
6034
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
6042
6035
|
};
|
|
6043
6036
|
export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
|
|
6044
6037
|
export declare const OrderChannelEnum: {
|
|
@@ -6083,7 +6076,7 @@ export interface OrderBase {
|
|
|
6083
6076
|
*/
|
|
6084
6077
|
'created_at': string;
|
|
6085
6078
|
/**
|
|
6086
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
6079
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
6087
6080
|
* @type {string}
|
|
6088
6081
|
* @memberof OrderBase
|
|
6089
6082
|
*/
|
|
@@ -6114,6 +6107,7 @@ export declare const OrderBaseStatusEnum: {
|
|
|
6114
6107
|
readonly Failed: "FAILED";
|
|
6115
6108
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
6116
6109
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
6110
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
6117
6111
|
};
|
|
6118
6112
|
export type OrderBaseStatusEnum = typeof OrderBaseStatusEnum[keyof typeof OrderBaseStatusEnum];
|
|
6119
6113
|
export declare const OrderBaseChannelEnum: {
|
|
@@ -6165,7 +6159,7 @@ export interface OrderBasePayment {
|
|
|
6165
6159
|
'refund'?: PaymentDetailsRefund;
|
|
6166
6160
|
}
|
|
6167
6161
|
/**
|
|
6168
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
6162
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
6169
6163
|
* @export
|
|
6170
6164
|
* @enum {string}
|
|
6171
6165
|
*/
|
|
@@ -6176,6 +6170,7 @@ export declare const OrderStatus: {
|
|
|
6176
6170
|
readonly Failed: "FAILED";
|
|
6177
6171
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
6178
6172
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
6173
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
6179
6174
|
};
|
|
6180
6175
|
export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
|
|
6181
6176
|
/**
|
|
@@ -6209,7 +6204,7 @@ export interface OrderWithLink {
|
|
|
6209
6204
|
*/
|
|
6210
6205
|
'created_at': string;
|
|
6211
6206
|
/**
|
|
6212
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
6207
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
6213
6208
|
* @type {string}
|
|
6214
6209
|
* @memberof OrderWithLink
|
|
6215
6210
|
*/
|
|
@@ -6246,6 +6241,7 @@ export declare const OrderWithLinkStatusEnum: {
|
|
|
6246
6241
|
readonly Failed: "FAILED";
|
|
6247
6242
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
6248
6243
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
6244
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
6249
6245
|
};
|
|
6250
6246
|
export type OrderWithLinkStatusEnum = typeof OrderWithLinkStatusEnum[keyof typeof OrderWithLinkStatusEnum];
|
|
6251
6247
|
export declare const OrderWithLinkChannelEnum: {
|
|
@@ -6363,7 +6359,7 @@ export interface OrderWithoutLink {
|
|
|
6363
6359
|
*/
|
|
6364
6360
|
'created_at': string;
|
|
6365
6361
|
/**
|
|
6366
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
6362
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
6367
6363
|
* @type {string}
|
|
6368
6364
|
* @memberof OrderWithoutLink
|
|
6369
6365
|
*/
|
|
@@ -6400,6 +6396,7 @@ export declare const OrderWithoutLinkStatusEnum: {
|
|
|
6400
6396
|
readonly Failed: "FAILED";
|
|
6401
6397
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
6402
6398
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
6399
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
6403
6400
|
};
|
|
6404
6401
|
export type OrderWithoutLinkStatusEnum = typeof OrderWithoutLinkStatusEnum[keyof typeof OrderWithoutLinkStatusEnum];
|
|
6405
6402
|
export declare const OrderWithoutLinkChannelEnum: {
|
|
@@ -6662,7 +6659,7 @@ export interface Product {
|
|
|
6662
6659
|
*/
|
|
6663
6660
|
'description': string;
|
|
6664
6661
|
/**
|
|
6665
|
-
* 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> </tbody> </table>
|
|
6662
|
+
* 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>
|
|
6666
6663
|
* @type {string}
|
|
6667
6664
|
* @memberof Product
|
|
6668
6665
|
*/
|
|
@@ -6725,6 +6722,7 @@ export declare const ProductCategoryEnum: {
|
|
|
6725
6722
|
readonly Venmo: "venmo";
|
|
6726
6723
|
readonly VisaCard: "visa_card";
|
|
6727
6724
|
readonly CashApp: "cash_app";
|
|
6725
|
+
readonly InternationalBank: "international_bank";
|
|
6728
6726
|
};
|
|
6729
6727
|
export type ProductCategoryEnum = typeof ProductCategoryEnum[keyof typeof ProductCategoryEnum];
|
|
6730
6728
|
export declare const ProductSubcategoryEnum: {
|
|
@@ -6761,7 +6759,7 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
6761
6759
|
readonly Bob: "BOB";
|
|
6762
6760
|
readonly Brl: "BRL";
|
|
6763
6761
|
readonly Bwp: "BWP";
|
|
6764
|
-
readonly
|
|
6762
|
+
readonly Byn: "BYN";
|
|
6765
6763
|
readonly Bzd: "BZD";
|
|
6766
6764
|
readonly Cdf: "CDF";
|
|
6767
6765
|
readonly Chf: "CHF";
|
|
@@ -6775,7 +6773,6 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
6775
6773
|
readonly Dkk: "DKK";
|
|
6776
6774
|
readonly Dop: "DOP";
|
|
6777
6775
|
readonly Dzd: "DZD";
|
|
6778
|
-
readonly Eek: "EEK";
|
|
6779
6776
|
readonly Egp: "EGP";
|
|
6780
6777
|
readonly Ern: "ERN";
|
|
6781
6778
|
readonly Etb: "ETB";
|
|
@@ -6804,8 +6801,6 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
6804
6801
|
readonly Kzt: "KZT";
|
|
6805
6802
|
readonly Lbp: "LBP";
|
|
6806
6803
|
readonly Lkr: "LKR";
|
|
6807
|
-
readonly Ltl: "LTL";
|
|
6808
|
-
readonly Lvl: "LVL";
|
|
6809
6804
|
readonly Mad: "MAD";
|
|
6810
6805
|
readonly Mdl: "MDL";
|
|
6811
6806
|
readonly Mga: "MGA";
|
|
@@ -6857,7 +6852,6 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
6857
6852
|
readonly Xof: "XOF";
|
|
6858
6853
|
readonly Yer: "YER";
|
|
6859
6854
|
readonly Zar: "ZAR";
|
|
6860
|
-
readonly Zmk: "ZMK";
|
|
6861
6855
|
};
|
|
6862
6856
|
export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum];
|
|
6863
6857
|
/**
|
|
@@ -7488,7 +7482,7 @@ export declare const RewardValueCurrencyCodeEnum: {
|
|
|
7488
7482
|
readonly Bob: "BOB";
|
|
7489
7483
|
readonly Brl: "BRL";
|
|
7490
7484
|
readonly Bwp: "BWP";
|
|
7491
|
-
readonly
|
|
7485
|
+
readonly Byn: "BYN";
|
|
7492
7486
|
readonly Bzd: "BZD";
|
|
7493
7487
|
readonly Cdf: "CDF";
|
|
7494
7488
|
readonly Chf: "CHF";
|
|
@@ -7502,7 +7496,6 @@ export declare const RewardValueCurrencyCodeEnum: {
|
|
|
7502
7496
|
readonly Dkk: "DKK";
|
|
7503
7497
|
readonly Dop: "DOP";
|
|
7504
7498
|
readonly Dzd: "DZD";
|
|
7505
|
-
readonly Eek: "EEK";
|
|
7506
7499
|
readonly Egp: "EGP";
|
|
7507
7500
|
readonly Ern: "ERN";
|
|
7508
7501
|
readonly Etb: "ETB";
|
|
@@ -7531,8 +7524,6 @@ export declare const RewardValueCurrencyCodeEnum: {
|
|
|
7531
7524
|
readonly Kzt: "KZT";
|
|
7532
7525
|
readonly Lbp: "LBP";
|
|
7533
7526
|
readonly Lkr: "LKR";
|
|
7534
|
-
readonly Ltl: "LTL";
|
|
7535
|
-
readonly Lvl: "LVL";
|
|
7536
7527
|
readonly Mad: "MAD";
|
|
7537
7528
|
readonly Mdl: "MDL";
|
|
7538
7529
|
readonly Mga: "MGA";
|
|
@@ -7584,7 +7575,6 @@ export declare const RewardValueCurrencyCodeEnum: {
|
|
|
7584
7575
|
readonly Xof: "XOF";
|
|
7585
7576
|
readonly Yer: "YER";
|
|
7586
7577
|
readonly Zar: "ZAR";
|
|
7587
|
-
readonly Zmk: "ZMK";
|
|
7588
7578
|
};
|
|
7589
7579
|
export type RewardValueCurrencyCodeEnum = typeof RewardValueCurrencyCodeEnum[keyof typeof RewardValueCurrencyCodeEnum];
|
|
7590
7580
|
/**
|
|
@@ -8047,7 +8037,7 @@ export interface SingleRewardOrderWithLinkOrder {
|
|
|
8047
8037
|
*/
|
|
8048
8038
|
'created_at': string;
|
|
8049
8039
|
/**
|
|
8050
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
8040
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
8051
8041
|
* @type {string}
|
|
8052
8042
|
* @memberof SingleRewardOrderWithLinkOrder
|
|
8053
8043
|
*/
|
|
@@ -8084,6 +8074,7 @@ export declare const SingleRewardOrderWithLinkOrderStatusEnum: {
|
|
|
8084
8074
|
readonly Failed: "FAILED";
|
|
8085
8075
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
8086
8076
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
8077
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
8087
8078
|
};
|
|
8088
8079
|
export type SingleRewardOrderWithLinkOrderStatusEnum = typeof SingleRewardOrderWithLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithLinkOrderStatusEnum];
|
|
8089
8080
|
export declare const SingleRewardOrderWithLinkOrderChannelEnum: {
|
|
@@ -8141,7 +8132,7 @@ export interface SingleRewardOrderWithoutLinkOrder {
|
|
|
8141
8132
|
*/
|
|
8142
8133
|
'created_at': string;
|
|
8143
8134
|
/**
|
|
8144
|
-
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> </tbody> </table>
|
|
8135
|
+
* Execution status of a given order <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> <code> CANCELED </code> </td> <td> The order and all of its rewards were canceled. </td> </tr> <tr> <td> <code> OPEN </code> </td> <td> The order has been created, but hasn\'t yet been processed. </td> </tr> <tr> <td> <code> EXECUTED </code> </td> <td> The order has been executed. Payment has been handled and rewards are being delivered (if applicable). </td> </tr> <tr> <td> <code> FAILED </code> </td> <td> The order could not be processed due to an error. E.g. due to insufficient funds in the account. </td> </tr> <tr> <td> <code> PENDING APPROVAL </code> </td> <td> The order has been created but needs approval to be executed. </td> </tr> <tr> <td> <code> PENDING INTERNAL PAYMENT APPROVAL </code> </td> <td> The order has been created but it is under review and requires approval from our team. </td> </tr> <tr> <td> <code> PENDING SETTLEMENT </code> </td> <td> The order has been created but the funds are being held until the settlement window clears. </td> </tr> </tbody> </table>
|
|
8145
8136
|
* @type {string}
|
|
8146
8137
|
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
8147
8138
|
*/
|
|
@@ -8178,6 +8169,7 @@ export declare const SingleRewardOrderWithoutLinkOrderStatusEnum: {
|
|
|
8178
8169
|
readonly Failed: "FAILED";
|
|
8179
8170
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
8180
8171
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
8172
|
+
readonly PendingSettlement: "PENDING SETTLEMENT";
|
|
8181
8173
|
};
|
|
8182
8174
|
export type SingleRewardOrderWithoutLinkOrderStatusEnum = typeof SingleRewardOrderWithoutLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithoutLinkOrderStatusEnum];
|
|
8183
8175
|
export declare const SingleRewardOrderWithoutLinkOrderChannelEnum: {
|
|
@@ -8544,7 +8536,7 @@ export declare class BalanceTransactionsApi extends BaseAPI {
|
|
|
8544
8536
|
* @throws {RequiredError}
|
|
8545
8537
|
* @memberof BalanceTransactionsApi
|
|
8546
8538
|
*/
|
|
8547
|
-
listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8539
|
+
listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListBalanceTransactions200Response, any, {}>>;
|
|
8548
8540
|
}
|
|
8549
8541
|
/**
|
|
8550
8542
|
* CampaignsApi - axios parameter creator
|
|
@@ -8675,7 +8667,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
8675
8667
|
* @throws {RequiredError}
|
|
8676
8668
|
* @memberof CampaignsApi
|
|
8677
8669
|
*/
|
|
8678
|
-
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8670
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateCampaign200Response, any, {}>>;
|
|
8679
8671
|
/**
|
|
8680
8672
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
8681
8673
|
* @summary Retrieve campaign
|
|
@@ -8684,7 +8676,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
8684
8676
|
* @throws {RequiredError}
|
|
8685
8677
|
* @memberof CampaignsApi
|
|
8686
8678
|
*/
|
|
8687
|
-
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
8679
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateCampaign200Response, any, {}>>;
|
|
8688
8680
|
/**
|
|
8689
8681
|
* Retrieve a list of all campaigns created in your account
|
|
8690
8682
|
* @summary List campaigns
|
|
@@ -8692,7 +8684,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
8692
8684
|
* @throws {RequiredError}
|
|
8693
8685
|
* @memberof CampaignsApi
|
|
8694
8686
|
*/
|
|
8695
|
-
listCampaigns(options?: RawAxiosRequestConfig): Promise<
|
|
8687
|
+
listCampaigns(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListCampaigns200Response, any, {}>>;
|
|
8696
8688
|
/**
|
|
8697
8689
|
*
|
|
8698
8690
|
* @summary Update campaign
|
|
@@ -8702,7 +8694,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
8702
8694
|
* @throws {RequiredError}
|
|
8703
8695
|
* @memberof CampaignsApi
|
|
8704
8696
|
*/
|
|
8705
|
-
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8697
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateCampaign200Response, any, {}>>;
|
|
8706
8698
|
}
|
|
8707
8699
|
/**
|
|
8708
8700
|
* ConnectedOrganizationMembersApi - axios parameter creator
|
|
@@ -8842,7 +8834,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
8842
8834
|
* @throws {RequiredError}
|
|
8843
8835
|
* @memberof ConnectedOrganizationMembersApi
|
|
8844
8836
|
*/
|
|
8845
|
-
createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8837
|
+
createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganizationMember200Response, any, {}>>;
|
|
8846
8838
|
/**
|
|
8847
8839
|
* Create a connected organization member session.
|
|
8848
8840
|
* @summary Create connected organization member session
|
|
@@ -8852,7 +8844,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
8852
8844
|
* @throws {RequiredError}
|
|
8853
8845
|
* @memberof ConnectedOrganizationMembersApi
|
|
8854
8846
|
*/
|
|
8855
|
-
createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8847
|
+
createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganizationMemberSession200Response, any, {}>>;
|
|
8856
8848
|
/**
|
|
8857
8849
|
* Retrieve the connected organization member, identified by the given `id` in the URL
|
|
8858
8850
|
* @summary Retrieve a connected organization member
|
|
@@ -8861,7 +8853,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
8861
8853
|
* @throws {RequiredError}
|
|
8862
8854
|
* @memberof ConnectedOrganizationMembersApi
|
|
8863
8855
|
*/
|
|
8864
|
-
getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
8856
|
+
getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganizationMember200Response, any, {}>>;
|
|
8865
8857
|
/**
|
|
8866
8858
|
* Retrieve a list of connected organization members.
|
|
8867
8859
|
* @summary List connected organization members
|
|
@@ -8872,7 +8864,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
8872
8864
|
* @throws {RequiredError}
|
|
8873
8865
|
* @memberof ConnectedOrganizationMembersApi
|
|
8874
8866
|
*/
|
|
8875
|
-
listConnectedOrganizationMembers(connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8867
|
+
listConnectedOrganizationMembers(connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListConnectedOrganizationMembers200Response, any, {}>>;
|
|
8876
8868
|
}
|
|
8877
8869
|
/**
|
|
8878
8870
|
* ConnectedOrganizationsApi - axios parameter creator
|
|
@@ -8982,7 +8974,7 @@ export declare class ConnectedOrganizationsApi extends BaseAPI {
|
|
|
8982
8974
|
* @throws {RequiredError}
|
|
8983
8975
|
* @memberof ConnectedOrganizationsApi
|
|
8984
8976
|
*/
|
|
8985
|
-
createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8977
|
+
createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganization200Response, any, {}>>;
|
|
8986
8978
|
/**
|
|
8987
8979
|
* Retrieve the connected organization, identified by the given `id` in the URL
|
|
8988
8980
|
* @summary Retrieve a connected organization
|
|
@@ -8991,7 +8983,7 @@ export declare class ConnectedOrganizationsApi extends BaseAPI {
|
|
|
8991
8983
|
* @throws {RequiredError}
|
|
8992
8984
|
* @memberof ConnectedOrganizationsApi
|
|
8993
8985
|
*/
|
|
8994
|
-
getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
8986
|
+
getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganization200Response, any, {}>>;
|
|
8995
8987
|
/**
|
|
8996
8988
|
* Retrieve a list of connected organizations.
|
|
8997
8989
|
* @summary List connected organizations
|
|
@@ -9001,7 +8993,7 @@ export declare class ConnectedOrganizationsApi extends BaseAPI {
|
|
|
9001
8993
|
* @throws {RequiredError}
|
|
9002
8994
|
* @memberof ConnectedOrganizationsApi
|
|
9003
8995
|
*/
|
|
9004
|
-
listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8996
|
+
listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListConnectedOrganizations200Response, any, {}>>;
|
|
9005
8997
|
}
|
|
9006
8998
|
/**
|
|
9007
8999
|
* FieldsApi - axios parameter creator
|
|
@@ -9081,7 +9073,7 @@ export declare class FieldsApi extends BaseAPI {
|
|
|
9081
9073
|
* @throws {RequiredError}
|
|
9082
9074
|
* @memberof FieldsApi
|
|
9083
9075
|
*/
|
|
9084
|
-
createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9076
|
+
createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateField200Response, any, {}>>;
|
|
9085
9077
|
/**
|
|
9086
9078
|
* 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.
|
|
9087
9079
|
* @summary List fields
|
|
@@ -9089,7 +9081,7 @@ export declare class FieldsApi extends BaseAPI {
|
|
|
9089
9081
|
* @throws {RequiredError}
|
|
9090
9082
|
* @memberof FieldsApi
|
|
9091
9083
|
*/
|
|
9092
|
-
listFields(options?: RawAxiosRequestConfig): Promise<
|
|
9084
|
+
listFields(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFields200Response, any, {}>>;
|
|
9093
9085
|
}
|
|
9094
9086
|
/**
|
|
9095
9087
|
* ForexApi - axios parameter creator
|
|
@@ -9148,7 +9140,7 @@ export declare class ForexApi extends BaseAPI {
|
|
|
9148
9140
|
* @throws {RequiredError}
|
|
9149
9141
|
* @memberof ForexApi
|
|
9150
9142
|
*/
|
|
9151
|
-
listForex(base?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9143
|
+
listForex(base?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListForexResponse, any, {}>>;
|
|
9152
9144
|
}
|
|
9153
9145
|
/**
|
|
9154
9146
|
* FraudReviewsApi - axios parameter creator
|
|
@@ -9297,7 +9289,7 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9297
9289
|
* @throws {RequiredError}
|
|
9298
9290
|
* @memberof FraudReviewsApi
|
|
9299
9291
|
*/
|
|
9300
|
-
blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9292
|
+
blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFraudReview200Response, any, {}>>;
|
|
9301
9293
|
/**
|
|
9302
9294
|
* Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc.
|
|
9303
9295
|
* @summary Retrieve single fraud review
|
|
@@ -9306,7 +9298,7 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9306
9298
|
* @throws {RequiredError}
|
|
9307
9299
|
* @memberof FraudReviewsApi
|
|
9308
9300
|
*/
|
|
9309
|
-
getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9301
|
+
getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFraudReview200Response, any, {}>>;
|
|
9310
9302
|
/**
|
|
9311
9303
|
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
9312
9304
|
* @summary List fraud reviews
|
|
@@ -9321,7 +9313,7 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9321
9313
|
* @throws {RequiredError}
|
|
9322
9314
|
* @memberof FraudReviewsApi
|
|
9323
9315
|
*/
|
|
9324
|
-
listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9316
|
+
listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFraudReviews200Response, any, {}>>;
|
|
9325
9317
|
/**
|
|
9326
9318
|
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
9327
9319
|
* @summary Release fraud review
|
|
@@ -9330,7 +9322,7 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9330
9322
|
* @throws {RequiredError}
|
|
9331
9323
|
* @memberof FraudReviewsApi
|
|
9332
9324
|
*/
|
|
9333
|
-
releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9325
|
+
releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFraudReview200Response, any, {}>>;
|
|
9334
9326
|
}
|
|
9335
9327
|
/**
|
|
9336
9328
|
* @export
|
|
@@ -9473,7 +9465,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9473
9465
|
* @throws {RequiredError}
|
|
9474
9466
|
* @memberof FraudRulesApi
|
|
9475
9467
|
*/
|
|
9476
|
-
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<
|
|
9468
|
+
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteFraudRule200Response, any, {}>>;
|
|
9477
9469
|
/**
|
|
9478
9470
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
9479
9471
|
* @summary Configure fraud rule
|
|
@@ -9483,7 +9475,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9483
9475
|
* @throws {RequiredError}
|
|
9484
9476
|
* @memberof FraudRulesApi
|
|
9485
9477
|
*/
|
|
9486
|
-
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9478
|
+
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<FraudRule200Response, any, {}>>;
|
|
9487
9479
|
/**
|
|
9488
9480
|
* List active fraud rules associated with the organization tied to your API key.
|
|
9489
9481
|
* @summary List fraud rules
|
|
@@ -9491,7 +9483,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9491
9483
|
* @throws {RequiredError}
|
|
9492
9484
|
* @memberof FraudRulesApi
|
|
9493
9485
|
*/
|
|
9494
|
-
listFraudRules(options?: RawAxiosRequestConfig): Promise<
|
|
9486
|
+
listFraudRules(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFraudRules200Response, any, {}>>;
|
|
9495
9487
|
/**
|
|
9496
9488
|
* Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ```
|
|
9497
9489
|
* @summary Update fraud rule list
|
|
@@ -9501,7 +9493,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9501
9493
|
* @throws {RequiredError}
|
|
9502
9494
|
* @memberof FraudRulesApi
|
|
9503
9495
|
*/
|
|
9504
|
-
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9496
|
+
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateFraudRuleList200Response, any, {}>>;
|
|
9505
9497
|
}
|
|
9506
9498
|
/**
|
|
9507
9499
|
* @export
|
|
@@ -9626,7 +9618,7 @@ export declare class FundingSourcesApi extends BaseAPI {
|
|
|
9626
9618
|
* @throws {RequiredError}
|
|
9627
9619
|
* @memberof FundingSourcesApi
|
|
9628
9620
|
*/
|
|
9629
|
-
getFundingSource(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9621
|
+
getFundingSource(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFundingSource200Response, any, {}>>;
|
|
9630
9622
|
/**
|
|
9631
9623
|
* Retrieve a list of all funding sources in your organization\'s account.
|
|
9632
9624
|
* @summary List funding sources
|
|
@@ -9634,7 +9626,7 @@ export declare class FundingSourcesApi extends BaseAPI {
|
|
|
9634
9626
|
* @throws {RequiredError}
|
|
9635
9627
|
* @memberof FundingSourcesApi
|
|
9636
9628
|
*/
|
|
9637
|
-
listFundingSources(options?: RawAxiosRequestConfig): Promise<
|
|
9629
|
+
listFundingSources(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFundingSources200Response, any, {}>>;
|
|
9638
9630
|
}
|
|
9639
9631
|
/**
|
|
9640
9632
|
* InvoicesApi - axios parameter creator
|
|
@@ -9816,7 +9808,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9816
9808
|
* @throws {RequiredError}
|
|
9817
9809
|
* @memberof InvoicesApi
|
|
9818
9810
|
*/
|
|
9819
|
-
createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9811
|
+
createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInvoice200Response, any, {}>>;
|
|
9820
9812
|
/**
|
|
9821
9813
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
9822
9814
|
* @summary Delete invoice
|
|
@@ -9825,7 +9817,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9825
9817
|
* @throws {RequiredError}
|
|
9826
9818
|
* @memberof InvoicesApi
|
|
9827
9819
|
*/
|
|
9828
|
-
deleteInvoices(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9820
|
+
deleteInvoices(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInvoice200Response, any, {}>>;
|
|
9829
9821
|
/**
|
|
9830
9822
|
* Generates a CSV version for an invoice listing the associated rewards and orders
|
|
9831
9823
|
* @summary Retrieve invoice as CSV
|
|
@@ -9834,7 +9826,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9834
9826
|
* @throws {RequiredError}
|
|
9835
9827
|
* @memberof InvoicesApi
|
|
9836
9828
|
*/
|
|
9837
|
-
downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9829
|
+
downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
9838
9830
|
/**
|
|
9839
9831
|
* Generates a PDF version for an invoice
|
|
9840
9832
|
* @summary Retrieve invoice as PDF
|
|
@@ -9843,7 +9835,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9843
9835
|
* @throws {RequiredError}
|
|
9844
9836
|
* @memberof InvoicesApi
|
|
9845
9837
|
*/
|
|
9846
|
-
downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9838
|
+
downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<File, any, {}>>;
|
|
9847
9839
|
/**
|
|
9848
9840
|
* Retrieve an invoice, identified by the given `id` in the URL > 📘 Deleted Invoices > > This endpoint can be used to retrieve details on deleted invoices > that the list of invoices omits.
|
|
9849
9841
|
* @summary Retrieve invoice
|
|
@@ -9852,7 +9844,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9852
9844
|
* @throws {RequiredError}
|
|
9853
9845
|
* @memberof InvoicesApi
|
|
9854
9846
|
*/
|
|
9855
|
-
getInvoice(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9847
|
+
getInvoice(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInvoice200Response, any, {}>>;
|
|
9856
9848
|
/**
|
|
9857
9849
|
* Fetch a list of all invoices on your account. > 🚧 Deleted invoices are omitted > > The response does not include any previously deleted invoices.
|
|
9858
9850
|
* @summary List invoices
|
|
@@ -9862,7 +9854,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9862
9854
|
* @throws {RequiredError}
|
|
9863
9855
|
* @memberof InvoicesApi
|
|
9864
9856
|
*/
|
|
9865
|
-
listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
9857
|
+
listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInvoices200Response, any, {}>>;
|
|
9866
9858
|
}
|
|
9867
9859
|
/**
|
|
9868
9860
|
* MembersApi - axios parameter creator
|
|
@@ -9966,7 +9958,7 @@ export declare class MembersApi extends BaseAPI {
|
|
|
9966
9958
|
* @throws {RequiredError}
|
|
9967
9959
|
* @memberof MembersApi
|
|
9968
9960
|
*/
|
|
9969
|
-
createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9961
|
+
createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateMember200Response, any, {}>>;
|
|
9970
9962
|
/**
|
|
9971
9963
|
*
|
|
9972
9964
|
* @summary Retrieve member
|
|
@@ -9975,7 +9967,7 @@ export declare class MembersApi extends BaseAPI {
|
|
|
9975
9967
|
* @throws {RequiredError}
|
|
9976
9968
|
* @memberof MembersApi
|
|
9977
9969
|
*/
|
|
9978
|
-
getMember(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9970
|
+
getMember(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetMember200Response, any, {}>>;
|
|
9979
9971
|
/**
|
|
9980
9972
|
* To list members of a sub-organization [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the list members request.
|
|
9981
9973
|
* @summary List members
|
|
@@ -9983,7 +9975,7 @@ export declare class MembersApi extends BaseAPI {
|
|
|
9983
9975
|
* @throws {RequiredError}
|
|
9984
9976
|
* @memberof MembersApi
|
|
9985
9977
|
*/
|
|
9986
|
-
listMembers(options?: RawAxiosRequestConfig): Promise<
|
|
9978
|
+
listMembers(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListMembers200Response, any, {}>>;
|
|
9987
9979
|
}
|
|
9988
9980
|
/**
|
|
9989
9981
|
* OrdersApi - axios parameter creator
|
|
@@ -10153,7 +10145,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10153
10145
|
* @throws {RequiredError}
|
|
10154
10146
|
* @memberof OrdersApi
|
|
10155
10147
|
*/
|
|
10156
|
-
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10148
|
+
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrder200Response, any, {}>>;
|
|
10157
10149
|
/**
|
|
10158
10150
|
* Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order. Use <code>balance</code> to use your Tremendous's balance.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The link can be retrieved on a successfully ordered reward via the <code>/rewards</code> or <code>/rewards/{id}</code> endpoint. That link must then be delivered to the recipient out-of-band.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
|
|
10159
10151
|
* @summary Create order
|
|
@@ -10162,7 +10154,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10162
10154
|
* @throws {RequiredError}
|
|
10163
10155
|
* @memberof OrdersApi
|
|
10164
10156
|
*/
|
|
10165
|
-
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10157
|
+
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateOrder200Response, any, {}>>;
|
|
10166
10158
|
/**
|
|
10167
10159
|
* Retrieve the order, identified by the given `id` in the URL
|
|
10168
10160
|
* @summary Retrieve order
|
|
@@ -10171,7 +10163,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10171
10163
|
* @throws {RequiredError}
|
|
10172
10164
|
* @memberof OrdersApi
|
|
10173
10165
|
*/
|
|
10174
|
-
getOrder(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10166
|
+
getOrder(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrder200Response, any, {}>>;
|
|
10175
10167
|
/**
|
|
10176
10168
|
* Retrieve a list of orders
|
|
10177
10169
|
* @summary List orders
|
|
@@ -10185,7 +10177,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10185
10177
|
* @throws {RequiredError}
|
|
10186
10178
|
* @memberof OrdersApi
|
|
10187
10179
|
*/
|
|
10188
|
-
listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
10180
|
+
listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListOrders200Response, any, {}>>;
|
|
10189
10181
|
/**
|
|
10190
10182
|
* Rejects an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard.
|
|
10191
10183
|
* @summary Reject order
|
|
@@ -10194,7 +10186,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10194
10186
|
* @throws {RequiredError}
|
|
10195
10187
|
* @memberof OrdersApi
|
|
10196
10188
|
*/
|
|
10197
|
-
rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10189
|
+
rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrder200Response, any, {}>>;
|
|
10198
10190
|
}
|
|
10199
10191
|
/**
|
|
10200
10192
|
* OrganizationsApi - axios parameter creator
|
|
@@ -10318,7 +10310,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10318
10310
|
* @throws {RequiredError}
|
|
10319
10311
|
* @memberof OrganizationsApi
|
|
10320
10312
|
*/
|
|
10321
|
-
createApiKey(options?: RawAxiosRequestConfig): Promise<
|
|
10313
|
+
createApiKey(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateApiKey200Response, any, {}>>;
|
|
10322
10314
|
/**
|
|
10323
10315
|
* Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard.
|
|
10324
10316
|
* @summary Create organization
|
|
@@ -10327,7 +10319,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10327
10319
|
* @throws {RequiredError}
|
|
10328
10320
|
* @memberof OrganizationsApi
|
|
10329
10321
|
*/
|
|
10330
|
-
createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10322
|
+
createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateOrganization200Response, any, {}>>;
|
|
10331
10323
|
/**
|
|
10332
10324
|
*
|
|
10333
10325
|
* @summary Retrieve organization
|
|
@@ -10336,7 +10328,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10336
10328
|
* @throws {RequiredError}
|
|
10337
10329
|
* @memberof OrganizationsApi
|
|
10338
10330
|
*/
|
|
10339
|
-
getOrganization(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10331
|
+
getOrganization(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrganization200Response, any, {}>>;
|
|
10340
10332
|
/**
|
|
10341
10333
|
* The returned list only includes the organization to which the API key belongs to, that is used for the request.
|
|
10342
10334
|
* @summary List organizations
|
|
@@ -10344,7 +10336,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10344
10336
|
* @throws {RequiredError}
|
|
10345
10337
|
* @memberof OrganizationsApi
|
|
10346
10338
|
*/
|
|
10347
|
-
listOrganizations(options?: RawAxiosRequestConfig): Promise<
|
|
10339
|
+
listOrganizations(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListOrganizations200Response, any, {}>>;
|
|
10348
10340
|
}
|
|
10349
10341
|
/**
|
|
10350
10342
|
* ProductsApi - axios parameter creator
|
|
@@ -10433,7 +10425,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
10433
10425
|
* @throws {RequiredError}
|
|
10434
10426
|
* @memberof ProductsApi
|
|
10435
10427
|
*/
|
|
10436
|
-
getProduct(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10428
|
+
getProduct(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetProductResponse, any, {}>>;
|
|
10437
10429
|
/**
|
|
10438
10430
|
* Retrieve a list of available products
|
|
10439
10431
|
* @summary List products
|
|
@@ -10444,7 +10436,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
10444
10436
|
* @throws {RequiredError}
|
|
10445
10437
|
* @memberof ProductsApi
|
|
10446
10438
|
*/
|
|
10447
|
-
listProducts(country?: string, currency?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<
|
|
10439
|
+
listProducts(country?: string, currency?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListProductsResponse, any, {}>>;
|
|
10448
10440
|
}
|
|
10449
10441
|
/**
|
|
10450
10442
|
* ReportsApi - axios parameter creator
|
|
@@ -10527,7 +10519,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
10527
10519
|
* @throws {RequiredError}
|
|
10528
10520
|
* @memberof ReportsApi
|
|
10529
10521
|
*/
|
|
10530
|
-
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10522
|
+
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateReport200Response, any, {}>>;
|
|
10531
10523
|
/**
|
|
10532
10524
|
* Retrieve the report, identified by the given `id` in the URL Using the ID that was returned by `POST /api/v2/reports`, retrieves a download link for the report, identified by the given ID in the URL. Returns the report’s current status and, if available, the URL for download. The URL is valid for 7 days.
|
|
10533
10525
|
* @summary Retrieve report
|
|
@@ -10536,7 +10528,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
10536
10528
|
* @throws {RequiredError}
|
|
10537
10529
|
* @memberof ReportsApi
|
|
10538
10530
|
*/
|
|
10539
|
-
getReport(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10531
|
+
getReport(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateReport200Response, any, {}>>;
|
|
10540
10532
|
}
|
|
10541
10533
|
/**
|
|
10542
10534
|
* RewardsApi - axios parameter creator
|
|
@@ -10697,7 +10689,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10697
10689
|
* @throws {RequiredError}
|
|
10698
10690
|
* @memberof RewardsApi
|
|
10699
10691
|
*/
|
|
10700
|
-
cancelReward(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10692
|
+
cancelReward(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<object, any, {}>>;
|
|
10701
10693
|
/**
|
|
10702
10694
|
* Generate a redemption link for the reward identified by the `id` in the URL
|
|
10703
10695
|
* @summary Generate a reward URL
|
|
@@ -10706,7 +10698,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10706
10698
|
* @throws {RequiredError}
|
|
10707
10699
|
* @memberof RewardsApi
|
|
10708
10700
|
*/
|
|
10709
|
-
generateRewardLink(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10701
|
+
generateRewardLink(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateRewardLink200Response, any, {}>>;
|
|
10710
10702
|
/**
|
|
10711
10703
|
* Retrieve the reward, identified by the given `id` in the URL
|
|
10712
10704
|
* @summary Retrieve single reward
|
|
@@ -10715,7 +10707,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10715
10707
|
* @throws {RequiredError}
|
|
10716
10708
|
* @memberof RewardsApi
|
|
10717
10709
|
*/
|
|
10718
|
-
getReward(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10710
|
+
getReward(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetReward200Response, any, {}>>;
|
|
10719
10711
|
/**
|
|
10720
10712
|
* Retrieve a list of all created rewards. You can query for rewards by custom field attributes using the field label and values as query params. [Learn more](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards#querying-by-custom-fields)
|
|
10721
10713
|
* @summary List rewards
|
|
@@ -10725,7 +10717,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10725
10717
|
* @throws {RequiredError}
|
|
10726
10718
|
* @memberof RewardsApi
|
|
10727
10719
|
*/
|
|
10728
|
-
listRewards(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
10720
|
+
listRewards(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListRewards200Response, any, {}>>;
|
|
10729
10721
|
/**
|
|
10730
10722
|
* Resends a reward, identified by the given `id` in the URL, to its recipient. Only rewards with a previous delivery failure can be resent.
|
|
10731
10723
|
* @summary Resend reward
|
|
@@ -10735,7 +10727,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10735
10727
|
* @throws {RequiredError}
|
|
10736
10728
|
* @memberof RewardsApi
|
|
10737
10729
|
*/
|
|
10738
|
-
resendReward(id: string, resendRewardRequest?: ResendRewardRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10730
|
+
resendReward(id: string, resendRewardRequest?: ResendRewardRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<object, any, {}>>;
|
|
10739
10731
|
}
|
|
10740
10732
|
/**
|
|
10741
10733
|
* RolesApi - axios parameter creator
|
|
@@ -10790,7 +10782,7 @@ export declare class RolesApi extends BaseAPI {
|
|
|
10790
10782
|
* @throws {RequiredError}
|
|
10791
10783
|
* @memberof RolesApi
|
|
10792
10784
|
*/
|
|
10793
|
-
listRoles(options?: RawAxiosRequestConfig): Promise<
|
|
10785
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListRoles200Response, any, {}>>;
|
|
10794
10786
|
}
|
|
10795
10787
|
/**
|
|
10796
10788
|
* TopupsApi - axios parameter creator
|
|
@@ -10897,7 +10889,7 @@ export declare class TopupsApi extends BaseAPI {
|
|
|
10897
10889
|
* @throws {RequiredError}
|
|
10898
10890
|
* @memberof TopupsApi
|
|
10899
10891
|
*/
|
|
10900
|
-
createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10892
|
+
createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateTopup200Response, any, {}>>;
|
|
10901
10893
|
/**
|
|
10902
10894
|
* Retrieve a topup, identified by the given `id` in the URL.
|
|
10903
10895
|
* @summary Retrieve single topup
|
|
@@ -10906,7 +10898,7 @@ export declare class TopupsApi extends BaseAPI {
|
|
|
10906
10898
|
* @throws {RequiredError}
|
|
10907
10899
|
* @memberof TopupsApi
|
|
10908
10900
|
*/
|
|
10909
|
-
getTopup(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10901
|
+
getTopup(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateTopup200Response, any, {}>>;
|
|
10910
10902
|
/**
|
|
10911
10903
|
* Retrieve a list of all topup requests.
|
|
10912
10904
|
* @summary List topups
|
|
@@ -10915,7 +10907,7 @@ export declare class TopupsApi extends BaseAPI {
|
|
|
10915
10907
|
* @throws {RequiredError}
|
|
10916
10908
|
* @memberof TopupsApi
|
|
10917
10909
|
*/
|
|
10918
|
-
listTopups(offset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
10910
|
+
listTopups(offset?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListTopups200Response, any, {}>>;
|
|
10919
10911
|
}
|
|
10920
10912
|
/**
|
|
10921
10913
|
* WebhooksApi - axios parameter creator
|
|
@@ -11094,7 +11086,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11094
11086
|
* @throws {RequiredError}
|
|
11095
11087
|
* @memberof WebhooksApi
|
|
11096
11088
|
*/
|
|
11097
|
-
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11089
|
+
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateWebhook200Response, any, {}>>;
|
|
11098
11090
|
/**
|
|
11099
11091
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
11100
11092
|
* @summary Delete webhook
|
|
@@ -11103,7 +11095,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11103
11095
|
* @throws {RequiredError}
|
|
11104
11096
|
* @memberof WebhooksApi
|
|
11105
11097
|
*/
|
|
11106
|
-
deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
11098
|
+
deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
11107
11099
|
/**
|
|
11108
11100
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
11109
11101
|
* @summary Retrieve webhook
|
|
@@ -11112,7 +11104,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11112
11104
|
* @throws {RequiredError}
|
|
11113
11105
|
* @memberof WebhooksApi
|
|
11114
11106
|
*/
|
|
11115
|
-
getWebhook(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
11107
|
+
getWebhook(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateWebhook200Response, any, {}>>;
|
|
11116
11108
|
/**
|
|
11117
11109
|
* Lists all event types that can be sent to the configured webhook endpoint. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
11118
11110
|
* @summary List events
|
|
@@ -11121,7 +11113,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11121
11113
|
* @throws {RequiredError}
|
|
11122
11114
|
* @memberof WebhooksApi
|
|
11123
11115
|
*/
|
|
11124
|
-
listWebhookEvents(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
11116
|
+
listWebhookEvents(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListWebhookEvents200Response, any, {}>>;
|
|
11125
11117
|
/**
|
|
11126
11118
|
* Every organization can only have one webhook. This endpoint shows the details about that webhook. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
11127
11119
|
* @summary List webhooks
|
|
@@ -11129,7 +11121,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11129
11121
|
* @throws {RequiredError}
|
|
11130
11122
|
* @memberof WebhooksApi
|
|
11131
11123
|
*/
|
|
11132
|
-
listWebhooks(options?: RawAxiosRequestConfig): Promise<
|
|
11124
|
+
listWebhooks(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListWebhooks200Response, any, {}>>;
|
|
11133
11125
|
/**
|
|
11134
11126
|
* Making a request to this endpoint will cause our system to trigger a webhook for the specified event. This can be very useful when testing the setup that processes webhooks on your end. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
11135
11127
|
* @summary Test webhook
|
|
@@ -11139,5 +11131,5 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11139
11131
|
* @throws {RequiredError}
|
|
11140
11132
|
* @memberof WebhooksApi
|
|
11141
11133
|
*/
|
|
11142
|
-
simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11134
|
+
simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
11143
11135
|
}
|