tremendous 3.1.0 → 3.4.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/README.md +2 -2
- package/dist/api.d.ts +3947 -2096
- package/dist/api.js +1917 -328
- package/package.json +3 -3
package/dist/api.js
CHANGED
|
@@ -22,47 +22,15 @@ 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 = void 0;
|
|
25
|
+
exports.MemberWithEventsStatusEnum = exports.MemberBaseStatusEnum = exports.MemberStatusEnum = exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = exports.ListRewards200ResponseRewardsInnerDeliveryStatusEnum = exports.ListRewards200ResponseRewardsInnerDeliveryMethodEnum = exports.ListProductsResponseProductsInnerImagesInnerTypeEnum = exports.ListProductsResponseProductsInnerCurrencyCodesEnum = exports.ListProductsResponseProductsInnerCategoryEnum = exports.ListOrganizations200ResponseOrganizationsInnerStatusEnum = exports.ListOrders200ResponseOrdersInnerPaymentChannelEnum = 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 = void 0;
|
|
26
|
+
exports.FundingSourcesApiFactory = exports.FundingSourcesApiFp = exports.FundingSourcesApiAxiosParamCreator = exports.UpdateFraudRuleListRuleTypeEnum = exports.FraudRuleRuleTypeEnum = 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.CampaignsApi = exports.CampaignsApiFactory = exports.CampaignsApiFp = exports.CampaignsApiAxiosParamCreator = exports.BalanceTransactionsApi = exports.BalanceTransactionsApiFactory = exports.BalanceTransactionsApiFp = exports.BalanceTransactionsApiAxiosParamCreator = exports.UpdateFraudRuleListRequestOperationEnum = 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.OrderWithoutLinkStatusEnum = exports.OrderStatus = exports.OrderBasePaymentChannelEnum = exports.OrderBaseStatusEnum = exports.OrderStatusEnum = exports.MemberWithoutEventsStatusEnum = 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 = 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
|
-
exports.CreateMemberRoleEnum = {
|
|
35
|
-
Member: 'MEMBER',
|
|
36
|
-
Admin: 'ADMIN'
|
|
37
|
-
};
|
|
38
|
-
exports.CreateMemberRequestRoleEnum = {
|
|
39
|
-
Member: 'MEMBER',
|
|
40
|
-
Admin: 'ADMIN'
|
|
41
|
-
};
|
|
42
|
-
exports.CreateOrder200ResponseOrderStatusEnum = {
|
|
43
|
-
Canceled: 'CANCELED',
|
|
44
|
-
Cart: 'CART',
|
|
45
|
-
Executed: 'EXECUTED',
|
|
46
|
-
Failed: 'FAILED',
|
|
47
|
-
PendingApproval: 'PENDING APPROVAL',
|
|
48
|
-
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
49
|
-
};
|
|
50
|
-
exports.CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum = {
|
|
51
|
-
Email: 'EMAIL',
|
|
52
|
-
Link: 'LINK',
|
|
53
|
-
Phone: 'PHONE'
|
|
54
|
-
};
|
|
55
|
-
exports.CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum = {
|
|
56
|
-
Scheduled: 'SCHEDULED',
|
|
57
|
-
Failed: 'FAILED',
|
|
58
|
-
Succeeded: 'SUCCEEDED',
|
|
59
|
-
Pending: 'PENDING'
|
|
60
|
-
};
|
|
61
|
-
exports.CreateOrderRequestRewardDeliveryMethodEnum = {
|
|
62
|
-
Email: 'EMAIL',
|
|
63
|
-
Link: 'LINK',
|
|
64
|
-
Phone: 'PHONE'
|
|
65
|
-
};
|
|
66
34
|
exports.CreateOrganization200ResponseOrganizationStatusEnum = {
|
|
67
35
|
Pending: 'PENDING',
|
|
68
36
|
Approved: 'APPROVED',
|
|
@@ -202,17 +170,6 @@ exports.DeliveryDetailsStatusEnum = {
|
|
|
202
170
|
Succeeded: 'SUCCEEDED',
|
|
203
171
|
Pending: 'PENDING'
|
|
204
172
|
};
|
|
205
|
-
exports.DeliveryDetailsWithLinkMethodEnum = {
|
|
206
|
-
Email: 'EMAIL',
|
|
207
|
-
Link: 'LINK',
|
|
208
|
-
Phone: 'PHONE'
|
|
209
|
-
};
|
|
210
|
-
exports.DeliveryDetailsWithLinkStatusEnum = {
|
|
211
|
-
Scheduled: 'SCHEDULED',
|
|
212
|
-
Failed: 'FAILED',
|
|
213
|
-
Succeeded: 'SUCCEEDED',
|
|
214
|
-
Pending: 'PENDING'
|
|
215
|
-
};
|
|
216
173
|
/**
|
|
217
174
|
* How to deliver the reward to the recipient. <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>
|
|
218
175
|
* @export
|
|
@@ -234,6 +191,181 @@ exports.DeliveryStatus = {
|
|
|
234
191
|
Succeeded: 'SUCCEEDED',
|
|
235
192
|
Pending: 'PENDING'
|
|
236
193
|
};
|
|
194
|
+
exports.FraudConfigCountryTypeEnum = {
|
|
195
|
+
Whitelist: 'whitelist',
|
|
196
|
+
Blacklist: 'blacklist'
|
|
197
|
+
};
|
|
198
|
+
exports.FraudConfigRedeemedRewardsAmountPeriodEnum = {
|
|
199
|
+
_7: '7',
|
|
200
|
+
_30: '30',
|
|
201
|
+
_90: '90',
|
|
202
|
+
_120: '120',
|
|
203
|
+
_365: '365',
|
|
204
|
+
AllTime: 'all_time'
|
|
205
|
+
};
|
|
206
|
+
exports.FraudConfigRedeemedRewardsCountPeriodEnum = {
|
|
207
|
+
_7: '7',
|
|
208
|
+
_30: '30',
|
|
209
|
+
_90: '90',
|
|
210
|
+
_120: '120',
|
|
211
|
+
_365: '365',
|
|
212
|
+
AllTime: 'all_time'
|
|
213
|
+
};
|
|
214
|
+
exports.FraudReviewStatusEnum = {
|
|
215
|
+
Flagged: 'flagged',
|
|
216
|
+
Blocked: 'blocked',
|
|
217
|
+
Released: 'released'
|
|
218
|
+
};
|
|
219
|
+
exports.FraudReviewReasonsEnum = {
|
|
220
|
+
DisallowedIp: 'Disallowed IP',
|
|
221
|
+
DisallowedEmail: 'Disallowed email',
|
|
222
|
+
DisallowedCountry: 'Disallowed country',
|
|
223
|
+
OverRewardDollarLimit: 'Over reward dollar limit',
|
|
224
|
+
OverRewardCountLimit: 'Over reward count limit',
|
|
225
|
+
VpnDetected: 'VPN detected',
|
|
226
|
+
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
227
|
+
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
228
|
+
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
229
|
+
BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list',
|
|
230
|
+
FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list',
|
|
231
|
+
EmailOnATremendousFraudList: 'Email on a Tremendous fraud list',
|
|
232
|
+
PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list',
|
|
233
|
+
IpRelatedToABlockedReward: 'IP related to a blocked reward',
|
|
234
|
+
BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward',
|
|
235
|
+
FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward',
|
|
236
|
+
EmailRelatedToABlockedReward: 'Email related to a blocked reward',
|
|
237
|
+
PhoneRelatedToABlockedReward: 'Phone related to a blocked reward',
|
|
238
|
+
AllowedIp: 'Allowed IP',
|
|
239
|
+
AllowedEmail: 'Allowed email'
|
|
240
|
+
};
|
|
241
|
+
exports.FraudReviewRedemptionMethodEnum = {
|
|
242
|
+
Paypal: 'paypal',
|
|
243
|
+
Bank: 'bank',
|
|
244
|
+
MerchantCard: 'merchant card',
|
|
245
|
+
VisaCard: 'visa card',
|
|
246
|
+
Charity: 'charity',
|
|
247
|
+
Venmo: 'venmo'
|
|
248
|
+
};
|
|
249
|
+
exports.FraudReviewListItemStatusEnum = {
|
|
250
|
+
Flagged: 'flagged',
|
|
251
|
+
Blocked: 'blocked',
|
|
252
|
+
Released: 'released'
|
|
253
|
+
};
|
|
254
|
+
exports.FraudReviewListItemReasonsEnum = {
|
|
255
|
+
DisallowedIp: 'Disallowed IP',
|
|
256
|
+
DisallowedEmail: 'Disallowed email',
|
|
257
|
+
DisallowedCountry: 'Disallowed country',
|
|
258
|
+
OverRewardDollarLimit: 'Over reward dollar limit',
|
|
259
|
+
OverRewardCountLimit: 'Over reward count limit',
|
|
260
|
+
VpnDetected: 'VPN detected',
|
|
261
|
+
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
262
|
+
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
263
|
+
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
264
|
+
BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list',
|
|
265
|
+
FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list',
|
|
266
|
+
EmailOnATremendousFraudList: 'Email on a Tremendous fraud list',
|
|
267
|
+
PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list',
|
|
268
|
+
IpRelatedToABlockedReward: 'IP related to a blocked reward',
|
|
269
|
+
BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward',
|
|
270
|
+
FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward',
|
|
271
|
+
EmailRelatedToABlockedReward: 'Email related to a blocked reward',
|
|
272
|
+
PhoneRelatedToABlockedReward: 'Phone related to a blocked reward',
|
|
273
|
+
AllowedIp: 'Allowed IP',
|
|
274
|
+
AllowedEmail: 'Allowed email'
|
|
275
|
+
};
|
|
276
|
+
/**
|
|
277
|
+
*
|
|
278
|
+
* @export
|
|
279
|
+
* @enum {string}
|
|
280
|
+
*/
|
|
281
|
+
exports.FraudReviewReason = {
|
|
282
|
+
DisallowedIp: 'Disallowed IP',
|
|
283
|
+
DisallowedEmail: 'Disallowed email',
|
|
284
|
+
DisallowedCountry: 'Disallowed country',
|
|
285
|
+
OverRewardDollarLimit: 'Over reward dollar limit',
|
|
286
|
+
OverRewardCountLimit: 'Over reward count limit',
|
|
287
|
+
VpnDetected: 'VPN detected',
|
|
288
|
+
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
289
|
+
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
290
|
+
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
291
|
+
BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list',
|
|
292
|
+
FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list',
|
|
293
|
+
EmailOnATremendousFraudList: 'Email on a Tremendous fraud list',
|
|
294
|
+
PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list',
|
|
295
|
+
IpRelatedToABlockedReward: 'IP related to a blocked reward',
|
|
296
|
+
BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward',
|
|
297
|
+
FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward',
|
|
298
|
+
EmailRelatedToABlockedReward: 'Email related to a blocked reward',
|
|
299
|
+
PhoneRelatedToABlockedReward: 'Phone related to a blocked reward',
|
|
300
|
+
AllowedIp: 'Allowed IP',
|
|
301
|
+
AllowedEmail: 'Allowed email'
|
|
302
|
+
};
|
|
303
|
+
/**
|
|
304
|
+
*
|
|
305
|
+
* @export
|
|
306
|
+
* @enum {string}
|
|
307
|
+
*/
|
|
308
|
+
exports.FraudReviewRedemptionMethod = {
|
|
309
|
+
Paypal: 'paypal',
|
|
310
|
+
Bank: 'bank',
|
|
311
|
+
MerchantCard: 'merchant card',
|
|
312
|
+
VisaCard: 'visa card',
|
|
313
|
+
Charity: 'charity',
|
|
314
|
+
Venmo: 'venmo'
|
|
315
|
+
};
|
|
316
|
+
/**
|
|
317
|
+
* The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released.
|
|
318
|
+
* @export
|
|
319
|
+
* @enum {string}
|
|
320
|
+
*/
|
|
321
|
+
exports.FraudReviewStatus = {
|
|
322
|
+
Flagged: 'flagged',
|
|
323
|
+
Blocked: 'blocked',
|
|
324
|
+
Released: 'released'
|
|
325
|
+
};
|
|
326
|
+
exports.FraudRuleRequestConfigTypeEnum = {
|
|
327
|
+
Whitelist: 'whitelist',
|
|
328
|
+
Blacklist: 'blacklist'
|
|
329
|
+
};
|
|
330
|
+
exports.FraudRuleRequestConfigPeriodEnum = {
|
|
331
|
+
_7: '7',
|
|
332
|
+
_30: '30',
|
|
333
|
+
_90: '90',
|
|
334
|
+
_120: '120',
|
|
335
|
+
_365: '365',
|
|
336
|
+
AllTime: 'all_time'
|
|
337
|
+
};
|
|
338
|
+
/**
|
|
339
|
+
* * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list
|
|
340
|
+
* @export
|
|
341
|
+
* @enum {string}
|
|
342
|
+
*/
|
|
343
|
+
exports.FraudRuleType = {
|
|
344
|
+
ReviewCountry: 'review_country',
|
|
345
|
+
ReviewIp: 'review_ip',
|
|
346
|
+
ReviewEmail: 'review_email',
|
|
347
|
+
ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count',
|
|
348
|
+
ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount',
|
|
349
|
+
ReviewMultipleEmails: 'review_multiple_emails',
|
|
350
|
+
ReviewVpn: 'review_vpn',
|
|
351
|
+
ReviewTremendousFlagList: 'review_tremendous_flag_list',
|
|
352
|
+
ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients',
|
|
353
|
+
AllowIp: 'allow_ip',
|
|
354
|
+
AllowEmail: 'allow_email'
|
|
355
|
+
};
|
|
356
|
+
exports.FraudRulesListItemRuleTypeEnum = {
|
|
357
|
+
ReviewCountry: 'review_country',
|
|
358
|
+
ReviewIp: 'review_ip',
|
|
359
|
+
ReviewEmail: 'review_email',
|
|
360
|
+
ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count',
|
|
361
|
+
ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount',
|
|
362
|
+
ReviewMultipleEmails: 'review_multiple_emails',
|
|
363
|
+
ReviewVpn: 'review_vpn',
|
|
364
|
+
ReviewTremendousFlagList: 'review_tremendous_flag_list',
|
|
365
|
+
ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients',
|
|
366
|
+
AllowIp: 'allow_ip',
|
|
367
|
+
AllowEmail: 'allow_email'
|
|
368
|
+
};
|
|
237
369
|
exports.FundingSourceMethodEnum = {
|
|
238
370
|
Balance: 'balance',
|
|
239
371
|
BankAccount: 'bank_account',
|
|
@@ -245,9 +377,40 @@ exports.FundingSourceTypeEnum = {
|
|
|
245
377
|
ProForma: 'PRO_FORMA',
|
|
246
378
|
PrefundingOnly: 'PREFUNDING_ONLY'
|
|
247
379
|
};
|
|
248
|
-
exports.
|
|
249
|
-
|
|
250
|
-
|
|
380
|
+
exports.GetFraudReview200ResponseFraudReviewStatusEnum = {
|
|
381
|
+
Flagged: 'flagged',
|
|
382
|
+
Blocked: 'blocked',
|
|
383
|
+
Released: 'released'
|
|
384
|
+
};
|
|
385
|
+
exports.GetFraudReview200ResponseFraudReviewReasonsEnum = {
|
|
386
|
+
DisallowedIp: 'Disallowed IP',
|
|
387
|
+
DisallowedEmail: 'Disallowed email',
|
|
388
|
+
DisallowedCountry: 'Disallowed country',
|
|
389
|
+
OverRewardDollarLimit: 'Over reward dollar limit',
|
|
390
|
+
OverRewardCountLimit: 'Over reward count limit',
|
|
391
|
+
VpnDetected: 'VPN detected',
|
|
392
|
+
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
393
|
+
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
394
|
+
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
395
|
+
BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list',
|
|
396
|
+
FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list',
|
|
397
|
+
EmailOnATremendousFraudList: 'Email on a Tremendous fraud list',
|
|
398
|
+
PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list',
|
|
399
|
+
IpRelatedToABlockedReward: 'IP related to a blocked reward',
|
|
400
|
+
BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward',
|
|
401
|
+
FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward',
|
|
402
|
+
EmailRelatedToABlockedReward: 'Email related to a blocked reward',
|
|
403
|
+
PhoneRelatedToABlockedReward: 'Phone related to a blocked reward',
|
|
404
|
+
AllowedIp: 'Allowed IP',
|
|
405
|
+
AllowedEmail: 'Allowed email'
|
|
406
|
+
};
|
|
407
|
+
exports.GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = {
|
|
408
|
+
Paypal: 'paypal',
|
|
409
|
+
Bank: 'bank',
|
|
410
|
+
MerchantCard: 'merchant card',
|
|
411
|
+
VisaCard: 'visa card',
|
|
412
|
+
Charity: 'charity',
|
|
413
|
+
Venmo: 'venmo'
|
|
251
414
|
};
|
|
252
415
|
exports.GetMember200ResponseMemberStatusEnum = {
|
|
253
416
|
Registered: 'REGISTERED',
|
|
@@ -263,6 +426,46 @@ exports.InvoiceStatusEnum = {
|
|
|
263
426
|
Open: 'OPEN',
|
|
264
427
|
MarkedAsPaid: 'MARKED_AS_PAID'
|
|
265
428
|
};
|
|
429
|
+
exports.ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = {
|
|
430
|
+
Flagged: 'flagged',
|
|
431
|
+
Blocked: 'blocked',
|
|
432
|
+
Released: 'released'
|
|
433
|
+
};
|
|
434
|
+
exports.ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = {
|
|
435
|
+
DisallowedIp: 'Disallowed IP',
|
|
436
|
+
DisallowedEmail: 'Disallowed email',
|
|
437
|
+
DisallowedCountry: 'Disallowed country',
|
|
438
|
+
OverRewardDollarLimit: 'Over reward dollar limit',
|
|
439
|
+
OverRewardCountLimit: 'Over reward count limit',
|
|
440
|
+
VpnDetected: 'VPN detected',
|
|
441
|
+
DeviceRelatedToMultipleEmails: 'Device related to multiple emails',
|
|
442
|
+
DeviceOrAccountRelatedToMultipleEmails: 'Device or account related to multiple emails',
|
|
443
|
+
IpOnATremendousFraudList: 'IP on a Tremendous fraud list',
|
|
444
|
+
BankAccountOnATremendousFraudList: 'Bank account on a Tremendous fraud list',
|
|
445
|
+
FingerprintOnATremendousFraudList: 'Fingerprint on a Tremendous fraud list',
|
|
446
|
+
EmailOnATremendousFraudList: 'Email on a Tremendous fraud list',
|
|
447
|
+
PhoneOnATremendousFraudList: 'Phone on a Tremendous fraud list',
|
|
448
|
+
IpRelatedToABlockedReward: 'IP related to a blocked reward',
|
|
449
|
+
BankAccountRelatedToABlockedReward: 'Bank account related to a blocked reward',
|
|
450
|
+
FingerprintRelatedToABlockedReward: 'Fingerprint related to a blocked reward',
|
|
451
|
+
EmailRelatedToABlockedReward: 'Email related to a blocked reward',
|
|
452
|
+
PhoneRelatedToABlockedReward: 'Phone related to a blocked reward',
|
|
453
|
+
AllowedIp: 'Allowed IP',
|
|
454
|
+
AllowedEmail: 'Allowed email'
|
|
455
|
+
};
|
|
456
|
+
exports.ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = {
|
|
457
|
+
ReviewCountry: 'review_country',
|
|
458
|
+
ReviewIp: 'review_ip',
|
|
459
|
+
ReviewEmail: 'review_email',
|
|
460
|
+
ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count',
|
|
461
|
+
ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount',
|
|
462
|
+
ReviewMultipleEmails: 'review_multiple_emails',
|
|
463
|
+
ReviewVpn: 'review_vpn',
|
|
464
|
+
ReviewTremendousFlagList: 'review_tremendous_flag_list',
|
|
465
|
+
ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients',
|
|
466
|
+
AllowIp: 'allow_ip',
|
|
467
|
+
AllowEmail: 'allow_email'
|
|
468
|
+
};
|
|
266
469
|
exports.ListFundingSources200ResponseFundingSourcesInnerMethodEnum = {
|
|
267
470
|
Balance: 'balance',
|
|
268
471
|
BankAccount: 'bank_account',
|
|
@@ -296,10 +499,6 @@ exports.ListInvoices200ResponseInvoicesInnerStatusEnum = {
|
|
|
296
499
|
Open: 'OPEN',
|
|
297
500
|
MarkedAsPaid: 'MARKED_AS_PAID'
|
|
298
501
|
};
|
|
299
|
-
exports.ListMembers200ResponseMembersInnerRoleEnum = {
|
|
300
|
-
Member: 'MEMBER',
|
|
301
|
-
Admin: 'ADMIN'
|
|
302
|
-
};
|
|
303
502
|
exports.ListMembers200ResponseMembersInnerStatusEnum = {
|
|
304
503
|
Registered: 'REGISTERED',
|
|
305
504
|
Invited: 'INVITED'
|
|
@@ -585,34 +784,18 @@ exports.ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = {
|
|
|
585
784
|
Zar: 'ZAR',
|
|
586
785
|
Zmk: 'ZMK'
|
|
587
786
|
};
|
|
588
|
-
exports.MemberRoleEnum = {
|
|
589
|
-
Member: 'MEMBER',
|
|
590
|
-
Admin: 'ADMIN'
|
|
591
|
-
};
|
|
592
787
|
exports.MemberStatusEnum = {
|
|
593
788
|
Registered: 'REGISTERED',
|
|
594
789
|
Invited: 'INVITED'
|
|
595
790
|
};
|
|
596
|
-
exports.MemberBaseRoleEnum = {
|
|
597
|
-
Member: 'MEMBER',
|
|
598
|
-
Admin: 'ADMIN'
|
|
599
|
-
};
|
|
600
791
|
exports.MemberBaseStatusEnum = {
|
|
601
792
|
Registered: 'REGISTERED',
|
|
602
793
|
Invited: 'INVITED'
|
|
603
794
|
};
|
|
604
|
-
exports.MemberWithEventsRoleEnum = {
|
|
605
|
-
Member: 'MEMBER',
|
|
606
|
-
Admin: 'ADMIN'
|
|
607
|
-
};
|
|
608
795
|
exports.MemberWithEventsStatusEnum = {
|
|
609
796
|
Registered: 'REGISTERED',
|
|
610
797
|
Invited: 'INVITED'
|
|
611
798
|
};
|
|
612
|
-
exports.MemberWithoutEventsRoleEnum = {
|
|
613
|
-
Member: 'MEMBER',
|
|
614
|
-
Admin: 'ADMIN'
|
|
615
|
-
};
|
|
616
799
|
exports.MemberWithoutEventsStatusEnum = {
|
|
617
800
|
Registered: 'REGISTERED',
|
|
618
801
|
Invited: 'INVITED'
|
|
@@ -655,14 +838,6 @@ exports.OrderStatus = {
|
|
|
655
838
|
PendingApproval: 'PENDING APPROVAL',
|
|
656
839
|
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
657
840
|
};
|
|
658
|
-
exports.OrderWithLinkStatusEnum = {
|
|
659
|
-
Canceled: 'CANCELED',
|
|
660
|
-
Cart: 'CART',
|
|
661
|
-
Executed: 'EXECUTED',
|
|
662
|
-
Failed: 'FAILED',
|
|
663
|
-
PendingApproval: 'PENDING APPROVAL',
|
|
664
|
-
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
665
|
-
};
|
|
666
841
|
exports.OrderWithoutLinkStatusEnum = {
|
|
667
842
|
Canceled: 'CANCELED',
|
|
668
843
|
Cart: 'CART',
|
|
@@ -811,6 +986,26 @@ exports.ProductCurrencyCodesEnum = {
|
|
|
811
986
|
Zar: 'ZAR',
|
|
812
987
|
Zmk: 'ZMK'
|
|
813
988
|
};
|
|
989
|
+
exports.ReviewCountryTypeEnum = {
|
|
990
|
+
Whitelist: 'whitelist',
|
|
991
|
+
Blacklist: 'blacklist'
|
|
992
|
+
};
|
|
993
|
+
exports.ReviewRedeemedRewardsAmountPeriodEnum = {
|
|
994
|
+
_7: '7',
|
|
995
|
+
_30: '30',
|
|
996
|
+
_90: '90',
|
|
997
|
+
_120: '120',
|
|
998
|
+
_365: '365',
|
|
999
|
+
AllTime: 'all_time'
|
|
1000
|
+
};
|
|
1001
|
+
exports.ReviewRedeemedRewardsCountPeriodEnum = {
|
|
1002
|
+
_7: '7',
|
|
1003
|
+
_30: '30',
|
|
1004
|
+
_90: '90',
|
|
1005
|
+
_120: '120',
|
|
1006
|
+
_365: '365',
|
|
1007
|
+
AllTime: 'all_time'
|
|
1008
|
+
};
|
|
814
1009
|
exports.RewardValueCurrencyCodeEnum = {
|
|
815
1010
|
Usd: 'USD',
|
|
816
1011
|
Cad: 'CAD',
|
|
@@ -929,27 +1124,33 @@ exports.RewardValueCurrencyCodeEnum = {
|
|
|
929
1124
|
Zar: 'ZAR',
|
|
930
1125
|
Zmk: 'ZMK'
|
|
931
1126
|
};
|
|
932
|
-
exports.
|
|
1127
|
+
exports.RewardWithoutLinkDeliveryMethodEnum = {
|
|
933
1128
|
Email: 'EMAIL',
|
|
934
1129
|
Link: 'LINK',
|
|
935
1130
|
Phone: 'PHONE'
|
|
936
1131
|
};
|
|
937
|
-
exports.
|
|
1132
|
+
exports.RewardWithoutLinkDeliveryStatusEnum = {
|
|
938
1133
|
Scheduled: 'SCHEDULED',
|
|
939
1134
|
Failed: 'FAILED',
|
|
940
1135
|
Succeeded: 'SUCCEEDED',
|
|
941
1136
|
Pending: 'PENDING'
|
|
942
1137
|
};
|
|
943
|
-
exports.
|
|
1138
|
+
exports.SingleRewardOrder1RewardDeliveryMethodEnum = {
|
|
944
1139
|
Email: 'EMAIL',
|
|
945
1140
|
Link: 'LINK',
|
|
946
1141
|
Phone: 'PHONE'
|
|
947
1142
|
};
|
|
948
|
-
exports.
|
|
949
|
-
|
|
1143
|
+
exports.SingleRewardOrderWithoutLinkOrderStatusEnum = {
|
|
1144
|
+
Canceled: 'CANCELED',
|
|
1145
|
+
Cart: 'CART',
|
|
1146
|
+
Executed: 'EXECUTED',
|
|
950
1147
|
Failed: 'FAILED',
|
|
951
|
-
|
|
952
|
-
|
|
1148
|
+
PendingApproval: 'PENDING APPROVAL',
|
|
1149
|
+
PendingInternalPaymentApproval: 'PENDING INTERNAL PAYMENT APPROVAL'
|
|
1150
|
+
};
|
|
1151
|
+
exports.UpdateFraudRuleListRequestOperationEnum = {
|
|
1152
|
+
Add: 'add',
|
|
1153
|
+
Remove: 'remove'
|
|
953
1154
|
};
|
|
954
1155
|
/**
|
|
955
1156
|
* BalanceTransactionsApi - axios parameter creator
|
|
@@ -1125,7 +1326,7 @@ const CampaignsApiAxiosParamCreator = function (configuration) {
|
|
|
1125
1326
|
* @param {*} [options] Override http request option.
|
|
1126
1327
|
* @throws {RequiredError}
|
|
1127
1328
|
*/
|
|
1128
|
-
getCampaign: (id_1, ...
|
|
1329
|
+
getCampaign: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
1129
1330
|
// verify required parameter 'id' is not null or undefined
|
|
1130
1331
|
(0, common_1.assertParamExists)('getCampaign', 'id', id);
|
|
1131
1332
|
const localVarPath = `/campaigns/{id}`
|
|
@@ -1156,7 +1357,7 @@ const CampaignsApiAxiosParamCreator = function (configuration) {
|
|
|
1156
1357
|
* @param {*} [options] Override http request option.
|
|
1157
1358
|
* @throws {RequiredError}
|
|
1158
1359
|
*/
|
|
1159
|
-
listCampaigns: (...
|
|
1360
|
+
listCampaigns: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
1160
1361
|
const localVarPath = `/campaigns`;
|
|
1161
1362
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1162
1363
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -1182,15 +1383,15 @@ const CampaignsApiAxiosParamCreator = function (configuration) {
|
|
|
1182
1383
|
*
|
|
1183
1384
|
* @summary Update campaign
|
|
1184
1385
|
* @param {string} id ID of the campaign that should be updated
|
|
1185
|
-
* @param {
|
|
1386
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
1186
1387
|
* @param {*} [options] Override http request option.
|
|
1187
1388
|
* @throws {RequiredError}
|
|
1188
1389
|
*/
|
|
1189
|
-
updateCampaign: (
|
|
1390
|
+
updateCampaign: (id_1, updateCampaignRequest_1, ...args_1) => __awaiter(this, [id_1, updateCampaignRequest_1, ...args_1], void 0, function* (id, updateCampaignRequest, options = {}) {
|
|
1190
1391
|
// verify required parameter 'id' is not null or undefined
|
|
1191
1392
|
(0, common_1.assertParamExists)('updateCampaign', 'id', id);
|
|
1192
|
-
// verify required parameter '
|
|
1193
|
-
(0, common_1.assertParamExists)('updateCampaign', '
|
|
1393
|
+
// verify required parameter 'updateCampaignRequest' is not null or undefined
|
|
1394
|
+
(0, common_1.assertParamExists)('updateCampaign', 'updateCampaignRequest', updateCampaignRequest);
|
|
1194
1395
|
const localVarPath = `/campaigns/{id}`
|
|
1195
1396
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1196
1397
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -1209,7 +1410,7 @@ const CampaignsApiAxiosParamCreator = function (configuration) {
|
|
|
1209
1410
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1210
1411
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1211
1412
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1212
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
1413
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateCampaignRequest, localVarRequestOptions, configuration);
|
|
1213
1414
|
return {
|
|
1214
1415
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1215
1416
|
options: localVarRequestOptions,
|
|
@@ -1276,14 +1477,14 @@ const CampaignsApiFp = function (configuration) {
|
|
|
1276
1477
|
*
|
|
1277
1478
|
* @summary Update campaign
|
|
1278
1479
|
* @param {string} id ID of the campaign that should be updated
|
|
1279
|
-
* @param {
|
|
1480
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
1280
1481
|
* @param {*} [options] Override http request option.
|
|
1281
1482
|
* @throws {RequiredError}
|
|
1282
1483
|
*/
|
|
1283
|
-
updateCampaign(id,
|
|
1484
|
+
updateCampaign(id, updateCampaignRequest, options) {
|
|
1284
1485
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1285
1486
|
var _a, _b, _c;
|
|
1286
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateCampaign(id,
|
|
1487
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateCampaign(id, updateCampaignRequest, options);
|
|
1287
1488
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1288
1489
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CampaignsApi.updateCampaign']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1289
1490
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1332,12 +1533,12 @@ const CampaignsApiFactory = function (configuration, basePath, axios) {
|
|
|
1332
1533
|
*
|
|
1333
1534
|
* @summary Update campaign
|
|
1334
1535
|
* @param {string} id ID of the campaign that should be updated
|
|
1335
|
-
* @param {
|
|
1536
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
1336
1537
|
* @param {*} [options] Override http request option.
|
|
1337
1538
|
* @throws {RequiredError}
|
|
1338
1539
|
*/
|
|
1339
|
-
updateCampaign(id,
|
|
1340
|
-
return localVarFp.updateCampaign(id,
|
|
1540
|
+
updateCampaign(id, updateCampaignRequest, options) {
|
|
1541
|
+
return localVarFp.updateCampaign(id, updateCampaignRequest, options).then((request) => request(axios, basePath));
|
|
1341
1542
|
},
|
|
1342
1543
|
};
|
|
1343
1544
|
};
|
|
@@ -1385,13 +1586,13 @@ class CampaignsApi extends base_1.BaseAPI {
|
|
|
1385
1586
|
*
|
|
1386
1587
|
* @summary Update campaign
|
|
1387
1588
|
* @param {string} id ID of the campaign that should be updated
|
|
1388
|
-
* @param {
|
|
1589
|
+
* @param {UpdateCampaignRequest} updateCampaignRequest Campaign details
|
|
1389
1590
|
* @param {*} [options] Override http request option.
|
|
1390
1591
|
* @throws {RequiredError}
|
|
1391
1592
|
* @memberof CampaignsApi
|
|
1392
1593
|
*/
|
|
1393
|
-
updateCampaign(id,
|
|
1394
|
-
return (0, exports.CampaignsApiFp)(this.configuration).updateCampaign(id,
|
|
1594
|
+
updateCampaign(id, updateCampaignRequest, options) {
|
|
1595
|
+
return (0, exports.CampaignsApiFp)(this.configuration).updateCampaign(id, updateCampaignRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1395
1596
|
}
|
|
1396
1597
|
}
|
|
1397
1598
|
exports.CampaignsApi = CampaignsApi;
|
|
@@ -1496,23 +1697,20 @@ class FieldsApi extends base_1.BaseAPI {
|
|
|
1496
1697
|
}
|
|
1497
1698
|
exports.FieldsApi = FieldsApi;
|
|
1498
1699
|
/**
|
|
1499
|
-
*
|
|
1700
|
+
* ForexApi - axios parameter creator
|
|
1500
1701
|
* @export
|
|
1501
1702
|
*/
|
|
1502
|
-
const
|
|
1703
|
+
const ForexApiAxiosParamCreator = function (configuration) {
|
|
1503
1704
|
return {
|
|
1504
1705
|
/**
|
|
1505
|
-
* Retrieve a
|
|
1506
|
-
* @summary
|
|
1507
|
-
* @param {string}
|
|
1706
|
+
* Retrieve a list of exchange rates
|
|
1707
|
+
* @summary List exchange rates
|
|
1708
|
+
* @param {string} [base] Base currency code, default is USD.
|
|
1508
1709
|
* @param {*} [options] Override http request option.
|
|
1509
1710
|
* @throws {RequiredError}
|
|
1510
1711
|
*/
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
(0, common_1.assertParamExists)('getFundingSource', 'id', id);
|
|
1514
|
-
const localVarPath = `/funding_sources/{id}`
|
|
1515
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1712
|
+
listForex: (base_2, ...args_1) => __awaiter(this, [base_2, ...args_1], void 0, function* (base, options = {}) {
|
|
1713
|
+
const localVarPath = `/forex`;
|
|
1516
1714
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1517
1715
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1518
1716
|
let baseOptions;
|
|
@@ -1525,34 +1723,9 @@ const FundingSourcesApiAxiosParamCreator = function (configuration) {
|
|
|
1525
1723
|
// authentication BearerApiKey required
|
|
1526
1724
|
// http bearer authentication required
|
|
1527
1725
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1528
|
-
(
|
|
1529
|
-
|
|
1530
|
-
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1531
|
-
return {
|
|
1532
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1533
|
-
options: localVarRequestOptions,
|
|
1534
|
-
};
|
|
1535
|
-
}),
|
|
1536
|
-
/**
|
|
1537
|
-
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
1538
|
-
* @summary List funding sources
|
|
1539
|
-
* @param {*} [options] Override http request option.
|
|
1540
|
-
* @throws {RequiredError}
|
|
1541
|
-
*/
|
|
1542
|
-
listFundingSources: (...args_2) => __awaiter(this, [...args_2], void 0, function* (options = {}) {
|
|
1543
|
-
const localVarPath = `/funding_sources`;
|
|
1544
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1545
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1546
|
-
let baseOptions;
|
|
1547
|
-
if (configuration) {
|
|
1548
|
-
baseOptions = configuration.baseOptions;
|
|
1726
|
+
if (base !== undefined) {
|
|
1727
|
+
localVarQueryParameter['base'] = base;
|
|
1549
1728
|
}
|
|
1550
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1551
|
-
const localVarHeaderParameter = {};
|
|
1552
|
-
const localVarQueryParameter = {};
|
|
1553
|
-
// authentication BearerApiKey required
|
|
1554
|
-
// http bearer authentication required
|
|
1555
|
-
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1556
1729
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1557
1730
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1558
1731
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -1563,157 +1736,122 @@ const FundingSourcesApiAxiosParamCreator = function (configuration) {
|
|
|
1563
1736
|
}),
|
|
1564
1737
|
};
|
|
1565
1738
|
};
|
|
1566
|
-
exports.
|
|
1739
|
+
exports.ForexApiAxiosParamCreator = ForexApiAxiosParamCreator;
|
|
1567
1740
|
/**
|
|
1568
|
-
*
|
|
1741
|
+
* ForexApi - functional programming interface
|
|
1569
1742
|
* @export
|
|
1570
1743
|
*/
|
|
1571
|
-
const
|
|
1572
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
1744
|
+
const ForexApiFp = function (configuration) {
|
|
1745
|
+
const localVarAxiosParamCreator = (0, exports.ForexApiAxiosParamCreator)(configuration);
|
|
1573
1746
|
return {
|
|
1574
1747
|
/**
|
|
1575
|
-
* Retrieve a
|
|
1576
|
-
* @summary
|
|
1577
|
-
* @param {string}
|
|
1578
|
-
* @param {*} [options] Override http request option.
|
|
1579
|
-
* @throws {RequiredError}
|
|
1580
|
-
*/
|
|
1581
|
-
getFundingSource(id, options) {
|
|
1582
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
1583
|
-
var _a, _b, _c;
|
|
1584
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFundingSource(id, options);
|
|
1585
|
-
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1586
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FundingSourcesApi.getFundingSource']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1587
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1588
|
-
});
|
|
1589
|
-
},
|
|
1590
|
-
/**
|
|
1591
|
-
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
1592
|
-
* @summary List funding sources
|
|
1748
|
+
* Retrieve a list of exchange rates
|
|
1749
|
+
* @summary List exchange rates
|
|
1750
|
+
* @param {string} [base] Base currency code, default is USD.
|
|
1593
1751
|
* @param {*} [options] Override http request option.
|
|
1594
1752
|
* @throws {RequiredError}
|
|
1595
1753
|
*/
|
|
1596
|
-
|
|
1754
|
+
listForex(base, options) {
|
|
1597
1755
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1598
1756
|
var _a, _b, _c;
|
|
1599
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1757
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listForex(base, options);
|
|
1600
1758
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1601
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['
|
|
1759
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ForexApi.listForex']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1602
1760
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1603
1761
|
});
|
|
1604
1762
|
},
|
|
1605
1763
|
};
|
|
1606
1764
|
};
|
|
1607
|
-
exports.
|
|
1765
|
+
exports.ForexApiFp = ForexApiFp;
|
|
1608
1766
|
/**
|
|
1609
|
-
*
|
|
1767
|
+
* ForexApi - factory interface
|
|
1610
1768
|
* @export
|
|
1611
1769
|
*/
|
|
1612
|
-
const
|
|
1613
|
-
const localVarFp = (0, exports.
|
|
1770
|
+
const ForexApiFactory = function (configuration, basePath, axios) {
|
|
1771
|
+
const localVarFp = (0, exports.ForexApiFp)(configuration);
|
|
1614
1772
|
return {
|
|
1615
1773
|
/**
|
|
1616
|
-
* Retrieve a
|
|
1617
|
-
* @summary
|
|
1618
|
-
* @param {string}
|
|
1619
|
-
* @param {*} [options] Override http request option.
|
|
1620
|
-
* @throws {RequiredError}
|
|
1621
|
-
*/
|
|
1622
|
-
getFundingSource(id, options) {
|
|
1623
|
-
return localVarFp.getFundingSource(id, options).then((request) => request(axios, basePath));
|
|
1624
|
-
},
|
|
1625
|
-
/**
|
|
1626
|
-
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
1627
|
-
* @summary List funding sources
|
|
1774
|
+
* Retrieve a list of exchange rates
|
|
1775
|
+
* @summary List exchange rates
|
|
1776
|
+
* @param {string} [base] Base currency code, default is USD.
|
|
1628
1777
|
* @param {*} [options] Override http request option.
|
|
1629
1778
|
* @throws {RequiredError}
|
|
1630
1779
|
*/
|
|
1631
|
-
|
|
1632
|
-
return localVarFp.
|
|
1780
|
+
listForex(base, options) {
|
|
1781
|
+
return localVarFp.listForex(base, options).then((request) => request(axios, basePath));
|
|
1633
1782
|
},
|
|
1634
1783
|
};
|
|
1635
1784
|
};
|
|
1636
|
-
exports.
|
|
1785
|
+
exports.ForexApiFactory = ForexApiFactory;
|
|
1637
1786
|
/**
|
|
1638
|
-
*
|
|
1787
|
+
* ForexApi - object-oriented interface
|
|
1639
1788
|
* @export
|
|
1640
|
-
* @class
|
|
1789
|
+
* @class ForexApi
|
|
1641
1790
|
* @extends {BaseAPI}
|
|
1642
1791
|
*/
|
|
1643
|
-
class
|
|
1792
|
+
class ForexApi extends base_1.BaseAPI {
|
|
1644
1793
|
/**
|
|
1645
|
-
* Retrieve a
|
|
1646
|
-
* @summary
|
|
1647
|
-
* @param {string}
|
|
1648
|
-
* @param {*} [options] Override http request option.
|
|
1649
|
-
* @throws {RequiredError}
|
|
1650
|
-
* @memberof FundingSourcesApi
|
|
1651
|
-
*/
|
|
1652
|
-
getFundingSource(id, options) {
|
|
1653
|
-
return (0, exports.FundingSourcesApiFp)(this.configuration).getFundingSource(id, options).then((request) => request(this.axios, this.basePath));
|
|
1654
|
-
}
|
|
1655
|
-
/**
|
|
1656
|
-
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
1657
|
-
* @summary List funding sources
|
|
1794
|
+
* Retrieve a list of exchange rates
|
|
1795
|
+
* @summary List exchange rates
|
|
1796
|
+
* @param {string} [base] Base currency code, default is USD.
|
|
1658
1797
|
* @param {*} [options] Override http request option.
|
|
1659
1798
|
* @throws {RequiredError}
|
|
1660
|
-
* @memberof
|
|
1799
|
+
* @memberof ForexApi
|
|
1661
1800
|
*/
|
|
1662
|
-
|
|
1663
|
-
return (0, exports.
|
|
1801
|
+
listForex(base, options) {
|
|
1802
|
+
return (0, exports.ForexApiFp)(this.configuration).listForex(base, options).then((request) => request(this.axios, this.basePath));
|
|
1664
1803
|
}
|
|
1665
1804
|
}
|
|
1666
|
-
exports.
|
|
1805
|
+
exports.ForexApi = ForexApi;
|
|
1667
1806
|
/**
|
|
1668
|
-
*
|
|
1807
|
+
* FraudReviewsApi - axios parameter creator
|
|
1669
1808
|
* @export
|
|
1670
1809
|
*/
|
|
1671
|
-
const
|
|
1810
|
+
const FraudReviewsApiAxiosParamCreator = function (configuration) {
|
|
1672
1811
|
return {
|
|
1673
1812
|
/**
|
|
1674
|
-
*
|
|
1675
|
-
* @summary
|
|
1676
|
-
* @param {
|
|
1813
|
+
* Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
|
|
1814
|
+
* @summary Block fraud review
|
|
1815
|
+
* @param {string} id The ID of the reward that should be blocked.
|
|
1677
1816
|
* @param {*} [options] Override http request option.
|
|
1678
1817
|
* @throws {RequiredError}
|
|
1679
1818
|
*/
|
|
1680
|
-
|
|
1681
|
-
// verify required parameter '
|
|
1682
|
-
(0, common_1.assertParamExists)('
|
|
1683
|
-
const localVarPath = `/
|
|
1819
|
+
blockFraudReview: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
1820
|
+
// verify required parameter 'id' is not null or undefined
|
|
1821
|
+
(0, common_1.assertParamExists)('blockFraudReview', 'id', id);
|
|
1822
|
+
const localVarPath = `/fraud_reviews/{id}/block`
|
|
1823
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1684
1824
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1685
1825
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1686
1826
|
let baseOptions;
|
|
1687
1827
|
if (configuration) {
|
|
1688
1828
|
baseOptions = configuration.baseOptions;
|
|
1689
1829
|
}
|
|
1690
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1830
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
1691
1831
|
const localVarHeaderParameter = {};
|
|
1692
1832
|
const localVarQueryParameter = {};
|
|
1693
1833
|
// authentication BearerApiKey required
|
|
1694
1834
|
// http bearer authentication required
|
|
1695
1835
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1696
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1697
1836
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1698
1837
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1699
1838
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1700
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createInvoiceRequest, localVarRequestOptions, configuration);
|
|
1701
1839
|
return {
|
|
1702
1840
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1703
1841
|
options: localVarRequestOptions,
|
|
1704
1842
|
};
|
|
1705
1843
|
}),
|
|
1706
1844
|
/**
|
|
1707
|
-
*
|
|
1708
|
-
* @summary
|
|
1709
|
-
* @param {string} id ID of the
|
|
1845
|
+
* 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.
|
|
1846
|
+
* @summary Retrieve single fraud review
|
|
1847
|
+
* @param {string} id The ID of the reward that should be retrieved.
|
|
1710
1848
|
* @param {*} [options] Override http request option.
|
|
1711
1849
|
* @throws {RequiredError}
|
|
1712
1850
|
*/
|
|
1713
|
-
|
|
1851
|
+
getFraudReview: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
1714
1852
|
// verify required parameter 'id' is not null or undefined
|
|
1715
|
-
(0, common_1.assertParamExists)('
|
|
1716
|
-
const localVarPath = `/
|
|
1853
|
+
(0, common_1.assertParamExists)('getFraudReview', 'id', id);
|
|
1854
|
+
const localVarPath = `/fraud_reviews/{id}`
|
|
1717
1855
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1718
1856
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1719
1857
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -1721,7 +1859,7 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
1721
1859
|
if (configuration) {
|
|
1722
1860
|
baseOptions = configuration.baseOptions;
|
|
1723
1861
|
}
|
|
1724
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
1862
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1725
1863
|
const localVarHeaderParameter = {};
|
|
1726
1864
|
const localVarQueryParameter = {};
|
|
1727
1865
|
// authentication BearerApiKey required
|
|
@@ -1736,17 +1874,20 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
1736
1874
|
};
|
|
1737
1875
|
}),
|
|
1738
1876
|
/**
|
|
1739
|
-
*
|
|
1740
|
-
* @summary
|
|
1741
|
-
* @param {
|
|
1877
|
+
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
1878
|
+
* @summary List fraud reviews
|
|
1879
|
+
* @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC).
|
|
1880
|
+
* @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
|
|
1881
|
+
* @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`.
|
|
1882
|
+
* @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime.
|
|
1883
|
+
* @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime.
|
|
1884
|
+
* @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime.
|
|
1885
|
+
* @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime.
|
|
1742
1886
|
* @param {*} [options] Override http request option.
|
|
1743
1887
|
* @throws {RequiredError}
|
|
1744
1888
|
*/
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
(0, common_1.assertParamExists)('downloadInvoiceCsv', 'id', id);
|
|
1748
|
-
const localVarPath = `/invoices/{id}/csv`
|
|
1749
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1889
|
+
listFraudReviews: (offset_1, limit_1, status_1, createdAtGte_1, createdAtLte_1, redeemedAtGte_1, redeemedAtLte_1, ...args_1) => __awaiter(this, [offset_1, limit_1, status_1, createdAtGte_1, createdAtLte_1, redeemedAtGte_1, redeemedAtLte_1, ...args_1], void 0, function* (offset, limit, status, createdAtGte, createdAtLte, redeemedAtGte, redeemedAtLte, options = {}) {
|
|
1890
|
+
const localVarPath = `/fraud_reviews`;
|
|
1750
1891
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1751
1892
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1752
1893
|
let baseOptions;
|
|
@@ -1759,6 +1900,27 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
1759
1900
|
// authentication BearerApiKey required
|
|
1760
1901
|
// http bearer authentication required
|
|
1761
1902
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1903
|
+
if (offset !== undefined) {
|
|
1904
|
+
localVarQueryParameter['offset'] = offset;
|
|
1905
|
+
}
|
|
1906
|
+
if (limit !== undefined) {
|
|
1907
|
+
localVarQueryParameter['limit'] = limit;
|
|
1908
|
+
}
|
|
1909
|
+
if (status !== undefined) {
|
|
1910
|
+
localVarQueryParameter['status'] = status;
|
|
1911
|
+
}
|
|
1912
|
+
if (createdAtGte !== undefined) {
|
|
1913
|
+
localVarQueryParameter['created_at[gte]'] = createdAtGte;
|
|
1914
|
+
}
|
|
1915
|
+
if (createdAtLte !== undefined) {
|
|
1916
|
+
localVarQueryParameter['created_at[lte]'] = createdAtLte;
|
|
1917
|
+
}
|
|
1918
|
+
if (redeemedAtGte !== undefined) {
|
|
1919
|
+
localVarQueryParameter['redeemed_at[gte]'] = redeemedAtGte;
|
|
1920
|
+
}
|
|
1921
|
+
if (redeemedAtLte !== undefined) {
|
|
1922
|
+
localVarQueryParameter['redeemed_at[lte]'] = redeemedAtLte;
|
|
1923
|
+
}
|
|
1762
1924
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1763
1925
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1764
1926
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -1768,13 +1930,886 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
1768
1930
|
};
|
|
1769
1931
|
}),
|
|
1770
1932
|
/**
|
|
1771
|
-
*
|
|
1772
|
-
* @summary
|
|
1773
|
-
* @param {string} id ID of the
|
|
1933
|
+
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
1934
|
+
* @summary Release fraud review
|
|
1935
|
+
* @param {string} id The ID of the reward that should be released.
|
|
1774
1936
|
* @param {*} [options] Override http request option.
|
|
1775
1937
|
* @throws {RequiredError}
|
|
1776
1938
|
*/
|
|
1777
|
-
|
|
1939
|
+
releaseFraudReview: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
1940
|
+
// verify required parameter 'id' is not null or undefined
|
|
1941
|
+
(0, common_1.assertParamExists)('releaseFraudReview', 'id', id);
|
|
1942
|
+
const localVarPath = `/fraud_reviews/{id}/release`
|
|
1943
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1944
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1945
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1946
|
+
let baseOptions;
|
|
1947
|
+
if (configuration) {
|
|
1948
|
+
baseOptions = configuration.baseOptions;
|
|
1949
|
+
}
|
|
1950
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
1951
|
+
const localVarHeaderParameter = {};
|
|
1952
|
+
const localVarQueryParameter = {};
|
|
1953
|
+
// authentication BearerApiKey required
|
|
1954
|
+
// http bearer authentication required
|
|
1955
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1956
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1957
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1958
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1959
|
+
return {
|
|
1960
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1961
|
+
options: localVarRequestOptions,
|
|
1962
|
+
};
|
|
1963
|
+
}),
|
|
1964
|
+
};
|
|
1965
|
+
};
|
|
1966
|
+
exports.FraudReviewsApiAxiosParamCreator = FraudReviewsApiAxiosParamCreator;
|
|
1967
|
+
/**
|
|
1968
|
+
* FraudReviewsApi - functional programming interface
|
|
1969
|
+
* @export
|
|
1970
|
+
*/
|
|
1971
|
+
const FraudReviewsApiFp = function (configuration) {
|
|
1972
|
+
const localVarAxiosParamCreator = (0, exports.FraudReviewsApiAxiosParamCreator)(configuration);
|
|
1973
|
+
return {
|
|
1974
|
+
/**
|
|
1975
|
+
* Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
|
|
1976
|
+
* @summary Block fraud review
|
|
1977
|
+
* @param {string} id The ID of the reward that should be blocked.
|
|
1978
|
+
* @param {*} [options] Override http request option.
|
|
1979
|
+
* @throws {RequiredError}
|
|
1980
|
+
*/
|
|
1981
|
+
blockFraudReview(id, options) {
|
|
1982
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1983
|
+
var _a, _b, _c;
|
|
1984
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.blockFraudReview(id, options);
|
|
1985
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1986
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FraudReviewsApi.blockFraudReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1987
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1988
|
+
});
|
|
1989
|
+
},
|
|
1990
|
+
/**
|
|
1991
|
+
* 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.
|
|
1992
|
+
* @summary Retrieve single fraud review
|
|
1993
|
+
* @param {string} id The ID of the reward that should be retrieved.
|
|
1994
|
+
* @param {*} [options] Override http request option.
|
|
1995
|
+
* @throws {RequiredError}
|
|
1996
|
+
*/
|
|
1997
|
+
getFraudReview(id, options) {
|
|
1998
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1999
|
+
var _a, _b, _c;
|
|
2000
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFraudReview(id, options);
|
|
2001
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2002
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FraudReviewsApi.getFraudReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2003
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2004
|
+
});
|
|
2005
|
+
},
|
|
2006
|
+
/**
|
|
2007
|
+
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
2008
|
+
* @summary List fraud reviews
|
|
2009
|
+
* @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC).
|
|
2010
|
+
* @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
|
|
2011
|
+
* @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`.
|
|
2012
|
+
* @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime.
|
|
2013
|
+
* @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime.
|
|
2014
|
+
* @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime.
|
|
2015
|
+
* @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime.
|
|
2016
|
+
* @param {*} [options] Override http request option.
|
|
2017
|
+
* @throws {RequiredError}
|
|
2018
|
+
*/
|
|
2019
|
+
listFraudReviews(offset, limit, status, createdAtGte, createdAtLte, redeemedAtGte, redeemedAtLte, options) {
|
|
2020
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2021
|
+
var _a, _b, _c;
|
|
2022
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFraudReviews(offset, limit, status, createdAtGte, createdAtLte, redeemedAtGte, redeemedAtLte, options);
|
|
2023
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2024
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FraudReviewsApi.listFraudReviews']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2025
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2026
|
+
});
|
|
2027
|
+
},
|
|
2028
|
+
/**
|
|
2029
|
+
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
2030
|
+
* @summary Release fraud review
|
|
2031
|
+
* @param {string} id The ID of the reward that should be released.
|
|
2032
|
+
* @param {*} [options] Override http request option.
|
|
2033
|
+
* @throws {RequiredError}
|
|
2034
|
+
*/
|
|
2035
|
+
releaseFraudReview(id, options) {
|
|
2036
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2037
|
+
var _a, _b, _c;
|
|
2038
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.releaseFraudReview(id, options);
|
|
2039
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2040
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FraudReviewsApi.releaseFraudReview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2041
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2042
|
+
});
|
|
2043
|
+
},
|
|
2044
|
+
};
|
|
2045
|
+
};
|
|
2046
|
+
exports.FraudReviewsApiFp = FraudReviewsApiFp;
|
|
2047
|
+
/**
|
|
2048
|
+
* FraudReviewsApi - factory interface
|
|
2049
|
+
* @export
|
|
2050
|
+
*/
|
|
2051
|
+
const FraudReviewsApiFactory = function (configuration, basePath, axios) {
|
|
2052
|
+
const localVarFp = (0, exports.FraudReviewsApiFp)(configuration);
|
|
2053
|
+
return {
|
|
2054
|
+
/**
|
|
2055
|
+
* Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
|
|
2056
|
+
* @summary Block fraud review
|
|
2057
|
+
* @param {string} id The ID of the reward that should be blocked.
|
|
2058
|
+
* @param {*} [options] Override http request option.
|
|
2059
|
+
* @throws {RequiredError}
|
|
2060
|
+
*/
|
|
2061
|
+
blockFraudReview(id, options) {
|
|
2062
|
+
return localVarFp.blockFraudReview(id, options).then((request) => request(axios, basePath));
|
|
2063
|
+
},
|
|
2064
|
+
/**
|
|
2065
|
+
* 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.
|
|
2066
|
+
* @summary Retrieve single fraud review
|
|
2067
|
+
* @param {string} id The ID of the reward that should be retrieved.
|
|
2068
|
+
* @param {*} [options] Override http request option.
|
|
2069
|
+
* @throws {RequiredError}
|
|
2070
|
+
*/
|
|
2071
|
+
getFraudReview(id, options) {
|
|
2072
|
+
return localVarFp.getFraudReview(id, options).then((request) => request(axios, basePath));
|
|
2073
|
+
},
|
|
2074
|
+
/**
|
|
2075
|
+
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
2076
|
+
* @summary List fraud reviews
|
|
2077
|
+
* @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC).
|
|
2078
|
+
* @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
|
|
2079
|
+
* @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`.
|
|
2080
|
+
* @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime.
|
|
2081
|
+
* @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime.
|
|
2082
|
+
* @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime.
|
|
2083
|
+
* @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime.
|
|
2084
|
+
* @param {*} [options] Override http request option.
|
|
2085
|
+
* @throws {RequiredError}
|
|
2086
|
+
*/
|
|
2087
|
+
listFraudReviews(offset, limit, status, createdAtGte, createdAtLte, redeemedAtGte, redeemedAtLte, options) {
|
|
2088
|
+
return localVarFp.listFraudReviews(offset, limit, status, createdAtGte, createdAtLte, redeemedAtGte, redeemedAtLte, options).then((request) => request(axios, basePath));
|
|
2089
|
+
},
|
|
2090
|
+
/**
|
|
2091
|
+
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
2092
|
+
* @summary Release fraud review
|
|
2093
|
+
* @param {string} id The ID of the reward that should be released.
|
|
2094
|
+
* @param {*} [options] Override http request option.
|
|
2095
|
+
* @throws {RequiredError}
|
|
2096
|
+
*/
|
|
2097
|
+
releaseFraudReview(id, options) {
|
|
2098
|
+
return localVarFp.releaseFraudReview(id, options).then((request) => request(axios, basePath));
|
|
2099
|
+
},
|
|
2100
|
+
};
|
|
2101
|
+
};
|
|
2102
|
+
exports.FraudReviewsApiFactory = FraudReviewsApiFactory;
|
|
2103
|
+
/**
|
|
2104
|
+
* FraudReviewsApi - object-oriented interface
|
|
2105
|
+
* @export
|
|
2106
|
+
* @class FraudReviewsApi
|
|
2107
|
+
* @extends {BaseAPI}
|
|
2108
|
+
*/
|
|
2109
|
+
class FraudReviewsApi extends base_1.BaseAPI {
|
|
2110
|
+
/**
|
|
2111
|
+
* Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded.
|
|
2112
|
+
* @summary Block fraud review
|
|
2113
|
+
* @param {string} id The ID of the reward that should be blocked.
|
|
2114
|
+
* @param {*} [options] Override http request option.
|
|
2115
|
+
* @throws {RequiredError}
|
|
2116
|
+
* @memberof FraudReviewsApi
|
|
2117
|
+
*/
|
|
2118
|
+
blockFraudReview(id, options) {
|
|
2119
|
+
return (0, exports.FraudReviewsApiFp)(this.configuration).blockFraudReview(id, options).then((request) => request(this.axios, this.basePath));
|
|
2120
|
+
}
|
|
2121
|
+
/**
|
|
2122
|
+
* 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.
|
|
2123
|
+
* @summary Retrieve single fraud review
|
|
2124
|
+
* @param {string} id The ID of the reward that should be retrieved.
|
|
2125
|
+
* @param {*} [options] Override http request option.
|
|
2126
|
+
* @throws {RequiredError}
|
|
2127
|
+
* @memberof FraudReviewsApi
|
|
2128
|
+
*/
|
|
2129
|
+
getFraudReview(id, options) {
|
|
2130
|
+
return (0, exports.FraudReviewsApiFp)(this.configuration).getFraudReview(id, options).then((request) => request(this.axios, this.basePath));
|
|
2131
|
+
}
|
|
2132
|
+
/**
|
|
2133
|
+
* Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates.
|
|
2134
|
+
* @summary List fraud reviews
|
|
2135
|
+
* @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC).
|
|
2136
|
+
* @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10.
|
|
2137
|
+
* @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`.
|
|
2138
|
+
* @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime.
|
|
2139
|
+
* @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime.
|
|
2140
|
+
* @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime.
|
|
2141
|
+
* @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime.
|
|
2142
|
+
* @param {*} [options] Override http request option.
|
|
2143
|
+
* @throws {RequiredError}
|
|
2144
|
+
* @memberof FraudReviewsApi
|
|
2145
|
+
*/
|
|
2146
|
+
listFraudReviews(offset, limit, status, createdAtGte, createdAtLte, redeemedAtGte, redeemedAtLte, options) {
|
|
2147
|
+
return (0, exports.FraudReviewsApiFp)(this.configuration).listFraudReviews(offset, limit, status, createdAtGte, createdAtLte, redeemedAtGte, redeemedAtLte, options).then((request) => request(this.axios, this.basePath));
|
|
2148
|
+
}
|
|
2149
|
+
/**
|
|
2150
|
+
* Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient.
|
|
2151
|
+
* @summary Release fraud review
|
|
2152
|
+
* @param {string} id The ID of the reward that should be released.
|
|
2153
|
+
* @param {*} [options] Override http request option.
|
|
2154
|
+
* @throws {RequiredError}
|
|
2155
|
+
* @memberof FraudReviewsApi
|
|
2156
|
+
*/
|
|
2157
|
+
releaseFraudReview(id, options) {
|
|
2158
|
+
return (0, exports.FraudReviewsApiFp)(this.configuration).releaseFraudReview(id, options).then((request) => request(this.axios, this.basePath));
|
|
2159
|
+
}
|
|
2160
|
+
}
|
|
2161
|
+
exports.FraudReviewsApi = FraudReviewsApi;
|
|
2162
|
+
/**
|
|
2163
|
+
* @export
|
|
2164
|
+
*/
|
|
2165
|
+
exports.ListFraudReviewsStatusEnum = {
|
|
2166
|
+
Flagged: 'flagged',
|
|
2167
|
+
Blocked: 'blocked',
|
|
2168
|
+
Released: 'released'
|
|
2169
|
+
};
|
|
2170
|
+
/**
|
|
2171
|
+
* FraudRulesApi - axios parameter creator
|
|
2172
|
+
* @export
|
|
2173
|
+
*/
|
|
2174
|
+
const FraudRulesApiAxiosParamCreator = function (configuration) {
|
|
2175
|
+
return {
|
|
2176
|
+
/**
|
|
2177
|
+
* Deletes the rule of the type passed in the URL.
|
|
2178
|
+
* @summary Delete fraud rule
|
|
2179
|
+
* @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
2180
|
+
* @param {*} [options] Override http request option.
|
|
2181
|
+
* @throws {RequiredError}
|
|
2182
|
+
*/
|
|
2183
|
+
deleteFraudRule: (ruleType_1, ...args_1) => __awaiter(this, [ruleType_1, ...args_1], void 0, function* (ruleType, options = {}) {
|
|
2184
|
+
// verify required parameter 'ruleType' is not null or undefined
|
|
2185
|
+
(0, common_1.assertParamExists)('deleteFraudRule', 'ruleType', ruleType);
|
|
2186
|
+
const localVarPath = `/fraud_rules/{rule_type}`
|
|
2187
|
+
.replace(`{${"rule_type"}}`, encodeURIComponent(String(ruleType)));
|
|
2188
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2189
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2190
|
+
let baseOptions;
|
|
2191
|
+
if (configuration) {
|
|
2192
|
+
baseOptions = configuration.baseOptions;
|
|
2193
|
+
}
|
|
2194
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
2195
|
+
const localVarHeaderParameter = {};
|
|
2196
|
+
const localVarQueryParameter = {};
|
|
2197
|
+
// authentication BearerApiKey required
|
|
2198
|
+
// http bearer authentication required
|
|
2199
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2200
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2201
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2202
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2203
|
+
return {
|
|
2204
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2205
|
+
options: localVarRequestOptions,
|
|
2206
|
+
};
|
|
2207
|
+
}),
|
|
2208
|
+
/**
|
|
2209
|
+
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
2210
|
+
* @summary Configure fraud rule
|
|
2211
|
+
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
2212
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
|
|
2213
|
+
* @param {*} [options] Override http request option.
|
|
2214
|
+
* @throws {RequiredError}
|
|
2215
|
+
*/
|
|
2216
|
+
fraudRule: (ruleType_1, fraudRuleRequest_1, ...args_1) => __awaiter(this, [ruleType_1, fraudRuleRequest_1, ...args_1], void 0, function* (ruleType, fraudRuleRequest, options = {}) {
|
|
2217
|
+
// verify required parameter 'ruleType' is not null or undefined
|
|
2218
|
+
(0, common_1.assertParamExists)('fraudRule', 'ruleType', ruleType);
|
|
2219
|
+
const localVarPath = `/fraud_rules/{rule_type}`
|
|
2220
|
+
.replace(`{${"rule_type"}}`, encodeURIComponent(String(ruleType)));
|
|
2221
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2222
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2223
|
+
let baseOptions;
|
|
2224
|
+
if (configuration) {
|
|
2225
|
+
baseOptions = configuration.baseOptions;
|
|
2226
|
+
}
|
|
2227
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2228
|
+
const localVarHeaderParameter = {};
|
|
2229
|
+
const localVarQueryParameter = {};
|
|
2230
|
+
// authentication BearerApiKey required
|
|
2231
|
+
// http bearer authentication required
|
|
2232
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2233
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2234
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2235
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2236
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2237
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(fraudRuleRequest, localVarRequestOptions, configuration);
|
|
2238
|
+
return {
|
|
2239
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2240
|
+
options: localVarRequestOptions,
|
|
2241
|
+
};
|
|
2242
|
+
}),
|
|
2243
|
+
/**
|
|
2244
|
+
* List active fraud rules associated with the organization tied to your API key.
|
|
2245
|
+
* @summary List fraud rules
|
|
2246
|
+
* @param {*} [options] Override http request option.
|
|
2247
|
+
* @throws {RequiredError}
|
|
2248
|
+
*/
|
|
2249
|
+
listFraudRules: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
2250
|
+
const localVarPath = `/fraud_rules`;
|
|
2251
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2252
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2253
|
+
let baseOptions;
|
|
2254
|
+
if (configuration) {
|
|
2255
|
+
baseOptions = configuration.baseOptions;
|
|
2256
|
+
}
|
|
2257
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2258
|
+
const localVarHeaderParameter = {};
|
|
2259
|
+
const localVarQueryParameter = {};
|
|
2260
|
+
// authentication BearerApiKey required
|
|
2261
|
+
// http bearer authentication required
|
|
2262
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2263
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2264
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2265
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2266
|
+
return {
|
|
2267
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2268
|
+
options: localVarRequestOptions,
|
|
2269
|
+
};
|
|
2270
|
+
}),
|
|
2271
|
+
/**
|
|
2272
|
+
* 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\"] } } ```
|
|
2273
|
+
* @summary Update fraud rule list
|
|
2274
|
+
* @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
|
|
2275
|
+
* @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
|
|
2276
|
+
* @param {*} [options] Override http request option.
|
|
2277
|
+
* @throws {RequiredError}
|
|
2278
|
+
*/
|
|
2279
|
+
updateFraudRuleList: (ruleType_1, updateFraudRuleListRequest_1, ...args_1) => __awaiter(this, [ruleType_1, updateFraudRuleListRequest_1, ...args_1], void 0, function* (ruleType, updateFraudRuleListRequest, options = {}) {
|
|
2280
|
+
// verify required parameter 'ruleType' is not null or undefined
|
|
2281
|
+
(0, common_1.assertParamExists)('updateFraudRuleList', 'ruleType', ruleType);
|
|
2282
|
+
// verify required parameter 'updateFraudRuleListRequest' is not null or undefined
|
|
2283
|
+
(0, common_1.assertParamExists)('updateFraudRuleList', 'updateFraudRuleListRequest', updateFraudRuleListRequest);
|
|
2284
|
+
const localVarPath = `/fraud_rules/{rule_type}/update_list`
|
|
2285
|
+
.replace(`{${"rule_type"}}`, encodeURIComponent(String(ruleType)));
|
|
2286
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2287
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2288
|
+
let baseOptions;
|
|
2289
|
+
if (configuration) {
|
|
2290
|
+
baseOptions = configuration.baseOptions;
|
|
2291
|
+
}
|
|
2292
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2293
|
+
const localVarHeaderParameter = {};
|
|
2294
|
+
const localVarQueryParameter = {};
|
|
2295
|
+
// authentication BearerApiKey required
|
|
2296
|
+
// http bearer authentication required
|
|
2297
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2298
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2299
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2300
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2301
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2302
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFraudRuleListRequest, localVarRequestOptions, configuration);
|
|
2303
|
+
return {
|
|
2304
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2305
|
+
options: localVarRequestOptions,
|
|
2306
|
+
};
|
|
2307
|
+
}),
|
|
2308
|
+
};
|
|
2309
|
+
};
|
|
2310
|
+
exports.FraudRulesApiAxiosParamCreator = FraudRulesApiAxiosParamCreator;
|
|
2311
|
+
/**
|
|
2312
|
+
* FraudRulesApi - functional programming interface
|
|
2313
|
+
* @export
|
|
2314
|
+
*/
|
|
2315
|
+
const FraudRulesApiFp = function (configuration) {
|
|
2316
|
+
const localVarAxiosParamCreator = (0, exports.FraudRulesApiAxiosParamCreator)(configuration);
|
|
2317
|
+
return {
|
|
2318
|
+
/**
|
|
2319
|
+
* Deletes the rule of the type passed in the URL.
|
|
2320
|
+
* @summary Delete fraud rule
|
|
2321
|
+
* @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
2322
|
+
* @param {*} [options] Override http request option.
|
|
2323
|
+
* @throws {RequiredError}
|
|
2324
|
+
*/
|
|
2325
|
+
deleteFraudRule(ruleType, options) {
|
|
2326
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2327
|
+
var _a, _b, _c;
|
|
2328
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFraudRule(ruleType, options);
|
|
2329
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2330
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FraudRulesApi.deleteFraudRule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2331
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2332
|
+
});
|
|
2333
|
+
},
|
|
2334
|
+
/**
|
|
2335
|
+
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
2336
|
+
* @summary Configure fraud rule
|
|
2337
|
+
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
2338
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
|
|
2339
|
+
* @param {*} [options] Override http request option.
|
|
2340
|
+
* @throws {RequiredError}
|
|
2341
|
+
*/
|
|
2342
|
+
fraudRule(ruleType, fraudRuleRequest, options) {
|
|
2343
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2344
|
+
var _a, _b, _c;
|
|
2345
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.fraudRule(ruleType, fraudRuleRequest, options);
|
|
2346
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2347
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FraudRulesApi.fraudRule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2348
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2349
|
+
});
|
|
2350
|
+
},
|
|
2351
|
+
/**
|
|
2352
|
+
* List active fraud rules associated with the organization tied to your API key.
|
|
2353
|
+
* @summary List fraud rules
|
|
2354
|
+
* @param {*} [options] Override http request option.
|
|
2355
|
+
* @throws {RequiredError}
|
|
2356
|
+
*/
|
|
2357
|
+
listFraudRules(options) {
|
|
2358
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2359
|
+
var _a, _b, _c;
|
|
2360
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFraudRules(options);
|
|
2361
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2362
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FraudRulesApi.listFraudRules']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2363
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2364
|
+
});
|
|
2365
|
+
},
|
|
2366
|
+
/**
|
|
2367
|
+
* 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\"] } } ```
|
|
2368
|
+
* @summary Update fraud rule list
|
|
2369
|
+
* @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
|
|
2370
|
+
* @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
|
|
2371
|
+
* @param {*} [options] Override http request option.
|
|
2372
|
+
* @throws {RequiredError}
|
|
2373
|
+
*/
|
|
2374
|
+
updateFraudRuleList(ruleType, updateFraudRuleListRequest, options) {
|
|
2375
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2376
|
+
var _a, _b, _c;
|
|
2377
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFraudRuleList(ruleType, updateFraudRuleListRequest, options);
|
|
2378
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2379
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FraudRulesApi.updateFraudRuleList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2380
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2381
|
+
});
|
|
2382
|
+
},
|
|
2383
|
+
};
|
|
2384
|
+
};
|
|
2385
|
+
exports.FraudRulesApiFp = FraudRulesApiFp;
|
|
2386
|
+
/**
|
|
2387
|
+
* FraudRulesApi - factory interface
|
|
2388
|
+
* @export
|
|
2389
|
+
*/
|
|
2390
|
+
const FraudRulesApiFactory = function (configuration, basePath, axios) {
|
|
2391
|
+
const localVarFp = (0, exports.FraudRulesApiFp)(configuration);
|
|
2392
|
+
return {
|
|
2393
|
+
/**
|
|
2394
|
+
* Deletes the rule of the type passed in the URL.
|
|
2395
|
+
* @summary Delete fraud rule
|
|
2396
|
+
* @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
2397
|
+
* @param {*} [options] Override http request option.
|
|
2398
|
+
* @throws {RequiredError}
|
|
2399
|
+
*/
|
|
2400
|
+
deleteFraudRule(ruleType, options) {
|
|
2401
|
+
return localVarFp.deleteFraudRule(ruleType, options).then((request) => request(axios, basePath));
|
|
2402
|
+
},
|
|
2403
|
+
/**
|
|
2404
|
+
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
2405
|
+
* @summary Configure fraud rule
|
|
2406
|
+
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
2407
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
|
|
2408
|
+
* @param {*} [options] Override http request option.
|
|
2409
|
+
* @throws {RequiredError}
|
|
2410
|
+
*/
|
|
2411
|
+
fraudRule(ruleType, fraudRuleRequest, options) {
|
|
2412
|
+
return localVarFp.fraudRule(ruleType, fraudRuleRequest, options).then((request) => request(axios, basePath));
|
|
2413
|
+
},
|
|
2414
|
+
/**
|
|
2415
|
+
* List active fraud rules associated with the organization tied to your API key.
|
|
2416
|
+
* @summary List fraud rules
|
|
2417
|
+
* @param {*} [options] Override http request option.
|
|
2418
|
+
* @throws {RequiredError}
|
|
2419
|
+
*/
|
|
2420
|
+
listFraudRules(options) {
|
|
2421
|
+
return localVarFp.listFraudRules(options).then((request) => request(axios, basePath));
|
|
2422
|
+
},
|
|
2423
|
+
/**
|
|
2424
|
+
* 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\"] } } ```
|
|
2425
|
+
* @summary Update fraud rule list
|
|
2426
|
+
* @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
|
|
2427
|
+
* @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
|
|
2428
|
+
* @param {*} [options] Override http request option.
|
|
2429
|
+
* @throws {RequiredError}
|
|
2430
|
+
*/
|
|
2431
|
+
updateFraudRuleList(ruleType, updateFraudRuleListRequest, options) {
|
|
2432
|
+
return localVarFp.updateFraudRuleList(ruleType, updateFraudRuleListRequest, options).then((request) => request(axios, basePath));
|
|
2433
|
+
},
|
|
2434
|
+
};
|
|
2435
|
+
};
|
|
2436
|
+
exports.FraudRulesApiFactory = FraudRulesApiFactory;
|
|
2437
|
+
/**
|
|
2438
|
+
* FraudRulesApi - object-oriented interface
|
|
2439
|
+
* @export
|
|
2440
|
+
* @class FraudRulesApi
|
|
2441
|
+
* @extends {BaseAPI}
|
|
2442
|
+
*/
|
|
2443
|
+
class FraudRulesApi extends base_1.BaseAPI {
|
|
2444
|
+
/**
|
|
2445
|
+
* Deletes the rule of the type passed in the URL.
|
|
2446
|
+
* @summary Delete fraud rule
|
|
2447
|
+
* @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
2448
|
+
* @param {*} [options] Override http request option.
|
|
2449
|
+
* @throws {RequiredError}
|
|
2450
|
+
* @memberof FraudRulesApi
|
|
2451
|
+
*/
|
|
2452
|
+
deleteFraudRule(ruleType, options) {
|
|
2453
|
+
return (0, exports.FraudRulesApiFp)(this.configuration).deleteFraudRule(ruleType, options).then((request) => request(this.axios, this.basePath));
|
|
2454
|
+
}
|
|
2455
|
+
/**
|
|
2456
|
+
* Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten.
|
|
2457
|
+
* @summary Configure fraud rule
|
|
2458
|
+
* @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update.
|
|
2459
|
+
* @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
|
|
2460
|
+
* @param {*} [options] Override http request option.
|
|
2461
|
+
* @throws {RequiredError}
|
|
2462
|
+
* @memberof FraudRulesApi
|
|
2463
|
+
*/
|
|
2464
|
+
fraudRule(ruleType, fraudRuleRequest, options) {
|
|
2465
|
+
return (0, exports.FraudRulesApiFp)(this.configuration).fraudRule(ruleType, fraudRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2466
|
+
}
|
|
2467
|
+
/**
|
|
2468
|
+
* List active fraud rules associated with the organization tied to your API key.
|
|
2469
|
+
* @summary List fraud rules
|
|
2470
|
+
* @param {*} [options] Override http request option.
|
|
2471
|
+
* @throws {RequiredError}
|
|
2472
|
+
* @memberof FraudRulesApi
|
|
2473
|
+
*/
|
|
2474
|
+
listFraudRules(options) {
|
|
2475
|
+
return (0, exports.FraudRulesApiFp)(this.configuration).listFraudRules(options).then((request) => request(this.axios, this.basePath));
|
|
2476
|
+
}
|
|
2477
|
+
/**
|
|
2478
|
+
* 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\"] } } ```
|
|
2479
|
+
* @summary Update fraud rule list
|
|
2480
|
+
* @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update.
|
|
2481
|
+
* @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration
|
|
2482
|
+
* @param {*} [options] Override http request option.
|
|
2483
|
+
* @throws {RequiredError}
|
|
2484
|
+
* @memberof FraudRulesApi
|
|
2485
|
+
*/
|
|
2486
|
+
updateFraudRuleList(ruleType, updateFraudRuleListRequest, options) {
|
|
2487
|
+
return (0, exports.FraudRulesApiFp)(this.configuration).updateFraudRuleList(ruleType, updateFraudRuleListRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2488
|
+
}
|
|
2489
|
+
}
|
|
2490
|
+
exports.FraudRulesApi = FraudRulesApi;
|
|
2491
|
+
/**
|
|
2492
|
+
* @export
|
|
2493
|
+
*/
|
|
2494
|
+
exports.DeleteFraudRuleRuleTypeEnum = {
|
|
2495
|
+
ReviewCountry: 'review_country',
|
|
2496
|
+
ReviewIp: 'review_ip',
|
|
2497
|
+
ReviewEmail: 'review_email',
|
|
2498
|
+
ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count',
|
|
2499
|
+
ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount',
|
|
2500
|
+
ReviewMultipleEmails: 'review_multiple_emails',
|
|
2501
|
+
ReviewVpn: 'review_vpn',
|
|
2502
|
+
ReviewTremendousFlagList: 'review_tremendous_flag_list',
|
|
2503
|
+
ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients',
|
|
2504
|
+
AllowIp: 'allow_ip',
|
|
2505
|
+
AllowEmail: 'allow_email'
|
|
2506
|
+
};
|
|
2507
|
+
/**
|
|
2508
|
+
* @export
|
|
2509
|
+
*/
|
|
2510
|
+
exports.FraudRuleRuleTypeEnum = {
|
|
2511
|
+
ReviewCountry: 'review_country',
|
|
2512
|
+
ReviewIp: 'review_ip',
|
|
2513
|
+
ReviewEmail: 'review_email',
|
|
2514
|
+
ReviewRedeemedRewardsCount: 'review_redeemed_rewards_count',
|
|
2515
|
+
ReviewRedeemedRewardsAmount: 'review_redeemed_rewards_amount',
|
|
2516
|
+
ReviewMultipleEmails: 'review_multiple_emails',
|
|
2517
|
+
ReviewVpn: 'review_vpn',
|
|
2518
|
+
ReviewTremendousFlagList: 'review_tremendous_flag_list',
|
|
2519
|
+
ReviewPreviouslyBlockedRecipients: 'review_previously_blocked_recipients',
|
|
2520
|
+
AllowIp: 'allow_ip',
|
|
2521
|
+
AllowEmail: 'allow_email'
|
|
2522
|
+
};
|
|
2523
|
+
/**
|
|
2524
|
+
* @export
|
|
2525
|
+
*/
|
|
2526
|
+
exports.UpdateFraudRuleListRuleTypeEnum = {
|
|
2527
|
+
ReviewCountry: 'review_country',
|
|
2528
|
+
ReviewIp: 'review_ip',
|
|
2529
|
+
ReviewEmail: 'review_email',
|
|
2530
|
+
AllowIp: 'allow_ip',
|
|
2531
|
+
AllowEmail: 'allow_email'
|
|
2532
|
+
};
|
|
2533
|
+
/**
|
|
2534
|
+
* FundingSourcesApi - axios parameter creator
|
|
2535
|
+
* @export
|
|
2536
|
+
*/
|
|
2537
|
+
const FundingSourcesApiAxiosParamCreator = function (configuration) {
|
|
2538
|
+
return {
|
|
2539
|
+
/**
|
|
2540
|
+
* Retrieve a funding source, identified by the given `id` in the URL
|
|
2541
|
+
* @summary Retrieve funding source
|
|
2542
|
+
* @param {string} id ID of the funding source that should be retrieved
|
|
2543
|
+
* @param {*} [options] Override http request option.
|
|
2544
|
+
* @throws {RequiredError}
|
|
2545
|
+
*/
|
|
2546
|
+
getFundingSource: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
2547
|
+
// verify required parameter 'id' is not null or undefined
|
|
2548
|
+
(0, common_1.assertParamExists)('getFundingSource', 'id', id);
|
|
2549
|
+
const localVarPath = `/funding_sources/{id}`
|
|
2550
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
2551
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2552
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2553
|
+
let baseOptions;
|
|
2554
|
+
if (configuration) {
|
|
2555
|
+
baseOptions = configuration.baseOptions;
|
|
2556
|
+
}
|
|
2557
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2558
|
+
const localVarHeaderParameter = {};
|
|
2559
|
+
const localVarQueryParameter = {};
|
|
2560
|
+
// authentication BearerApiKey required
|
|
2561
|
+
// http bearer authentication required
|
|
2562
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2563
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2564
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2565
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2566
|
+
return {
|
|
2567
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2568
|
+
options: localVarRequestOptions,
|
|
2569
|
+
};
|
|
2570
|
+
}),
|
|
2571
|
+
/**
|
|
2572
|
+
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
2573
|
+
* @summary List funding sources
|
|
2574
|
+
* @param {*} [options] Override http request option.
|
|
2575
|
+
* @throws {RequiredError}
|
|
2576
|
+
*/
|
|
2577
|
+
listFundingSources: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
2578
|
+
const localVarPath = `/funding_sources`;
|
|
2579
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2580
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2581
|
+
let baseOptions;
|
|
2582
|
+
if (configuration) {
|
|
2583
|
+
baseOptions = configuration.baseOptions;
|
|
2584
|
+
}
|
|
2585
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2586
|
+
const localVarHeaderParameter = {};
|
|
2587
|
+
const localVarQueryParameter = {};
|
|
2588
|
+
// authentication BearerApiKey required
|
|
2589
|
+
// http bearer authentication required
|
|
2590
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2591
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2592
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2593
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2594
|
+
return {
|
|
2595
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2596
|
+
options: localVarRequestOptions,
|
|
2597
|
+
};
|
|
2598
|
+
}),
|
|
2599
|
+
};
|
|
2600
|
+
};
|
|
2601
|
+
exports.FundingSourcesApiAxiosParamCreator = FundingSourcesApiAxiosParamCreator;
|
|
2602
|
+
/**
|
|
2603
|
+
* FundingSourcesApi - functional programming interface
|
|
2604
|
+
* @export
|
|
2605
|
+
*/
|
|
2606
|
+
const FundingSourcesApiFp = function (configuration) {
|
|
2607
|
+
const localVarAxiosParamCreator = (0, exports.FundingSourcesApiAxiosParamCreator)(configuration);
|
|
2608
|
+
return {
|
|
2609
|
+
/**
|
|
2610
|
+
* Retrieve a funding source, identified by the given `id` in the URL
|
|
2611
|
+
* @summary Retrieve funding source
|
|
2612
|
+
* @param {string} id ID of the funding source that should be retrieved
|
|
2613
|
+
* @param {*} [options] Override http request option.
|
|
2614
|
+
* @throws {RequiredError}
|
|
2615
|
+
*/
|
|
2616
|
+
getFundingSource(id, options) {
|
|
2617
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2618
|
+
var _a, _b, _c;
|
|
2619
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFundingSource(id, options);
|
|
2620
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2621
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FundingSourcesApi.getFundingSource']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2622
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2623
|
+
});
|
|
2624
|
+
},
|
|
2625
|
+
/**
|
|
2626
|
+
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
2627
|
+
* @summary List funding sources
|
|
2628
|
+
* @param {*} [options] Override http request option.
|
|
2629
|
+
* @throws {RequiredError}
|
|
2630
|
+
*/
|
|
2631
|
+
listFundingSources(options) {
|
|
2632
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2633
|
+
var _a, _b, _c;
|
|
2634
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFundingSources(options);
|
|
2635
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2636
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FundingSourcesApi.listFundingSources']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2637
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2638
|
+
});
|
|
2639
|
+
},
|
|
2640
|
+
};
|
|
2641
|
+
};
|
|
2642
|
+
exports.FundingSourcesApiFp = FundingSourcesApiFp;
|
|
2643
|
+
/**
|
|
2644
|
+
* FundingSourcesApi - factory interface
|
|
2645
|
+
* @export
|
|
2646
|
+
*/
|
|
2647
|
+
const FundingSourcesApiFactory = function (configuration, basePath, axios) {
|
|
2648
|
+
const localVarFp = (0, exports.FundingSourcesApiFp)(configuration);
|
|
2649
|
+
return {
|
|
2650
|
+
/**
|
|
2651
|
+
* Retrieve a funding source, identified by the given `id` in the URL
|
|
2652
|
+
* @summary Retrieve funding source
|
|
2653
|
+
* @param {string} id ID of the funding source that should be retrieved
|
|
2654
|
+
* @param {*} [options] Override http request option.
|
|
2655
|
+
* @throws {RequiredError}
|
|
2656
|
+
*/
|
|
2657
|
+
getFundingSource(id, options) {
|
|
2658
|
+
return localVarFp.getFundingSource(id, options).then((request) => request(axios, basePath));
|
|
2659
|
+
},
|
|
2660
|
+
/**
|
|
2661
|
+
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
2662
|
+
* @summary List funding sources
|
|
2663
|
+
* @param {*} [options] Override http request option.
|
|
2664
|
+
* @throws {RequiredError}
|
|
2665
|
+
*/
|
|
2666
|
+
listFundingSources(options) {
|
|
2667
|
+
return localVarFp.listFundingSources(options).then((request) => request(axios, basePath));
|
|
2668
|
+
},
|
|
2669
|
+
};
|
|
2670
|
+
};
|
|
2671
|
+
exports.FundingSourcesApiFactory = FundingSourcesApiFactory;
|
|
2672
|
+
/**
|
|
2673
|
+
* FundingSourcesApi - object-oriented interface
|
|
2674
|
+
* @export
|
|
2675
|
+
* @class FundingSourcesApi
|
|
2676
|
+
* @extends {BaseAPI}
|
|
2677
|
+
*/
|
|
2678
|
+
class FundingSourcesApi extends base_1.BaseAPI {
|
|
2679
|
+
/**
|
|
2680
|
+
* Retrieve a funding source, identified by the given `id` in the URL
|
|
2681
|
+
* @summary Retrieve funding source
|
|
2682
|
+
* @param {string} id ID of the funding source that should be retrieved
|
|
2683
|
+
* @param {*} [options] Override http request option.
|
|
2684
|
+
* @throws {RequiredError}
|
|
2685
|
+
* @memberof FundingSourcesApi
|
|
2686
|
+
*/
|
|
2687
|
+
getFundingSource(id, options) {
|
|
2688
|
+
return (0, exports.FundingSourcesApiFp)(this.configuration).getFundingSource(id, options).then((request) => request(this.axios, this.basePath));
|
|
2689
|
+
}
|
|
2690
|
+
/**
|
|
2691
|
+
* Retrieve a list of all funding sources available for ordering through the API in your organization\'s account.
|
|
2692
|
+
* @summary List funding sources
|
|
2693
|
+
* @param {*} [options] Override http request option.
|
|
2694
|
+
* @throws {RequiredError}
|
|
2695
|
+
* @memberof FundingSourcesApi
|
|
2696
|
+
*/
|
|
2697
|
+
listFundingSources(options) {
|
|
2698
|
+
return (0, exports.FundingSourcesApiFp)(this.configuration).listFundingSources(options).then((request) => request(this.axios, this.basePath));
|
|
2699
|
+
}
|
|
2700
|
+
}
|
|
2701
|
+
exports.FundingSourcesApi = FundingSourcesApi;
|
|
2702
|
+
/**
|
|
2703
|
+
* InvoicesApi - axios parameter creator
|
|
2704
|
+
* @export
|
|
2705
|
+
*/
|
|
2706
|
+
const InvoicesApiAxiosParamCreator = function (configuration) {
|
|
2707
|
+
return {
|
|
2708
|
+
/**
|
|
2709
|
+
* Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">po_number</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference to the purchase order number within your organization</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">amount</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the invoice in USD</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">memo</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.</p> </td></tr> </tbody> </table> </div>
|
|
2710
|
+
* @summary Create invoice
|
|
2711
|
+
* @param {CreateInvoiceRequest} createInvoiceRequest Invoice details
|
|
2712
|
+
* @param {*} [options] Override http request option.
|
|
2713
|
+
* @throws {RequiredError}
|
|
2714
|
+
*/
|
|
2715
|
+
createInvoice: (createInvoiceRequest_1, ...args_1) => __awaiter(this, [createInvoiceRequest_1, ...args_1], void 0, function* (createInvoiceRequest, options = {}) {
|
|
2716
|
+
// verify required parameter 'createInvoiceRequest' is not null or undefined
|
|
2717
|
+
(0, common_1.assertParamExists)('createInvoice', 'createInvoiceRequest', createInvoiceRequest);
|
|
2718
|
+
const localVarPath = `/invoices`;
|
|
2719
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2720
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2721
|
+
let baseOptions;
|
|
2722
|
+
if (configuration) {
|
|
2723
|
+
baseOptions = configuration.baseOptions;
|
|
2724
|
+
}
|
|
2725
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2726
|
+
const localVarHeaderParameter = {};
|
|
2727
|
+
const localVarQueryParameter = {};
|
|
2728
|
+
// authentication BearerApiKey required
|
|
2729
|
+
// http bearer authentication required
|
|
2730
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2731
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2732
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2733
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2734
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2735
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createInvoiceRequest, localVarRequestOptions, configuration);
|
|
2736
|
+
return {
|
|
2737
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2738
|
+
options: localVarRequestOptions,
|
|
2739
|
+
};
|
|
2740
|
+
}),
|
|
2741
|
+
/**
|
|
2742
|
+
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
2743
|
+
* @summary Delete invoice
|
|
2744
|
+
* @param {string} id ID of the invoice that should be removed
|
|
2745
|
+
* @param {*} [options] Override http request option.
|
|
2746
|
+
* @throws {RequiredError}
|
|
2747
|
+
*/
|
|
2748
|
+
deleteInvoices: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
2749
|
+
// verify required parameter 'id' is not null or undefined
|
|
2750
|
+
(0, common_1.assertParamExists)('deleteInvoices', 'id', id);
|
|
2751
|
+
const localVarPath = `/invoices/{id}`
|
|
2752
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
2753
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2754
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2755
|
+
let baseOptions;
|
|
2756
|
+
if (configuration) {
|
|
2757
|
+
baseOptions = configuration.baseOptions;
|
|
2758
|
+
}
|
|
2759
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
2760
|
+
const localVarHeaderParameter = {};
|
|
2761
|
+
const localVarQueryParameter = {};
|
|
2762
|
+
// authentication BearerApiKey required
|
|
2763
|
+
// http bearer authentication required
|
|
2764
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2765
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2766
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2767
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2768
|
+
return {
|
|
2769
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2770
|
+
options: localVarRequestOptions,
|
|
2771
|
+
};
|
|
2772
|
+
}),
|
|
2773
|
+
/**
|
|
2774
|
+
* Generates a CSV version for an invoice listing the associated rewards and orders
|
|
2775
|
+
* @summary Retrieve invoice as CSV
|
|
2776
|
+
* @param {string} id ID of the Invoice for that the CSV should be generated
|
|
2777
|
+
* @param {*} [options] Override http request option.
|
|
2778
|
+
* @throws {RequiredError}
|
|
2779
|
+
*/
|
|
2780
|
+
downloadInvoiceCsv: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
2781
|
+
// verify required parameter 'id' is not null or undefined
|
|
2782
|
+
(0, common_1.assertParamExists)('downloadInvoiceCsv', 'id', id);
|
|
2783
|
+
const localVarPath = `/invoices/{id}/csv`
|
|
2784
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
2785
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2786
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
2787
|
+
let baseOptions;
|
|
2788
|
+
if (configuration) {
|
|
2789
|
+
baseOptions = configuration.baseOptions;
|
|
2790
|
+
}
|
|
2791
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2792
|
+
const localVarHeaderParameter = {};
|
|
2793
|
+
const localVarQueryParameter = {};
|
|
2794
|
+
// authentication BearerApiKey required
|
|
2795
|
+
// http bearer authentication required
|
|
2796
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
2797
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2798
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2799
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2800
|
+
return {
|
|
2801
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
2802
|
+
options: localVarRequestOptions,
|
|
2803
|
+
};
|
|
2804
|
+
}),
|
|
2805
|
+
/**
|
|
2806
|
+
* Generates a PDF version for an invoice
|
|
2807
|
+
* @summary Retrieve invoice as PDF
|
|
2808
|
+
* @param {string} id ID of the Invoice for that the PDF should be generated
|
|
2809
|
+
* @param {*} [options] Override http request option.
|
|
2810
|
+
* @throws {RequiredError}
|
|
2811
|
+
*/
|
|
2812
|
+
downloadInvoicePdf: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
1778
2813
|
// verify required parameter 'id' is not null or undefined
|
|
1779
2814
|
(0, common_1.assertParamExists)('downloadInvoicePdf', 'id', id);
|
|
1780
2815
|
const localVarPath = `/invoices/{id}/pdf`
|
|
@@ -1806,7 +2841,7 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
1806
2841
|
* @param {*} [options] Override http request option.
|
|
1807
2842
|
* @throws {RequiredError}
|
|
1808
2843
|
*/
|
|
1809
|
-
getInvoice: (
|
|
2844
|
+
getInvoice: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
1810
2845
|
// verify required parameter 'id' is not null or undefined
|
|
1811
2846
|
(0, common_1.assertParamExists)('getInvoice', 'id', id);
|
|
1812
2847
|
const localVarPath = `/invoices/{id}`
|
|
@@ -1839,7 +2874,7 @@ const InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
1839
2874
|
* @param {*} [options] Override http request option.
|
|
1840
2875
|
* @throws {RequiredError}
|
|
1841
2876
|
*/
|
|
1842
|
-
listInvoices: (offset_1, limit_1, ...
|
|
2877
|
+
listInvoices: (offset_1, limit_1, ...args_1) => __awaiter(this, [offset_1, limit_1, ...args_1], void 0, function* (offset, limit, options = {}) {
|
|
1843
2878
|
const localVarPath = `/invoices`;
|
|
1844
2879
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1845
2880
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -1896,7 +2931,7 @@ const InvoicesApiFp = function (configuration) {
|
|
|
1896
2931
|
/**
|
|
1897
2932
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
1898
2933
|
* @summary Delete invoice
|
|
1899
|
-
* @param {string} id ID of the invoice that should be
|
|
2934
|
+
* @param {string} id ID of the invoice that should be removed
|
|
1900
2935
|
* @param {*} [options] Override http request option.
|
|
1901
2936
|
* @throws {RequiredError}
|
|
1902
2937
|
*/
|
|
@@ -1997,7 +3032,7 @@ const InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
1997
3032
|
/**
|
|
1998
3033
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
1999
3034
|
* @summary Delete invoice
|
|
2000
|
-
* @param {string} id ID of the invoice that should be
|
|
3035
|
+
* @param {string} id ID of the invoice that should be removed
|
|
2001
3036
|
* @param {*} [options] Override http request option.
|
|
2002
3037
|
* @throws {RequiredError}
|
|
2003
3038
|
*/
|
|
@@ -2069,7 +3104,7 @@ class InvoicesApi extends base_1.BaseAPI {
|
|
|
2069
3104
|
/**
|
|
2070
3105
|
* Removes an invoice. This has no further consequences but is a rather cosmetic operation.
|
|
2071
3106
|
* @summary Delete invoice
|
|
2072
|
-
* @param {string} id ID of the invoice that should be
|
|
3107
|
+
* @param {string} id ID of the invoice that should be removed
|
|
2073
3108
|
* @param {*} [options] Override http request option.
|
|
2074
3109
|
* @throws {RequiredError}
|
|
2075
3110
|
* @memberof InvoicesApi
|
|
@@ -2131,7 +3166,7 @@ exports.InvoicesApi = InvoicesApi;
|
|
|
2131
3166
|
const MembersApiAxiosParamCreator = function (configuration) {
|
|
2132
3167
|
return {
|
|
2133
3168
|
/**
|
|
2134
|
-
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have
|
|
3169
|
+
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
2135
3170
|
* @summary Create member
|
|
2136
3171
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
2137
3172
|
* @param {*} [options] Override http request option.
|
|
@@ -2170,7 +3205,7 @@ const MembersApiAxiosParamCreator = function (configuration) {
|
|
|
2170
3205
|
* @param {*} [options] Override http request option.
|
|
2171
3206
|
* @throws {RequiredError}
|
|
2172
3207
|
*/
|
|
2173
|
-
getMember: (id_1, ...
|
|
3208
|
+
getMember: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
2174
3209
|
// verify required parameter 'id' is not null or undefined
|
|
2175
3210
|
(0, common_1.assertParamExists)('getMember', 'id', id);
|
|
2176
3211
|
const localVarPath = `/members/{id}`
|
|
@@ -2201,7 +3236,7 @@ const MembersApiAxiosParamCreator = function (configuration) {
|
|
|
2201
3236
|
* @param {*} [options] Override http request option.
|
|
2202
3237
|
* @throws {RequiredError}
|
|
2203
3238
|
*/
|
|
2204
|
-
listMembers: (...
|
|
3239
|
+
listMembers: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
2205
3240
|
const localVarPath = `/members`;
|
|
2206
3241
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2207
3242
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -2234,7 +3269,7 @@ const MembersApiFp = function (configuration) {
|
|
|
2234
3269
|
const localVarAxiosParamCreator = (0, exports.MembersApiAxiosParamCreator)(configuration);
|
|
2235
3270
|
return {
|
|
2236
3271
|
/**
|
|
2237
|
-
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have
|
|
3272
|
+
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
2238
3273
|
* @summary Create member
|
|
2239
3274
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
2240
3275
|
* @param {*} [options] Override http request option.
|
|
@@ -2291,7 +3326,7 @@ const MembersApiFactory = function (configuration, basePath, axios) {
|
|
|
2291
3326
|
const localVarFp = (0, exports.MembersApiFp)(configuration);
|
|
2292
3327
|
return {
|
|
2293
3328
|
/**
|
|
2294
|
-
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have
|
|
3329
|
+
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
2295
3330
|
* @summary Create member
|
|
2296
3331
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
2297
3332
|
* @param {*} [options] Override http request option.
|
|
@@ -2330,7 +3365,7 @@ exports.MembersApiFactory = MembersApiFactory;
|
|
|
2330
3365
|
*/
|
|
2331
3366
|
class MembersApi extends base_1.BaseAPI {
|
|
2332
3367
|
/**
|
|
2333
|
-
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have
|
|
3368
|
+
* Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead.
|
|
2334
3369
|
* @summary Create member
|
|
2335
3370
|
* @param {CreateMemberRequest} createMemberRequest Member details
|
|
2336
3371
|
* @param {*} [options] Override http request option.
|
|
@@ -2408,7 +3443,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
2408
3443
|
* @param {*} [options] Override http request option.
|
|
2409
3444
|
* @throws {RequiredError}
|
|
2410
3445
|
*/
|
|
2411
|
-
createOrder: (createOrderRequest_1, ...
|
|
3446
|
+
createOrder: (createOrderRequest_1, ...args_1) => __awaiter(this, [createOrderRequest_1, ...args_1], void 0, function* (createOrderRequest, options = {}) {
|
|
2412
3447
|
// verify required parameter 'createOrderRequest' is not null or undefined
|
|
2413
3448
|
(0, common_1.assertParamExists)('createOrder', 'createOrderRequest', createOrderRequest);
|
|
2414
3449
|
const localVarPath = `/orders`;
|
|
@@ -2441,7 +3476,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
2441
3476
|
* @param {*} [options] Override http request option.
|
|
2442
3477
|
* @throws {RequiredError}
|
|
2443
3478
|
*/
|
|
2444
|
-
getOrder: (
|
|
3479
|
+
getOrder: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
2445
3480
|
// verify required parameter 'id' is not null or undefined
|
|
2446
3481
|
(0, common_1.assertParamExists)('getOrder', 'id', id);
|
|
2447
3482
|
const localVarPath = `/orders/{id}`
|
|
@@ -2478,7 +3513,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
2478
3513
|
* @param {*} [options] Override http request option.
|
|
2479
3514
|
* @throws {RequiredError}
|
|
2480
3515
|
*/
|
|
2481
|
-
listOrders: (offset_1, campaignId_1, externalId_1, createdAtGte_1, createdAtLte_1, limit_1, ...
|
|
3516
|
+
listOrders: (offset_1, campaignId_1, externalId_1, createdAtGte_1, createdAtLte_1, limit_1, ...args_1) => __awaiter(this, [offset_1, campaignId_1, externalId_1, createdAtGte_1, createdAtLte_1, limit_1, ...args_1], void 0, function* (offset, campaignId, externalId, createdAtGte, createdAtLte, limit, options = {}) {
|
|
2482
3517
|
const localVarPath = `/orders`;
|
|
2483
3518
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2484
3519
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -2525,7 +3560,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
2525
3560
|
* @param {*} [options] Override http request option.
|
|
2526
3561
|
* @throws {RequiredError}
|
|
2527
3562
|
*/
|
|
2528
|
-
rejectOrder: (
|
|
3563
|
+
rejectOrder: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
2529
3564
|
// verify required parameter 'id' is not null or undefined
|
|
2530
3565
|
(0, common_1.assertParamExists)('rejectOrder', 'id', id);
|
|
2531
3566
|
const localVarPath = `/order_approvals/{id}/reject`
|
|
@@ -2823,7 +3858,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
2823
3858
|
* @param {*} [options] Override http request option.
|
|
2824
3859
|
* @throws {RequiredError}
|
|
2825
3860
|
*/
|
|
2826
|
-
createOrganization: (createOrganizationRequest_1, ...
|
|
3861
|
+
createOrganization: (createOrganizationRequest_1, ...args_1) => __awaiter(this, [createOrganizationRequest_1, ...args_1], void 0, function* (createOrganizationRequest, options = {}) {
|
|
2827
3862
|
// verify required parameter 'createOrganizationRequest' is not null or undefined
|
|
2828
3863
|
(0, common_1.assertParamExists)('createOrganization', 'createOrganizationRequest', createOrganizationRequest);
|
|
2829
3864
|
const localVarPath = `/organizations`;
|
|
@@ -2856,7 +3891,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
2856
3891
|
* @param {*} [options] Override http request option.
|
|
2857
3892
|
* @throws {RequiredError}
|
|
2858
3893
|
*/
|
|
2859
|
-
getOrganization: (id_1, ...
|
|
3894
|
+
getOrganization: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
2860
3895
|
// verify required parameter 'id' is not null or undefined
|
|
2861
3896
|
(0, common_1.assertParamExists)('getOrganization', 'id', id);
|
|
2862
3897
|
const localVarPath = `/organizations/{id}`
|
|
@@ -2887,7 +3922,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
2887
3922
|
* @param {*} [options] Override http request option.
|
|
2888
3923
|
* @throws {RequiredError}
|
|
2889
3924
|
*/
|
|
2890
|
-
listOrganizations: (...
|
|
3925
|
+
listOrganizations: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
2891
3926
|
const localVarPath = `/organizations`;
|
|
2892
3927
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2893
3928
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -3090,17 +4125,293 @@ exports.OrganizationsApi = OrganizationsApi;
|
|
|
3090
4125
|
const ProductsApiAxiosParamCreator = function (configuration) {
|
|
3091
4126
|
return {
|
|
3092
4127
|
/**
|
|
3093
|
-
* Retrieve a product, identified by the given `id` in the URL
|
|
3094
|
-
* @summary Retrieve product
|
|
3095
|
-
* @param {string} id ID of the product that should be retrieved
|
|
4128
|
+
* Retrieve a product, identified by the given `id` in the URL
|
|
4129
|
+
* @summary Retrieve product
|
|
4130
|
+
* @param {string} id ID of the product that should be retrieved
|
|
4131
|
+
* @param {*} [options] Override http request option.
|
|
4132
|
+
* @throws {RequiredError}
|
|
4133
|
+
*/
|
|
4134
|
+
getProduct: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
4135
|
+
// verify required parameter 'id' is not null or undefined
|
|
4136
|
+
(0, common_1.assertParamExists)('getProduct', 'id', id);
|
|
4137
|
+
const localVarPath = `/products/{id}`
|
|
4138
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
4139
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4140
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4141
|
+
let baseOptions;
|
|
4142
|
+
if (configuration) {
|
|
4143
|
+
baseOptions = configuration.baseOptions;
|
|
4144
|
+
}
|
|
4145
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
4146
|
+
const localVarHeaderParameter = {};
|
|
4147
|
+
const localVarQueryParameter = {};
|
|
4148
|
+
// authentication BearerApiKey required
|
|
4149
|
+
// http bearer authentication required
|
|
4150
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
4151
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4152
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4153
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4154
|
+
return {
|
|
4155
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
4156
|
+
options: localVarRequestOptions,
|
|
4157
|
+
};
|
|
4158
|
+
}),
|
|
4159
|
+
/**
|
|
4160
|
+
* Retrieve a list of available products
|
|
4161
|
+
* @summary List products
|
|
4162
|
+
* @param {string} [country] Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries
|
|
4163
|
+
* @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
4164
|
+
* @param {*} [options] Override http request option.
|
|
4165
|
+
* @throws {RequiredError}
|
|
4166
|
+
*/
|
|
4167
|
+
listProducts: (country_1, currency_1, ...args_1) => __awaiter(this, [country_1, currency_1, ...args_1], void 0, function* (country, currency, options = {}) {
|
|
4168
|
+
const localVarPath = `/products`;
|
|
4169
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4170
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4171
|
+
let baseOptions;
|
|
4172
|
+
if (configuration) {
|
|
4173
|
+
baseOptions = configuration.baseOptions;
|
|
4174
|
+
}
|
|
4175
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
4176
|
+
const localVarHeaderParameter = {};
|
|
4177
|
+
const localVarQueryParameter = {};
|
|
4178
|
+
// authentication BearerApiKey required
|
|
4179
|
+
// http bearer authentication required
|
|
4180
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
4181
|
+
if (country !== undefined) {
|
|
4182
|
+
localVarQueryParameter['country'] = country;
|
|
4183
|
+
}
|
|
4184
|
+
if (currency !== undefined) {
|
|
4185
|
+
localVarQueryParameter['currency'] = currency;
|
|
4186
|
+
}
|
|
4187
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4188
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4189
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4190
|
+
return {
|
|
4191
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
4192
|
+
options: localVarRequestOptions,
|
|
4193
|
+
};
|
|
4194
|
+
}),
|
|
4195
|
+
};
|
|
4196
|
+
};
|
|
4197
|
+
exports.ProductsApiAxiosParamCreator = ProductsApiAxiosParamCreator;
|
|
4198
|
+
/**
|
|
4199
|
+
* ProductsApi - functional programming interface
|
|
4200
|
+
* @export
|
|
4201
|
+
*/
|
|
4202
|
+
const ProductsApiFp = function (configuration) {
|
|
4203
|
+
const localVarAxiosParamCreator = (0, exports.ProductsApiAxiosParamCreator)(configuration);
|
|
4204
|
+
return {
|
|
4205
|
+
/**
|
|
4206
|
+
* Retrieve a product, identified by the given `id` in the URL
|
|
4207
|
+
* @summary Retrieve product
|
|
4208
|
+
* @param {string} id ID of the product that should be retrieved
|
|
4209
|
+
* @param {*} [options] Override http request option.
|
|
4210
|
+
* @throws {RequiredError}
|
|
4211
|
+
*/
|
|
4212
|
+
getProduct(id, options) {
|
|
4213
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4214
|
+
var _a, _b, _c;
|
|
4215
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProduct(id, options);
|
|
4216
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4217
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.getProduct']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4218
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4219
|
+
});
|
|
4220
|
+
},
|
|
4221
|
+
/**
|
|
4222
|
+
* Retrieve a list of available products
|
|
4223
|
+
* @summary List products
|
|
4224
|
+
* @param {string} [country] Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries
|
|
4225
|
+
* @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
4226
|
+
* @param {*} [options] Override http request option.
|
|
4227
|
+
* @throws {RequiredError}
|
|
4228
|
+
*/
|
|
4229
|
+
listProducts(country, currency, options) {
|
|
4230
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4231
|
+
var _a, _b, _c;
|
|
4232
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(country, currency, options);
|
|
4233
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4234
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4235
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4236
|
+
});
|
|
4237
|
+
},
|
|
4238
|
+
};
|
|
4239
|
+
};
|
|
4240
|
+
exports.ProductsApiFp = ProductsApiFp;
|
|
4241
|
+
/**
|
|
4242
|
+
* ProductsApi - factory interface
|
|
4243
|
+
* @export
|
|
4244
|
+
*/
|
|
4245
|
+
const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
4246
|
+
const localVarFp = (0, exports.ProductsApiFp)(configuration);
|
|
4247
|
+
return {
|
|
4248
|
+
/**
|
|
4249
|
+
* Retrieve a product, identified by the given `id` in the URL
|
|
4250
|
+
* @summary Retrieve product
|
|
4251
|
+
* @param {string} id ID of the product that should be retrieved
|
|
4252
|
+
* @param {*} [options] Override http request option.
|
|
4253
|
+
* @throws {RequiredError}
|
|
4254
|
+
*/
|
|
4255
|
+
getProduct(id, options) {
|
|
4256
|
+
return localVarFp.getProduct(id, options).then((request) => request(axios, basePath));
|
|
4257
|
+
},
|
|
4258
|
+
/**
|
|
4259
|
+
* Retrieve a list of available products
|
|
4260
|
+
* @summary List products
|
|
4261
|
+
* @param {string} [country] Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries
|
|
4262
|
+
* @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
4263
|
+
* @param {*} [options] Override http request option.
|
|
4264
|
+
* @throws {RequiredError}
|
|
4265
|
+
*/
|
|
4266
|
+
listProducts(country, currency, options) {
|
|
4267
|
+
return localVarFp.listProducts(country, currency, options).then((request) => request(axios, basePath));
|
|
4268
|
+
},
|
|
4269
|
+
};
|
|
4270
|
+
};
|
|
4271
|
+
exports.ProductsApiFactory = ProductsApiFactory;
|
|
4272
|
+
/**
|
|
4273
|
+
* ProductsApi - object-oriented interface
|
|
4274
|
+
* @export
|
|
4275
|
+
* @class ProductsApi
|
|
4276
|
+
* @extends {BaseAPI}
|
|
4277
|
+
*/
|
|
4278
|
+
class ProductsApi extends base_1.BaseAPI {
|
|
4279
|
+
/**
|
|
4280
|
+
* Retrieve a product, identified by the given `id` in the URL
|
|
4281
|
+
* @summary Retrieve product
|
|
4282
|
+
* @param {string} id ID of the product that should be retrieved
|
|
4283
|
+
* @param {*} [options] Override http request option.
|
|
4284
|
+
* @throws {RequiredError}
|
|
4285
|
+
* @memberof ProductsApi
|
|
4286
|
+
*/
|
|
4287
|
+
getProduct(id, options) {
|
|
4288
|
+
return (0, exports.ProductsApiFp)(this.configuration).getProduct(id, options).then((request) => request(this.axios, this.basePath));
|
|
4289
|
+
}
|
|
4290
|
+
/**
|
|
4291
|
+
* Retrieve a list of available products
|
|
4292
|
+
* @summary List products
|
|
4293
|
+
* @param {string} [country] Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries
|
|
4294
|
+
* @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
4295
|
+
* @param {*} [options] Override http request option.
|
|
4296
|
+
* @throws {RequiredError}
|
|
4297
|
+
* @memberof ProductsApi
|
|
4298
|
+
*/
|
|
4299
|
+
listProducts(country, currency, options) {
|
|
4300
|
+
return (0, exports.ProductsApiFp)(this.configuration).listProducts(country, currency, options).then((request) => request(this.axios, this.basePath));
|
|
4301
|
+
}
|
|
4302
|
+
}
|
|
4303
|
+
exports.ProductsApi = ProductsApi;
|
|
4304
|
+
/**
|
|
4305
|
+
* PublicKeysApi - axios parameter creator
|
|
4306
|
+
* @export
|
|
4307
|
+
*/
|
|
4308
|
+
const PublicKeysApiAxiosParamCreator = function (configuration) {
|
|
4309
|
+
return {
|
|
4310
|
+
/**
|
|
4311
|
+
* Creating a public key is the way for your organization to share it with Tremendous. > 🔒 Generating asymmetric keys > > **We recommend using [OpenSSL](https://www.openssl.org/).** > > 1. Generate a private key and a public key in PEM: > `openssl genrsa -out tremendous_key.pem 4096` > > 2. Extract the public key in PEM format: > `openssl rsa -in tremendous_key.pem -outform PEM -pubout -out tremendous_key.pem.pub` > > 3. And, before making your request, encode it as a `base64` string: > `base64 -i tremendous_key.pem.pub` <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\">public_key</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Base64 encoded (public) PEM file</p> </td></tr> </tbody> </table> </div>
|
|
4312
|
+
* @summary Create public key
|
|
4313
|
+
* @param {CreatePublicKeyRequest} createPublicKeyRequest Public key details
|
|
4314
|
+
* @param {*} [options] Override http request option.
|
|
4315
|
+
* @throws {RequiredError}
|
|
4316
|
+
*/
|
|
4317
|
+
createPublicKey: (createPublicKeyRequest_1, ...args_1) => __awaiter(this, [createPublicKeyRequest_1, ...args_1], void 0, function* (createPublicKeyRequest, options = {}) {
|
|
4318
|
+
// verify required parameter 'createPublicKeyRequest' is not null or undefined
|
|
4319
|
+
(0, common_1.assertParamExists)('createPublicKey', 'createPublicKeyRequest', createPublicKeyRequest);
|
|
4320
|
+
const localVarPath = `/public_keys`;
|
|
4321
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4322
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4323
|
+
let baseOptions;
|
|
4324
|
+
if (configuration) {
|
|
4325
|
+
baseOptions = configuration.baseOptions;
|
|
4326
|
+
}
|
|
4327
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
4328
|
+
const localVarHeaderParameter = {};
|
|
4329
|
+
const localVarQueryParameter = {};
|
|
4330
|
+
// authentication BearerApiKey required
|
|
4331
|
+
// http bearer authentication required
|
|
4332
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
4333
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
4334
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4335
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4336
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4337
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPublicKeyRequest, localVarRequestOptions, configuration);
|
|
4338
|
+
return {
|
|
4339
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
4340
|
+
options: localVarRequestOptions,
|
|
4341
|
+
};
|
|
4342
|
+
}),
|
|
4343
|
+
/**
|
|
4344
|
+
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
4345
|
+
* @summary Delete public key
|
|
4346
|
+
* @param {string} id ID of the public key that should be deactivated
|
|
4347
|
+
* @param {*} [options] Override http request option.
|
|
4348
|
+
* @throws {RequiredError}
|
|
4349
|
+
*/
|
|
4350
|
+
deletePublicKey: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
4351
|
+
// verify required parameter 'id' is not null or undefined
|
|
4352
|
+
(0, common_1.assertParamExists)('deletePublicKey', 'id', id);
|
|
4353
|
+
const localVarPath = `/public_keys/{id}`
|
|
4354
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
4355
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4356
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4357
|
+
let baseOptions;
|
|
4358
|
+
if (configuration) {
|
|
4359
|
+
baseOptions = configuration.baseOptions;
|
|
4360
|
+
}
|
|
4361
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
4362
|
+
const localVarHeaderParameter = {};
|
|
4363
|
+
const localVarQueryParameter = {};
|
|
4364
|
+
// authentication BearerApiKey required
|
|
4365
|
+
// http bearer authentication required
|
|
4366
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
4367
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4368
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4369
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4370
|
+
return {
|
|
4371
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
4372
|
+
options: localVarRequestOptions,
|
|
4373
|
+
};
|
|
4374
|
+
}),
|
|
4375
|
+
/**
|
|
4376
|
+
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
4377
|
+
* @summary Retrieve public key
|
|
4378
|
+
* @param {string} id ID of the public key that should be retrieved
|
|
4379
|
+
* @param {*} [options] Override http request option.
|
|
4380
|
+
* @throws {RequiredError}
|
|
4381
|
+
*/
|
|
4382
|
+
getPublicKey: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
4383
|
+
// verify required parameter 'id' is not null or undefined
|
|
4384
|
+
(0, common_1.assertParamExists)('getPublicKey', 'id', id);
|
|
4385
|
+
const localVarPath = `/public_keys/{id}`
|
|
4386
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
4387
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4388
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4389
|
+
let baseOptions;
|
|
4390
|
+
if (configuration) {
|
|
4391
|
+
baseOptions = configuration.baseOptions;
|
|
4392
|
+
}
|
|
4393
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
4394
|
+
const localVarHeaderParameter = {};
|
|
4395
|
+
const localVarQueryParameter = {};
|
|
4396
|
+
// authentication BearerApiKey required
|
|
4397
|
+
// http bearer authentication required
|
|
4398
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
4399
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4400
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4401
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4402
|
+
return {
|
|
4403
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
4404
|
+
options: localVarRequestOptions,
|
|
4405
|
+
};
|
|
4406
|
+
}),
|
|
4407
|
+
/**
|
|
4408
|
+
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
4409
|
+
* @summary List public keys
|
|
3096
4410
|
* @param {*} [options] Override http request option.
|
|
3097
4411
|
* @throws {RequiredError}
|
|
3098
4412
|
*/
|
|
3099
|
-
|
|
3100
|
-
|
|
3101
|
-
(0, common_1.assertParamExists)('getProduct', 'id', id);
|
|
3102
|
-
const localVarPath = `/products/{id}`
|
|
3103
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
4413
|
+
listPublicKeys: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
4414
|
+
const localVarPath = `/public_keys`;
|
|
3104
4415
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3105
4416
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3106
4417
|
let baseOptions;
|
|
@@ -3122,15 +4433,20 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
3122
4433
|
};
|
|
3123
4434
|
}),
|
|
3124
4435
|
/**
|
|
3125
|
-
*
|
|
3126
|
-
* @summary
|
|
3127
|
-
* @param {string}
|
|
3128
|
-
* @param {
|
|
4436
|
+
* 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.
|
|
4437
|
+
* @summary Test public key
|
|
4438
|
+
* @param {string} id ID of the public key to test
|
|
4439
|
+
* @param {TestPublicKeyRequest} testPublicKeyRequest
|
|
3129
4440
|
* @param {*} [options] Override http request option.
|
|
3130
4441
|
* @throws {RequiredError}
|
|
3131
4442
|
*/
|
|
3132
|
-
|
|
3133
|
-
|
|
4443
|
+
testPublicKey: (id_1, testPublicKeyRequest_1, ...args_1) => __awaiter(this, [id_1, testPublicKeyRequest_1, ...args_1], void 0, function* (id, testPublicKeyRequest, options = {}) {
|
|
4444
|
+
// verify required parameter 'id' is not null or undefined
|
|
4445
|
+
(0, common_1.assertParamExists)('testPublicKey', 'id', id);
|
|
4446
|
+
// verify required parameter 'testPublicKeyRequest' is not null or undefined
|
|
4447
|
+
(0, common_1.assertParamExists)('testPublicKey', 'testPublicKeyRequest', testPublicKeyRequest);
|
|
4448
|
+
const localVarPath = `/public_keys/{id}/decode_jwt`
|
|
4449
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
3134
4450
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3135
4451
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3136
4452
|
let baseOptions;
|
|
@@ -3143,15 +4459,11 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
3143
4459
|
// authentication BearerApiKey required
|
|
3144
4460
|
// http bearer authentication required
|
|
3145
4461
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
3146
|
-
|
|
3147
|
-
localVarQueryParameter['country'] = country;
|
|
3148
|
-
}
|
|
3149
|
-
if (currency !== undefined) {
|
|
3150
|
-
localVarQueryParameter['currency'] = currency;
|
|
3151
|
-
}
|
|
4462
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3152
4463
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3153
4464
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3154
4465
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4466
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(testPublicKeyRequest, localVarRequestOptions, configuration);
|
|
3155
4467
|
return {
|
|
3156
4468
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3157
4469
|
options: localVarRequestOptions,
|
|
@@ -3159,113 +4471,221 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
3159
4471
|
}),
|
|
3160
4472
|
};
|
|
3161
4473
|
};
|
|
3162
|
-
exports.
|
|
4474
|
+
exports.PublicKeysApiAxiosParamCreator = PublicKeysApiAxiosParamCreator;
|
|
3163
4475
|
/**
|
|
3164
|
-
*
|
|
4476
|
+
* PublicKeysApi - functional programming interface
|
|
3165
4477
|
* @export
|
|
3166
4478
|
*/
|
|
3167
|
-
const
|
|
3168
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
4479
|
+
const PublicKeysApiFp = function (configuration) {
|
|
4480
|
+
const localVarAxiosParamCreator = (0, exports.PublicKeysApiAxiosParamCreator)(configuration);
|
|
3169
4481
|
return {
|
|
3170
4482
|
/**
|
|
3171
|
-
*
|
|
3172
|
-
* @summary
|
|
3173
|
-
* @param {
|
|
4483
|
+
* Creating a public key is the way for your organization to share it with Tremendous. > 🔒 Generating asymmetric keys > > **We recommend using [OpenSSL](https://www.openssl.org/).** > > 1. Generate a private key and a public key in PEM: > `openssl genrsa -out tremendous_key.pem 4096` > > 2. Extract the public key in PEM format: > `openssl rsa -in tremendous_key.pem -outform PEM -pubout -out tremendous_key.pem.pub` > > 3. And, before making your request, encode it as a `base64` string: > `base64 -i tremendous_key.pem.pub` <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\">public_key</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Base64 encoded (public) PEM file</p> </td></tr> </tbody> </table> </div>
|
|
4484
|
+
* @summary Create public key
|
|
4485
|
+
* @param {CreatePublicKeyRequest} createPublicKeyRequest Public key details
|
|
3174
4486
|
* @param {*} [options] Override http request option.
|
|
3175
4487
|
* @throws {RequiredError}
|
|
3176
4488
|
*/
|
|
3177
|
-
|
|
4489
|
+
createPublicKey(createPublicKeyRequest, options) {
|
|
3178
4490
|
return __awaiter(this, void 0, void 0, function* () {
|
|
3179
4491
|
var _a, _b, _c;
|
|
3180
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
4492
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createPublicKey(createPublicKeyRequest, options);
|
|
3181
4493
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3182
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['
|
|
4494
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PublicKeysApi.createPublicKey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3183
4495
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3184
4496
|
});
|
|
3185
4497
|
},
|
|
3186
4498
|
/**
|
|
3187
|
-
*
|
|
3188
|
-
* @summary
|
|
3189
|
-
* @param {string}
|
|
3190
|
-
* @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
4499
|
+
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
4500
|
+
* @summary Delete public key
|
|
4501
|
+
* @param {string} id ID of the public key that should be deactivated
|
|
3191
4502
|
* @param {*} [options] Override http request option.
|
|
3192
4503
|
* @throws {RequiredError}
|
|
3193
4504
|
*/
|
|
3194
|
-
|
|
4505
|
+
deletePublicKey(id, options) {
|
|
3195
4506
|
return __awaiter(this, void 0, void 0, function* () {
|
|
3196
4507
|
var _a, _b, _c;
|
|
3197
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
4508
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePublicKey(id, options);
|
|
3198
4509
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3199
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['
|
|
4510
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PublicKeysApi.deletePublicKey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4511
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4512
|
+
});
|
|
4513
|
+
},
|
|
4514
|
+
/**
|
|
4515
|
+
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
4516
|
+
* @summary Retrieve public key
|
|
4517
|
+
* @param {string} id ID of the public key that should be retrieved
|
|
4518
|
+
* @param {*} [options] Override http request option.
|
|
4519
|
+
* @throws {RequiredError}
|
|
4520
|
+
*/
|
|
4521
|
+
getPublicKey(id, options) {
|
|
4522
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4523
|
+
var _a, _b, _c;
|
|
4524
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPublicKey(id, options);
|
|
4525
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4526
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PublicKeysApi.getPublicKey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4527
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4528
|
+
});
|
|
4529
|
+
},
|
|
4530
|
+
/**
|
|
4531
|
+
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
4532
|
+
* @summary List public keys
|
|
4533
|
+
* @param {*} [options] Override http request option.
|
|
4534
|
+
* @throws {RequiredError}
|
|
4535
|
+
*/
|
|
4536
|
+
listPublicKeys(options) {
|
|
4537
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4538
|
+
var _a, _b, _c;
|
|
4539
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPublicKeys(options);
|
|
4540
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4541
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PublicKeysApi.listPublicKeys']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4542
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4543
|
+
});
|
|
4544
|
+
},
|
|
4545
|
+
/**
|
|
4546
|
+
* 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.
|
|
4547
|
+
* @summary Test public key
|
|
4548
|
+
* @param {string} id ID of the public key to test
|
|
4549
|
+
* @param {TestPublicKeyRequest} testPublicKeyRequest
|
|
4550
|
+
* @param {*} [options] Override http request option.
|
|
4551
|
+
* @throws {RequiredError}
|
|
4552
|
+
*/
|
|
4553
|
+
testPublicKey(id, testPublicKeyRequest, options) {
|
|
4554
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4555
|
+
var _a, _b, _c;
|
|
4556
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.testPublicKey(id, testPublicKeyRequest, options);
|
|
4557
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4558
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PublicKeysApi.testPublicKey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3200
4559
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3201
4560
|
});
|
|
3202
4561
|
},
|
|
3203
4562
|
};
|
|
3204
4563
|
};
|
|
3205
|
-
exports.
|
|
4564
|
+
exports.PublicKeysApiFp = PublicKeysApiFp;
|
|
3206
4565
|
/**
|
|
3207
|
-
*
|
|
4566
|
+
* PublicKeysApi - factory interface
|
|
3208
4567
|
* @export
|
|
3209
4568
|
*/
|
|
3210
|
-
const
|
|
3211
|
-
const localVarFp = (0, exports.
|
|
4569
|
+
const PublicKeysApiFactory = function (configuration, basePath, axios) {
|
|
4570
|
+
const localVarFp = (0, exports.PublicKeysApiFp)(configuration);
|
|
3212
4571
|
return {
|
|
3213
4572
|
/**
|
|
3214
|
-
*
|
|
3215
|
-
* @summary
|
|
3216
|
-
* @param {
|
|
4573
|
+
* Creating a public key is the way for your organization to share it with Tremendous. > 🔒 Generating asymmetric keys > > **We recommend using [OpenSSL](https://www.openssl.org/).** > > 1. Generate a private key and a public key in PEM: > `openssl genrsa -out tremendous_key.pem 4096` > > 2. Extract the public key in PEM format: > `openssl rsa -in tremendous_key.pem -outform PEM -pubout -out tremendous_key.pem.pub` > > 3. And, before making your request, encode it as a `base64` string: > `base64 -i tremendous_key.pem.pub` <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\">public_key</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Base64 encoded (public) PEM file</p> </td></tr> </tbody> </table> </div>
|
|
4574
|
+
* @summary Create public key
|
|
4575
|
+
* @param {CreatePublicKeyRequest} createPublicKeyRequest Public key details
|
|
3217
4576
|
* @param {*} [options] Override http request option.
|
|
3218
4577
|
* @throws {RequiredError}
|
|
3219
4578
|
*/
|
|
3220
|
-
|
|
3221
|
-
return localVarFp.
|
|
4579
|
+
createPublicKey(createPublicKeyRequest, options) {
|
|
4580
|
+
return localVarFp.createPublicKey(createPublicKeyRequest, options).then((request) => request(axios, basePath));
|
|
3222
4581
|
},
|
|
3223
4582
|
/**
|
|
3224
|
-
*
|
|
3225
|
-
* @summary
|
|
3226
|
-
* @param {string}
|
|
3227
|
-
* @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
4583
|
+
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
4584
|
+
* @summary Delete public key
|
|
4585
|
+
* @param {string} id ID of the public key that should be deactivated
|
|
3228
4586
|
* @param {*} [options] Override http request option.
|
|
3229
4587
|
* @throws {RequiredError}
|
|
3230
4588
|
*/
|
|
3231
|
-
|
|
3232
|
-
return localVarFp.
|
|
4589
|
+
deletePublicKey(id, options) {
|
|
4590
|
+
return localVarFp.deletePublicKey(id, options).then((request) => request(axios, basePath));
|
|
4591
|
+
},
|
|
4592
|
+
/**
|
|
4593
|
+
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
4594
|
+
* @summary Retrieve public key
|
|
4595
|
+
* @param {string} id ID of the public key that should be retrieved
|
|
4596
|
+
* @param {*} [options] Override http request option.
|
|
4597
|
+
* @throws {RequiredError}
|
|
4598
|
+
*/
|
|
4599
|
+
getPublicKey(id, options) {
|
|
4600
|
+
return localVarFp.getPublicKey(id, options).then((request) => request(axios, basePath));
|
|
4601
|
+
},
|
|
4602
|
+
/**
|
|
4603
|
+
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
4604
|
+
* @summary List public keys
|
|
4605
|
+
* @param {*} [options] Override http request option.
|
|
4606
|
+
* @throws {RequiredError}
|
|
4607
|
+
*/
|
|
4608
|
+
listPublicKeys(options) {
|
|
4609
|
+
return localVarFp.listPublicKeys(options).then((request) => request(axios, basePath));
|
|
4610
|
+
},
|
|
4611
|
+
/**
|
|
4612
|
+
* 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.
|
|
4613
|
+
* @summary Test public key
|
|
4614
|
+
* @param {string} id ID of the public key to test
|
|
4615
|
+
* @param {TestPublicKeyRequest} testPublicKeyRequest
|
|
4616
|
+
* @param {*} [options] Override http request option.
|
|
4617
|
+
* @throws {RequiredError}
|
|
4618
|
+
*/
|
|
4619
|
+
testPublicKey(id, testPublicKeyRequest, options) {
|
|
4620
|
+
return localVarFp.testPublicKey(id, testPublicKeyRequest, options).then((request) => request(axios, basePath));
|
|
3233
4621
|
},
|
|
3234
4622
|
};
|
|
3235
4623
|
};
|
|
3236
|
-
exports.
|
|
4624
|
+
exports.PublicKeysApiFactory = PublicKeysApiFactory;
|
|
3237
4625
|
/**
|
|
3238
|
-
*
|
|
4626
|
+
* PublicKeysApi - object-oriented interface
|
|
3239
4627
|
* @export
|
|
3240
|
-
* @class
|
|
4628
|
+
* @class PublicKeysApi
|
|
3241
4629
|
* @extends {BaseAPI}
|
|
3242
4630
|
*/
|
|
3243
|
-
class
|
|
4631
|
+
class PublicKeysApi extends base_1.BaseAPI {
|
|
3244
4632
|
/**
|
|
3245
|
-
*
|
|
3246
|
-
* @summary
|
|
3247
|
-
* @param {
|
|
4633
|
+
* Creating a public key is the way for your organization to share it with Tremendous. > 🔒 Generating asymmetric keys > > **We recommend using [OpenSSL](https://www.openssl.org/).** > > 1. Generate a private key and a public key in PEM: > `openssl genrsa -out tremendous_key.pem 4096` > > 2. Extract the public key in PEM format: > `openssl rsa -in tremendous_key.pem -outform PEM -pubout -out tremendous_key.pem.pub` > > 3. And, before making your request, encode it as a `base64` string: > `base64 -i tremendous_key.pem.pub` <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\">public_key</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Base64 encoded (public) PEM file</p> </td></tr> </tbody> </table> </div>
|
|
4634
|
+
* @summary Create public key
|
|
4635
|
+
* @param {CreatePublicKeyRequest} createPublicKeyRequest Public key details
|
|
3248
4636
|
* @param {*} [options] Override http request option.
|
|
3249
4637
|
* @throws {RequiredError}
|
|
3250
|
-
* @memberof
|
|
4638
|
+
* @memberof PublicKeysApi
|
|
3251
4639
|
*/
|
|
3252
|
-
|
|
3253
|
-
return (0, exports.
|
|
4640
|
+
createPublicKey(createPublicKeyRequest, options) {
|
|
4641
|
+
return (0, exports.PublicKeysApiFp)(this.configuration).createPublicKey(createPublicKeyRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3254
4642
|
}
|
|
3255
4643
|
/**
|
|
3256
|
-
*
|
|
3257
|
-
* @summary
|
|
3258
|
-
* @param {string}
|
|
3259
|
-
* @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
4644
|
+
* Deactivates a public key. Any further attempt to verify a request signature with this key will fail.
|
|
4645
|
+
* @summary Delete public key
|
|
4646
|
+
* @param {string} id ID of the public key that should be deactivated
|
|
3260
4647
|
* @param {*} [options] Override http request option.
|
|
3261
4648
|
* @throws {RequiredError}
|
|
3262
|
-
* @memberof
|
|
4649
|
+
* @memberof PublicKeysApi
|
|
3263
4650
|
*/
|
|
3264
|
-
|
|
3265
|
-
return (0, exports.
|
|
4651
|
+
deletePublicKey(id, options) {
|
|
4652
|
+
return (0, exports.PublicKeysApiFp)(this.configuration).deletePublicKey(id, options).then((request) => request(this.axios, this.basePath));
|
|
4653
|
+
}
|
|
4654
|
+
/**
|
|
4655
|
+
* Retrieve an active public key, identified by the given `id` in the URL.
|
|
4656
|
+
* @summary Retrieve public key
|
|
4657
|
+
* @param {string} id ID of the public key that should be retrieved
|
|
4658
|
+
* @param {*} [options] Override http request option.
|
|
4659
|
+
* @throws {RequiredError}
|
|
4660
|
+
* @memberof PublicKeysApi
|
|
4661
|
+
*/
|
|
4662
|
+
getPublicKey(id, options) {
|
|
4663
|
+
return (0, exports.PublicKeysApiFp)(this.configuration).getPublicKey(id, options).then((request) => request(this.axios, this.basePath));
|
|
4664
|
+
}
|
|
4665
|
+
/**
|
|
4666
|
+
* Fetch a list of active public keys on your account. > 🚧 Inactive public keys are omitted > > The response does not include inactive public keys.
|
|
4667
|
+
* @summary List public keys
|
|
4668
|
+
* @param {*} [options] Override http request option.
|
|
4669
|
+
* @throws {RequiredError}
|
|
4670
|
+
* @memberof PublicKeysApi
|
|
4671
|
+
*/
|
|
4672
|
+
listPublicKeys(options) {
|
|
4673
|
+
return (0, exports.PublicKeysApiFp)(this.configuration).listPublicKeys(options).then((request) => request(this.axios, this.basePath));
|
|
4674
|
+
}
|
|
4675
|
+
/**
|
|
4676
|
+
* 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.
|
|
4677
|
+
* @summary Test public key
|
|
4678
|
+
* @param {string} id ID of the public key to test
|
|
4679
|
+
* @param {TestPublicKeyRequest} testPublicKeyRequest
|
|
4680
|
+
* @param {*} [options] Override http request option.
|
|
4681
|
+
* @throws {RequiredError}
|
|
4682
|
+
* @memberof PublicKeysApi
|
|
4683
|
+
*/
|
|
4684
|
+
testPublicKey(id, testPublicKeyRequest, options) {
|
|
4685
|
+
return (0, exports.PublicKeysApiFp)(this.configuration).testPublicKey(id, testPublicKeyRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3266
4686
|
}
|
|
3267
4687
|
}
|
|
3268
|
-
exports.
|
|
4688
|
+
exports.PublicKeysApi = PublicKeysApi;
|
|
3269
4689
|
/**
|
|
3270
4690
|
* RewardsApi - axios parameter creator
|
|
3271
4691
|
* @export
|
|
@@ -3311,7 +4731,7 @@ const RewardsApiAxiosParamCreator = function (configuration) {
|
|
|
3311
4731
|
* @param {*} [options] Override http request option.
|
|
3312
4732
|
* @throws {RequiredError}
|
|
3313
4733
|
*/
|
|
3314
|
-
generateRewardToken: (
|
|
4734
|
+
generateRewardToken: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
3315
4735
|
// verify required parameter 'id' is not null or undefined
|
|
3316
4736
|
(0, common_1.assertParamExists)('generateRewardToken', 'id', id);
|
|
3317
4737
|
const localVarPath = `/rewards/{id}/generate_embed_token`
|
|
@@ -3343,7 +4763,7 @@ const RewardsApiAxiosParamCreator = function (configuration) {
|
|
|
3343
4763
|
* @param {*} [options] Override http request option.
|
|
3344
4764
|
* @throws {RequiredError}
|
|
3345
4765
|
*/
|
|
3346
|
-
getReward: (
|
|
4766
|
+
getReward: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
3347
4767
|
// verify required parameter 'id' is not null or undefined
|
|
3348
4768
|
(0, common_1.assertParamExists)('getReward', 'id', id);
|
|
3349
4769
|
const localVarPath = `/rewards/{id}`
|
|
@@ -3375,7 +4795,7 @@ const RewardsApiAxiosParamCreator = function (configuration) {
|
|
|
3375
4795
|
* @param {*} [options] Override http request option.
|
|
3376
4796
|
* @throws {RequiredError}
|
|
3377
4797
|
*/
|
|
3378
|
-
listRewards: (offset_1, ...
|
|
4798
|
+
listRewards: (offset_1, ...args_1) => __awaiter(this, [offset_1, ...args_1], void 0, function* (offset, options = {}) {
|
|
3379
4799
|
const localVarPath = `/rewards`;
|
|
3380
4800
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3381
4801
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -3407,7 +4827,7 @@ const RewardsApiAxiosParamCreator = function (configuration) {
|
|
|
3407
4827
|
* @param {*} [options] Override http request option.
|
|
3408
4828
|
* @throws {RequiredError}
|
|
3409
4829
|
*/
|
|
3410
|
-
resendReward: (
|
|
4830
|
+
resendReward: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
3411
4831
|
// verify required parameter 'id' is not null or undefined
|
|
3412
4832
|
(0, common_1.assertParamExists)('resendReward', 'id', id);
|
|
3413
4833
|
const localVarPath = `/rewards/{id}/resend`
|
|
@@ -3649,6 +5069,106 @@ class RewardsApi extends base_1.BaseAPI {
|
|
|
3649
5069
|
}
|
|
3650
5070
|
}
|
|
3651
5071
|
exports.RewardsApi = RewardsApi;
|
|
5072
|
+
/**
|
|
5073
|
+
* RolesApi - axios parameter creator
|
|
5074
|
+
* @export
|
|
5075
|
+
*/
|
|
5076
|
+
const RolesApiAxiosParamCreator = function (configuration) {
|
|
5077
|
+
return {
|
|
5078
|
+
/**
|
|
5079
|
+
* List all available roles in the organization.
|
|
5080
|
+
* @summary List roles
|
|
5081
|
+
* @param {*} [options] Override http request option.
|
|
5082
|
+
* @throws {RequiredError}
|
|
5083
|
+
*/
|
|
5084
|
+
listRoles: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
5085
|
+
const localVarPath = `/roles`;
|
|
5086
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5087
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5088
|
+
let baseOptions;
|
|
5089
|
+
if (configuration) {
|
|
5090
|
+
baseOptions = configuration.baseOptions;
|
|
5091
|
+
}
|
|
5092
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
5093
|
+
const localVarHeaderParameter = {};
|
|
5094
|
+
const localVarQueryParameter = {};
|
|
5095
|
+
// authentication BearerApiKey required
|
|
5096
|
+
// http bearer authentication required
|
|
5097
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
5098
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5099
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5100
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5101
|
+
return {
|
|
5102
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5103
|
+
options: localVarRequestOptions,
|
|
5104
|
+
};
|
|
5105
|
+
}),
|
|
5106
|
+
};
|
|
5107
|
+
};
|
|
5108
|
+
exports.RolesApiAxiosParamCreator = RolesApiAxiosParamCreator;
|
|
5109
|
+
/**
|
|
5110
|
+
* RolesApi - functional programming interface
|
|
5111
|
+
* @export
|
|
5112
|
+
*/
|
|
5113
|
+
const RolesApiFp = function (configuration) {
|
|
5114
|
+
const localVarAxiosParamCreator = (0, exports.RolesApiAxiosParamCreator)(configuration);
|
|
5115
|
+
return {
|
|
5116
|
+
/**
|
|
5117
|
+
* List all available roles in the organization.
|
|
5118
|
+
* @summary List roles
|
|
5119
|
+
* @param {*} [options] Override http request option.
|
|
5120
|
+
* @throws {RequiredError}
|
|
5121
|
+
*/
|
|
5122
|
+
listRoles(options) {
|
|
5123
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5124
|
+
var _a, _b, _c;
|
|
5125
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listRoles(options);
|
|
5126
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5127
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RolesApi.listRoles']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5128
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5129
|
+
});
|
|
5130
|
+
},
|
|
5131
|
+
};
|
|
5132
|
+
};
|
|
5133
|
+
exports.RolesApiFp = RolesApiFp;
|
|
5134
|
+
/**
|
|
5135
|
+
* RolesApi - factory interface
|
|
5136
|
+
* @export
|
|
5137
|
+
*/
|
|
5138
|
+
const RolesApiFactory = function (configuration, basePath, axios) {
|
|
5139
|
+
const localVarFp = (0, exports.RolesApiFp)(configuration);
|
|
5140
|
+
return {
|
|
5141
|
+
/**
|
|
5142
|
+
* List all available roles in the organization.
|
|
5143
|
+
* @summary List roles
|
|
5144
|
+
* @param {*} [options] Override http request option.
|
|
5145
|
+
* @throws {RequiredError}
|
|
5146
|
+
*/
|
|
5147
|
+
listRoles(options) {
|
|
5148
|
+
return localVarFp.listRoles(options).then((request) => request(axios, basePath));
|
|
5149
|
+
},
|
|
5150
|
+
};
|
|
5151
|
+
};
|
|
5152
|
+
exports.RolesApiFactory = RolesApiFactory;
|
|
5153
|
+
/**
|
|
5154
|
+
* RolesApi - object-oriented interface
|
|
5155
|
+
* @export
|
|
5156
|
+
* @class RolesApi
|
|
5157
|
+
* @extends {BaseAPI}
|
|
5158
|
+
*/
|
|
5159
|
+
class RolesApi extends base_1.BaseAPI {
|
|
5160
|
+
/**
|
|
5161
|
+
* List all available roles in the organization.
|
|
5162
|
+
* @summary List roles
|
|
5163
|
+
* @param {*} [options] Override http request option.
|
|
5164
|
+
* @throws {RequiredError}
|
|
5165
|
+
* @memberof RolesApi
|
|
5166
|
+
*/
|
|
5167
|
+
listRoles(options) {
|
|
5168
|
+
return (0, exports.RolesApiFp)(this.configuration).listRoles(options).then((request) => request(this.axios, this.basePath));
|
|
5169
|
+
}
|
|
5170
|
+
}
|
|
5171
|
+
exports.RolesApi = RolesApi;
|
|
3652
5172
|
/**
|
|
3653
5173
|
* WebhooksApi - axios parameter creator
|
|
3654
5174
|
* @export
|
|
@@ -3688,6 +5208,38 @@ const WebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
3688
5208
|
options: localVarRequestOptions,
|
|
3689
5209
|
};
|
|
3690
5210
|
}),
|
|
5211
|
+
/**
|
|
5212
|
+
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
5213
|
+
* @summary Delete webhook
|
|
5214
|
+
* @param {string} id ID of the webhook to delete
|
|
5215
|
+
* @param {*} [options] Override http request option.
|
|
5216
|
+
* @throws {RequiredError}
|
|
5217
|
+
*/
|
|
5218
|
+
deleteWebhook: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
5219
|
+
// verify required parameter 'id' is not null or undefined
|
|
5220
|
+
(0, common_1.assertParamExists)('deleteWebhook', 'id', id);
|
|
5221
|
+
const localVarPath = `/webhooks/{id}`
|
|
5222
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
5223
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5224
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5225
|
+
let baseOptions;
|
|
5226
|
+
if (configuration) {
|
|
5227
|
+
baseOptions = configuration.baseOptions;
|
|
5228
|
+
}
|
|
5229
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
5230
|
+
const localVarHeaderParameter = {};
|
|
5231
|
+
const localVarQueryParameter = {};
|
|
5232
|
+
// authentication BearerApiKey required
|
|
5233
|
+
// http bearer authentication required
|
|
5234
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
5235
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5236
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5237
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5238
|
+
return {
|
|
5239
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5240
|
+
options: localVarRequestOptions,
|
|
5241
|
+
};
|
|
5242
|
+
}),
|
|
3691
5243
|
/**
|
|
3692
5244
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
3693
5245
|
* @summary Retrieve webhook
|
|
@@ -3695,7 +5247,7 @@ const WebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
3695
5247
|
* @param {*} [options] Override http request option.
|
|
3696
5248
|
* @throws {RequiredError}
|
|
3697
5249
|
*/
|
|
3698
|
-
getWebhook: (id_1, ...
|
|
5250
|
+
getWebhook: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
3699
5251
|
// verify required parameter 'id' is not null or undefined
|
|
3700
5252
|
(0, common_1.assertParamExists)('getWebhook', 'id', id);
|
|
3701
5253
|
const localVarPath = `/webhooks/{id}`
|
|
@@ -3727,7 +5279,7 @@ const WebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
3727
5279
|
* @param {*} [options] Override http request option.
|
|
3728
5280
|
* @throws {RequiredError}
|
|
3729
5281
|
*/
|
|
3730
|
-
listWebhookEvents: (
|
|
5282
|
+
listWebhookEvents: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
3731
5283
|
// verify required parameter 'id' is not null or undefined
|
|
3732
5284
|
(0, common_1.assertParamExists)('listWebhookEvents', 'id', id);
|
|
3733
5285
|
const localVarPath = `/webhooks/{id}/events`
|
|
@@ -3758,7 +5310,7 @@ const WebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
3758
5310
|
* @param {*} [options] Override http request option.
|
|
3759
5311
|
* @throws {RequiredError}
|
|
3760
5312
|
*/
|
|
3761
|
-
listWebhooks: (...
|
|
5313
|
+
listWebhooks: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
3762
5314
|
const localVarPath = `/webhooks`;
|
|
3763
5315
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3764
5316
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -3788,7 +5340,7 @@ const WebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
3788
5340
|
* @param {*} [options] Override http request option.
|
|
3789
5341
|
* @throws {RequiredError}
|
|
3790
5342
|
*/
|
|
3791
|
-
simulateWebhook: (
|
|
5343
|
+
simulateWebhook: (id_1, simulateWebhookRequest_1, ...args_1) => __awaiter(this, [id_1, simulateWebhookRequest_1, ...args_1], void 0, function* (id, simulateWebhookRequest, options = {}) {
|
|
3792
5344
|
// verify required parameter 'id' is not null or undefined
|
|
3793
5345
|
(0, common_1.assertParamExists)('simulateWebhook', 'id', id);
|
|
3794
5346
|
// verify required parameter 'simulateWebhookRequest' is not null or undefined
|
|
@@ -3843,6 +5395,22 @@ const WebhooksApiFp = function (configuration) {
|
|
|
3843
5395
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3844
5396
|
});
|
|
3845
5397
|
},
|
|
5398
|
+
/**
|
|
5399
|
+
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
5400
|
+
* @summary Delete webhook
|
|
5401
|
+
* @param {string} id ID of the webhook to delete
|
|
5402
|
+
* @param {*} [options] Override http request option.
|
|
5403
|
+
* @throws {RequiredError}
|
|
5404
|
+
*/
|
|
5405
|
+
deleteWebhook(id, options) {
|
|
5406
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5407
|
+
var _a, _b, _c;
|
|
5408
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteWebhook(id, options);
|
|
5409
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5410
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['WebhooksApi.deleteWebhook']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5411
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5412
|
+
});
|
|
5413
|
+
},
|
|
3846
5414
|
/**
|
|
3847
5415
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
3848
5416
|
* @summary Retrieve webhook
|
|
@@ -3927,6 +5495,16 @@ const WebhooksApiFactory = function (configuration, basePath, axios) {
|
|
|
3927
5495
|
createWebhook(createWebhookRequest, options) {
|
|
3928
5496
|
return localVarFp.createWebhook(createWebhookRequest, options).then((request) => request(axios, basePath));
|
|
3929
5497
|
},
|
|
5498
|
+
/**
|
|
5499
|
+
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
5500
|
+
* @summary Delete webhook
|
|
5501
|
+
* @param {string} id ID of the webhook to delete
|
|
5502
|
+
* @param {*} [options] Override http request option.
|
|
5503
|
+
* @throws {RequiredError}
|
|
5504
|
+
*/
|
|
5505
|
+
deleteWebhook(id, options) {
|
|
5506
|
+
return localVarFp.deleteWebhook(id, options).then((request) => request(axios, basePath));
|
|
5507
|
+
},
|
|
3930
5508
|
/**
|
|
3931
5509
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
3932
5510
|
* @summary Retrieve webhook
|
|
@@ -3988,6 +5566,17 @@ class WebhooksApi extends base_1.BaseAPI {
|
|
|
3988
5566
|
createWebhook(createWebhookRequest, options) {
|
|
3989
5567
|
return (0, exports.WebhooksApiFp)(this.configuration).createWebhook(createWebhookRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3990
5568
|
}
|
|
5569
|
+
/**
|
|
5570
|
+
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
5571
|
+
* @summary Delete webhook
|
|
5572
|
+
* @param {string} id ID of the webhook to delete
|
|
5573
|
+
* @param {*} [options] Override http request option.
|
|
5574
|
+
* @throws {RequiredError}
|
|
5575
|
+
* @memberof WebhooksApi
|
|
5576
|
+
*/
|
|
5577
|
+
deleteWebhook(id, options) {
|
|
5578
|
+
return (0, exports.WebhooksApiFp)(this.configuration).deleteWebhook(id, options).then((request) => request(this.axios, this.basePath));
|
|
5579
|
+
}
|
|
3991
5580
|
/**
|
|
3992
5581
|
* > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1)
|
|
3993
5582
|
* @summary Retrieve webhook
|