tremendous 3.0.0 → 3.0.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/dist/api.d.ts +76 -69
- package/dist/api.js +199 -192
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -274,7 +274,7 @@ export interface CreateOrder200ResponseOrder {
|
|
|
274
274
|
*/
|
|
275
275
|
'created_at': string;
|
|
276
276
|
/**
|
|
277
|
-
* 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> CART </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>
|
|
277
|
+
* 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> CART </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>
|
|
278
278
|
* @type {string}
|
|
279
279
|
* @memberof CreateOrder200ResponseOrder
|
|
280
280
|
*/
|
|
@@ -304,6 +304,7 @@ export declare const CreateOrder200ResponseOrderStatusEnum: {
|
|
|
304
304
|
readonly Executed: "EXECUTED";
|
|
305
305
|
readonly Failed: "FAILED";
|
|
306
306
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
307
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
307
308
|
};
|
|
308
309
|
export type CreateOrder200ResponseOrderStatusEnum = typeof CreateOrder200ResponseOrderStatusEnum[keyof typeof CreateOrder200ResponseOrderStatusEnum];
|
|
309
310
|
/**
|
|
@@ -1283,15 +1284,15 @@ export interface GetOrganization200Response {
|
|
|
1283
1284
|
/**
|
|
1284
1285
|
*
|
|
1285
1286
|
* @export
|
|
1286
|
-
* @interface
|
|
1287
|
+
* @interface GetProductResponse
|
|
1287
1288
|
*/
|
|
1288
|
-
export interface
|
|
1289
|
+
export interface GetProductResponse {
|
|
1289
1290
|
/**
|
|
1290
1291
|
*
|
|
1291
|
-
* @type {
|
|
1292
|
-
* @memberof
|
|
1292
|
+
* @type {ListProductsResponseProductsInner}
|
|
1293
|
+
* @memberof GetProductResponse
|
|
1293
1294
|
*/
|
|
1294
|
-
'product':
|
|
1295
|
+
'product': ListProductsResponseProductsInner;
|
|
1295
1296
|
}
|
|
1296
1297
|
/**
|
|
1297
1298
|
*
|
|
@@ -1612,7 +1613,7 @@ export interface ListFundingSources200ResponseFundingSourcesInnerMeta {
|
|
|
1612
1613
|
* @type {string}
|
|
1613
1614
|
* @memberof ListFundingSources200ResponseFundingSourcesInnerMeta
|
|
1614
1615
|
*/
|
|
1615
|
-
'bank_name'?: string;
|
|
1616
|
+
'bank_name'?: string | null;
|
|
1616
1617
|
/**
|
|
1617
1618
|
* **Only available when `method` is set to `bank_account`.** Last 4 digits of the account number
|
|
1618
1619
|
* @type {string}
|
|
@@ -1878,7 +1879,7 @@ export interface ListOrders200ResponseOrdersInner {
|
|
|
1878
1879
|
*/
|
|
1879
1880
|
'created_at': string;
|
|
1880
1881
|
/**
|
|
1881
|
-
* 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> CART </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>
|
|
1882
|
+
* 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> CART </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>
|
|
1882
1883
|
* @type {string}
|
|
1883
1884
|
* @memberof ListOrders200ResponseOrdersInner
|
|
1884
1885
|
*/
|
|
@@ -1908,6 +1909,7 @@ export declare const ListOrders200ResponseOrdersInnerStatusEnum: {
|
|
|
1908
1909
|
readonly Executed: "EXECUTED";
|
|
1909
1910
|
readonly Failed: "FAILED";
|
|
1910
1911
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
1912
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
1911
1913
|
};
|
|
1912
1914
|
export type ListOrders200ResponseOrdersInnerStatusEnum = typeof ListOrders200ResponseOrdersInnerStatusEnum[keyof typeof ListOrders200ResponseOrdersInnerStatusEnum];
|
|
1913
1915
|
/**
|
|
@@ -2029,78 +2031,78 @@ export type ListOrganizations200ResponseOrganizationsInnerStatusEnum = typeof Li
|
|
|
2029
2031
|
/**
|
|
2030
2032
|
*
|
|
2031
2033
|
* @export
|
|
2032
|
-
* @interface
|
|
2034
|
+
* @interface ListProductsResponse
|
|
2033
2035
|
*/
|
|
2034
|
-
export interface
|
|
2036
|
+
export interface ListProductsResponse {
|
|
2035
2037
|
/**
|
|
2036
2038
|
*
|
|
2037
|
-
* @type {Array<
|
|
2038
|
-
* @memberof
|
|
2039
|
+
* @type {Array<ListProductsResponseProductsInner>}
|
|
2040
|
+
* @memberof ListProductsResponse
|
|
2039
2041
|
*/
|
|
2040
|
-
'products': Array<
|
|
2042
|
+
'products': Array<ListProductsResponseProductsInner>;
|
|
2041
2043
|
}
|
|
2042
2044
|
/**
|
|
2043
2045
|
* A product represents one way to payout a reward to it\'s recipient. Think: * Amazon.com gift card (ID: `OKMHM2X2OHYV`) * Donations to Save the Children (ID: `ESRNAD533W5A`) * Virtual Visa debit card (ID: `Q24BD9EZ332JT`) each of which is one specific product on Tremendous. > 📘 All available products > > See this [list](https://www.tremendous.com/catalog) Products can be limited in their availability to recipients by * geography (field `countries`) * currency (field `currencies`) * amount of the reward (field `skus`) * e.g. adidas gift cards accept any amount between 5 and 200 USD. See the description of each respective parameter for further details.
|
|
2044
2046
|
* @export
|
|
2045
|
-
* @interface
|
|
2047
|
+
* @interface ListProductsResponseProductsInner
|
|
2046
2048
|
*/
|
|
2047
|
-
export interface
|
|
2049
|
+
export interface ListProductsResponseProductsInner {
|
|
2048
2050
|
/**
|
|
2049
2051
|
*
|
|
2050
2052
|
* @type {string}
|
|
2051
|
-
* @memberof
|
|
2053
|
+
* @memberof ListProductsResponseProductsInner
|
|
2052
2054
|
*/
|
|
2053
2055
|
'id': string;
|
|
2054
2056
|
/**
|
|
2055
2057
|
* Name of the product
|
|
2056
2058
|
* @type {string}
|
|
2057
|
-
* @memberof
|
|
2059
|
+
* @memberof ListProductsResponseProductsInner
|
|
2058
2060
|
*/
|
|
2059
2061
|
'name': string;
|
|
2060
2062
|
/**
|
|
2061
2063
|
* Detailed description of the product. Mostly used for products with a `category` of `charities`.
|
|
2062
2064
|
* @type {string}
|
|
2063
|
-
* @memberof
|
|
2065
|
+
* @memberof ListProductsResponseProductsInner
|
|
2064
2066
|
*/
|
|
2065
2067
|
'description': string;
|
|
2066
2068
|
/**
|
|
2067
2069
|
* The category of this 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>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> </tbody> </table>
|
|
2068
2070
|
* @type {string}
|
|
2069
|
-
* @memberof
|
|
2071
|
+
* @memberof ListProductsResponseProductsInner
|
|
2070
2072
|
*/
|
|
2071
|
-
'category':
|
|
2073
|
+
'category': ListProductsResponseProductsInnerCategoryEnum;
|
|
2072
2074
|
/**
|
|
2073
2075
|
* Legal disclosures for this product. Can be in HTML format.
|
|
2074
2076
|
* @type {string}
|
|
2075
|
-
* @memberof
|
|
2077
|
+
* @memberof ListProductsResponseProductsInner
|
|
2076
2078
|
*/
|
|
2077
2079
|
'disclosure': string;
|
|
2078
2080
|
/**
|
|
2079
2081
|
* Products may are restricted in their usage based on the amount of the reward. The `skus` array defines bands of denominations in which this product may be used for payouts.
|
|
2080
|
-
* @type {Array<
|
|
2081
|
-
* @memberof
|
|
2082
|
+
* @type {Array<ListProductsResponseProductsInnerSkusInner>}
|
|
2083
|
+
* @memberof ListProductsResponseProductsInner
|
|
2082
2084
|
*/
|
|
2083
|
-
'skus'?: Array<
|
|
2085
|
+
'skus'?: Array<ListProductsResponseProductsInnerSkusInner>;
|
|
2084
2086
|
/**
|
|
2085
2087
|
* Available currencies for this product
|
|
2086
2088
|
* @type {Array<string>}
|
|
2087
|
-
* @memberof
|
|
2089
|
+
* @memberof ListProductsResponseProductsInner
|
|
2088
2090
|
*/
|
|
2089
|
-
'currency_codes': Array<
|
|
2091
|
+
'currency_codes': Array<ListProductsResponseProductsInnerCurrencyCodesEnum>;
|
|
2090
2092
|
/**
|
|
2091
2093
|
* List of countries in which this product is available to recipients.
|
|
2092
|
-
* @type {Array<
|
|
2093
|
-
* @memberof
|
|
2094
|
+
* @type {Array<ListProductsResponseProductsInnerCountriesInner>}
|
|
2095
|
+
* @memberof ListProductsResponseProductsInner
|
|
2094
2096
|
*/
|
|
2095
|
-
'countries': Array<
|
|
2097
|
+
'countries': Array<ListProductsResponseProductsInnerCountriesInner>;
|
|
2096
2098
|
/**
|
|
2097
2099
|
* List of product images associated with this product (e.g. logos or images of the gift cards)
|
|
2098
|
-
* @type {Array<
|
|
2099
|
-
* @memberof
|
|
2100
|
+
* @type {Array<ListProductsResponseProductsInnerImagesInner>}
|
|
2101
|
+
* @memberof ListProductsResponseProductsInner
|
|
2100
2102
|
*/
|
|
2101
|
-
'images': Array<
|
|
2103
|
+
'images': Array<ListProductsResponseProductsInnerImagesInner>;
|
|
2102
2104
|
}
|
|
2103
|
-
export declare const
|
|
2105
|
+
export declare const ListProductsResponseProductsInnerCategoryEnum: {
|
|
2104
2106
|
readonly Ach: "ach";
|
|
2105
2107
|
readonly Charity: "charity";
|
|
2106
2108
|
readonly MerchantCard: "merchant_card";
|
|
@@ -2108,8 +2110,8 @@ export declare const ListProducts200ResponseProductsInnerCategoryEnum: {
|
|
|
2108
2110
|
readonly Venmo: "venmo";
|
|
2109
2111
|
readonly VisaCard: "visa_card";
|
|
2110
2112
|
};
|
|
2111
|
-
export type
|
|
2112
|
-
export declare const
|
|
2113
|
+
export type ListProductsResponseProductsInnerCategoryEnum = typeof ListProductsResponseProductsInnerCategoryEnum[keyof typeof ListProductsResponseProductsInnerCategoryEnum];
|
|
2114
|
+
export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
2113
2115
|
readonly Usd: "USD";
|
|
2114
2116
|
readonly Cad: "CAD";
|
|
2115
2117
|
readonly Eur: "EUR";
|
|
@@ -2227,60 +2229,60 @@ export declare const ListProducts200ResponseProductsInnerCurrencyCodesEnum: {
|
|
|
2227
2229
|
readonly Zar: "ZAR";
|
|
2228
2230
|
readonly Zmk: "ZMK";
|
|
2229
2231
|
};
|
|
2230
|
-
export type
|
|
2232
|
+
export type ListProductsResponseProductsInnerCurrencyCodesEnum = typeof ListProductsResponseProductsInnerCurrencyCodesEnum[keyof typeof ListProductsResponseProductsInnerCurrencyCodesEnum];
|
|
2231
2233
|
/**
|
|
2232
2234
|
*
|
|
2233
2235
|
* @export
|
|
2234
|
-
* @interface
|
|
2236
|
+
* @interface ListProductsResponseProductsInnerCountriesInner
|
|
2235
2237
|
*/
|
|
2236
|
-
export interface
|
|
2238
|
+
export interface ListProductsResponseProductsInnerCountriesInner {
|
|
2237
2239
|
/**
|
|
2238
2240
|
* ISO 3166 country code
|
|
2239
2241
|
* @type {string}
|
|
2240
|
-
* @memberof
|
|
2242
|
+
* @memberof ListProductsResponseProductsInnerCountriesInner
|
|
2241
2243
|
*/
|
|
2242
2244
|
'abbr': string;
|
|
2243
2245
|
}
|
|
2244
2246
|
/**
|
|
2245
2247
|
*
|
|
2246
2248
|
* @export
|
|
2247
|
-
* @interface
|
|
2249
|
+
* @interface ListProductsResponseProductsInnerImagesInner
|
|
2248
2250
|
*/
|
|
2249
|
-
export interface
|
|
2251
|
+
export interface ListProductsResponseProductsInnerImagesInner {
|
|
2250
2252
|
/**
|
|
2251
2253
|
* URL to this image
|
|
2252
2254
|
* @type {string}
|
|
2253
|
-
* @memberof
|
|
2255
|
+
* @memberof ListProductsResponseProductsInnerImagesInner
|
|
2254
2256
|
*/
|
|
2255
2257
|
'src': string;
|
|
2256
2258
|
/**
|
|
2257
2259
|
* Type of image
|
|
2258
2260
|
* @type {string}
|
|
2259
|
-
* @memberof
|
|
2261
|
+
* @memberof ListProductsResponseProductsInnerImagesInner
|
|
2260
2262
|
*/
|
|
2261
|
-
'type':
|
|
2263
|
+
'type': ListProductsResponseProductsInnerImagesInnerTypeEnum;
|
|
2262
2264
|
}
|
|
2263
|
-
export declare const
|
|
2265
|
+
export declare const ListProductsResponseProductsInnerImagesInnerTypeEnum: {
|
|
2264
2266
|
readonly Card: "card";
|
|
2265
2267
|
readonly Logo: "logo";
|
|
2266
2268
|
};
|
|
2267
|
-
export type
|
|
2269
|
+
export type ListProductsResponseProductsInnerImagesInnerTypeEnum = typeof ListProductsResponseProductsInnerImagesInnerTypeEnum[keyof typeof ListProductsResponseProductsInnerImagesInnerTypeEnum];
|
|
2268
2270
|
/**
|
|
2269
2271
|
*
|
|
2270
2272
|
* @export
|
|
2271
|
-
* @interface
|
|
2273
|
+
* @interface ListProductsResponseProductsInnerSkusInner
|
|
2272
2274
|
*/
|
|
2273
|
-
export interface
|
|
2275
|
+
export interface ListProductsResponseProductsInnerSkusInner {
|
|
2274
2276
|
/**
|
|
2275
2277
|
* Minimal denomination that this product supports (in the product\'s currency)
|
|
2276
2278
|
* @type {number}
|
|
2277
|
-
* @memberof
|
|
2279
|
+
* @memberof ListProductsResponseProductsInnerSkusInner
|
|
2278
2280
|
*/
|
|
2279
2281
|
'min': number;
|
|
2280
2282
|
/**
|
|
2281
2283
|
* Maximum denomination that this product supports (in the product\'s currency)
|
|
2282
2284
|
* @type {number}
|
|
2283
|
-
* @memberof
|
|
2285
|
+
* @memberof ListProductsResponseProductsInnerSkusInner
|
|
2284
2286
|
*/
|
|
2285
2287
|
'max': number;
|
|
2286
2288
|
}
|
|
@@ -2660,7 +2662,7 @@ export interface ListWebhooks200ResponseWebhooksInner {
|
|
|
2660
2662
|
* @type {string}
|
|
2661
2663
|
* @memberof ListWebhooks200ResponseWebhooksInner
|
|
2662
2664
|
*/
|
|
2663
|
-
'url': string;
|
|
2665
|
+
'url': string | null;
|
|
2664
2666
|
/**
|
|
2665
2667
|
* Private key for the webhook
|
|
2666
2668
|
* @type {string}
|
|
@@ -2921,7 +2923,7 @@ export interface Order {
|
|
|
2921
2923
|
*/
|
|
2922
2924
|
'created_at': string;
|
|
2923
2925
|
/**
|
|
2924
|
-
* 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> CART </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>
|
|
2926
|
+
* 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> CART </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>
|
|
2925
2927
|
* @type {string}
|
|
2926
2928
|
* @memberof Order
|
|
2927
2929
|
*/
|
|
@@ -2951,6 +2953,7 @@ export declare const OrderStatusEnum: {
|
|
|
2951
2953
|
readonly Executed: "EXECUTED";
|
|
2952
2954
|
readonly Failed: "FAILED";
|
|
2953
2955
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
2956
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
2954
2957
|
};
|
|
2955
2958
|
export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
|
|
2956
2959
|
/**
|
|
@@ -2984,7 +2987,7 @@ export interface OrderBase {
|
|
|
2984
2987
|
*/
|
|
2985
2988
|
'created_at': string;
|
|
2986
2989
|
/**
|
|
2987
|
-
* 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> CART </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>
|
|
2990
|
+
* 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> CART </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>
|
|
2988
2991
|
* @type {string}
|
|
2989
2992
|
* @memberof OrderBase
|
|
2990
2993
|
*/
|
|
@@ -3008,6 +3011,7 @@ export declare const OrderBaseStatusEnum: {
|
|
|
3008
3011
|
readonly Executed: "EXECUTED";
|
|
3009
3012
|
readonly Failed: "FAILED";
|
|
3010
3013
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
3014
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3011
3015
|
};
|
|
3012
3016
|
export type OrderBaseStatusEnum = typeof OrderBaseStatusEnum[keyof typeof OrderBaseStatusEnum];
|
|
3013
3017
|
/**
|
|
@@ -3156,7 +3160,7 @@ export interface OrderForCreateReward {
|
|
|
3156
3160
|
'delivery'?: CreateOrderRequestRewardDelivery;
|
|
3157
3161
|
}
|
|
3158
3162
|
/**
|
|
3159
|
-
* 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> CART </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>
|
|
3163
|
+
* 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> CART </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>
|
|
3160
3164
|
* @export
|
|
3161
3165
|
* @enum {string}
|
|
3162
3166
|
*/
|
|
@@ -3166,6 +3170,7 @@ export declare const OrderStatus: {
|
|
|
3166
3170
|
readonly Executed: "EXECUTED";
|
|
3167
3171
|
readonly Failed: "FAILED";
|
|
3168
3172
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
3173
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3169
3174
|
};
|
|
3170
3175
|
export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
|
|
3171
3176
|
/**
|
|
@@ -3199,7 +3204,7 @@ export interface OrderWithLink {
|
|
|
3199
3204
|
*/
|
|
3200
3205
|
'created_at': string;
|
|
3201
3206
|
/**
|
|
3202
|
-
* 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> CART </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>
|
|
3207
|
+
* 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> CART </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>
|
|
3203
3208
|
* @type {string}
|
|
3204
3209
|
* @memberof OrderWithLink
|
|
3205
3210
|
*/
|
|
@@ -3229,6 +3234,7 @@ export declare const OrderWithLinkStatusEnum: {
|
|
|
3229
3234
|
readonly Executed: "EXECUTED";
|
|
3230
3235
|
readonly Failed: "FAILED";
|
|
3231
3236
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
3237
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3232
3238
|
};
|
|
3233
3239
|
export type OrderWithLinkStatusEnum = typeof OrderWithLinkStatusEnum[keyof typeof OrderWithLinkStatusEnum];
|
|
3234
3240
|
/**
|
|
@@ -3329,7 +3335,7 @@ export interface OrderWithoutLink {
|
|
|
3329
3335
|
*/
|
|
3330
3336
|
'created_at': string;
|
|
3331
3337
|
/**
|
|
3332
|
-
* 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> CART </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>
|
|
3338
|
+
* 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> CART </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>
|
|
3333
3339
|
* @type {string}
|
|
3334
3340
|
* @memberof OrderWithoutLink
|
|
3335
3341
|
*/
|
|
@@ -3359,6 +3365,7 @@ export declare const OrderWithoutLinkStatusEnum: {
|
|
|
3359
3365
|
readonly Executed: "EXECUTED";
|
|
3360
3366
|
readonly Failed: "FAILED";
|
|
3361
3367
|
readonly PendingApproval: "PENDING APPROVAL";
|
|
3368
|
+
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3362
3369
|
};
|
|
3363
3370
|
export type OrderWithoutLinkStatusEnum = typeof OrderWithoutLinkStatusEnum[keyof typeof OrderWithoutLinkStatusEnum];
|
|
3364
3371
|
/**
|
|
@@ -3569,10 +3576,10 @@ export interface Product {
|
|
|
3569
3576
|
'disclosure': string;
|
|
3570
3577
|
/**
|
|
3571
3578
|
* Products may are restricted in their usage based on the amount of the reward. The `skus` array defines bands of denominations in which this product may be used for payouts.
|
|
3572
|
-
* @type {Array<
|
|
3579
|
+
* @type {Array<ListProductsResponseProductsInnerSkusInner>}
|
|
3573
3580
|
* @memberof Product
|
|
3574
3581
|
*/
|
|
3575
|
-
'skus'?: Array<
|
|
3582
|
+
'skus'?: Array<ListProductsResponseProductsInnerSkusInner>;
|
|
3576
3583
|
/**
|
|
3577
3584
|
* Available currencies for this product
|
|
3578
3585
|
* @type {Array<string>}
|
|
@@ -3581,16 +3588,16 @@ export interface Product {
|
|
|
3581
3588
|
'currency_codes': Array<ProductCurrencyCodesEnum>;
|
|
3582
3589
|
/**
|
|
3583
3590
|
* List of countries in which this product is available to recipients.
|
|
3584
|
-
* @type {Array<
|
|
3591
|
+
* @type {Array<ListProductsResponseProductsInnerCountriesInner>}
|
|
3585
3592
|
* @memberof Product
|
|
3586
3593
|
*/
|
|
3587
|
-
'countries': Array<
|
|
3594
|
+
'countries': Array<ListProductsResponseProductsInnerCountriesInner>;
|
|
3588
3595
|
/**
|
|
3589
3596
|
* List of product images associated with this product (e.g. logos or images of the gift cards)
|
|
3590
|
-
* @type {Array<
|
|
3597
|
+
* @type {Array<ListProductsResponseProductsInnerImagesInner>}
|
|
3591
3598
|
* @memberof Product
|
|
3592
3599
|
*/
|
|
3593
|
-
'images': Array<
|
|
3600
|
+
'images': Array<ListProductsResponseProductsInnerImagesInner>;
|
|
3594
3601
|
}
|
|
3595
3602
|
export declare const ProductCategoryEnum: {
|
|
3596
3603
|
readonly Ach: "ach";
|
|
@@ -4407,7 +4414,7 @@ export interface Webhook {
|
|
|
4407
4414
|
* @type {string}
|
|
4408
4415
|
* @memberof Webhook
|
|
4409
4416
|
*/
|
|
4410
|
-
'url': string;
|
|
4417
|
+
'url': string | null;
|
|
4411
4418
|
/**
|
|
4412
4419
|
* Private key for the webhook
|
|
4413
4420
|
* @type {string}
|
|
@@ -5475,7 +5482,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
5475
5482
|
* @param {*} [options] Override http request option.
|
|
5476
5483
|
* @throws {RequiredError}
|
|
5477
5484
|
*/
|
|
5478
|
-
getProduct(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5485
|
+
getProduct(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductResponse>>;
|
|
5479
5486
|
/**
|
|
5480
5487
|
* Retrieve a list of available products
|
|
5481
5488
|
* @summary List products
|
|
@@ -5484,7 +5491,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
5484
5491
|
* @param {*} [options] Override http request option.
|
|
5485
5492
|
* @throws {RequiredError}
|
|
5486
5493
|
*/
|
|
5487
|
-
listProducts(country?: string, currency?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5494
|
+
listProducts(country?: string, currency?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductsResponse>>;
|
|
5488
5495
|
};
|
|
5489
5496
|
/**
|
|
5490
5497
|
* ProductsApi - factory interface
|
|
@@ -5498,7 +5505,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
5498
5505
|
* @param {*} [options] Override http request option.
|
|
5499
5506
|
* @throws {RequiredError}
|
|
5500
5507
|
*/
|
|
5501
|
-
getProduct(id: string, options?: any): AxiosPromise<
|
|
5508
|
+
getProduct(id: string, options?: any): AxiosPromise<GetProductResponse>;
|
|
5502
5509
|
/**
|
|
5503
5510
|
* Retrieve a list of available products
|
|
5504
5511
|
* @summary List products
|
|
@@ -5507,7 +5514,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
5507
5514
|
* @param {*} [options] Override http request option.
|
|
5508
5515
|
* @throws {RequiredError}
|
|
5509
5516
|
*/
|
|
5510
|
-
listProducts(country?: string, currency?: string, options?: any): AxiosPromise<
|
|
5517
|
+
listProducts(country?: string, currency?: string, options?: any): AxiosPromise<ListProductsResponse>;
|
|
5511
5518
|
};
|
|
5512
5519
|
/**
|
|
5513
5520
|
* ProductsApi - object-oriented interface
|
|
@@ -5524,7 +5531,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
5524
5531
|
* @throws {RequiredError}
|
|
5525
5532
|
* @memberof ProductsApi
|
|
5526
5533
|
*/
|
|
5527
|
-
getProduct(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5534
|
+
getProduct(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductResponse, any>>;
|
|
5528
5535
|
/**
|
|
5529
5536
|
* Retrieve a list of available products
|
|
5530
5537
|
* @summary List products
|
|
@@ -5534,7 +5541,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
5534
5541
|
* @throws {RequiredError}
|
|
5535
5542
|
* @memberof ProductsApi
|
|
5536
5543
|
*/
|
|
5537
|
-
listProducts(country?: string, currency?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
5544
|
+
listProducts(country?: string, currency?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductsResponse, any>>;
|
|
5538
5545
|
}
|
|
5539
5546
|
/**
|
|
5540
5547
|
* RewardsApi - axios parameter creator
|