ultracart_rest_api_v2_typescript 4.1.91 → 4.1.94
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/.openapi-generator/FILES +14 -0
- package/README.md +5 -2
- package/dist/apis/AutoOrderApi.d.ts +24 -1
- package/dist/apis/AutoOrderApi.js +56 -0
- package/dist/apis/ConversationEmbedApi.js +3 -3
- package/dist/apis/FraudApi.d.ts +163 -0
- package/dist/apis/FraudApi.js +383 -0
- package/dist/apis/OauthApi.js +3 -3
- package/dist/apis/StorefrontApi.js +1 -1
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AutoOrderCancelReason.d.ts +43 -0
- package/dist/models/AutoOrderCancelReason.js +54 -0
- package/dist/models/AutoOrderCancelReasonsResponse.d.ts +59 -0
- package/dist/models/AutoOrderCancelReasonsResponse.js +62 -0
- package/dist/models/FraudDeclineEmailRequest.d.ts +31 -0
- package/dist/models/FraudDeclineEmailRequest.js +50 -0
- package/dist/models/FraudLookupValues.d.ts +61 -0
- package/dist/models/FraudLookupValues.js +60 -0
- package/dist/models/FraudLookupValuesResponse.d.ts +59 -0
- package/dist/models/FraudLookupValuesResponse.js +62 -0
- package/dist/models/FraudRuleInsertRequest.d.ts +291 -0
- package/dist/models/FraudRuleInsertRequest.js +189 -0
- package/dist/models/FraudRuleItemFilter.d.ts +37 -0
- package/dist/models/FraudRuleItemFilter.js +52 -0
- package/dist/models/FraudRulePublic.d.ts +350 -0
- package/dist/models/FraudRulePublic.js +219 -0
- package/dist/models/FraudRuleResponse.d.ts +59 -0
- package/dist/models/FraudRuleResponse.js +62 -0
- package/dist/models/FraudRuleRotatingTransactionGatewayFilter.d.ts +37 -0
- package/dist/models/FraudRuleRotatingTransactionGatewayFilter.js +52 -0
- package/dist/models/FraudRuleSearchRequest.d.ts +294 -0
- package/dist/models/FraudRuleSearchRequest.js +189 -0
- package/dist/models/FraudRuleStorefrontFilter.d.ts +37 -0
- package/dist/models/FraudRuleStorefrontFilter.js +52 -0
- package/dist/models/FraudRulesResponse.d.ts +59 -0
- package/dist/models/FraudRulesResponse.js +62 -0
- package/dist/models/ItemVariantItem.d.ts +6 -0
- package/dist/models/ItemVariantItem.js +2 -0
- package/dist/models/index.d.ts +13 -0
- package/dist/models/index.js +13 -0
- package/package.json +1 -1
- package/src/apis/AutoOrderApi.ts +55 -0
- package/src/apis/ConversationEmbedApi.ts +3 -3
- package/src/apis/FraudApi.ts +376 -0
- package/src/apis/OauthApi.ts +3 -3
- package/src/apis/StorefrontApi.ts +1 -1
- package/src/apis/index.ts +1 -0
- package/src/models/AutoOrderCancelReason.ts +83 -0
- package/src/models/AutoOrderCancelReasonsResponse.ts +124 -0
- package/src/models/FraudDeclineEmailRequest.ts +67 -0
- package/src/models/FraudLookupValues.ts +107 -0
- package/src/models/FraudLookupValuesResponse.ts +124 -0
- package/src/models/FraudRuleInsertRequest.ts +391 -0
- package/src/models/FraudRuleItemFilter.ts +75 -0
- package/src/models/FraudRulePublic.ts +481 -0
- package/src/models/FraudRuleResponse.ts +124 -0
- package/src/models/FraudRuleRotatingTransactionGatewayFilter.ts +75 -0
- package/src/models/FraudRuleSearchRequest.ts +395 -0
- package/src/models/FraudRuleStorefrontFilter.ts +75 -0
- package/src/models/FraudRulesResponse.ts +124 -0
- package/src/models/ItemVariantItem.ts +8 -0
- package/src/models/index.ts +13 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -11,6 +11,7 @@ src/apis/ConversationEmbedApi.ts
|
|
|
11
11
|
src/apis/CouponApi.ts
|
|
12
12
|
src/apis/CustomerApi.ts
|
|
13
13
|
src/apis/DatawarehouseApi.ts
|
|
14
|
+
src/apis/FraudApi.ts
|
|
14
15
|
src/apis/FulfillmentApi.ts
|
|
15
16
|
src/apis/GiftCertificateApi.ts
|
|
16
17
|
src/apis/IntegrationLogApi.ts
|
|
@@ -52,6 +53,8 @@ src/models/AutoOrder.ts
|
|
|
52
53
|
src/models/AutoOrderAddonItem.ts
|
|
53
54
|
src/models/AutoOrderAddonItemOption.ts
|
|
54
55
|
src/models/AutoOrderAddonItemsUpdateRequest.ts
|
|
56
|
+
src/models/AutoOrderCancelReason.ts
|
|
57
|
+
src/models/AutoOrderCancelReasonsResponse.ts
|
|
55
58
|
src/models/AutoOrderConsolidate.ts
|
|
56
59
|
src/models/AutoOrderEmail.ts
|
|
57
60
|
src/models/AutoOrderEmailsResponse.ts
|
|
@@ -606,6 +609,17 @@ src/models/FileManagerPage.ts
|
|
|
606
609
|
src/models/FileManagerPageResponse.ts
|
|
607
610
|
src/models/FileManagerUploadRequest.ts
|
|
608
611
|
src/models/FileManagerUploadUrlResponse.ts
|
|
612
|
+
src/models/FraudDeclineEmailRequest.ts
|
|
613
|
+
src/models/FraudLookupValues.ts
|
|
614
|
+
src/models/FraudLookupValuesResponse.ts
|
|
615
|
+
src/models/FraudRuleInsertRequest.ts
|
|
616
|
+
src/models/FraudRuleItemFilter.ts
|
|
617
|
+
src/models/FraudRulePublic.ts
|
|
618
|
+
src/models/FraudRuleResponse.ts
|
|
619
|
+
src/models/FraudRuleRotatingTransactionGatewayFilter.ts
|
|
620
|
+
src/models/FraudRuleSearchRequest.ts
|
|
621
|
+
src/models/FraudRuleStorefrontFilter.ts
|
|
622
|
+
src/models/FraudRulesResponse.ts
|
|
609
623
|
src/models/FulfillmentInventory.ts
|
|
610
624
|
src/models/FulfillmentShipment.ts
|
|
611
625
|
src/models/GeoPoint.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.94
|
|
3
3
|
|
|
4
4
|
Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
|
|
5
5
|
|
|
6
6
|
Installation
|
|
7
7
|
|
|
8
8
|
```
|
|
9
|
-
npm install ultracart_rest_api_v2_typescript@4.1.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.94 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,9 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.94 | 06/02/2026 | fraud api alpha version |
|
|
89
|
+
| 4.1.93 | 06/02/2026 | fraud api alpha version for testing |
|
|
90
|
+
| 4.1.92 | 05/26/2026 | AutoOrderApi.getAutoOrderCancelReasons |
|
|
88
91
|
| 4.1.91 | 05/18/2026 | ChannelPartner - support creation_dts on import of a store_completed (historical) order |
|
|
89
92
|
| 4.1.90 | 05/13/2026 | webhook rest api - new method getWebhookEventCategories |
|
|
90
93
|
| 4.1.89 | 05/11/2026 | auto order item level webhooks - cancel scheduled, cancel, pause, reactive, and unpause |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
|
|
13
|
+
import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderCancelReasonsResponse, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
|
|
14
14
|
export interface CancelAutoOrderItemByReferenceOrderIdRequest {
|
|
15
15
|
referenceOrderId: string;
|
|
16
16
|
originalItemId: string;
|
|
@@ -211,6 +211,19 @@ export interface AutoOrderApiInterface {
|
|
|
211
211
|
* Retrieve an auto order by order id
|
|
212
212
|
*/
|
|
213
213
|
getAutoOrderByReferenceOrderId(requestParameters: GetAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
214
|
+
/**
|
|
215
|
+
* Retrieves auto order cancel reasons.
|
|
216
|
+
* @summary Retrieve auto order cancel reasons.
|
|
217
|
+
* @param {*} [options] Override http request option.
|
|
218
|
+
* @throws {RequiredError}
|
|
219
|
+
* @memberof AutoOrderApiInterface
|
|
220
|
+
*/
|
|
221
|
+
getAutoOrderCancelReasonsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderCancelReasonsResponse>>;
|
|
222
|
+
/**
|
|
223
|
+
* Retrieves auto order cancel reasons.
|
|
224
|
+
* Retrieve auto order cancel reasons.
|
|
225
|
+
*/
|
|
226
|
+
getAutoOrderCancelReasons(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderCancelReasonsResponse>;
|
|
214
227
|
/**
|
|
215
228
|
* Retrieves email delivery records associated with the specified auto order.
|
|
216
229
|
* @summary Retrieve email delivery information for this auto order.
|
|
@@ -459,6 +472,16 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
|
|
|
459
472
|
* Retrieve an auto order by order id
|
|
460
473
|
*/
|
|
461
474
|
getAutoOrderByReferenceOrderId(requestParameters: GetAutoOrderByReferenceOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
|
|
475
|
+
/**
|
|
476
|
+
* Retrieves auto order cancel reasons.
|
|
477
|
+
* Retrieve auto order cancel reasons.
|
|
478
|
+
*/
|
|
479
|
+
getAutoOrderCancelReasonsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderCancelReasonsResponse>>;
|
|
480
|
+
/**
|
|
481
|
+
* Retrieves auto order cancel reasons.
|
|
482
|
+
* Retrieve auto order cancel reasons.
|
|
483
|
+
*/
|
|
484
|
+
getAutoOrderCancelReasons(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderCancelReasonsResponse>;
|
|
462
485
|
/**
|
|
463
486
|
* Retrieves email delivery records associated with the specified auto order.
|
|
464
487
|
* Retrieve email delivery information for this auto order.
|
|
@@ -457,6 +457,62 @@ var AutoOrderApi = /** @class */ (function (_super) {
|
|
|
457
457
|
});
|
|
458
458
|
});
|
|
459
459
|
};
|
|
460
|
+
/**
|
|
461
|
+
* Retrieves auto order cancel reasons.
|
|
462
|
+
* Retrieve auto order cancel reasons.
|
|
463
|
+
*/
|
|
464
|
+
AutoOrderApi.prototype.getAutoOrderCancelReasonsRaw = function (initOverrides) {
|
|
465
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
466
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
467
|
+
return __generator(this, function (_c) {
|
|
468
|
+
switch (_c.label) {
|
|
469
|
+
case 0:
|
|
470
|
+
queryParameters = {};
|
|
471
|
+
headerParameters = {};
|
|
472
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
473
|
+
// oauth required
|
|
474
|
+
_a = headerParameters;
|
|
475
|
+
_b = "Authorization";
|
|
476
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_read"])];
|
|
477
|
+
case 1:
|
|
478
|
+
// oauth required
|
|
479
|
+
_a[_b] = _c.sent();
|
|
480
|
+
_c.label = 2;
|
|
481
|
+
case 2:
|
|
482
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
483
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
484
|
+
}
|
|
485
|
+
return [4 /*yield*/, this.request({
|
|
486
|
+
path: "/auto_order/auto_orders/cancel_reasons",
|
|
487
|
+
method: 'GET',
|
|
488
|
+
headers: headerParameters,
|
|
489
|
+
query: queryParameters,
|
|
490
|
+
}, initOverrides)];
|
|
491
|
+
case 3:
|
|
492
|
+
response = _c.sent();
|
|
493
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.AutoOrderCancelReasonsResponseFromJSON)(jsonValue); })];
|
|
494
|
+
}
|
|
495
|
+
});
|
|
496
|
+
});
|
|
497
|
+
};
|
|
498
|
+
/**
|
|
499
|
+
* Retrieves auto order cancel reasons.
|
|
500
|
+
* Retrieve auto order cancel reasons.
|
|
501
|
+
*/
|
|
502
|
+
AutoOrderApi.prototype.getAutoOrderCancelReasons = function (initOverrides) {
|
|
503
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
504
|
+
var response;
|
|
505
|
+
return __generator(this, function (_a) {
|
|
506
|
+
switch (_a.label) {
|
|
507
|
+
case 0: return [4 /*yield*/, this.getAutoOrderCancelReasonsRaw(initOverrides)];
|
|
508
|
+
case 1:
|
|
509
|
+
response = _a.sent();
|
|
510
|
+
return [4 /*yield*/, response.value()];
|
|
511
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
512
|
+
}
|
|
513
|
+
});
|
|
514
|
+
});
|
|
515
|
+
};
|
|
460
516
|
/**
|
|
461
517
|
* Retrieves email delivery records associated with the specified auto order.
|
|
462
518
|
* Retrieve email delivery information for this auto order.
|
|
@@ -100,7 +100,7 @@ var ConversationEmbedApi = /** @class */ (function (_super) {
|
|
|
100
100
|
// oauth required
|
|
101
101
|
_a = headerParameters;
|
|
102
102
|
_b = "Authorization";
|
|
103
|
-
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"])];
|
|
103
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fraud_read", "fraud_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"])];
|
|
104
104
|
case 1:
|
|
105
105
|
// oauth required
|
|
106
106
|
_a[_b] = _c.sent();
|
|
@@ -181,7 +181,7 @@ var ConversationEmbedApi = /** @class */ (function (_super) {
|
|
|
181
181
|
// oauth required
|
|
182
182
|
_a = headerParameters;
|
|
183
183
|
_b = "Authorization";
|
|
184
|
-
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"])];
|
|
184
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fraud_read", "fraud_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"])];
|
|
185
185
|
case 1:
|
|
186
186
|
// oauth required
|
|
187
187
|
_a[_b] = _c.sent();
|
|
@@ -262,7 +262,7 @@ var ConversationEmbedApi = /** @class */ (function (_super) {
|
|
|
262
262
|
// oauth required
|
|
263
263
|
_a = headerParameters;
|
|
264
264
|
_b = "Authorization";
|
|
265
|
-
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"])];
|
|
265
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fraud_read", "fraud_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write"])];
|
|
266
266
|
case 1:
|
|
267
267
|
// oauth required
|
|
268
268
|
_a[_b] = _c.sent();
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import { FraudDeclineEmailRequest, FraudLookupValuesResponse, FraudRuleInsertRequest, FraudRuleResponse, FraudRuleSearchRequest, FraudRulesResponse } from '../models';
|
|
14
|
+
export interface DeclineEmailRequest {
|
|
15
|
+
fraudDeclineEmailsRequest: FraudDeclineEmailRequest;
|
|
16
|
+
}
|
|
17
|
+
export interface DeleteFraudRuleRequest {
|
|
18
|
+
fraudRuleOid: number;
|
|
19
|
+
}
|
|
20
|
+
export interface InsertFraudRuleRequest {
|
|
21
|
+
fraudRuleInsertRequest: FraudRuleInsertRequest;
|
|
22
|
+
}
|
|
23
|
+
export interface SearchFraudRulesRequest {
|
|
24
|
+
fraudRuleSearchRequest: FraudRuleSearchRequest;
|
|
25
|
+
limit?: number;
|
|
26
|
+
offset?: number;
|
|
27
|
+
sort?: string;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* FraudApi - interface
|
|
31
|
+
*
|
|
32
|
+
* @export
|
|
33
|
+
* @interface FraudApiInterface
|
|
34
|
+
*/
|
|
35
|
+
export interface FraudApiInterface {
|
|
36
|
+
/**
|
|
37
|
+
* Adds one or more email addresses to the fraud decline list for this merchant account.
|
|
38
|
+
* @summary Decline emails during checkout fraud review
|
|
39
|
+
* @param {FraudDeclineEmailRequest} fraudDeclineEmailsRequest Fraud decline emails request
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
* @memberof FraudApiInterface
|
|
43
|
+
*/
|
|
44
|
+
declineEmailRaw(requestParameters: DeclineEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
45
|
+
/**
|
|
46
|
+
* Adds one or more email addresses to the fraud decline list for this merchant account.
|
|
47
|
+
* Decline emails during checkout fraud review
|
|
48
|
+
*/
|
|
49
|
+
declineEmail(requestParameters: DeclineEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
50
|
+
/**
|
|
51
|
+
* Deletes a fraud rule for this merchant account.
|
|
52
|
+
* @summary Delete a fraud rule
|
|
53
|
+
* @param {number} fraudRuleOid
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
* @memberof FraudApiInterface
|
|
57
|
+
*/
|
|
58
|
+
deleteFraudRuleRaw(requestParameters: DeleteFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
59
|
+
/**
|
|
60
|
+
* Deletes a fraud rule for this merchant account.
|
|
61
|
+
* Delete a fraud rule
|
|
62
|
+
*/
|
|
63
|
+
deleteFraudRule(requestParameters: DeleteFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
64
|
+
/**
|
|
65
|
+
* Returns the dropdown values required to build valid fraud rule insert and search requests. Includes rule types, failure actions, user actions, IP range types, AVS match types, the merchant\'s rotating transaction gateways, screen branding themes, countries, and affiliates.
|
|
66
|
+
* @summary Retrieve fraud rule lookup values
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
* @memberof FraudApiInterface
|
|
70
|
+
*/
|
|
71
|
+
getFraudLookupValuesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FraudLookupValuesResponse>>;
|
|
72
|
+
/**
|
|
73
|
+
* Returns the dropdown values required to build valid fraud rule insert and search requests. Includes rule types, failure actions, user actions, IP range types, AVS match types, the merchant\'s rotating transaction gateways, screen branding themes, countries, and affiliates.
|
|
74
|
+
* Retrieve fraud rule lookup values
|
|
75
|
+
*/
|
|
76
|
+
getFraudLookupValues(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FraudLookupValuesResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* Creates a fraud rule for this merchant account. Field names in the request body are semantic (eg amount_threshold, email, ip_address). Call GET /v2/fraud/lookup_values for the list of valid rule_type, failure_action, and related dropdown values. The \'credit card matches\' rule type is not supported via REST.
|
|
79
|
+
* @summary Insert a fraud rule
|
|
80
|
+
* @param {FraudRuleInsertRequest} fraudRuleInsertRequest Fraud rule insert request
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
* @memberof FraudApiInterface
|
|
84
|
+
*/
|
|
85
|
+
insertFraudRuleRaw(requestParameters: InsertFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FraudRuleResponse>>;
|
|
86
|
+
/**
|
|
87
|
+
* Creates a fraud rule for this merchant account. Field names in the request body are semantic (eg amount_threshold, email, ip_address). Call GET /v2/fraud/lookup_values for the list of valid rule_type, failure_action, and related dropdown values. The \'credit card matches\' rule type is not supported via REST.
|
|
88
|
+
* Insert a fraud rule
|
|
89
|
+
*/
|
|
90
|
+
insertFraudRule(requestParameters: InsertFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FraudRuleResponse>;
|
|
91
|
+
/**
|
|
92
|
+
* Searches fraud rules for this merchant account using semantic filter fields. Pagination and sort are passed as query parameters (_limit, _offset, _sort). You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. Results are capped at 10,000 records by ElasticSearch and the warning slot indicates when that cap was hit. Use more selective filters in that case.
|
|
93
|
+
* @summary Search fraud rules
|
|
94
|
+
* @param {FraudRuleSearchRequest} fraudRuleSearchRequest Fraud rule search request
|
|
95
|
+
* @param {number} [limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
96
|
+
* @param {number} [offset] Pagination of the record set. Offset is a zero based index.
|
|
97
|
+
* @param {string} [sort] The sort order of the fraud rules. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
* @memberof FraudApiInterface
|
|
101
|
+
*/
|
|
102
|
+
searchFraudRulesRaw(requestParameters: SearchFraudRulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FraudRulesResponse>>;
|
|
103
|
+
/**
|
|
104
|
+
* Searches fraud rules for this merchant account using semantic filter fields. Pagination and sort are passed as query parameters (_limit, _offset, _sort). You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. Results are capped at 10,000 records by ElasticSearch and the warning slot indicates when that cap was hit. Use more selective filters in that case.
|
|
105
|
+
* Search fraud rules
|
|
106
|
+
*/
|
|
107
|
+
searchFraudRules(requestParameters: SearchFraudRulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FraudRulesResponse>;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
*
|
|
111
|
+
*/
|
|
112
|
+
export declare class FraudApi extends runtime.BaseAPI implements FraudApiInterface {
|
|
113
|
+
/**
|
|
114
|
+
* Adds one or more email addresses to the fraud decline list for this merchant account.
|
|
115
|
+
* Decline emails during checkout fraud review
|
|
116
|
+
*/
|
|
117
|
+
declineEmailRaw(requestParameters: DeclineEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
118
|
+
/**
|
|
119
|
+
* Adds one or more email addresses to the fraud decline list for this merchant account.
|
|
120
|
+
* Decline emails during checkout fraud review
|
|
121
|
+
*/
|
|
122
|
+
declineEmail(requestParameters: DeclineEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
123
|
+
/**
|
|
124
|
+
* Deletes a fraud rule for this merchant account.
|
|
125
|
+
* Delete a fraud rule
|
|
126
|
+
*/
|
|
127
|
+
deleteFraudRuleRaw(requestParameters: DeleteFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
128
|
+
/**
|
|
129
|
+
* Deletes a fraud rule for this merchant account.
|
|
130
|
+
* Delete a fraud rule
|
|
131
|
+
*/
|
|
132
|
+
deleteFraudRule(requestParameters: DeleteFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
133
|
+
/**
|
|
134
|
+
* Returns the dropdown values required to build valid fraud rule insert and search requests. Includes rule types, failure actions, user actions, IP range types, AVS match types, the merchant\'s rotating transaction gateways, screen branding themes, countries, and affiliates.
|
|
135
|
+
* Retrieve fraud rule lookup values
|
|
136
|
+
*/
|
|
137
|
+
getFraudLookupValuesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FraudLookupValuesResponse>>;
|
|
138
|
+
/**
|
|
139
|
+
* Returns the dropdown values required to build valid fraud rule insert and search requests. Includes rule types, failure actions, user actions, IP range types, AVS match types, the merchant\'s rotating transaction gateways, screen branding themes, countries, and affiliates.
|
|
140
|
+
* Retrieve fraud rule lookup values
|
|
141
|
+
*/
|
|
142
|
+
getFraudLookupValues(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FraudLookupValuesResponse>;
|
|
143
|
+
/**
|
|
144
|
+
* Creates a fraud rule for this merchant account. Field names in the request body are semantic (eg amount_threshold, email, ip_address). Call GET /v2/fraud/lookup_values for the list of valid rule_type, failure_action, and related dropdown values. The \'credit card matches\' rule type is not supported via REST.
|
|
145
|
+
* Insert a fraud rule
|
|
146
|
+
*/
|
|
147
|
+
insertFraudRuleRaw(requestParameters: InsertFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FraudRuleResponse>>;
|
|
148
|
+
/**
|
|
149
|
+
* Creates a fraud rule for this merchant account. Field names in the request body are semantic (eg amount_threshold, email, ip_address). Call GET /v2/fraud/lookup_values for the list of valid rule_type, failure_action, and related dropdown values. The \'credit card matches\' rule type is not supported via REST.
|
|
150
|
+
* Insert a fraud rule
|
|
151
|
+
*/
|
|
152
|
+
insertFraudRule(requestParameters: InsertFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FraudRuleResponse>;
|
|
153
|
+
/**
|
|
154
|
+
* Searches fraud rules for this merchant account using semantic filter fields. Pagination and sort are passed as query parameters (_limit, _offset, _sort). You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. Results are capped at 10,000 records by ElasticSearch and the warning slot indicates when that cap was hit. Use more selective filters in that case.
|
|
155
|
+
* Search fraud rules
|
|
156
|
+
*/
|
|
157
|
+
searchFraudRulesRaw(requestParameters: SearchFraudRulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FraudRulesResponse>>;
|
|
158
|
+
/**
|
|
159
|
+
* Searches fraud rules for this merchant account using semantic filter fields. Pagination and sort are passed as query parameters (_limit, _offset, _sort). You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. Results are capped at 10,000 records by ElasticSearch and the warning slot indicates when that cap was hit. Use more selective filters in that case.
|
|
160
|
+
* Search fraud rules
|
|
161
|
+
*/
|
|
162
|
+
searchFraudRules(requestParameters: SearchFraudRulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FraudRulesResponse>;
|
|
163
|
+
}
|