tremendous 3.4.0 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts +192 -97
- package/dist/api.js +62 -3
- package/dist/environments.d.ts +4 -5
- package/dist/environments.js +1 -1
- package/package.json +2 -2
package/dist/api.d.ts
CHANGED
|
@@ -76,31 +76,31 @@ export interface BalanceTransaction {
|
|
|
76
76
|
* @type {string}
|
|
77
77
|
* @memberof BalanceTransaction
|
|
78
78
|
*/
|
|
79
|
-
'created_at'
|
|
79
|
+
'created_at': string;
|
|
80
80
|
/**
|
|
81
81
|
* Amount of the transaction in USD
|
|
82
82
|
* @type {number}
|
|
83
83
|
* @memberof BalanceTransaction
|
|
84
84
|
*/
|
|
85
|
-
'amount'
|
|
85
|
+
'amount': number;
|
|
86
86
|
/**
|
|
87
87
|
* The updated total after the transaction. Note that this running balance may be delayed and contain `null`.
|
|
88
88
|
* @type {number}
|
|
89
89
|
* @memberof BalanceTransaction
|
|
90
90
|
*/
|
|
91
|
-
'balance'
|
|
91
|
+
'balance': number;
|
|
92
92
|
/**
|
|
93
93
|
* The action that was performed
|
|
94
94
|
* @type {string}
|
|
95
95
|
* @memberof BalanceTransaction
|
|
96
96
|
*/
|
|
97
|
-
'action'
|
|
97
|
+
'action': string;
|
|
98
98
|
/**
|
|
99
99
|
* A brief description of the transaction
|
|
100
100
|
* @type {string}
|
|
101
101
|
* @memberof BalanceTransaction
|
|
102
102
|
*/
|
|
103
|
-
'description'
|
|
103
|
+
'description': string;
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
106
|
*
|
|
@@ -207,6 +207,21 @@ export interface CampaignBase {
|
|
|
207
207
|
*/
|
|
208
208
|
'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle;
|
|
209
209
|
}
|
|
210
|
+
/**
|
|
211
|
+
* Name of the channel in which the order was created
|
|
212
|
+
* @export
|
|
213
|
+
* @enum {string}
|
|
214
|
+
*/
|
|
215
|
+
export declare const Channel: {
|
|
216
|
+
readonly Ui: "UI";
|
|
217
|
+
readonly Api: "API";
|
|
218
|
+
readonly Embed: "EMBED";
|
|
219
|
+
readonly Decipher: "DECIPHER";
|
|
220
|
+
readonly Qualtrics: "QUALTRICS";
|
|
221
|
+
readonly Typeform: "TYPEFORM";
|
|
222
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
223
|
+
};
|
|
224
|
+
export type Channel = typeof Channel[keyof typeof Channel];
|
|
210
225
|
/**
|
|
211
226
|
*
|
|
212
227
|
* @export
|
|
@@ -1146,10 +1161,10 @@ export interface FraudReview {
|
|
|
1146
1161
|
'geo'?: GetFraudReview200ResponseFraudReviewGeo;
|
|
1147
1162
|
/**
|
|
1148
1163
|
*
|
|
1149
|
-
* @type {
|
|
1164
|
+
* @type {OrderWithoutLinkRewardsInner}
|
|
1150
1165
|
* @memberof FraudReview
|
|
1151
1166
|
*/
|
|
1152
|
-
'reward'?:
|
|
1167
|
+
'reward'?: OrderWithoutLinkRewardsInner;
|
|
1153
1168
|
}
|
|
1154
1169
|
export declare const FraudReviewStatusEnum: {
|
|
1155
1170
|
readonly Flagged: "flagged";
|
|
@@ -1234,10 +1249,10 @@ export interface FraudReviewListItem {
|
|
|
1234
1249
|
'reasons'?: Array<FraudReviewListItemReasonsEnum>;
|
|
1235
1250
|
/**
|
|
1236
1251
|
*
|
|
1237
|
-
* @type {
|
|
1252
|
+
* @type {OrderWithoutLinkRewardsInner}
|
|
1238
1253
|
* @memberof FraudReviewListItem
|
|
1239
1254
|
*/
|
|
1240
|
-
'reward'?:
|
|
1255
|
+
'reward'?: OrderWithoutLinkRewardsInner;
|
|
1241
1256
|
}
|
|
1242
1257
|
export declare const FraudReviewListItemStatusEnum: {
|
|
1243
1258
|
readonly Flagged: "flagged";
|
|
@@ -2033,47 +2048,47 @@ export type InvoiceStatusEnum = typeof InvoiceStatusEnum[keyof typeof InvoiceSta
|
|
|
2033
2048
|
export interface ListBalanceTransactions200Response {
|
|
2034
2049
|
/**
|
|
2035
2050
|
*
|
|
2036
|
-
* @type {Array<
|
|
2051
|
+
* @type {Array<ListBalanceTransactions200ResponseTransactionsInner>}
|
|
2037
2052
|
* @memberof ListBalanceTransactions200Response
|
|
2038
2053
|
*/
|
|
2039
|
-
'
|
|
2054
|
+
'transactions': Array<ListBalanceTransactions200ResponseTransactionsInner>;
|
|
2040
2055
|
}
|
|
2041
2056
|
/**
|
|
2042
2057
|
* A balance transaction represents a specific movement or change in an account\'s balance.
|
|
2043
2058
|
* @export
|
|
2044
|
-
* @interface
|
|
2059
|
+
* @interface ListBalanceTransactions200ResponseTransactionsInner
|
|
2045
2060
|
*/
|
|
2046
|
-
export interface
|
|
2061
|
+
export interface ListBalanceTransactions200ResponseTransactionsInner {
|
|
2047
2062
|
/**
|
|
2048
2063
|
* Date that the transaction was created
|
|
2049
2064
|
* @type {string}
|
|
2050
|
-
* @memberof
|
|
2065
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
2051
2066
|
*/
|
|
2052
|
-
'created_at'
|
|
2067
|
+
'created_at': string;
|
|
2053
2068
|
/**
|
|
2054
2069
|
* Amount of the transaction in USD
|
|
2055
2070
|
* @type {number}
|
|
2056
|
-
* @memberof
|
|
2071
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
2057
2072
|
*/
|
|
2058
|
-
'amount'
|
|
2073
|
+
'amount': number;
|
|
2059
2074
|
/**
|
|
2060
2075
|
* The updated total after the transaction. Note that this running balance may be delayed and contain `null`.
|
|
2061
2076
|
* @type {number}
|
|
2062
|
-
* @memberof
|
|
2077
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
2063
2078
|
*/
|
|
2064
|
-
'balance'
|
|
2079
|
+
'balance': number;
|
|
2065
2080
|
/**
|
|
2066
2081
|
* The action that was performed
|
|
2067
2082
|
* @type {string}
|
|
2068
|
-
* @memberof
|
|
2083
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
2069
2084
|
*/
|
|
2070
|
-
'action'
|
|
2085
|
+
'action': string;
|
|
2071
2086
|
/**
|
|
2072
2087
|
* A brief description of the transaction
|
|
2073
2088
|
* @type {string}
|
|
2074
|
-
* @memberof
|
|
2089
|
+
* @memberof ListBalanceTransactions200ResponseTransactionsInner
|
|
2075
2090
|
*/
|
|
2076
|
-
'description'
|
|
2091
|
+
'description': string;
|
|
2077
2092
|
}
|
|
2078
2093
|
/**
|
|
2079
2094
|
*
|
|
@@ -2766,6 +2781,12 @@ export interface ListOrders200ResponseOrdersInner {
|
|
|
2766
2781
|
* @memberof ListOrders200ResponseOrdersInner
|
|
2767
2782
|
*/
|
|
2768
2783
|
'status': ListOrders200ResponseOrdersInnerStatusEnum;
|
|
2784
|
+
/**
|
|
2785
|
+
* Name of the channel in which the order was created
|
|
2786
|
+
* @type {string}
|
|
2787
|
+
* @memberof ListOrders200ResponseOrdersInner
|
|
2788
|
+
*/
|
|
2789
|
+
'channel'?: ListOrders200ResponseOrdersInnerChannelEnum;
|
|
2769
2790
|
/**
|
|
2770
2791
|
*
|
|
2771
2792
|
* @type {ListOrders200ResponseOrdersInnerPayment}
|
|
@@ -2780,10 +2801,10 @@ export interface ListOrders200ResponseOrdersInner {
|
|
|
2780
2801
|
'invoice_id'?: string;
|
|
2781
2802
|
/**
|
|
2782
2803
|
*
|
|
2783
|
-
* @type {ListRewards200ResponseRewardsInner}
|
|
2804
|
+
* @type {Array<ListRewards200ResponseRewardsInner>}
|
|
2784
2805
|
* @memberof ListOrders200ResponseOrdersInner
|
|
2785
2806
|
*/
|
|
2786
|
-
'
|
|
2807
|
+
'rewards'?: Array<ListRewards200ResponseRewardsInner>;
|
|
2787
2808
|
}
|
|
2788
2809
|
export declare const ListOrders200ResponseOrdersInnerStatusEnum: {
|
|
2789
2810
|
readonly Canceled: "CANCELED";
|
|
@@ -2794,6 +2815,16 @@ export declare const ListOrders200ResponseOrdersInnerStatusEnum: {
|
|
|
2794
2815
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
2795
2816
|
};
|
|
2796
2817
|
export type ListOrders200ResponseOrdersInnerStatusEnum = typeof ListOrders200ResponseOrdersInnerStatusEnum[keyof typeof ListOrders200ResponseOrdersInnerStatusEnum];
|
|
2818
|
+
export declare const ListOrders200ResponseOrdersInnerChannelEnum: {
|
|
2819
|
+
readonly Ui: "UI";
|
|
2820
|
+
readonly Api: "API";
|
|
2821
|
+
readonly Embed: "EMBED";
|
|
2822
|
+
readonly Decipher: "DECIPHER";
|
|
2823
|
+
readonly Qualtrics: "QUALTRICS";
|
|
2824
|
+
readonly Typeform: "TYPEFORM";
|
|
2825
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
2826
|
+
};
|
|
2827
|
+
export type ListOrders200ResponseOrdersInnerChannelEnum = typeof ListOrders200ResponseOrdersInnerChannelEnum[keyof typeof ListOrders200ResponseOrdersInnerChannelEnum];
|
|
2797
2828
|
/**
|
|
2798
2829
|
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are always denominated in USD, independent from the currency of the ordered rewards. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
|
|
2799
2830
|
* @export
|
|
@@ -3854,6 +3885,12 @@ export interface Order {
|
|
|
3854
3885
|
* @memberof Order
|
|
3855
3886
|
*/
|
|
3856
3887
|
'status': OrderStatusEnum;
|
|
3888
|
+
/**
|
|
3889
|
+
* Name of the channel in which the order was created
|
|
3890
|
+
* @type {string}
|
|
3891
|
+
* @memberof Order
|
|
3892
|
+
*/
|
|
3893
|
+
'channel'?: OrderChannelEnum;
|
|
3857
3894
|
/**
|
|
3858
3895
|
*
|
|
3859
3896
|
* @type {OrderBasePayment}
|
|
@@ -3868,10 +3905,10 @@ export interface Order {
|
|
|
3868
3905
|
'invoice_id'?: string;
|
|
3869
3906
|
/**
|
|
3870
3907
|
*
|
|
3871
|
-
* @type {
|
|
3908
|
+
* @type {Array<OrderWithoutLinkRewardsInner>}
|
|
3872
3909
|
* @memberof Order
|
|
3873
3910
|
*/
|
|
3874
|
-
'
|
|
3911
|
+
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
3875
3912
|
}
|
|
3876
3913
|
export declare const OrderStatusEnum: {
|
|
3877
3914
|
readonly Canceled: "CANCELED";
|
|
@@ -3882,6 +3919,16 @@ export declare const OrderStatusEnum: {
|
|
|
3882
3919
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3883
3920
|
};
|
|
3884
3921
|
export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
|
|
3922
|
+
export declare const OrderChannelEnum: {
|
|
3923
|
+
readonly Ui: "UI";
|
|
3924
|
+
readonly Api: "API";
|
|
3925
|
+
readonly Embed: "EMBED";
|
|
3926
|
+
readonly Decipher: "DECIPHER";
|
|
3927
|
+
readonly Qualtrics: "QUALTRICS";
|
|
3928
|
+
readonly Typeform: "TYPEFORM";
|
|
3929
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
3930
|
+
};
|
|
3931
|
+
export type OrderChannelEnum = typeof OrderChannelEnum[keyof typeof OrderChannelEnum];
|
|
3885
3932
|
/**
|
|
3886
3933
|
* An order wraps around the fulfilment of one or more rewards.
|
|
3887
3934
|
* @export
|
|
@@ -3918,6 +3965,12 @@ export interface OrderBase {
|
|
|
3918
3965
|
* @memberof OrderBase
|
|
3919
3966
|
*/
|
|
3920
3967
|
'status': OrderBaseStatusEnum;
|
|
3968
|
+
/**
|
|
3969
|
+
* Name of the channel in which the order was created
|
|
3970
|
+
* @type {string}
|
|
3971
|
+
* @memberof OrderBase
|
|
3972
|
+
*/
|
|
3973
|
+
'channel'?: OrderBaseChannelEnum;
|
|
3921
3974
|
/**
|
|
3922
3975
|
*
|
|
3923
3976
|
* @type {OrderBasePayment}
|
|
@@ -3940,6 +3993,16 @@ export declare const OrderBaseStatusEnum: {
|
|
|
3940
3993
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
3941
3994
|
};
|
|
3942
3995
|
export type OrderBaseStatusEnum = typeof OrderBaseStatusEnum[keyof typeof OrderBaseStatusEnum];
|
|
3996
|
+
export declare const OrderBaseChannelEnum: {
|
|
3997
|
+
readonly Ui: "UI";
|
|
3998
|
+
readonly Api: "API";
|
|
3999
|
+
readonly Embed: "EMBED";
|
|
4000
|
+
readonly Decipher: "DECIPHER";
|
|
4001
|
+
readonly Qualtrics: "QUALTRICS";
|
|
4002
|
+
readonly Typeform: "TYPEFORM";
|
|
4003
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
4004
|
+
};
|
|
4005
|
+
export type OrderBaseChannelEnum = typeof OrderBaseChannelEnum[keyof typeof OrderBaseChannelEnum];
|
|
3943
4006
|
/**
|
|
3944
4007
|
* Cost breakdown of the order (cost of rewards + fees). Cost and fees are always denominated in USD, independent from the currency of the ordered rewards. Note that this property will only appear for processed orders (`status` is `EXECUTED`).
|
|
3945
4008
|
* @export
|
|
@@ -4037,6 +4100,12 @@ export interface OrderWithoutLink {
|
|
|
4037
4100
|
* @memberof OrderWithoutLink
|
|
4038
4101
|
*/
|
|
4039
4102
|
'status': OrderWithoutLinkStatusEnum;
|
|
4103
|
+
/**
|
|
4104
|
+
* Name of the channel in which the order was created
|
|
4105
|
+
* @type {string}
|
|
4106
|
+
* @memberof OrderWithoutLink
|
|
4107
|
+
*/
|
|
4108
|
+
'channel'?: OrderWithoutLinkChannelEnum;
|
|
4040
4109
|
/**
|
|
4041
4110
|
*
|
|
4042
4111
|
* @type {OrderBasePayment}
|
|
@@ -4051,10 +4120,10 @@ export interface OrderWithoutLink {
|
|
|
4051
4120
|
'invoice_id'?: string;
|
|
4052
4121
|
/**
|
|
4053
4122
|
*
|
|
4054
|
-
* @type {
|
|
4123
|
+
* @type {Array<OrderWithoutLinkRewardsInner>}
|
|
4055
4124
|
* @memberof OrderWithoutLink
|
|
4056
4125
|
*/
|
|
4057
|
-
'
|
|
4126
|
+
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
4058
4127
|
}
|
|
4059
4128
|
export declare const OrderWithoutLinkStatusEnum: {
|
|
4060
4129
|
readonly Canceled: "CANCELED";
|
|
@@ -4065,70 +4134,80 @@ export declare const OrderWithoutLinkStatusEnum: {
|
|
|
4065
4134
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
4066
4135
|
};
|
|
4067
4136
|
export type OrderWithoutLinkStatusEnum = typeof OrderWithoutLinkStatusEnum[keyof typeof OrderWithoutLinkStatusEnum];
|
|
4137
|
+
export declare const OrderWithoutLinkChannelEnum: {
|
|
4138
|
+
readonly Ui: "UI";
|
|
4139
|
+
readonly Api: "API";
|
|
4140
|
+
readonly Embed: "EMBED";
|
|
4141
|
+
readonly Decipher: "DECIPHER";
|
|
4142
|
+
readonly Qualtrics: "QUALTRICS";
|
|
4143
|
+
readonly Typeform: "TYPEFORM";
|
|
4144
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
4145
|
+
};
|
|
4146
|
+
export type OrderWithoutLinkChannelEnum = typeof OrderWithoutLinkChannelEnum[keyof typeof OrderWithoutLinkChannelEnum];
|
|
4068
4147
|
/**
|
|
4069
4148
|
* A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified.
|
|
4070
4149
|
* @export
|
|
4071
|
-
* @interface
|
|
4150
|
+
* @interface OrderWithoutLinkRewardsInner
|
|
4072
4151
|
*/
|
|
4073
|
-
export interface
|
|
4152
|
+
export interface OrderWithoutLinkRewardsInner {
|
|
4074
4153
|
/**
|
|
4075
4154
|
* Tremendous ID of the reward
|
|
4076
4155
|
* @type {string}
|
|
4077
|
-
* @memberof
|
|
4156
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4078
4157
|
*/
|
|
4079
4158
|
'id'?: string;
|
|
4080
4159
|
/**
|
|
4081
4160
|
* Tremendous ID of the order this reward is part of.
|
|
4082
4161
|
* @type {string}
|
|
4083
|
-
* @memberof
|
|
4162
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4084
4163
|
*/
|
|
4085
4164
|
'order_id'?: string;
|
|
4086
4165
|
/**
|
|
4087
4166
|
* Date the reward was created
|
|
4088
4167
|
* @type {string}
|
|
4089
|
-
* @memberof
|
|
4168
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4090
4169
|
*/
|
|
4091
4170
|
'created_at'?: string;
|
|
4092
4171
|
/**
|
|
4093
4172
|
* ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.
|
|
4094
4173
|
* @type {string}
|
|
4095
|
-
* @memberof
|
|
4174
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4096
4175
|
*/
|
|
4097
4176
|
'campaign_id'?: string | null;
|
|
4098
4177
|
/**
|
|
4099
4178
|
* List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel.
|
|
4100
4179
|
* @type {Array<string>}
|
|
4101
|
-
* @memberof
|
|
4180
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4102
4181
|
*/
|
|
4103
4182
|
'products'?: Array<string>;
|
|
4104
4183
|
/**
|
|
4105
4184
|
*
|
|
4106
4185
|
* @type {ListRewards200ResponseRewardsInnerValue}
|
|
4107
|
-
* @memberof
|
|
4186
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4108
4187
|
*/
|
|
4109
4188
|
'value'?: ListRewards200ResponseRewardsInnerValue;
|
|
4110
4189
|
/**
|
|
4111
4190
|
*
|
|
4112
4191
|
* @type {ListRewards200ResponseRewardsInnerRecipient}
|
|
4113
|
-
* @memberof
|
|
4192
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4114
4193
|
*/
|
|
4115
4194
|
'recipient'?: ListRewards200ResponseRewardsInnerRecipient;
|
|
4116
4195
|
/**
|
|
4117
4196
|
* Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.
|
|
4118
4197
|
* @type {string}
|
|
4119
|
-
* @memberof
|
|
4198
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4120
4199
|
*/
|
|
4121
4200
|
'deliver_at'?: string;
|
|
4122
4201
|
/**
|
|
4123
4202
|
*
|
|
4124
4203
|
* @type {Array<RewardBaseCustomFieldsInner>}
|
|
4125
|
-
* @memberof
|
|
4204
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4126
4205
|
*/
|
|
4127
4206
|
'custom_fields'?: Array<RewardBaseCustomFieldsInner>;
|
|
4128
4207
|
/**
|
|
4129
4208
|
*
|
|
4130
4209
|
* @type {RewardWithoutLinkDelivery}
|
|
4131
|
-
* @memberof
|
|
4210
|
+
* @memberof OrderWithoutLinkRewardsInner
|
|
4132
4211
|
*/
|
|
4133
4212
|
'delivery'?: RewardWithoutLinkDelivery;
|
|
4134
4213
|
}
|
|
@@ -5518,6 +5597,12 @@ export interface SingleRewardOrderWithoutLinkOrder {
|
|
|
5518
5597
|
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
5519
5598
|
*/
|
|
5520
5599
|
'status': SingleRewardOrderWithoutLinkOrderStatusEnum;
|
|
5600
|
+
/**
|
|
5601
|
+
* Name of the channel in which the order was created
|
|
5602
|
+
* @type {string}
|
|
5603
|
+
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
5604
|
+
*/
|
|
5605
|
+
'channel'?: SingleRewardOrderWithoutLinkOrderChannelEnum;
|
|
5521
5606
|
/**
|
|
5522
5607
|
*
|
|
5523
5608
|
* @type {OrderBasePayment}
|
|
@@ -5532,10 +5617,10 @@ export interface SingleRewardOrderWithoutLinkOrder {
|
|
|
5532
5617
|
'invoice_id'?: string;
|
|
5533
5618
|
/**
|
|
5534
5619
|
*
|
|
5535
|
-
* @type {
|
|
5620
|
+
* @type {Array<OrderWithoutLinkRewardsInner>}
|
|
5536
5621
|
* @memberof SingleRewardOrderWithoutLinkOrder
|
|
5537
5622
|
*/
|
|
5538
|
-
'
|
|
5623
|
+
'rewards'?: Array<OrderWithoutLinkRewardsInner>;
|
|
5539
5624
|
}
|
|
5540
5625
|
export declare const SingleRewardOrderWithoutLinkOrderStatusEnum: {
|
|
5541
5626
|
readonly Canceled: "CANCELED";
|
|
@@ -5546,6 +5631,16 @@ export declare const SingleRewardOrderWithoutLinkOrderStatusEnum: {
|
|
|
5546
5631
|
readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL";
|
|
5547
5632
|
};
|
|
5548
5633
|
export type SingleRewardOrderWithoutLinkOrderStatusEnum = typeof SingleRewardOrderWithoutLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithoutLinkOrderStatusEnum];
|
|
5634
|
+
export declare const SingleRewardOrderWithoutLinkOrderChannelEnum: {
|
|
5635
|
+
readonly Ui: "UI";
|
|
5636
|
+
readonly Api: "API";
|
|
5637
|
+
readonly Embed: "EMBED";
|
|
5638
|
+
readonly Decipher: "DECIPHER";
|
|
5639
|
+
readonly Qualtrics: "QUALTRICS";
|
|
5640
|
+
readonly Typeform: "TYPEFORM";
|
|
5641
|
+
readonly SurveyMonkey: "SURVEY MONKEY";
|
|
5642
|
+
};
|
|
5643
|
+
export type SingleRewardOrderWithoutLinkOrderChannelEnum = typeof SingleRewardOrderWithoutLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithoutLinkOrderChannelEnum];
|
|
5549
5644
|
/**
|
|
5550
5645
|
*
|
|
5551
5646
|
* @export
|
|
@@ -5807,7 +5902,7 @@ export declare const BalanceTransactionsApiFactory: (configuration?: Configurati
|
|
|
5807
5902
|
* @param {*} [options] Override http request option.
|
|
5808
5903
|
* @throws {RequiredError}
|
|
5809
5904
|
*/
|
|
5810
|
-
listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?:
|
|
5905
|
+
listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListBalanceTransactions200Response>;
|
|
5811
5906
|
};
|
|
5812
5907
|
/**
|
|
5813
5908
|
* BalanceTransactionsApi - object-oriented interface
|
|
@@ -5917,7 +6012,7 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
5917
6012
|
* @param {*} [options] Override http request option.
|
|
5918
6013
|
* @throws {RequiredError}
|
|
5919
6014
|
*/
|
|
5920
|
-
createCampaign(createCampaignRequest: CreateCampaignRequest, options?:
|
|
6015
|
+
createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign201Response>;
|
|
5921
6016
|
/**
|
|
5922
6017
|
* Retrieve a campaign, identified by the given `id` in the URL
|
|
5923
6018
|
* @summary Retrieve campaign
|
|
@@ -5925,14 +6020,14 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
5925
6020
|
* @param {*} [options] Override http request option.
|
|
5926
6021
|
* @throws {RequiredError}
|
|
5927
6022
|
*/
|
|
5928
|
-
getCampaign(id: string, options?:
|
|
6023
|
+
getCampaign(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign201Response>;
|
|
5929
6024
|
/**
|
|
5930
6025
|
* Retrieve a list of all campaigns created in your account
|
|
5931
6026
|
* @summary List campaigns
|
|
5932
6027
|
* @param {*} [options] Override http request option.
|
|
5933
6028
|
* @throws {RequiredError}
|
|
5934
6029
|
*/
|
|
5935
|
-
listCampaigns(options?:
|
|
6030
|
+
listCampaigns(options?: RawAxiosRequestConfig): AxiosPromise<ListCampaigns200Response>;
|
|
5936
6031
|
/**
|
|
5937
6032
|
*
|
|
5938
6033
|
* @summary Update campaign
|
|
@@ -5941,7 +6036,7 @@ export declare const CampaignsApiFactory: (configuration?: Configuration, basePa
|
|
|
5941
6036
|
* @param {*} [options] Override http request option.
|
|
5942
6037
|
* @throws {RequiredError}
|
|
5943
6038
|
*/
|
|
5944
|
-
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?:
|
|
6039
|
+
updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateCampaign201Response>;
|
|
5945
6040
|
};
|
|
5946
6041
|
/**
|
|
5947
6042
|
* CampaignsApi - object-oriented interface
|
|
@@ -6024,7 +6119,7 @@ export declare const FieldsApiFactory: (configuration?: Configuration, basePath?
|
|
|
6024
6119
|
* @param {*} [options] Override http request option.
|
|
6025
6120
|
* @throws {RequiredError}
|
|
6026
6121
|
*/
|
|
6027
|
-
listFields(options?:
|
|
6122
|
+
listFields(options?: RawAxiosRequestConfig): AxiosPromise<ListFields200Response>;
|
|
6028
6123
|
};
|
|
6029
6124
|
/**
|
|
6030
6125
|
* FieldsApi - object-oriented interface
|
|
@@ -6082,7 +6177,7 @@ export declare const ForexApiFactory: (configuration?: Configuration, basePath?:
|
|
|
6082
6177
|
* @param {*} [options] Override http request option.
|
|
6083
6178
|
* @throws {RequiredError}
|
|
6084
6179
|
*/
|
|
6085
|
-
listForex(base?: string, options?:
|
|
6180
|
+
listForex(base?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListForexResponse>;
|
|
6086
6181
|
};
|
|
6087
6182
|
/**
|
|
6088
6183
|
* ForexApi - object-oriented interface
|
|
@@ -6201,7 +6296,7 @@ export declare const FraudReviewsApiFactory: (configuration?: Configuration, bas
|
|
|
6201
6296
|
* @param {*} [options] Override http request option.
|
|
6202
6297
|
* @throws {RequiredError}
|
|
6203
6298
|
*/
|
|
6204
|
-
blockFraudReview(id: string, options?:
|
|
6299
|
+
blockFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFraudReview200Response>;
|
|
6205
6300
|
/**
|
|
6206
6301
|
* 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.
|
|
6207
6302
|
* @summary Retrieve single fraud review
|
|
@@ -6209,7 +6304,7 @@ export declare const FraudReviewsApiFactory: (configuration?: Configuration, bas
|
|
|
6209
6304
|
* @param {*} [options] Override http request option.
|
|
6210
6305
|
* @throws {RequiredError}
|
|
6211
6306
|
*/
|
|
6212
|
-
getFraudReview(id: string, options?:
|
|
6307
|
+
getFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFraudReview200Response>;
|
|
6213
6308
|
/**
|
|
6214
6309
|
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
6215
6310
|
* @summary List fraud reviews
|
|
@@ -6223,7 +6318,7 @@ export declare const FraudReviewsApiFactory: (configuration?: Configuration, bas
|
|
|
6223
6318
|
* @param {*} [options] Override http request option.
|
|
6224
6319
|
* @throws {RequiredError}
|
|
6225
6320
|
*/
|
|
6226
|
-
listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?:
|
|
6321
|
+
listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListFraudReviews200Response>;
|
|
6227
6322
|
/**
|
|
6228
6323
|
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
6229
6324
|
* @summary Release fraud review
|
|
@@ -6231,7 +6326,7 @@ export declare const FraudReviewsApiFactory: (configuration?: Configuration, bas
|
|
|
6231
6326
|
* @param {*} [options] Override http request option.
|
|
6232
6327
|
* @throws {RequiredError}
|
|
6233
6328
|
*/
|
|
6234
|
-
releaseFraudReview(id: string, options?:
|
|
6329
|
+
releaseFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFraudReview200Response>;
|
|
6235
6330
|
};
|
|
6236
6331
|
/**
|
|
6237
6332
|
* FraudReviewsApi - object-oriented interface
|
|
@@ -6382,7 +6477,7 @@ export declare const FraudRulesApiFactory: (configuration?: Configuration, baseP
|
|
|
6382
6477
|
* @param {*} [options] Override http request option.
|
|
6383
6478
|
* @throws {RequiredError}
|
|
6384
6479
|
*/
|
|
6385
|
-
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?:
|
|
6480
|
+
deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<DeleteFraudRule200Response>;
|
|
6386
6481
|
/**
|
|
6387
6482
|
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
6388
6483
|
* @summary Configure fraud rule
|
|
@@ -6391,14 +6486,14 @@ export declare const FraudRulesApiFactory: (configuration?: Configuration, baseP
|
|
|
6391
6486
|
* @param {*} [options] Override http request option.
|
|
6392
6487
|
* @throws {RequiredError}
|
|
6393
6488
|
*/
|
|
6394
|
-
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?:
|
|
6489
|
+
fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<FraudRule200Response>;
|
|
6395
6490
|
/**
|
|
6396
6491
|
* List active fraud rules associated with the organization tied to your API key.
|
|
6397
6492
|
* @summary List fraud rules
|
|
6398
6493
|
* @param {*} [options] Override http request option.
|
|
6399
6494
|
* @throws {RequiredError}
|
|
6400
6495
|
*/
|
|
6401
|
-
listFraudRules(options?:
|
|
6496
|
+
listFraudRules(options?: RawAxiosRequestConfig): AxiosPromise<ListFraudRules200Response>;
|
|
6402
6497
|
/**
|
|
6403
6498
|
* 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\"] } } ```
|
|
6404
6499
|
* @summary Update fraud rule list
|
|
@@ -6407,7 +6502,7 @@ export declare const FraudRulesApiFactory: (configuration?: Configuration, baseP
|
|
|
6407
6502
|
* @param {*} [options] Override http request option.
|
|
6408
6503
|
* @throws {RequiredError}
|
|
6409
6504
|
*/
|
|
6410
|
-
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?:
|
|
6505
|
+
updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateFraudRuleList200Response>;
|
|
6411
6506
|
};
|
|
6412
6507
|
/**
|
|
6413
6508
|
* FraudRulesApi - object-oriented interface
|
|
@@ -6553,14 +6648,14 @@ export declare const FundingSourcesApiFactory: (configuration?: Configuration, b
|
|
|
6553
6648
|
* @param {*} [options] Override http request option.
|
|
6554
6649
|
* @throws {RequiredError}
|
|
6555
6650
|
*/
|
|
6556
|
-
getFundingSource(id: string, options?:
|
|
6651
|
+
getFundingSource(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetFundingSource200Response>;
|
|
6557
6652
|
/**
|
|
6558
6653
|
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
6559
6654
|
* @summary List funding sources
|
|
6560
6655
|
* @param {*} [options] Override http request option.
|
|
6561
6656
|
* @throws {RequiredError}
|
|
6562
6657
|
*/
|
|
6563
|
-
listFundingSources(options?:
|
|
6658
|
+
listFundingSources(options?: RawAxiosRequestConfig): AxiosPromise<ListFundingSources200Response>;
|
|
6564
6659
|
};
|
|
6565
6660
|
/**
|
|
6566
6661
|
* FundingSourcesApi - object-oriented interface
|
|
@@ -6709,7 +6804,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
6709
6804
|
* @param {*} [options] Override http request option.
|
|
6710
6805
|
* @throws {RequiredError}
|
|
6711
6806
|
*/
|
|
6712
|
-
createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?:
|
|
6807
|
+
createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateInvoice200Response>;
|
|
6713
6808
|
/**
|
|
6714
6809
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
6715
6810
|
* @summary Delete invoice
|
|
@@ -6717,7 +6812,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
6717
6812
|
* @param {*} [options] Override http request option.
|
|
6718
6813
|
* @throws {RequiredError}
|
|
6719
6814
|
*/
|
|
6720
|
-
deleteInvoices(id: string, options?:
|
|
6815
|
+
deleteInvoices(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateInvoice200Response>;
|
|
6721
6816
|
/**
|
|
6722
6817
|
* Generates a CSV version for an invoice listing the associated rewards and orders
|
|
6723
6818
|
* @summary Retrieve invoice as CSV
|
|
@@ -6725,7 +6820,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
6725
6820
|
* @param {*} [options] Override http request option.
|
|
6726
6821
|
* @throws {RequiredError}
|
|
6727
6822
|
*/
|
|
6728
|
-
downloadInvoiceCsv(id: string, options?:
|
|
6823
|
+
downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
6729
6824
|
/**
|
|
6730
6825
|
* Generates a PDF version for an invoice
|
|
6731
6826
|
* @summary Retrieve invoice as PDF
|
|
@@ -6733,7 +6828,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
6733
6828
|
* @param {*} [options] Override http request option.
|
|
6734
6829
|
* @throws {RequiredError}
|
|
6735
6830
|
*/
|
|
6736
|
-
downloadInvoicePdf(id: string, options?:
|
|
6831
|
+
downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
6737
6832
|
/**
|
|
6738
6833
|
* 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.
|
|
6739
6834
|
* @summary Retrieve invoice
|
|
@@ -6741,7 +6836,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
6741
6836
|
* @param {*} [options] Override http request option.
|
|
6742
6837
|
* @throws {RequiredError}
|
|
6743
6838
|
*/
|
|
6744
|
-
getInvoice(id: string, options?:
|
|
6839
|
+
getInvoice(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateInvoice200Response>;
|
|
6745
6840
|
/**
|
|
6746
6841
|
* Fetch a list of all invoices on your account. > 🚧 Deleted invoices are omitted > > The response does not include any previously deleted invoices.
|
|
6747
6842
|
* @summary List invoices
|
|
@@ -6750,7 +6845,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
6750
6845
|
* @param {*} [options] Override http request option.
|
|
6751
6846
|
* @throws {RequiredError}
|
|
6752
6847
|
*/
|
|
6753
|
-
listInvoices(offset?: number, limit?: number, options?:
|
|
6848
|
+
listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListInvoices200Response>;
|
|
6754
6849
|
};
|
|
6755
6850
|
/**
|
|
6756
6851
|
* InvoicesApi - object-oriented interface
|
|
@@ -6885,7 +6980,7 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
|
|
|
6885
6980
|
* @param {*} [options] Override http request option.
|
|
6886
6981
|
* @throws {RequiredError}
|
|
6887
6982
|
*/
|
|
6888
|
-
createMember(createMemberRequest: CreateMemberRequest, options?:
|
|
6983
|
+
createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateMember200Response>;
|
|
6889
6984
|
/**
|
|
6890
6985
|
*
|
|
6891
6986
|
* @summary Retrieve member
|
|
@@ -6893,14 +6988,14 @@ export declare const MembersApiFactory: (configuration?: Configuration, basePath
|
|
|
6893
6988
|
* @param {*} [options] Override http request option.
|
|
6894
6989
|
* @throws {RequiredError}
|
|
6895
6990
|
*/
|
|
6896
|
-
getMember(id: string, options?:
|
|
6991
|
+
getMember(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetMember200Response>;
|
|
6897
6992
|
/**
|
|
6898
6993
|
* 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.
|
|
6899
6994
|
* @summary List members
|
|
6900
6995
|
* @param {*} [options] Override http request option.
|
|
6901
6996
|
* @throws {RequiredError}
|
|
6902
6997
|
*/
|
|
6903
|
-
listMembers(options?:
|
|
6998
|
+
listMembers(options?: RawAxiosRequestConfig): AxiosPromise<ListMembers200Response>;
|
|
6904
6999
|
};
|
|
6905
7000
|
/**
|
|
6906
7001
|
* MembersApi - object-oriented interface
|
|
@@ -7050,7 +7145,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
7050
7145
|
* @param {*} [options] Override http request option.
|
|
7051
7146
|
* @throws {RequiredError}
|
|
7052
7147
|
*/
|
|
7053
|
-
approveOrder(id: string, options?:
|
|
7148
|
+
approveOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrder200Response>;
|
|
7054
7149
|
/**
|
|
7055
7150
|
* 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-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> </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://tremendous.readme.io/reference/core-funding-source-index). 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://tremendous.readme.io/reference/sandbox). 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 result in a `201` response code. In this case the response will return a representation of the already existing order in the response body.
|
|
7056
7151
|
* @summary Create order
|
|
@@ -7058,7 +7153,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
7058
7153
|
* @param {*} [options] Override http request option.
|
|
7059
7154
|
* @throws {RequiredError}
|
|
7060
7155
|
*/
|
|
7061
|
-
createOrder(createOrderRequest: CreateOrderRequest, options?:
|
|
7156
|
+
createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrder200Response>;
|
|
7062
7157
|
/**
|
|
7063
7158
|
* Retrieve the order, identified by the given `id` in the URL
|
|
7064
7159
|
* @summary Retrieve order
|
|
@@ -7066,7 +7161,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
7066
7161
|
* @param {*} [options] Override http request option.
|
|
7067
7162
|
* @throws {RequiredError}
|
|
7068
7163
|
*/
|
|
7069
|
-
getOrder(id: string, options?:
|
|
7164
|
+
getOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrder200Response>;
|
|
7070
7165
|
/**
|
|
7071
7166
|
* Retrieve a list of orders
|
|
7072
7167
|
* @summary List orders
|
|
@@ -7079,7 +7174,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
7079
7174
|
* @param {*} [options] Override http request option.
|
|
7080
7175
|
* @throws {RequiredError}
|
|
7081
7176
|
*/
|
|
7082
|
-
listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?:
|
|
7177
|
+
listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListOrders200Response>;
|
|
7083
7178
|
/**
|
|
7084
7179
|
* 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.
|
|
7085
7180
|
* @summary Reject order
|
|
@@ -7087,7 +7182,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
7087
7182
|
* @param {*} [options] Override http request option.
|
|
7088
7183
|
* @throws {RequiredError}
|
|
7089
7184
|
*/
|
|
7090
|
-
rejectOrder(id: string, options?:
|
|
7185
|
+
rejectOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrder200Response>;
|
|
7091
7186
|
};
|
|
7092
7187
|
/**
|
|
7093
7188
|
* OrdersApi - object-oriented interface
|
|
@@ -7230,7 +7325,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
7230
7325
|
* @param {*} [options] Override http request option.
|
|
7231
7326
|
* @throws {RequiredError}
|
|
7232
7327
|
*/
|
|
7233
|
-
createApiKey(options?:
|
|
7328
|
+
createApiKey(options?: RawAxiosRequestConfig): AxiosPromise<CreateApiKey200Response>;
|
|
7234
7329
|
/**
|
|
7235
7330
|
* 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.
|
|
7236
7331
|
* @summary Create organization
|
|
@@ -7238,7 +7333,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
7238
7333
|
* @param {*} [options] Override http request option.
|
|
7239
7334
|
* @throws {RequiredError}
|
|
7240
7335
|
*/
|
|
7241
|
-
createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?:
|
|
7336
|
+
createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrganization200Response>;
|
|
7242
7337
|
/**
|
|
7243
7338
|
*
|
|
7244
7339
|
* @summary Retrieve organization
|
|
@@ -7246,14 +7341,14 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
7246
7341
|
* @param {*} [options] Override http request option.
|
|
7247
7342
|
* @throws {RequiredError}
|
|
7248
7343
|
*/
|
|
7249
|
-
getOrganization(id: string, options?:
|
|
7344
|
+
getOrganization(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganization200Response>;
|
|
7250
7345
|
/**
|
|
7251
7346
|
* The returned list only includes the organization to which the API key belongs to, that is used for the request.
|
|
7252
7347
|
* @summary List organizations
|
|
7253
7348
|
* @param {*} [options] Override http request option.
|
|
7254
7349
|
* @throws {RequiredError}
|
|
7255
7350
|
*/
|
|
7256
|
-
listOrganizations(options?:
|
|
7351
|
+
listOrganizations(options?: RawAxiosRequestConfig): AxiosPromise<ListOrganizations200Response>;
|
|
7257
7352
|
};
|
|
7258
7353
|
/**
|
|
7259
7354
|
* OrganizationsApi - object-oriented interface
|
|
@@ -7355,7 +7450,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
7355
7450
|
* @param {*} [options] Override http request option.
|
|
7356
7451
|
* @throws {RequiredError}
|
|
7357
7452
|
*/
|
|
7358
|
-
getProduct(id: string, options?:
|
|
7453
|
+
getProduct(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetProductResponse>;
|
|
7359
7454
|
/**
|
|
7360
7455
|
* Retrieve a list of available products
|
|
7361
7456
|
* @summary List products
|
|
@@ -7364,7 +7459,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
7364
7459
|
* @param {*} [options] Override http request option.
|
|
7365
7460
|
* @throws {RequiredError}
|
|
7366
7461
|
*/
|
|
7367
|
-
listProducts(country?: string, currency?: string, options?:
|
|
7462
|
+
listProducts(country?: string, currency?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListProductsResponse>;
|
|
7368
7463
|
};
|
|
7369
7464
|
/**
|
|
7370
7465
|
* ProductsApi - object-oriented interface
|
|
@@ -7497,7 +7592,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
7497
7592
|
* @param {*} [options] Override http request option.
|
|
7498
7593
|
* @throws {RequiredError}
|
|
7499
7594
|
*/
|
|
7500
|
-
createPublicKey(createPublicKeyRequest: CreatePublicKeyRequest, options?:
|
|
7595
|
+
createPublicKey(createPublicKeyRequest: CreatePublicKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePublicKey200Response>;
|
|
7501
7596
|
/**
|
|
7502
7597
|
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
7503
7598
|
* @summary Delete public key
|
|
@@ -7505,7 +7600,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
7505
7600
|
* @param {*} [options] Override http request option.
|
|
7506
7601
|
* @throws {RequiredError}
|
|
7507
7602
|
*/
|
|
7508
|
-
deletePublicKey(id: string, options?:
|
|
7603
|
+
deletePublicKey(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7509
7604
|
/**
|
|
7510
7605
|
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
7511
7606
|
* @summary Retrieve public key
|
|
@@ -7513,14 +7608,14 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
7513
7608
|
* @param {*} [options] Override http request option.
|
|
7514
7609
|
* @throws {RequiredError}
|
|
7515
7610
|
*/
|
|
7516
|
-
getPublicKey(id: string, options?:
|
|
7611
|
+
getPublicKey(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreatePublicKey200Response>;
|
|
7517
7612
|
/**
|
|
7518
7613
|
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
7519
7614
|
* @summary List public keys
|
|
7520
7615
|
* @param {*} [options] Override http request option.
|
|
7521
7616
|
* @throws {RequiredError}
|
|
7522
7617
|
*/
|
|
7523
|
-
listPublicKeys(options?:
|
|
7618
|
+
listPublicKeys(options?: RawAxiosRequestConfig): AxiosPromise<PublicKeysResponse>;
|
|
7524
7619
|
/**
|
|
7525
7620
|
* Making a request to this endpoint with a JWT signed with your private key will return a 200 response if the public key is active and the signature is valid. > 💡 Testing your integration > > **You can use [JWT.io](https://jwt.io/) to generate a signed token:** > > > 1. Select “RS256” in their algorithm dropdown; > 3. Define a JSON payload such as `{ \"foo\": \"bar\" }`; > 4. Fill the “Verify signature” fields with your public and private keys and copy the “Encoded” token.
|
|
7526
7621
|
* @summary Test public key
|
|
@@ -7529,7 +7624,7 @@ export declare const PublicKeysApiFactory: (configuration?: Configuration, baseP
|
|
|
7529
7624
|
* @param {*} [options] Override http request option.
|
|
7530
7625
|
* @throws {RequiredError}
|
|
7531
7626
|
*/
|
|
7532
|
-
testPublicKey(id: string, testPublicKeyRequest: TestPublicKeyRequest, options?:
|
|
7627
|
+
testPublicKey(id: string, testPublicKeyRequest: TestPublicKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7533
7628
|
};
|
|
7534
7629
|
/**
|
|
7535
7630
|
* PublicKeysApi - object-oriented interface
|
|
@@ -7688,7 +7783,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
7688
7783
|
* @param {*} [options] Override http request option.
|
|
7689
7784
|
* @throws {RequiredError}
|
|
7690
7785
|
*/
|
|
7691
|
-
generateRewardLink(id: string, options?:
|
|
7786
|
+
generateRewardLink(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GenerateRewardLink200Response>;
|
|
7692
7787
|
/**
|
|
7693
7788
|
* Generate a temporary reward token identified by the `id` in the URL. These tokens are needed to render a reward when using [Tremendous Embed](https://github.com/tremendous-rewards/embed/blob/master/docs/documentation.md). The token is valid for 24 hours.
|
|
7694
7789
|
* @summary Generate a reward token
|
|
@@ -7696,7 +7791,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
7696
7791
|
* @param {*} [options] Override http request option.
|
|
7697
7792
|
* @throws {RequiredError}
|
|
7698
7793
|
*/
|
|
7699
|
-
generateRewardToken(id: string, options?:
|
|
7794
|
+
generateRewardToken(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GenerateRewardToken200Response>;
|
|
7700
7795
|
/**
|
|
7701
7796
|
* Retrieve the reward, identified by the given `id` in the URL
|
|
7702
7797
|
* @summary Retrieve single reward
|
|
@@ -7704,7 +7799,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
7704
7799
|
* @param {*} [options] Override http request option.
|
|
7705
7800
|
* @throws {RequiredError}
|
|
7706
7801
|
*/
|
|
7707
|
-
getReward(id: string, options?:
|
|
7802
|
+
getReward(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GetReward200Response>;
|
|
7708
7803
|
/**
|
|
7709
7804
|
* Retrieve a list of all created rewards
|
|
7710
7805
|
* @summary List rewards
|
|
@@ -7712,7 +7807,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
7712
7807
|
* @param {*} [options] Override http request option.
|
|
7713
7808
|
* @throws {RequiredError}
|
|
7714
7809
|
*/
|
|
7715
|
-
listRewards(offset?: number, options?:
|
|
7810
|
+
listRewards(offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListRewards200Response>;
|
|
7716
7811
|
/**
|
|
7717
7812
|
* Resends a reward, identified by the given `id` in the URL, to its recipient.
|
|
7718
7813
|
* @summary Resend reward
|
|
@@ -7720,7 +7815,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
7720
7815
|
* @param {*} [options] Override http request option.
|
|
7721
7816
|
* @throws {RequiredError}
|
|
7722
7817
|
*/
|
|
7723
|
-
resendReward(id: string, options?:
|
|
7818
|
+
resendReward(id: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
7724
7819
|
};
|
|
7725
7820
|
/**
|
|
7726
7821
|
* RewardsApi - object-oriented interface
|
|
@@ -7812,7 +7907,7 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
7812
7907
|
* @param {*} [options] Override http request option.
|
|
7813
7908
|
* @throws {RequiredError}
|
|
7814
7909
|
*/
|
|
7815
|
-
listRoles(options?:
|
|
7910
|
+
listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRoles200Response>;
|
|
7816
7911
|
};
|
|
7817
7912
|
/**
|
|
7818
7913
|
* RolesApi - object-oriented interface
|
|
@@ -7950,7 +8045,7 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
7950
8045
|
* @param {*} [options] Override http request option.
|
|
7951
8046
|
* @throws {RequiredError}
|
|
7952
8047
|
*/
|
|
7953
|
-
createWebhook(createWebhookRequest: CreateWebhookRequest, options?:
|
|
8048
|
+
createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateWebhook200Response>;
|
|
7954
8049
|
/**
|
|
7955
8050
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
7956
8051
|
* @summary Delete webhook
|
|
@@ -7958,7 +8053,7 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
7958
8053
|
* @param {*} [options] Override http request option.
|
|
7959
8054
|
* @throws {RequiredError}
|
|
7960
8055
|
*/
|
|
7961
|
-
deleteWebhook(id: string, options?:
|
|
8056
|
+
deleteWebhook(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7962
8057
|
/**
|
|
7963
8058
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
7964
8059
|
* @summary Retrieve webhook
|
|
@@ -7966,7 +8061,7 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
7966
8061
|
* @param {*} [options] Override http request option.
|
|
7967
8062
|
* @throws {RequiredError}
|
|
7968
8063
|
*/
|
|
7969
|
-
getWebhook(id: string, options?:
|
|
8064
|
+
getWebhook(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateWebhook200Response>;
|
|
7970
8065
|
/**
|
|
7971
8066
|
* 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)
|
|
7972
8067
|
* @summary List events
|
|
@@ -7974,14 +8069,14 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
7974
8069
|
* @param {*} [options] Override http request option.
|
|
7975
8070
|
* @throws {RequiredError}
|
|
7976
8071
|
*/
|
|
7977
|
-
listWebhookEvents(id: string, options?:
|
|
8072
|
+
listWebhookEvents(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ListWebhookEvents200Response>;
|
|
7978
8073
|
/**
|
|
7979
8074
|
* 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)
|
|
7980
8075
|
* @summary List webhooks
|
|
7981
8076
|
* @param {*} [options] Override http request option.
|
|
7982
8077
|
* @throws {RequiredError}
|
|
7983
8078
|
*/
|
|
7984
|
-
listWebhooks(options?:
|
|
8079
|
+
listWebhooks(options?: RawAxiosRequestConfig): AxiosPromise<ListWebhooks200Response>;
|
|
7985
8080
|
/**
|
|
7986
8081
|
* 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)
|
|
7987
8082
|
* @summary Test webhook
|
|
@@ -7990,7 +8085,7 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
7990
8085
|
* @param {*} [options] Override http request option.
|
|
7991
8086
|
* @throws {RequiredError}
|
|
7992
8087
|
*/
|
|
7993
|
-
simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?:
|
|
8088
|
+
simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
7994
8089
|
};
|
|
7995
8090
|
/**
|
|
7996
8091
|
* WebhooksApi - object-oriented interface
|
package/dist/api.js
CHANGED
|
@@ -22,15 +22,29 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
26
|
-
exports.
|
|
27
|
-
exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RewardsApi = exports.RewardsApiFactory = exports.RewardsApiFp = exports.RewardsApiAxiosParamCreator = exports.PublicKeysApi = exports.PublicKeysApiFactory = exports.PublicKeysApiFp = exports.PublicKeysApiAxiosParamCreator = 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 = void 0;
|
|
25
|
+
exports.MemberStatusEnum = exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = exports.ListRewards200ResponseRewardsInnerDeliveryStatusEnum = exports.ListRewards200ResponseRewardsInnerDeliveryMethodEnum = exports.ListProductsResponseProductsInnerImagesInnerTypeEnum = exports.ListProductsResponseProductsInnerCurrencyCodesEnum = exports.ListProductsResponseProductsInnerCategoryEnum = exports.ListOrganizations200ResponseOrganizationsInnerStatusEnum = exports.ListOrders200ResponseOrdersInnerPaymentChannelEnum = exports.ListOrders200ResponseOrdersInnerChannelEnum = exports.ListOrders200ResponseOrdersInnerStatusEnum = exports.ListMembers200ResponseMembersInnerStatusEnum = exports.ListInvoices200ResponseInvoicesInnerStatusEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum = exports.ListFundingSources200ResponseFundingSourcesInnerTypeEnum = exports.ListFundingSources200ResponseFundingSourcesInnerMethodEnum = exports.ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = exports.ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = exports.ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = exports.InvoiceStatusEnum = exports.GetMember200ResponseMemberEventsInnerTypeEnum = exports.GetMember200ResponseMemberStatusEnum = exports.GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = exports.GetFraudReview200ResponseFraudReviewReasonsEnum = exports.GetFraudReview200ResponseFraudReviewStatusEnum = exports.FundingSourceTypeEnum = exports.FundingSourceMethodEnum = exports.FraudRulesListItemRuleTypeEnum = exports.FraudRuleType = exports.FraudRuleRequestConfigPeriodEnum = exports.FraudRuleRequestConfigTypeEnum = exports.FraudReviewStatus = exports.FraudReviewRedemptionMethod = exports.FraudReviewReason = exports.FraudReviewListItemReasonsEnum = exports.FraudReviewListItemStatusEnum = exports.FraudReviewRedemptionMethodEnum = exports.FraudReviewReasonsEnum = exports.FraudReviewStatusEnum = exports.FraudConfigRedeemedRewardsCountPeriodEnum = exports.FraudConfigRedeemedRewardsAmountPeriodEnum = exports.FraudConfigCountryTypeEnum = exports.DeliveryStatus = exports.DeliveryMethod = exports.DeliveryDetailsStatusEnum = exports.DeliveryDetailsMethodEnum = exports.CurrencyCodes = exports.CreateOrganization200ResponseOrganizationStatusEnum = exports.Channel = void 0;
|
|
26
|
+
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.CampaignsApi = exports.CampaignsApiFactory = exports.CampaignsApiFp = exports.CampaignsApiAxiosParamCreator = exports.BalanceTransactionsApi = exports.BalanceTransactionsApiFactory = exports.BalanceTransactionsApiFp = exports.BalanceTransactionsApiAxiosParamCreator = exports.UpdateFraudRuleListRequestOperationEnum = exports.SingleRewardOrderWithoutLinkOrderChannelEnum = exports.SingleRewardOrderWithoutLinkOrderStatusEnum = exports.SingleRewardOrder1RewardDeliveryMethodEnum = exports.RewardWithoutLinkDeliveryStatusEnum = exports.RewardWithoutLinkDeliveryMethodEnum = exports.RewardValueCurrencyCodeEnum = exports.ReviewRedeemedRewardsCountPeriodEnum = exports.ReviewRedeemedRewardsAmountPeriodEnum = exports.ReviewCountryTypeEnum = exports.ProductCurrencyCodesEnum = exports.ProductCategoryEnum = exports.PaymentDetailsChannelEnum = exports.OrganizationStatusEnum = exports.OrderWithoutLinkChannelEnum = exports.OrderWithoutLinkStatusEnum = exports.OrderStatus = exports.OrderBasePaymentChannelEnum = exports.OrderBaseChannelEnum = exports.OrderBaseStatusEnum = exports.OrderChannelEnum = exports.OrderStatusEnum = exports.MemberWithoutEventsStatusEnum = exports.MemberWithEventsStatusEnum = exports.MemberBaseStatusEnum = void 0;
|
|
27
|
+
exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RewardsApi = exports.RewardsApiFactory = exports.RewardsApiFp = exports.RewardsApiAxiosParamCreator = exports.PublicKeysApi = exports.PublicKeysApiFactory = exports.PublicKeysApiFp = exports.PublicKeysApiAxiosParamCreator = 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 = exports.DeleteFraudRuleRuleTypeEnum = void 0;
|
|
28
28
|
const axios_1 = require("axios");
|
|
29
29
|
// Some imports not used depending on template conditions
|
|
30
30
|
// @ts-ignore
|
|
31
31
|
const common_1 = require("./common");
|
|
32
32
|
// @ts-ignore
|
|
33
33
|
const base_1 = require("./base");
|
|
34
|
+
/**
|
|
35
|
+
* Name of the channel in which the order was created
|
|
36
|
+
* @export
|
|
37
|
+
* @enum {string}
|
|
38
|
+
*/
|
|
39
|
+
exports.Channel = {
|
|
40
|
+
Ui: 'UI',
|
|
41
|
+
Api: 'API',
|
|
42
|
+
Embed: 'EMBED',
|
|
43
|
+
Decipher: 'DECIPHER',
|
|
44
|
+
Qualtrics: 'QUALTRICS',
|
|
45
|
+
Typeform: 'TYPEFORM',
|
|
46
|
+
SurveyMonkey: 'SURVEY MONKEY'
|
|
47
|
+
};
|
|
34
48
|
exports.CreateOrganization200ResponseOrganizationStatusEnum = {
|
|
35
49
|
Pending: 'PENDING',
|
|
36
50
|
Approved: 'APPROVED',
|
|
@@ -511,6 +525,15 @@ exports.ListOrders200ResponseOrdersInnerStatusEnum = {
|
|
|
511
525
|
PendingApproval: 'PENDING APPROVAL',
|
|
512
526
|
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
513
527
|
};
|
|
528
|
+
exports.ListOrders200ResponseOrdersInnerChannelEnum = {
|
|
529
|
+
Ui: 'UI',
|
|
530
|
+
Api: 'API',
|
|
531
|
+
Embed: 'EMBED',
|
|
532
|
+
Decipher: 'DECIPHER',
|
|
533
|
+
Qualtrics: 'QUALTRICS',
|
|
534
|
+
Typeform: 'TYPEFORM',
|
|
535
|
+
SurveyMonkey: 'SURVEY MONKEY'
|
|
536
|
+
};
|
|
514
537
|
exports.ListOrders200ResponseOrdersInnerPaymentChannelEnum = {
|
|
515
538
|
Ui: 'UI',
|
|
516
539
|
Api: 'API',
|
|
@@ -808,6 +831,15 @@ exports.OrderStatusEnum = {
|
|
|
808
831
|
PendingApproval: 'PENDING APPROVAL',
|
|
809
832
|
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
810
833
|
};
|
|
834
|
+
exports.OrderChannelEnum = {
|
|
835
|
+
Ui: 'UI',
|
|
836
|
+
Api: 'API',
|
|
837
|
+
Embed: 'EMBED',
|
|
838
|
+
Decipher: 'DECIPHER',
|
|
839
|
+
Qualtrics: 'QUALTRICS',
|
|
840
|
+
Typeform: 'TYPEFORM',
|
|
841
|
+
SurveyMonkey: 'SURVEY MONKEY'
|
|
842
|
+
};
|
|
811
843
|
exports.OrderBaseStatusEnum = {
|
|
812
844
|
Canceled: 'CANCELED',
|
|
813
845
|
Cart: 'CART',
|
|
@@ -816,6 +848,15 @@ exports.OrderBaseStatusEnum = {
|
|
|
816
848
|
PendingApproval: 'PENDING APPROVAL',
|
|
817
849
|
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
818
850
|
};
|
|
851
|
+
exports.OrderBaseChannelEnum = {
|
|
852
|
+
Ui: 'UI',
|
|
853
|
+
Api: 'API',
|
|
854
|
+
Embed: 'EMBED',
|
|
855
|
+
Decipher: 'DECIPHER',
|
|
856
|
+
Qualtrics: 'QUALTRICS',
|
|
857
|
+
Typeform: 'TYPEFORM',
|
|
858
|
+
SurveyMonkey: 'SURVEY MONKEY'
|
|
859
|
+
};
|
|
819
860
|
exports.OrderBasePaymentChannelEnum = {
|
|
820
861
|
Ui: 'UI',
|
|
821
862
|
Api: 'API',
|
|
@@ -846,6 +887,15 @@ exports.OrderWithoutLinkStatusEnum = {
|
|
|
846
887
|
PendingApproval: 'PENDING APPROVAL',
|
|
847
888
|
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
848
889
|
};
|
|
890
|
+
exports.OrderWithoutLinkChannelEnum = {
|
|
891
|
+
Ui: 'UI',
|
|
892
|
+
Api: 'API',
|
|
893
|
+
Embed: 'EMBED',
|
|
894
|
+
Decipher: 'DECIPHER',
|
|
895
|
+
Qualtrics: 'QUALTRICS',
|
|
896
|
+
Typeform: 'TYPEFORM',
|
|
897
|
+
SurveyMonkey: 'SURVEY MONKEY'
|
|
898
|
+
};
|
|
849
899
|
exports.OrganizationStatusEnum = {
|
|
850
900
|
Pending: 'PENDING',
|
|
851
901
|
Approved: 'APPROVED',
|
|
@@ -1148,6 +1198,15 @@ exports.SingleRewardOrderWithoutLinkOrderStatusEnum = {
|
|
|
1148
1198
|
PendingApproval: 'PENDING APPROVAL',
|
|
1149
1199
|
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
1150
1200
|
};
|
|
1201
|
+
exports.SingleRewardOrderWithoutLinkOrderChannelEnum = {
|
|
1202
|
+
Ui: 'UI',
|
|
1203
|
+
Api: 'API',
|
|
1204
|
+
Embed: 'EMBED',
|
|
1205
|
+
Decipher: 'DECIPHER',
|
|
1206
|
+
Qualtrics: 'QUALTRICS',
|
|
1207
|
+
Typeform: 'TYPEFORM',
|
|
1208
|
+
SurveyMonkey: 'SURVEY MONKEY'
|
|
1209
|
+
};
|
|
1151
1210
|
exports.UpdateFraudRuleListRequestOperationEnum = {
|
|
1152
1211
|
Add: 'add',
|
|
1153
1212
|
Remove: 'remove'
|
package/dist/environments.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
export {};
|
|
1
|
+
export declare const Environments: {
|
|
2
|
+
production: string;
|
|
3
|
+
testflight: string;
|
|
4
|
+
};
|
package/dist/environments.js
CHANGED
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.Environments = void 0;
|
|
4
4
|
exports.Environments = {
|
|
5
|
-
production: 'https://
|
|
5
|
+
production: 'https://api.tremendous.com/api/v2',
|
|
6
6
|
testflight: 'https://testflight.tremendous.com/api/v2',
|
|
7
7
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tremendous",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.0",
|
|
4
4
|
"description": "A node.js client for the Tremendous API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"tremendous",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"typings": "./dist/index.d.ts",
|
|
24
24
|
"scripts": {
|
|
25
25
|
"build": "tsc --outDir dist/",
|
|
26
|
-
"test": "vitest --testTimeout 10000"
|
|
26
|
+
"test": "vitest --testTimeout 10000 --retry 3"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
29
|
"axios": "^1.6.1"
|