tremendous 4.5.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 +8 -0
- package/dist/api.d.ts +68 -87
- package/dist/api.js +14 -31
- package/dist/base.js +4 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [4.5.1](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.5.0...tremendous-v4.5.1) (2026-04-14)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* remove obsolete currency codes `EEK`, `LTL`, `LVL`, `ZMK` ([b22a19c](https://github.com/tremendous-rewards/tremendous-node/commit/b22a19cf4860a24e094760ad55c2697c66b8918e))
|
|
9
|
+
* replace obsolete `BYR` currency code with `BYN` ([b22a19c](https://github.com/tremendous-rewards/tremendous-node/commit/b22a19cf4860a24e094760ad55c2697c66b8918e))
|
|
10
|
+
|
|
3
11
|
## [4.5.0](https://github.com/tremendous-rewards/tremendous-node/compare/tremendous-v4.4.0...tremendous-v4.5.0) (2026-03-20)
|
|
4
12
|
|
|
5
13
|
|
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
|
/**
|
|
@@ -1728,7 +1729,7 @@ export declare const CurrencyCodes: {
|
|
|
1728
1729
|
readonly Bob: "BOB";
|
|
1729
1730
|
readonly Brl: "BRL";
|
|
1730
1731
|
readonly Bwp: "BWP";
|
|
1731
|
-
readonly
|
|
1732
|
+
readonly Byn: "BYN";
|
|
1732
1733
|
readonly Bzd: "BZD";
|
|
1733
1734
|
readonly Cdf: "CDF";
|
|
1734
1735
|
readonly Chf: "CHF";
|
|
@@ -1742,7 +1743,6 @@ export declare const CurrencyCodes: {
|
|
|
1742
1743
|
readonly Dkk: "DKK";
|
|
1743
1744
|
readonly Dop: "DOP";
|
|
1744
1745
|
readonly Dzd: "DZD";
|
|
1745
|
-
readonly Eek: "EEK";
|
|
1746
1746
|
readonly Egp: "EGP";
|
|
1747
1747
|
readonly Ern: "ERN";
|
|
1748
1748
|
readonly Etb: "ETB";
|
|
@@ -1771,8 +1771,6 @@ export declare const CurrencyCodes: {
|
|
|
1771
1771
|
readonly Kzt: "KZT";
|
|
1772
1772
|
readonly Lbp: "LBP";
|
|
1773
1773
|
readonly Lkr: "LKR";
|
|
1774
|
-
readonly Ltl: "LTL";
|
|
1775
|
-
readonly Lvl: "LVL";
|
|
1776
1774
|
readonly Mad: "MAD";
|
|
1777
1775
|
readonly Mdl: "MDL";
|
|
1778
1776
|
readonly Mga: "MGA";
|
|
@@ -1824,7 +1822,6 @@ export declare const CurrencyCodes: {
|
|
|
1824
1822
|
readonly Xof: "XOF";
|
|
1825
1823
|
readonly Yer: "YER";
|
|
1826
1824
|
readonly Zar: "ZAR";
|
|
1827
|
-
readonly Zmk: "ZMK";
|
|
1828
1825
|
};
|
|
1829
1826
|
export type CurrencyCodes = typeof CurrencyCodes[keyof typeof CurrencyCodes];
|
|
1830
1827
|
/**
|
|
@@ -5027,7 +5024,7 @@ export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
|
5027
5024
|
readonly Bob: "BOB";
|
|
5028
5025
|
readonly Brl: "BRL";
|
|
5029
5026
|
readonly Bwp: "BWP";
|
|
5030
|
-
readonly
|
|
5027
|
+
readonly Byn: "BYN";
|
|
5031
5028
|
readonly Bzd: "BZD";
|
|
5032
5029
|
readonly Cdf: "CDF";
|
|
5033
5030
|
readonly Chf: "CHF";
|
|
@@ -5041,7 +5038,6 @@ export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
|
5041
5038
|
readonly Dkk: "DKK";
|
|
5042
5039
|
readonly Dop: "DOP";
|
|
5043
5040
|
readonly Dzd: "DZD";
|
|
5044
|
-
readonly Eek: "EEK";
|
|
5045
5041
|
readonly Egp: "EGP";
|
|
5046
5042
|
readonly Ern: "ERN";
|
|
5047
5043
|
readonly Etb: "ETB";
|
|
@@ -5070,8 +5066,6 @@ export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
|
5070
5066
|
readonly Kzt: "KZT";
|
|
5071
5067
|
readonly Lbp: "LBP";
|
|
5072
5068
|
readonly Lkr: "LKR";
|
|
5073
|
-
readonly Ltl: "LTL";
|
|
5074
|
-
readonly Lvl: "LVL";
|
|
5075
5069
|
readonly Mad: "MAD";
|
|
5076
5070
|
readonly Mdl: "MDL";
|
|
5077
5071
|
readonly Mga: "MGA";
|
|
@@ -5123,7 +5117,6 @@ export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: {
|
|
|
5123
5117
|
readonly Xof: "XOF";
|
|
5124
5118
|
readonly Yer: "YER";
|
|
5125
5119
|
readonly Zar: "ZAR";
|
|
5126
|
-
readonly Zmk: "ZMK";
|
|
5127
5120
|
};
|
|
5128
5121
|
export type ListProductsResponseProductsInnerCurrencyCodesEnum = typeof ListProductsResponseProductsInnerCurrencyCodesEnum[keyof typeof ListProductsResponseProductsInnerCurrencyCodesEnum];
|
|
5129
5122
|
/**
|
|
@@ -5413,7 +5406,7 @@ export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
|
5413
5406
|
readonly Bob: "BOB";
|
|
5414
5407
|
readonly Brl: "BRL";
|
|
5415
5408
|
readonly Bwp: "BWP";
|
|
5416
|
-
readonly
|
|
5409
|
+
readonly Byn: "BYN";
|
|
5417
5410
|
readonly Bzd: "BZD";
|
|
5418
5411
|
readonly Cdf: "CDF";
|
|
5419
5412
|
readonly Chf: "CHF";
|
|
@@ -5427,7 +5420,6 @@ export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
|
5427
5420
|
readonly Dkk: "DKK";
|
|
5428
5421
|
readonly Dop: "DOP";
|
|
5429
5422
|
readonly Dzd: "DZD";
|
|
5430
|
-
readonly Eek: "EEK";
|
|
5431
5423
|
readonly Egp: "EGP";
|
|
5432
5424
|
readonly Ern: "ERN";
|
|
5433
5425
|
readonly Etb: "ETB";
|
|
@@ -5456,8 +5448,6 @@ export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
|
5456
5448
|
readonly Kzt: "KZT";
|
|
5457
5449
|
readonly Lbp: "LBP";
|
|
5458
5450
|
readonly Lkr: "LKR";
|
|
5459
|
-
readonly Ltl: "LTL";
|
|
5460
|
-
readonly Lvl: "LVL";
|
|
5461
5451
|
readonly Mad: "MAD";
|
|
5462
5452
|
readonly Mdl: "MDL";
|
|
5463
5453
|
readonly Mga: "MGA";
|
|
@@ -5509,7 +5499,6 @@ export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: {
|
|
|
5509
5499
|
readonly Xof: "XOF";
|
|
5510
5500
|
readonly Yer: "YER";
|
|
5511
5501
|
readonly Zar: "ZAR";
|
|
5512
|
-
readonly Zmk: "ZMK";
|
|
5513
5502
|
};
|
|
5514
5503
|
export type ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum[keyof typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum];
|
|
5515
5504
|
/**
|
|
@@ -6770,7 +6759,7 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
6770
6759
|
readonly Bob: "BOB";
|
|
6771
6760
|
readonly Brl: "BRL";
|
|
6772
6761
|
readonly Bwp: "BWP";
|
|
6773
|
-
readonly
|
|
6762
|
+
readonly Byn: "BYN";
|
|
6774
6763
|
readonly Bzd: "BZD";
|
|
6775
6764
|
readonly Cdf: "CDF";
|
|
6776
6765
|
readonly Chf: "CHF";
|
|
@@ -6784,7 +6773,6 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
6784
6773
|
readonly Dkk: "DKK";
|
|
6785
6774
|
readonly Dop: "DOP";
|
|
6786
6775
|
readonly Dzd: "DZD";
|
|
6787
|
-
readonly Eek: "EEK";
|
|
6788
6776
|
readonly Egp: "EGP";
|
|
6789
6777
|
readonly Ern: "ERN";
|
|
6790
6778
|
readonly Etb: "ETB";
|
|
@@ -6813,8 +6801,6 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
6813
6801
|
readonly Kzt: "KZT";
|
|
6814
6802
|
readonly Lbp: "LBP";
|
|
6815
6803
|
readonly Lkr: "LKR";
|
|
6816
|
-
readonly Ltl: "LTL";
|
|
6817
|
-
readonly Lvl: "LVL";
|
|
6818
6804
|
readonly Mad: "MAD";
|
|
6819
6805
|
readonly Mdl: "MDL";
|
|
6820
6806
|
readonly Mga: "MGA";
|
|
@@ -6866,7 +6852,6 @@ export declare const ProductCurrencyCodesEnum: {
|
|
|
6866
6852
|
readonly Xof: "XOF";
|
|
6867
6853
|
readonly Yer: "YER";
|
|
6868
6854
|
readonly Zar: "ZAR";
|
|
6869
|
-
readonly Zmk: "ZMK";
|
|
6870
6855
|
};
|
|
6871
6856
|
export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum];
|
|
6872
6857
|
/**
|
|
@@ -7497,7 +7482,7 @@ export declare const RewardValueCurrencyCodeEnum: {
|
|
|
7497
7482
|
readonly Bob: "BOB";
|
|
7498
7483
|
readonly Brl: "BRL";
|
|
7499
7484
|
readonly Bwp: "BWP";
|
|
7500
|
-
readonly
|
|
7485
|
+
readonly Byn: "BYN";
|
|
7501
7486
|
readonly Bzd: "BZD";
|
|
7502
7487
|
readonly Cdf: "CDF";
|
|
7503
7488
|
readonly Chf: "CHF";
|
|
@@ -7511,7 +7496,6 @@ export declare const RewardValueCurrencyCodeEnum: {
|
|
|
7511
7496
|
readonly Dkk: "DKK";
|
|
7512
7497
|
readonly Dop: "DOP";
|
|
7513
7498
|
readonly Dzd: "DZD";
|
|
7514
|
-
readonly Eek: "EEK";
|
|
7515
7499
|
readonly Egp: "EGP";
|
|
7516
7500
|
readonly Ern: "ERN";
|
|
7517
7501
|
readonly Etb: "ETB";
|
|
@@ -7540,8 +7524,6 @@ export declare const RewardValueCurrencyCodeEnum: {
|
|
|
7540
7524
|
readonly Kzt: "KZT";
|
|
7541
7525
|
readonly Lbp: "LBP";
|
|
7542
7526
|
readonly Lkr: "LKR";
|
|
7543
|
-
readonly Ltl: "LTL";
|
|
7544
|
-
readonly Lvl: "LVL";
|
|
7545
7527
|
readonly Mad: "MAD";
|
|
7546
7528
|
readonly Mdl: "MDL";
|
|
7547
7529
|
readonly Mga: "MGA";
|
|
@@ -7593,7 +7575,6 @@ export declare const RewardValueCurrencyCodeEnum: {
|
|
|
7593
7575
|
readonly Xof: "XOF";
|
|
7594
7576
|
readonly Yer: "YER";
|
|
7595
7577
|
readonly Zar: "ZAR";
|
|
7596
|
-
readonly Zmk: "ZMK";
|
|
7597
7578
|
};
|
|
7598
7579
|
export type RewardValueCurrencyCodeEnum = typeof RewardValueCurrencyCodeEnum[keyof typeof RewardValueCurrencyCodeEnum];
|
|
7599
7580
|
/**
|
|
@@ -8555,7 +8536,7 @@ export declare class BalanceTransactionsApi extends BaseAPI {
|
|
|
8555
8536
|
* @throws {RequiredError}
|
|
8556
8537
|
* @memberof BalanceTransactionsApi
|
|
8557
8538
|
*/
|
|
8558
|
-
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, {}>>;
|
|
8559
8540
|
}
|
|
8560
8541
|
/**
|
|
8561
8542
|
* CampaignsApi - axios parameter creator
|
|
@@ -8686,7 +8667,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
8686
8667
|
* @throws {RequiredError}
|
|
8687
8668
|
* @memberof CampaignsApi
|
|
8688
8669
|
*/
|
|
8689
|
-
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8670
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateCampaign200Response, any, {}>>;
|
|
8690
8671
|
/**
|
|
8691
8672
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
8692
8673
|
* @summary Retrieve campaign
|
|
@@ -8695,7 +8676,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
8695
8676
|
* @throws {RequiredError}
|
|
8696
8677
|
* @memberof CampaignsApi
|
|
8697
8678
|
*/
|
|
8698
|
-
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
8679
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateCampaign200Response, any, {}>>;
|
|
8699
8680
|
/**
|
|
8700
8681
|
* Retrieve a list of all campaigns created in your account
|
|
8701
8682
|
* @summary List campaigns
|
|
@@ -8703,7 +8684,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
8703
8684
|
* @throws {RequiredError}
|
|
8704
8685
|
* @memberof CampaignsApi
|
|
8705
8686
|
*/
|
|
8706
|
-
listCampaigns(options?: RawAxiosRequestConfig): Promise<
|
|
8687
|
+
listCampaigns(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListCampaigns200Response, any, {}>>;
|
|
8707
8688
|
/**
|
|
8708
8689
|
*
|
|
8709
8690
|
* @summary Update campaign
|
|
@@ -8713,7 +8694,7 @@ export declare class CampaignsApi extends BaseAPI {
|
|
|
8713
8694
|
* @throws {RequiredError}
|
|
8714
8695
|
* @memberof CampaignsApi
|
|
8715
8696
|
*/
|
|
8716
|
-
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8697
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateCampaign200Response, any, {}>>;
|
|
8717
8698
|
}
|
|
8718
8699
|
/**
|
|
8719
8700
|
* ConnectedOrganizationMembersApi - axios parameter creator
|
|
@@ -8853,7 +8834,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
8853
8834
|
* @throws {RequiredError}
|
|
8854
8835
|
* @memberof ConnectedOrganizationMembersApi
|
|
8855
8836
|
*/
|
|
8856
|
-
createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8837
|
+
createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganizationMember200Response, any, {}>>;
|
|
8857
8838
|
/**
|
|
8858
8839
|
* Create a connected organization member session.
|
|
8859
8840
|
* @summary Create connected organization member session
|
|
@@ -8863,7 +8844,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
8863
8844
|
* @throws {RequiredError}
|
|
8864
8845
|
* @memberof ConnectedOrganizationMembersApi
|
|
8865
8846
|
*/
|
|
8866
|
-
createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8847
|
+
createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganizationMemberSession200Response, any, {}>>;
|
|
8867
8848
|
/**
|
|
8868
8849
|
* Retrieve the connected organization member, identified by the given `id` in the URL
|
|
8869
8850
|
* @summary Retrieve a connected organization member
|
|
@@ -8872,7 +8853,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
8872
8853
|
* @throws {RequiredError}
|
|
8873
8854
|
* @memberof ConnectedOrganizationMembersApi
|
|
8874
8855
|
*/
|
|
8875
|
-
getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
8856
|
+
getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganizationMember200Response, any, {}>>;
|
|
8876
8857
|
/**
|
|
8877
8858
|
* Retrieve a list of connected organization members.
|
|
8878
8859
|
* @summary List connected organization members
|
|
@@ -8883,7 +8864,7 @@ export declare class ConnectedOrganizationMembersApi extends BaseAPI {
|
|
|
8883
8864
|
* @throws {RequiredError}
|
|
8884
8865
|
* @memberof ConnectedOrganizationMembersApi
|
|
8885
8866
|
*/
|
|
8886
|
-
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, {}>>;
|
|
8887
8868
|
}
|
|
8888
8869
|
/**
|
|
8889
8870
|
* ConnectedOrganizationsApi - axios parameter creator
|
|
@@ -8993,7 +8974,7 @@ export declare class ConnectedOrganizationsApi extends BaseAPI {
|
|
|
8993
8974
|
* @throws {RequiredError}
|
|
8994
8975
|
* @memberof ConnectedOrganizationsApi
|
|
8995
8976
|
*/
|
|
8996
|
-
createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8977
|
+
createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganization200Response, any, {}>>;
|
|
8997
8978
|
/**
|
|
8998
8979
|
* Retrieve the connected organization, identified by the given `id` in the URL
|
|
8999
8980
|
* @summary Retrieve a connected organization
|
|
@@ -9002,7 +8983,7 @@ export declare class ConnectedOrganizationsApi extends BaseAPI {
|
|
|
9002
8983
|
* @throws {RequiredError}
|
|
9003
8984
|
* @memberof ConnectedOrganizationsApi
|
|
9004
8985
|
*/
|
|
9005
|
-
getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
8986
|
+
getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateConnectedOrganization200Response, any, {}>>;
|
|
9006
8987
|
/**
|
|
9007
8988
|
* Retrieve a list of connected organizations.
|
|
9008
8989
|
* @summary List connected organizations
|
|
@@ -9012,7 +8993,7 @@ export declare class ConnectedOrganizationsApi extends BaseAPI {
|
|
|
9012
8993
|
* @throws {RequiredError}
|
|
9013
8994
|
* @memberof ConnectedOrganizationsApi
|
|
9014
8995
|
*/
|
|
9015
|
-
listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8996
|
+
listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListConnectedOrganizations200Response, any, {}>>;
|
|
9016
8997
|
}
|
|
9017
8998
|
/**
|
|
9018
8999
|
* FieldsApi - axios parameter creator
|
|
@@ -9092,7 +9073,7 @@ export declare class FieldsApi extends BaseAPI {
|
|
|
9092
9073
|
* @throws {RequiredError}
|
|
9093
9074
|
* @memberof FieldsApi
|
|
9094
9075
|
*/
|
|
9095
|
-
createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9076
|
+
createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateField200Response, any, {}>>;
|
|
9096
9077
|
/**
|
|
9097
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.
|
|
9098
9079
|
* @summary List fields
|
|
@@ -9100,7 +9081,7 @@ export declare class FieldsApi extends BaseAPI {
|
|
|
9100
9081
|
* @throws {RequiredError}
|
|
9101
9082
|
* @memberof FieldsApi
|
|
9102
9083
|
*/
|
|
9103
|
-
listFields(options?: RawAxiosRequestConfig): Promise<
|
|
9084
|
+
listFields(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFields200Response, any, {}>>;
|
|
9104
9085
|
}
|
|
9105
9086
|
/**
|
|
9106
9087
|
* ForexApi - axios parameter creator
|
|
@@ -9159,7 +9140,7 @@ export declare class ForexApi extends BaseAPI {
|
|
|
9159
9140
|
* @throws {RequiredError}
|
|
9160
9141
|
* @memberof ForexApi
|
|
9161
9142
|
*/
|
|
9162
|
-
listForex(base?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9143
|
+
listForex(base?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListForexResponse, any, {}>>;
|
|
9163
9144
|
}
|
|
9164
9145
|
/**
|
|
9165
9146
|
* FraudReviewsApi - axios parameter creator
|
|
@@ -9308,7 +9289,7 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9308
9289
|
* @throws {RequiredError}
|
|
9309
9290
|
* @memberof FraudReviewsApi
|
|
9310
9291
|
*/
|
|
9311
|
-
blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9292
|
+
blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFraudReview200Response, any, {}>>;
|
|
9312
9293
|
/**
|
|
9313
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.
|
|
9314
9295
|
* @summary Retrieve single fraud review
|
|
@@ -9317,7 +9298,7 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9317
9298
|
* @throws {RequiredError}
|
|
9318
9299
|
* @memberof FraudReviewsApi
|
|
9319
9300
|
*/
|
|
9320
|
-
getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9301
|
+
getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFraudReview200Response, any, {}>>;
|
|
9321
9302
|
/**
|
|
9322
9303
|
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
9323
9304
|
* @summary List fraud reviews
|
|
@@ -9332,7 +9313,7 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9332
9313
|
* @throws {RequiredError}
|
|
9333
9314
|
* @memberof FraudReviewsApi
|
|
9334
9315
|
*/
|
|
9335
|
-
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, {}>>;
|
|
9336
9317
|
/**
|
|
9337
9318
|
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
9338
9319
|
* @summary Release fraud review
|
|
@@ -9341,7 +9322,7 @@ export declare class FraudReviewsApi extends BaseAPI {
|
|
|
9341
9322
|
* @throws {RequiredError}
|
|
9342
9323
|
* @memberof FraudReviewsApi
|
|
9343
9324
|
*/
|
|
9344
|
-
releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9325
|
+
releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFraudReview200Response, any, {}>>;
|
|
9345
9326
|
}
|
|
9346
9327
|
/**
|
|
9347
9328
|
* @export
|
|
@@ -9484,7 +9465,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9484
9465
|
* @throws {RequiredError}
|
|
9485
9466
|
* @memberof FraudRulesApi
|
|
9486
9467
|
*/
|
|
9487
|
-
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<
|
|
9468
|
+
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteFraudRule200Response, any, {}>>;
|
|
9488
9469
|
/**
|
|
9489
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.
|
|
9490
9471
|
* @summary Configure fraud rule
|
|
@@ -9494,7 +9475,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9494
9475
|
* @throws {RequiredError}
|
|
9495
9476
|
* @memberof FraudRulesApi
|
|
9496
9477
|
*/
|
|
9497
|
-
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9478
|
+
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<FraudRule200Response, any, {}>>;
|
|
9498
9479
|
/**
|
|
9499
9480
|
* List active fraud rules associated with the organization tied to your API key.
|
|
9500
9481
|
* @summary List fraud rules
|
|
@@ -9502,7 +9483,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9502
9483
|
* @throws {RequiredError}
|
|
9503
9484
|
* @memberof FraudRulesApi
|
|
9504
9485
|
*/
|
|
9505
|
-
listFraudRules(options?: RawAxiosRequestConfig): Promise<
|
|
9486
|
+
listFraudRules(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFraudRules200Response, any, {}>>;
|
|
9506
9487
|
/**
|
|
9507
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\"] } } ```
|
|
9508
9489
|
* @summary Update fraud rule list
|
|
@@ -9512,7 +9493,7 @@ export declare class FraudRulesApi extends BaseAPI {
|
|
|
9512
9493
|
* @throws {RequiredError}
|
|
9513
9494
|
* @memberof FraudRulesApi
|
|
9514
9495
|
*/
|
|
9515
|
-
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9496
|
+
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateFraudRuleList200Response, any, {}>>;
|
|
9516
9497
|
}
|
|
9517
9498
|
/**
|
|
9518
9499
|
* @export
|
|
@@ -9637,7 +9618,7 @@ export declare class FundingSourcesApi extends BaseAPI {
|
|
|
9637
9618
|
* @throws {RequiredError}
|
|
9638
9619
|
* @memberof FundingSourcesApi
|
|
9639
9620
|
*/
|
|
9640
|
-
getFundingSource(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9621
|
+
getFundingSource(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFundingSource200Response, any, {}>>;
|
|
9641
9622
|
/**
|
|
9642
9623
|
* Retrieve a list of all funding sources in your organization\'s account.
|
|
9643
9624
|
* @summary List funding sources
|
|
@@ -9645,7 +9626,7 @@ export declare class FundingSourcesApi extends BaseAPI {
|
|
|
9645
9626
|
* @throws {RequiredError}
|
|
9646
9627
|
* @memberof FundingSourcesApi
|
|
9647
9628
|
*/
|
|
9648
|
-
listFundingSources(options?: RawAxiosRequestConfig): Promise<
|
|
9629
|
+
listFundingSources(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFundingSources200Response, any, {}>>;
|
|
9649
9630
|
}
|
|
9650
9631
|
/**
|
|
9651
9632
|
* InvoicesApi - axios parameter creator
|
|
@@ -9827,7 +9808,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9827
9808
|
* @throws {RequiredError}
|
|
9828
9809
|
* @memberof InvoicesApi
|
|
9829
9810
|
*/
|
|
9830
|
-
createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9811
|
+
createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInvoice200Response, any, {}>>;
|
|
9831
9812
|
/**
|
|
9832
9813
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
9833
9814
|
* @summary Delete invoice
|
|
@@ -9836,7 +9817,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9836
9817
|
* @throws {RequiredError}
|
|
9837
9818
|
* @memberof InvoicesApi
|
|
9838
9819
|
*/
|
|
9839
|
-
deleteInvoices(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9820
|
+
deleteInvoices(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInvoice200Response, any, {}>>;
|
|
9840
9821
|
/**
|
|
9841
9822
|
* Generates a CSV version for an invoice listing the associated rewards and orders
|
|
9842
9823
|
* @summary Retrieve invoice as CSV
|
|
@@ -9845,7 +9826,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9845
9826
|
* @throws {RequiredError}
|
|
9846
9827
|
* @memberof InvoicesApi
|
|
9847
9828
|
*/
|
|
9848
|
-
downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9829
|
+
downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
9849
9830
|
/**
|
|
9850
9831
|
* Generates a PDF version for an invoice
|
|
9851
9832
|
* @summary Retrieve invoice as PDF
|
|
@@ -9854,7 +9835,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9854
9835
|
* @throws {RequiredError}
|
|
9855
9836
|
* @memberof InvoicesApi
|
|
9856
9837
|
*/
|
|
9857
|
-
downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9838
|
+
downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<File, any, {}>>;
|
|
9858
9839
|
/**
|
|
9859
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.
|
|
9860
9841
|
* @summary Retrieve invoice
|
|
@@ -9863,7 +9844,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9863
9844
|
* @throws {RequiredError}
|
|
9864
9845
|
* @memberof InvoicesApi
|
|
9865
9846
|
*/
|
|
9866
|
-
getInvoice(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9847
|
+
getInvoice(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInvoice200Response, any, {}>>;
|
|
9867
9848
|
/**
|
|
9868
9849
|
* Fetch a list of all invoices on your account. > 🚧 Deleted invoices are omitted > > The response does not include any previously deleted invoices.
|
|
9869
9850
|
* @summary List invoices
|
|
@@ -9873,7 +9854,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
9873
9854
|
* @throws {RequiredError}
|
|
9874
9855
|
* @memberof InvoicesApi
|
|
9875
9856
|
*/
|
|
9876
|
-
listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
9857
|
+
listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInvoices200Response, any, {}>>;
|
|
9877
9858
|
}
|
|
9878
9859
|
/**
|
|
9879
9860
|
* MembersApi - axios parameter creator
|
|
@@ -9977,7 +9958,7 @@ export declare class MembersApi extends BaseAPI {
|
|
|
9977
9958
|
* @throws {RequiredError}
|
|
9978
9959
|
* @memberof MembersApi
|
|
9979
9960
|
*/
|
|
9980
|
-
createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9961
|
+
createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateMember200Response, any, {}>>;
|
|
9981
9962
|
/**
|
|
9982
9963
|
*
|
|
9983
9964
|
* @summary Retrieve member
|
|
@@ -9986,7 +9967,7 @@ export declare class MembersApi extends BaseAPI {
|
|
|
9986
9967
|
* @throws {RequiredError}
|
|
9987
9968
|
* @memberof MembersApi
|
|
9988
9969
|
*/
|
|
9989
|
-
getMember(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
9970
|
+
getMember(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetMember200Response, any, {}>>;
|
|
9990
9971
|
/**
|
|
9991
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.
|
|
9992
9973
|
* @summary List members
|
|
@@ -9994,7 +9975,7 @@ export declare class MembersApi extends BaseAPI {
|
|
|
9994
9975
|
* @throws {RequiredError}
|
|
9995
9976
|
* @memberof MembersApi
|
|
9996
9977
|
*/
|
|
9997
|
-
listMembers(options?: RawAxiosRequestConfig): Promise<
|
|
9978
|
+
listMembers(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListMembers200Response, any, {}>>;
|
|
9998
9979
|
}
|
|
9999
9980
|
/**
|
|
10000
9981
|
* OrdersApi - axios parameter creator
|
|
@@ -10164,7 +10145,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10164
10145
|
* @throws {RequiredError}
|
|
10165
10146
|
* @memberof OrdersApi
|
|
10166
10147
|
*/
|
|
10167
|
-
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10148
|
+
approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrder200Response, any, {}>>;
|
|
10168
10149
|
/**
|
|
10169
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.
|
|
10170
10151
|
* @summary Create order
|
|
@@ -10173,7 +10154,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10173
10154
|
* @throws {RequiredError}
|
|
10174
10155
|
* @memberof OrdersApi
|
|
10175
10156
|
*/
|
|
10176
|
-
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10157
|
+
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateOrder200Response, any, {}>>;
|
|
10177
10158
|
/**
|
|
10178
10159
|
* Retrieve the order, identified by the given `id` in the URL
|
|
10179
10160
|
* @summary Retrieve order
|
|
@@ -10182,7 +10163,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10182
10163
|
* @throws {RequiredError}
|
|
10183
10164
|
* @memberof OrdersApi
|
|
10184
10165
|
*/
|
|
10185
|
-
getOrder(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10166
|
+
getOrder(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrder200Response, any, {}>>;
|
|
10186
10167
|
/**
|
|
10187
10168
|
* Retrieve a list of orders
|
|
10188
10169
|
* @summary List orders
|
|
@@ -10196,7 +10177,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10196
10177
|
* @throws {RequiredError}
|
|
10197
10178
|
* @memberof OrdersApi
|
|
10198
10179
|
*/
|
|
10199
|
-
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, {}>>;
|
|
10200
10181
|
/**
|
|
10201
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.
|
|
10202
10183
|
* @summary Reject order
|
|
@@ -10205,7 +10186,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
10205
10186
|
* @throws {RequiredError}
|
|
10206
10187
|
* @memberof OrdersApi
|
|
10207
10188
|
*/
|
|
10208
|
-
rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10189
|
+
rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrder200Response, any, {}>>;
|
|
10209
10190
|
}
|
|
10210
10191
|
/**
|
|
10211
10192
|
* OrganizationsApi - axios parameter creator
|
|
@@ -10329,7 +10310,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10329
10310
|
* @throws {RequiredError}
|
|
10330
10311
|
* @memberof OrganizationsApi
|
|
10331
10312
|
*/
|
|
10332
|
-
createApiKey(options?: RawAxiosRequestConfig): Promise<
|
|
10313
|
+
createApiKey(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateApiKey200Response, any, {}>>;
|
|
10333
10314
|
/**
|
|
10334
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.
|
|
10335
10316
|
* @summary Create organization
|
|
@@ -10338,7 +10319,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10338
10319
|
* @throws {RequiredError}
|
|
10339
10320
|
* @memberof OrganizationsApi
|
|
10340
10321
|
*/
|
|
10341
|
-
createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10322
|
+
createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateOrganization200Response, any, {}>>;
|
|
10342
10323
|
/**
|
|
10343
10324
|
*
|
|
10344
10325
|
* @summary Retrieve organization
|
|
@@ -10347,7 +10328,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10347
10328
|
* @throws {RequiredError}
|
|
10348
10329
|
* @memberof OrganizationsApi
|
|
10349
10330
|
*/
|
|
10350
|
-
getOrganization(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10331
|
+
getOrganization(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrganization200Response, any, {}>>;
|
|
10351
10332
|
/**
|
|
10352
10333
|
* The returned list only includes the organization to which the API key belongs to, that is used for the request.
|
|
10353
10334
|
* @summary List organizations
|
|
@@ -10355,7 +10336,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
10355
10336
|
* @throws {RequiredError}
|
|
10356
10337
|
* @memberof OrganizationsApi
|
|
10357
10338
|
*/
|
|
10358
|
-
listOrganizations(options?: RawAxiosRequestConfig): Promise<
|
|
10339
|
+
listOrganizations(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListOrganizations200Response, any, {}>>;
|
|
10359
10340
|
}
|
|
10360
10341
|
/**
|
|
10361
10342
|
* ProductsApi - axios parameter creator
|
|
@@ -10444,7 +10425,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
10444
10425
|
* @throws {RequiredError}
|
|
10445
10426
|
* @memberof ProductsApi
|
|
10446
10427
|
*/
|
|
10447
|
-
getProduct(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10428
|
+
getProduct(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetProductResponse, any, {}>>;
|
|
10448
10429
|
/**
|
|
10449
10430
|
* Retrieve a list of available products
|
|
10450
10431
|
* @summary List products
|
|
@@ -10455,7 +10436,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
10455
10436
|
* @throws {RequiredError}
|
|
10456
10437
|
* @memberof ProductsApi
|
|
10457
10438
|
*/
|
|
10458
|
-
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, {}>>;
|
|
10459
10440
|
}
|
|
10460
10441
|
/**
|
|
10461
10442
|
* ReportsApi - axios parameter creator
|
|
@@ -10538,7 +10519,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
10538
10519
|
* @throws {RequiredError}
|
|
10539
10520
|
* @memberof ReportsApi
|
|
10540
10521
|
*/
|
|
10541
|
-
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10522
|
+
createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateReport200Response, any, {}>>;
|
|
10542
10523
|
/**
|
|
10543
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.
|
|
10544
10525
|
* @summary Retrieve report
|
|
@@ -10547,7 +10528,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
10547
10528
|
* @throws {RequiredError}
|
|
10548
10529
|
* @memberof ReportsApi
|
|
10549
10530
|
*/
|
|
10550
|
-
getReport(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10531
|
+
getReport(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateReport200Response, any, {}>>;
|
|
10551
10532
|
}
|
|
10552
10533
|
/**
|
|
10553
10534
|
* RewardsApi - axios parameter creator
|
|
@@ -10708,7 +10689,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10708
10689
|
* @throws {RequiredError}
|
|
10709
10690
|
* @memberof RewardsApi
|
|
10710
10691
|
*/
|
|
10711
|
-
cancelReward(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10692
|
+
cancelReward(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<object, any, {}>>;
|
|
10712
10693
|
/**
|
|
10713
10694
|
* Generate a redemption link for the reward identified by the `id` in the URL
|
|
10714
10695
|
* @summary Generate a reward URL
|
|
@@ -10717,7 +10698,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10717
10698
|
* @throws {RequiredError}
|
|
10718
10699
|
* @memberof RewardsApi
|
|
10719
10700
|
*/
|
|
10720
|
-
generateRewardLink(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10701
|
+
generateRewardLink(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateRewardLink200Response, any, {}>>;
|
|
10721
10702
|
/**
|
|
10722
10703
|
* Retrieve the reward, identified by the given `id` in the URL
|
|
10723
10704
|
* @summary Retrieve single reward
|
|
@@ -10726,7 +10707,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10726
10707
|
* @throws {RequiredError}
|
|
10727
10708
|
* @memberof RewardsApi
|
|
10728
10709
|
*/
|
|
10729
|
-
getReward(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10710
|
+
getReward(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetReward200Response, any, {}>>;
|
|
10730
10711
|
/**
|
|
10731
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)
|
|
10732
10713
|
* @summary List rewards
|
|
@@ -10736,7 +10717,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10736
10717
|
* @throws {RequiredError}
|
|
10737
10718
|
* @memberof RewardsApi
|
|
10738
10719
|
*/
|
|
10739
|
-
listRewards(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<
|
|
10720
|
+
listRewards(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListRewards200Response, any, {}>>;
|
|
10740
10721
|
/**
|
|
10741
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.
|
|
10742
10723
|
* @summary Resend reward
|
|
@@ -10746,7 +10727,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
10746
10727
|
* @throws {RequiredError}
|
|
10747
10728
|
* @memberof RewardsApi
|
|
10748
10729
|
*/
|
|
10749
|
-
resendReward(id: string, resendRewardRequest?: ResendRewardRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10730
|
+
resendReward(id: string, resendRewardRequest?: ResendRewardRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<object, any, {}>>;
|
|
10750
10731
|
}
|
|
10751
10732
|
/**
|
|
10752
10733
|
* RolesApi - axios parameter creator
|
|
@@ -10801,7 +10782,7 @@ export declare class RolesApi extends BaseAPI {
|
|
|
10801
10782
|
* @throws {RequiredError}
|
|
10802
10783
|
* @memberof RolesApi
|
|
10803
10784
|
*/
|
|
10804
|
-
listRoles(options?: RawAxiosRequestConfig): Promise<
|
|
10785
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListRoles200Response, any, {}>>;
|
|
10805
10786
|
}
|
|
10806
10787
|
/**
|
|
10807
10788
|
* TopupsApi - axios parameter creator
|
|
@@ -10908,7 +10889,7 @@ export declare class TopupsApi extends BaseAPI {
|
|
|
10908
10889
|
* @throws {RequiredError}
|
|
10909
10890
|
* @memberof TopupsApi
|
|
10910
10891
|
*/
|
|
10911
|
-
createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10892
|
+
createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateTopup200Response, any, {}>>;
|
|
10912
10893
|
/**
|
|
10913
10894
|
* Retrieve a topup, identified by the given `id` in the URL.
|
|
10914
10895
|
* @summary Retrieve single topup
|
|
@@ -10917,7 +10898,7 @@ export declare class TopupsApi extends BaseAPI {
|
|
|
10917
10898
|
* @throws {RequiredError}
|
|
10918
10899
|
* @memberof TopupsApi
|
|
10919
10900
|
*/
|
|
10920
|
-
getTopup(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
10901
|
+
getTopup(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateTopup200Response, any, {}>>;
|
|
10921
10902
|
/**
|
|
10922
10903
|
* Retrieve a list of all topup requests.
|
|
10923
10904
|
* @summary List topups
|
|
@@ -10926,7 +10907,7 @@ export declare class TopupsApi extends BaseAPI {
|
|
|
10926
10907
|
* @throws {RequiredError}
|
|
10927
10908
|
* @memberof TopupsApi
|
|
10928
10909
|
*/
|
|
10929
|
-
listTopups(offset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
10910
|
+
listTopups(offset?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListTopups200Response, any, {}>>;
|
|
10930
10911
|
}
|
|
10931
10912
|
/**
|
|
10932
10913
|
* WebhooksApi - axios parameter creator
|
|
@@ -11105,7 +11086,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11105
11086
|
* @throws {RequiredError}
|
|
11106
11087
|
* @memberof WebhooksApi
|
|
11107
11088
|
*/
|
|
11108
|
-
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11089
|
+
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateWebhook200Response, any, {}>>;
|
|
11109
11090
|
/**
|
|
11110
11091
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
11111
11092
|
* @summary Delete webhook
|
|
@@ -11114,7 +11095,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11114
11095
|
* @throws {RequiredError}
|
|
11115
11096
|
* @memberof WebhooksApi
|
|
11116
11097
|
*/
|
|
11117
|
-
deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
11098
|
+
deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
11118
11099
|
/**
|
|
11119
11100
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
11120
11101
|
* @summary Retrieve webhook
|
|
@@ -11123,7 +11104,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11123
11104
|
* @throws {RequiredError}
|
|
11124
11105
|
* @memberof WebhooksApi
|
|
11125
11106
|
*/
|
|
11126
|
-
getWebhook(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
11107
|
+
getWebhook(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateWebhook200Response, any, {}>>;
|
|
11127
11108
|
/**
|
|
11128
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)
|
|
11129
11110
|
* @summary List events
|
|
@@ -11132,7 +11113,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11132
11113
|
* @throws {RequiredError}
|
|
11133
11114
|
* @memberof WebhooksApi
|
|
11134
11115
|
*/
|
|
11135
|
-
listWebhookEvents(id: string, options?: RawAxiosRequestConfig): Promise<
|
|
11116
|
+
listWebhookEvents(id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListWebhookEvents200Response, any, {}>>;
|
|
11136
11117
|
/**
|
|
11137
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)
|
|
11138
11119
|
* @summary List webhooks
|
|
@@ -11140,7 +11121,7 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11140
11121
|
* @throws {RequiredError}
|
|
11141
11122
|
* @memberof WebhooksApi
|
|
11142
11123
|
*/
|
|
11143
|
-
listWebhooks(options?: RawAxiosRequestConfig): Promise<
|
|
11124
|
+
listWebhooks(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListWebhooks200Response, any, {}>>;
|
|
11144
11125
|
/**
|
|
11145
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)
|
|
11146
11127
|
* @summary Test webhook
|
|
@@ -11150,5 +11131,5 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
11150
11131
|
* @throws {RequiredError}
|
|
11151
11132
|
* @memberof WebhooksApi
|
|
11152
11133
|
*/
|
|
11153
|
-
simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11134
|
+
simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any, {}>>;
|
|
11154
11135
|
}
|
package/dist/api.js
CHANGED
|
@@ -21,12 +21,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
25
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
26
|
+
};
|
|
24
27
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
28
|
exports.GetFraudReview200ResponseFraudReviewStatusEnum = exports.FundingSourceTypeEnum = exports.FundingSourceStatusEnum = exports.FundingSourceUsagePermissionsEnum = exports.FundingSourceMethodEnum = exports.FraudRulesListItemRuleTypeEnum = exports.FraudRuleType = exports.FraudRuleRequestConfigPeriodEnum = exports.FraudRuleRequestConfigTypeEnum = exports.FraudReviewStatus = exports.FraudReviewRisk = exports.FraudReviewRedemptionMethod = exports.FraudReviewReason = exports.FraudReviewListItemRedemptionMethodEnum = exports.FraudReviewListItemReasonsEnum = exports.FraudReviewListItemStatusEnum = exports.FraudReviewBaseRedemptionMethodEnum = exports.FraudReviewBaseReasonsEnum = exports.FraudReviewBaseStatusEnum = exports.FraudReviewRiskEnum = exports.FraudReviewRedemptionMethodEnum = exports.FraudReviewReasonsEnum = exports.FraudReviewStatusEnum = exports.FraudConfigRedeemedRewardsCountPeriodEnum = exports.FraudConfigRedeemedRewardsAmountPeriodEnum = exports.FraudConfigCountryTypeEnum = exports.FieldDataTypeEnum = exports.DeliveryStatus = exports.DeliveryMethod = exports.DeliveryDetailsWithLinkStatusEnum = exports.DeliveryDetailsWithLinkMethodEnum = exports.DeliveryDetailsStatusEnum = exports.DeliveryDetailsMethodEnum = exports.CurrencyCodes = exports.CreateReportRequestFiltersDigitalRewardsStatusEnum = exports.CreateReportRequestFiltersDigitalRewardsOrderStatusEnum = exports.CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum = exports.CreateReportRequestFormatEnum = exports.CreateReportRequestReportTypeEnum = exports.CreateReport200ResponseReportStatusEnum = exports.CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum = exports.CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum = exports.CreateOrder200ResponseOrderChannelEnum = exports.CreateOrder200ResponseOrderStatusEnum = exports.CreateInvoiceRequestCurrencyEnum = exports.CreateFieldRequestDataTypeEnum = exports.CreateFieldDataTypeEnum = exports.ConnectedOrganizationOrganizationStatusEnum = exports.ConnectedOrganizationMemberMemberStatusEnum = exports.Channel = void 0;
|
|
26
29
|
exports.ProductSubcategoryEnum = exports.ProductCategoryEnum = exports.PayoutStatusEnum = exports.OrganizationStatusEnum = exports.OrderWithoutLinkChannelEnum = exports.OrderWithoutLinkStatusEnum = exports.OrderWithLinkChannelEnum = exports.OrderWithLinkStatusEnum = exports.OrderStatus = exports.OrderBaseChannelEnum = exports.OrderBaseStatusEnum = exports.OrderChannelEnum = exports.OrderStatusEnum = exports.MemberWithoutEventsStatusEnum = exports.MemberWithEventsStatusEnum = exports.MemberBaseStatusEnum = exports.MemberStatusEnum = exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = exports.ListRewards200ResponseRewardsInnerDeliveryStatusEnum = exports.ListRewards200ResponseRewardsInnerDeliveryMethodEnum = exports.ListProductsResponseProductsInnerImagesInnerTypeEnum = exports.ListProductsResponseProductsInnerCurrencyCodesEnum = exports.ListProductsResponseProductsInnerSubcategoryEnum = exports.ListProductsResponseProductsInnerCategoryEnum = exports.ListOrganizations200ResponseOrganizationsInnerStatusEnum = exports.ListOrders200ResponseOrdersInnerChannelEnum = exports.ListOrders200ResponseOrdersInnerStatusEnum = exports.ListMembers200ResponseMembersInnerStatusEnum = exports.ListInvoices200ResponseInvoicesInnerStatusEnum = exports.ListInvoices200ResponseInvoicesInnerCurrencyEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum = exports.ListFundingSources200ResponseFundingSourcesInnerTypeEnum = exports.ListFundingSources200ResponseFundingSourcesInnerStatusEnum = exports.ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMethodEnum = exports.ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = exports.ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum = exports.ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = exports.ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = exports.ListFields200ResponseFieldsInnerDataTypeEnum = exports.ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum = exports.ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum = exports.InvoiceStatusEnum = exports.InvoiceCurrencyEnum = exports.GetMember200ResponseMemberEventsInnerTypeEnum = exports.GetMember200ResponseMemberStatusEnum = exports.GetFraudReview200ResponseFraudReviewRiskEnum = exports.GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = exports.GetFraudReview200ResponseFraudReviewReasonsEnum = void 0;
|
|
27
30
|
exports.DeleteFraudRuleRuleTypeEnum = exports.FraudRulesApi = exports.FraudRulesApiFactory = exports.FraudRulesApiFp = exports.FraudRulesApiAxiosParamCreator = exports.ListFraudReviewsStatusEnum = exports.FraudReviewsApi = exports.FraudReviewsApiFactory = exports.FraudReviewsApiFp = exports.FraudReviewsApiAxiosParamCreator = exports.ForexApi = exports.ForexApiFactory = exports.ForexApiFp = exports.ForexApiAxiosParamCreator = exports.FieldsApi = exports.FieldsApiFactory = exports.FieldsApiFp = exports.FieldsApiAxiosParamCreator = exports.ConnectedOrganizationsApi = exports.ConnectedOrganizationsApiFactory = exports.ConnectedOrganizationsApiFp = exports.ConnectedOrganizationsApiAxiosParamCreator = exports.ConnectedOrganizationMembersApi = exports.ConnectedOrganizationMembersApiFactory = exports.ConnectedOrganizationMembersApiFp = exports.ConnectedOrganizationMembersApiAxiosParamCreator = exports.CampaignsApi = exports.CampaignsApiFactory = exports.CampaignsApiFp = exports.CampaignsApiAxiosParamCreator = exports.BalanceTransactionsApi = exports.BalanceTransactionsApiFactory = exports.BalanceTransactionsApiFp = exports.BalanceTransactionsApiAxiosParamCreator = exports.UpdateFraudRuleListRequestOperationEnum = exports.SingleRewardOrderWithoutLinkOrderChannelEnum = exports.SingleRewardOrderWithoutLinkOrderStatusEnum = exports.SingleRewardOrderWithLinkOrderChannelEnum = exports.SingleRewardOrderWithLinkOrderStatusEnum = exports.SingleRewardOrderRewardDeliveryMethodEnum = exports.RewardWithoutLinkDeliveryStatusEnum = exports.RewardWithoutLinkDeliveryMethodEnum = exports.RewardWithLinkDeliveryStatusEnum = exports.RewardWithLinkDeliveryMethodEnum = exports.RewardValueCurrencyCodeEnum = exports.ReviewRedeemedRewardsCountPeriodEnum = exports.ReviewRedeemedRewardsAmountPeriodEnum = exports.ReviewCountryTypeEnum = exports.ReportStatusEnum = exports.ProductCurrencyCodesEnum = void 0;
|
|
28
31
|
exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TopupsApi = exports.TopupsApiFactory = exports.TopupsApiFp = exports.TopupsApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RewardsApi = exports.RewardsApiFactory = exports.RewardsApiFp = exports.RewardsApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.MembersApi = exports.MembersApiFactory = exports.MembersApiFp = exports.MembersApiAxiosParamCreator = exports.InvoicesApi = exports.InvoicesApiFactory = exports.InvoicesApiFp = exports.InvoicesApiAxiosParamCreator = exports.FundingSourcesApi = exports.FundingSourcesApiFactory = exports.FundingSourcesApiFp = exports.FundingSourcesApiAxiosParamCreator = exports.UpdateFraudRuleListRuleTypeEnum = exports.FraudRuleRuleTypeEnum = void 0;
|
|
29
|
-
const axios_1 = require("axios");
|
|
32
|
+
const axios_1 = __importDefault(require("axios"));
|
|
30
33
|
// Some imports not used depending on template conditions
|
|
31
34
|
// @ts-ignore
|
|
32
35
|
const common_1 = require("./common");
|
|
@@ -170,7 +173,7 @@ exports.CurrencyCodes = {
|
|
|
170
173
|
Bob: 'BOB',
|
|
171
174
|
Brl: 'BRL',
|
|
172
175
|
Bwp: 'BWP',
|
|
173
|
-
|
|
176
|
+
Byn: 'BYN',
|
|
174
177
|
Bzd: 'BZD',
|
|
175
178
|
Cdf: 'CDF',
|
|
176
179
|
Chf: 'CHF',
|
|
@@ -184,7 +187,6 @@ exports.CurrencyCodes = {
|
|
|
184
187
|
Dkk: 'DKK',
|
|
185
188
|
Dop: 'DOP',
|
|
186
189
|
Dzd: 'DZD',
|
|
187
|
-
Eek: 'EEK',
|
|
188
190
|
Egp: 'EGP',
|
|
189
191
|
Ern: 'ERN',
|
|
190
192
|
Etb: 'ETB',
|
|
@@ -213,8 +215,6 @@ exports.CurrencyCodes = {
|
|
|
213
215
|
Kzt: 'KZT',
|
|
214
216
|
Lbp: 'LBP',
|
|
215
217
|
Lkr: 'LKR',
|
|
216
|
-
Ltl: 'LTL',
|
|
217
|
-
Lvl: 'LVL',
|
|
218
218
|
Mad: 'MAD',
|
|
219
219
|
Mdl: 'MDL',
|
|
220
220
|
Mga: 'MGA',
|
|
@@ -265,8 +265,7 @@ exports.CurrencyCodes = {
|
|
|
265
265
|
Xaf: 'XAF',
|
|
266
266
|
Xof: 'XOF',
|
|
267
267
|
Yer: 'YER',
|
|
268
|
-
Zar: 'ZAR'
|
|
269
|
-
Zmk: 'ZMK'
|
|
268
|
+
Zar: 'ZAR'
|
|
270
269
|
};
|
|
271
270
|
exports.DeliveryDetailsMethodEnum = {
|
|
272
271
|
Email: 'EMAIL',
|
|
@@ -843,7 +842,7 @@ exports.ListProductsResponseProductsInnerCurrencyCodesEnum = {
|
|
|
843
842
|
Bob: 'BOB',
|
|
844
843
|
Brl: 'BRL',
|
|
845
844
|
Bwp: 'BWP',
|
|
846
|
-
|
|
845
|
+
Byn: 'BYN',
|
|
847
846
|
Bzd: 'BZD',
|
|
848
847
|
Cdf: 'CDF',
|
|
849
848
|
Chf: 'CHF',
|
|
@@ -857,7 +856,6 @@ exports.ListProductsResponseProductsInnerCurrencyCodesEnum = {
|
|
|
857
856
|
Dkk: 'DKK',
|
|
858
857
|
Dop: 'DOP',
|
|
859
858
|
Dzd: 'DZD',
|
|
860
|
-
Eek: 'EEK',
|
|
861
859
|
Egp: 'EGP',
|
|
862
860
|
Ern: 'ERN',
|
|
863
861
|
Etb: 'ETB',
|
|
@@ -886,8 +884,6 @@ exports.ListProductsResponseProductsInnerCurrencyCodesEnum = {
|
|
|
886
884
|
Kzt: 'KZT',
|
|
887
885
|
Lbp: 'LBP',
|
|
888
886
|
Lkr: 'LKR',
|
|
889
|
-
Ltl: 'LTL',
|
|
890
|
-
Lvl: 'LVL',
|
|
891
887
|
Mad: 'MAD',
|
|
892
888
|
Mdl: 'MDL',
|
|
893
889
|
Mga: 'MGA',
|
|
@@ -938,8 +934,7 @@ exports.ListProductsResponseProductsInnerCurrencyCodesEnum = {
|
|
|
938
934
|
Xaf: 'XAF',
|
|
939
935
|
Xof: 'XOF',
|
|
940
936
|
Yer: 'YER',
|
|
941
|
-
Zar: 'ZAR'
|
|
942
|
-
Zmk: 'ZMK'
|
|
937
|
+
Zar: 'ZAR'
|
|
943
938
|
};
|
|
944
939
|
exports.ListProductsResponseProductsInnerImagesInnerTypeEnum = {
|
|
945
940
|
Card: 'card',
|
|
@@ -975,7 +970,7 @@ exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = {
|
|
|
975
970
|
Bob: 'BOB',
|
|
976
971
|
Brl: 'BRL',
|
|
977
972
|
Bwp: 'BWP',
|
|
978
|
-
|
|
973
|
+
Byn: 'BYN',
|
|
979
974
|
Bzd: 'BZD',
|
|
980
975
|
Cdf: 'CDF',
|
|
981
976
|
Chf: 'CHF',
|
|
@@ -989,7 +984,6 @@ exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = {
|
|
|
989
984
|
Dkk: 'DKK',
|
|
990
985
|
Dop: 'DOP',
|
|
991
986
|
Dzd: 'DZD',
|
|
992
|
-
Eek: 'EEK',
|
|
993
987
|
Egp: 'EGP',
|
|
994
988
|
Ern: 'ERN',
|
|
995
989
|
Etb: 'ETB',
|
|
@@ -1018,8 +1012,6 @@ exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = {
|
|
|
1018
1012
|
Kzt: 'KZT',
|
|
1019
1013
|
Lbp: 'LBP',
|
|
1020
1014
|
Lkr: 'LKR',
|
|
1021
|
-
Ltl: 'LTL',
|
|
1022
|
-
Lvl: 'LVL',
|
|
1023
1015
|
Mad: 'MAD',
|
|
1024
1016
|
Mdl: 'MDL',
|
|
1025
1017
|
Mga: 'MGA',
|
|
@@ -1070,8 +1062,7 @@ exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = {
|
|
|
1070
1062
|
Xaf: 'XAF',
|
|
1071
1063
|
Xof: 'XOF',
|
|
1072
1064
|
Yer: 'YER',
|
|
1073
|
-
Zar: 'ZAR'
|
|
1074
|
-
Zmk: 'ZMK'
|
|
1065
|
+
Zar: 'ZAR'
|
|
1075
1066
|
};
|
|
1076
1067
|
exports.MemberStatusEnum = {
|
|
1077
1068
|
Registered: 'REGISTERED',
|
|
@@ -1236,7 +1227,7 @@ exports.ProductCurrencyCodesEnum = {
|
|
|
1236
1227
|
Bob: 'BOB',
|
|
1237
1228
|
Brl: 'BRL',
|
|
1238
1229
|
Bwp: 'BWP',
|
|
1239
|
-
|
|
1230
|
+
Byn: 'BYN',
|
|
1240
1231
|
Bzd: 'BZD',
|
|
1241
1232
|
Cdf: 'CDF',
|
|
1242
1233
|
Chf: 'CHF',
|
|
@@ -1250,7 +1241,6 @@ exports.ProductCurrencyCodesEnum = {
|
|
|
1250
1241
|
Dkk: 'DKK',
|
|
1251
1242
|
Dop: 'DOP',
|
|
1252
1243
|
Dzd: 'DZD',
|
|
1253
|
-
Eek: 'EEK',
|
|
1254
1244
|
Egp: 'EGP',
|
|
1255
1245
|
Ern: 'ERN',
|
|
1256
1246
|
Etb: 'ETB',
|
|
@@ -1279,8 +1269,6 @@ exports.ProductCurrencyCodesEnum = {
|
|
|
1279
1269
|
Kzt: 'KZT',
|
|
1280
1270
|
Lbp: 'LBP',
|
|
1281
1271
|
Lkr: 'LKR',
|
|
1282
|
-
Ltl: 'LTL',
|
|
1283
|
-
Lvl: 'LVL',
|
|
1284
1272
|
Mad: 'MAD',
|
|
1285
1273
|
Mdl: 'MDL',
|
|
1286
1274
|
Mga: 'MGA',
|
|
@@ -1331,8 +1319,7 @@ exports.ProductCurrencyCodesEnum = {
|
|
|
1331
1319
|
Xaf: 'XAF',
|
|
1332
1320
|
Xof: 'XOF',
|
|
1333
1321
|
Yer: 'YER',
|
|
1334
|
-
Zar: 'ZAR'
|
|
1335
|
-
Zmk: 'ZMK'
|
|
1322
|
+
Zar: 'ZAR'
|
|
1336
1323
|
};
|
|
1337
1324
|
exports.ReportStatusEnum = {
|
|
1338
1325
|
Created: 'CREATED',
|
|
@@ -1379,7 +1366,7 @@ exports.RewardValueCurrencyCodeEnum = {
|
|
|
1379
1366
|
Bob: 'BOB',
|
|
1380
1367
|
Brl: 'BRL',
|
|
1381
1368
|
Bwp: 'BWP',
|
|
1382
|
-
|
|
1369
|
+
Byn: 'BYN',
|
|
1383
1370
|
Bzd: 'BZD',
|
|
1384
1371
|
Cdf: 'CDF',
|
|
1385
1372
|
Chf: 'CHF',
|
|
@@ -1393,7 +1380,6 @@ exports.RewardValueCurrencyCodeEnum = {
|
|
|
1393
1380
|
Dkk: 'DKK',
|
|
1394
1381
|
Dop: 'DOP',
|
|
1395
1382
|
Dzd: 'DZD',
|
|
1396
|
-
Eek: 'EEK',
|
|
1397
1383
|
Egp: 'EGP',
|
|
1398
1384
|
Ern: 'ERN',
|
|
1399
1385
|
Etb: 'ETB',
|
|
@@ -1422,8 +1408,6 @@ exports.RewardValueCurrencyCodeEnum = {
|
|
|
1422
1408
|
Kzt: 'KZT',
|
|
1423
1409
|
Lbp: 'LBP',
|
|
1424
1410
|
Lkr: 'LKR',
|
|
1425
|
-
Ltl: 'LTL',
|
|
1426
|
-
Lvl: 'LVL',
|
|
1427
1411
|
Mad: 'MAD',
|
|
1428
1412
|
Mdl: 'MDL',
|
|
1429
1413
|
Mga: 'MGA',
|
|
@@ -1474,8 +1458,7 @@ exports.RewardValueCurrencyCodeEnum = {
|
|
|
1474
1458
|
Xaf: 'XAF',
|
|
1475
1459
|
Xof: 'XOF',
|
|
1476
1460
|
Yer: 'YER',
|
|
1477
|
-
Zar: 'ZAR'
|
|
1478
|
-
Zmk: 'ZMK'
|
|
1461
|
+
Zar: 'ZAR'
|
|
1479
1462
|
};
|
|
1480
1463
|
exports.RewardWithLinkDeliveryMethodEnum = {
|
|
1481
1464
|
Email: 'EMAIL',
|
package/dist/base.js
CHANGED
|
@@ -12,9 +12,12 @@
|
|
|
12
12
|
* https://openapi-generator.tech
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
16
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
|
+
};
|
|
15
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
19
|
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
17
|
-
const axios_1 = require("axios");
|
|
20
|
+
const axios_1 = __importDefault(require("axios"));
|
|
18
21
|
exports.BASE_PATH = "https://testflight.tremendous.com/api/v2".replace(/\/+$/, "");
|
|
19
22
|
/**
|
|
20
23
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tremendous",
|
|
3
|
-
"version": "4.5.
|
|
3
|
+
"version": "4.5.1",
|
|
4
4
|
"description": "A node.js client for the Tremendous API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"tremendous",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"@types/node": "^25.0.2",
|
|
33
|
-
"typescript": "^
|
|
33
|
+
"typescript": "^6.0.2",
|
|
34
34
|
"vitest": "^4.0.6"
|
|
35
35
|
},
|
|
36
36
|
"homepage": "https://github.com/tremendous-rewards/tremendous-node#readme",
|