ultracart_rest_api_v2_typescript 4.1.96 → 4.1.97

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.
@@ -610,8 +610,12 @@ src/models/FileManagerPageResponse.ts
610
610
  src/models/FileManagerUploadRequest.ts
611
611
  src/models/FileManagerUploadUrlResponse.ts
612
612
  src/models/FraudDeclineEmailRequest.ts
613
+ src/models/FraudLookupAffiliate.ts
614
+ src/models/FraudLookupGateway.ts
615
+ src/models/FraudLookupTheme.ts
613
616
  src/models/FraudLookupValues.ts
614
617
  src/models/FraudLookupValuesResponse.ts
618
+ src/models/FraudRuleFromOrderRequest.ts
615
619
  src/models/FraudRuleInsertRequest.ts
616
620
  src/models/FraudRuleItemFilter.ts
617
621
  src/models/FraudRulePublic.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.96
2
+ ## ultracart_rest_api_v2_typescript@4.1.97
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.96 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.97 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.97 | 06/03/2026 | fraud api alpha version |
88
89
  | 4.1.96 | 06/03/2026 | fraud api alpha build |
89
90
  | 4.1.95 | 06/02/2026 | fraud api alpha version |
90
91
  | 4.1.94 | 06/02/2026 | fraud api alpha version |
@@ -10,13 +10,16 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { FraudDeclineEmailRequest, FraudLookupValuesResponse, FraudRuleInsertRequest, FraudRuleResponse, FraudRuleSearchRequest, FraudRulesResponse } from '../models';
13
+ import { FraudDeclineEmailRequest, FraudLookupValuesResponse, FraudRuleFromOrderRequest, FraudRuleInsertRequest, FraudRuleResponse, FraudRuleSearchRequest, FraudRulesResponse } from '../models';
14
14
  export interface DeclineEmailRequest {
15
15
  fraudDeclineEmailsRequest: FraudDeclineEmailRequest;
16
16
  }
17
17
  export interface DeleteFraudRuleRequest {
18
18
  fraudRuleOid: number;
19
19
  }
20
+ export interface EstablishFraudRulesFromOrderRequest {
21
+ fraudRuleFromOrderRequest: FraudRuleFromOrderRequest;
22
+ }
20
23
  export interface InsertFraudRuleRequest {
21
24
  fraudRuleInsertRequest: FraudRuleInsertRequest;
22
25
  }
@@ -34,8 +37,8 @@ export interface SearchFraudRulesRequest {
34
37
  */
35
38
  export interface FraudApiInterface {
36
39
  /**
37
- * Adds one or more email addresses to the fraud decline list for this merchant account.
38
- * @summary Decline emails during checkout fraud review
40
+ * Adds one email address to the fraud decline list for this merchant account.
41
+ * @summary Decline email during checkout fraud review
39
42
  * @param {FraudDeclineEmailRequest} fraudDeclineEmailsRequest Fraud decline emails request
40
43
  * @param {*} [options] Override http request option.
41
44
  * @throws {RequiredError}
@@ -43,8 +46,8 @@ export interface FraudApiInterface {
43
46
  */
44
47
  declineEmailRaw(requestParameters: DeclineEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
45
48
  /**
46
- * Adds one or more email addresses to the fraud decline list for this merchant account.
47
- * Decline emails during checkout fraud review
49
+ * Adds one email address to the fraud decline list for this merchant account.
50
+ * Decline email during checkout fraud review
48
51
  */
49
52
  declineEmail(requestParameters: DeclineEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
50
53
  /**
@@ -61,6 +64,20 @@ export interface FraudApiInterface {
61
64
  * Delete a fraud rule
62
65
  */
63
66
  deleteFraudRule(requestParameters: DeleteFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
67
+ /**
68
+ * Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the \'establish fraud filter\' action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order\'s /24 subnet (last octet masked). The credit card filter duplicates the order\'s stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request.
69
+ * @summary Establish fraud rules from an order
70
+ * @param {FraudRuleFromOrderRequest} fraudRuleFromOrderRequest Fraud rule from order request
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ * @memberof FraudApiInterface
74
+ */
75
+ establishFraudRulesFromOrderRaw(requestParameters: EstablishFraudRulesFromOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FraudRulesResponse>>;
76
+ /**
77
+ * Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the \'establish fraud filter\' action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order\'s /24 subnet (last octet masked). The credit card filter duplicates the order\'s stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request.
78
+ * Establish fraud rules from an order
79
+ */
80
+ establishFraudRulesFromOrder(requestParameters: EstablishFraudRulesFromOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FraudRulesResponse>;
64
81
  /**
65
82
  * 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
83
  * @summary Retrieve fraud rule lookup values
@@ -111,13 +128,13 @@ export interface FraudApiInterface {
111
128
  */
112
129
  export declare class FraudApi extends runtime.BaseAPI implements FraudApiInterface {
113
130
  /**
114
- * Adds one or more email addresses to the fraud decline list for this merchant account.
115
- * Decline emails during checkout fraud review
131
+ * Adds one email address to the fraud decline list for this merchant account.
132
+ * Decline email during checkout fraud review
116
133
  */
117
134
  declineEmailRaw(requestParameters: DeclineEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
118
135
  /**
119
- * Adds one or more email addresses to the fraud decline list for this merchant account.
120
- * Decline emails during checkout fraud review
136
+ * Adds one email address to the fraud decline list for this merchant account.
137
+ * Decline email during checkout fraud review
121
138
  */
122
139
  declineEmail(requestParameters: DeclineEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
123
140
  /**
@@ -130,6 +147,16 @@ export declare class FraudApi extends runtime.BaseAPI implements FraudApiInterfa
130
147
  * Delete a fraud rule
131
148
  */
132
149
  deleteFraudRule(requestParameters: DeleteFraudRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
150
+ /**
151
+ * Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the \'establish fraud filter\' action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order\'s /24 subnet (last octet masked). The credit card filter duplicates the order\'s stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request.
152
+ * Establish fraud rules from an order
153
+ */
154
+ establishFraudRulesFromOrderRaw(requestParameters: EstablishFraudRulesFromOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FraudRulesResponse>>;
155
+ /**
156
+ * Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the \'establish fraud filter\' action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order\'s /24 subnet (last octet masked). The credit card filter duplicates the order\'s stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request.
157
+ * Establish fraud rules from an order
158
+ */
159
+ establishFraudRulesFromOrder(requestParameters: EstablishFraudRulesFromOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FraudRulesResponse>;
133
160
  /**
134
161
  * 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
162
  * Retrieve fraud rule lookup values
@@ -76,8 +76,8 @@ var FraudApi = /** @class */ (function (_super) {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
78
  /**
79
- * Adds one or more email addresses to the fraud decline list for this merchant account.
80
- * Decline emails during checkout fraud review
79
+ * Adds one email address to the fraud decline list for this merchant account.
80
+ * Decline email during checkout fraud review
81
81
  */
82
82
  FraudApi.prototype.declineEmailRaw = function (requestParameters, initOverrides) {
83
83
  return __awaiter(this, void 0, void 0, function () {
@@ -119,8 +119,8 @@ var FraudApi = /** @class */ (function (_super) {
119
119
  });
120
120
  };
121
121
  /**
122
- * Adds one or more email addresses to the fraud decline list for this merchant account.
123
- * Decline emails during checkout fraud review
122
+ * Adds one email address to the fraud decline list for this merchant account.
123
+ * Decline email during checkout fraud review
124
124
  */
125
125
  FraudApi.prototype.declineEmail = function (requestParameters, initOverrides) {
126
126
  return __awaiter(this, void 0, void 0, function () {
@@ -191,6 +191,67 @@ var FraudApi = /** @class */ (function (_super) {
191
191
  });
192
192
  });
193
193
  };
194
+ /**
195
+ * Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the \'establish fraud filter\' action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order\'s /24 subnet (last octet masked). The credit card filter duplicates the order\'s stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request.
196
+ * Establish fraud rules from an order
197
+ */
198
+ FraudApi.prototype.establishFraudRulesFromOrderRaw = function (requestParameters, initOverrides) {
199
+ return __awaiter(this, void 0, void 0, function () {
200
+ var queryParameters, headerParameters, _a, _b, response;
201
+ return __generator(this, function (_c) {
202
+ switch (_c.label) {
203
+ case 0:
204
+ if (requestParameters.fraudRuleFromOrderRequest === null || requestParameters.fraudRuleFromOrderRequest === undefined) {
205
+ throw new runtime.RequiredError('fraudRuleFromOrderRequest', 'Required parameter requestParameters.fraudRuleFromOrderRequest was null or undefined when calling establishFraudRulesFromOrder.');
206
+ }
207
+ queryParameters = {};
208
+ headerParameters = {};
209
+ headerParameters['Content-Type'] = 'application/json';
210
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
211
+ // oauth required
212
+ _a = headerParameters;
213
+ _b = "Authorization";
214
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["fraud_write"])];
215
+ case 1:
216
+ // oauth required
217
+ _a[_b] = _c.sent();
218
+ _c.label = 2;
219
+ case 2:
220
+ if (this.configuration && this.configuration.apiKey) {
221
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
222
+ }
223
+ return [4 /*yield*/, this.request({
224
+ path: "/fraud/rules/from_order",
225
+ method: 'POST',
226
+ headers: headerParameters,
227
+ query: queryParameters,
228
+ body: (0, models_1.FraudRuleFromOrderRequestToJSON)(requestParameters.fraudRuleFromOrderRequest),
229
+ }, initOverrides)];
230
+ case 3:
231
+ response = _c.sent();
232
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.FraudRulesResponseFromJSON)(jsonValue); })];
233
+ }
234
+ });
235
+ });
236
+ };
237
+ /**
238
+ * Creates one or more fraud rules for this merchant account derived from an existing order, mirroring the \'establish fraud filter\' action in the order processing screen. Select which filters to establish; all values are taken from the order. The IP rule is created against the order\'s /24 subnet (last octet masked). The credit card filter duplicates the order\'s stored card vault token, so no card number is sent through the API. Filters whose order data is missing (no stored card, no email, no usable IP, or no numeric street) are skipped and reported in the warning slot rather than failing the request.
239
+ * Establish fraud rules from an order
240
+ */
241
+ FraudApi.prototype.establishFraudRulesFromOrder = function (requestParameters, initOverrides) {
242
+ return __awaiter(this, void 0, void 0, function () {
243
+ var response;
244
+ return __generator(this, function (_a) {
245
+ switch (_a.label) {
246
+ case 0: return [4 /*yield*/, this.establishFraudRulesFromOrderRaw(requestParameters, initOverrides)];
247
+ case 1:
248
+ response = _a.sent();
249
+ return [4 /*yield*/, response.value()];
250
+ case 2: return [2 /*return*/, _a.sent()];
251
+ }
252
+ });
253
+ });
254
+ };
194
255
  /**
195
256
  * 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.
196
257
  * Retrieve fraud rule lookup values
@@ -0,0 +1,37 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface FraudLookupAffiliate
16
+ */
17
+ export interface FraudLookupAffiliate {
18
+ /**
19
+ * Oid of the affiliate. Use this value in affiliate_oid on insert for the 'affiliate matches' rule type.
20
+ * @type {number}
21
+ * @memberof FraudLookupAffiliate
22
+ */
23
+ affiliate_oid?: number;
24
+ /**
25
+ * Email of the affiliate. May also be supplied as affiliate_email on insert in place of affiliate_oid.
26
+ * @type {string}
27
+ * @memberof FraudLookupAffiliate
28
+ */
29
+ email?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the FraudLookupAffiliate interface.
33
+ */
34
+ export declare function instanceOfFraudLookupAffiliate(value: object): boolean;
35
+ export declare function FraudLookupAffiliateFromJSON(json: any): FraudLookupAffiliate;
36
+ export declare function FraudLookupAffiliateFromJSONTyped(json: any, ignoreDiscriminator: boolean): FraudLookupAffiliate;
37
+ export declare function FraudLookupAffiliateToJSON(value?: FraudLookupAffiliate | null): any;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.FraudLookupAffiliateToJSON = exports.FraudLookupAffiliateFromJSONTyped = exports.FraudLookupAffiliateFromJSON = exports.instanceOfFraudLookupAffiliate = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the FraudLookupAffiliate interface.
20
+ */
21
+ function instanceOfFraudLookupAffiliate(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfFraudLookupAffiliate = instanceOfFraudLookupAffiliate;
26
+ function FraudLookupAffiliateFromJSON(json) {
27
+ return FraudLookupAffiliateFromJSONTyped(json, false);
28
+ }
29
+ exports.FraudLookupAffiliateFromJSON = FraudLookupAffiliateFromJSON;
30
+ function FraudLookupAffiliateFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'affiliate_oid': !(0, runtime_1.exists)(json, 'affiliate_oid') ? undefined : json['affiliate_oid'],
36
+ 'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
37
+ };
38
+ }
39
+ exports.FraudLookupAffiliateFromJSONTyped = FraudLookupAffiliateFromJSONTyped;
40
+ function FraudLookupAffiliateToJSON(value) {
41
+ if (value === undefined) {
42
+ return undefined;
43
+ }
44
+ if (value === null) {
45
+ return null;
46
+ }
47
+ return {
48
+ 'affiliate_oid': value.affiliate_oid,
49
+ 'email': value.email,
50
+ };
51
+ }
52
+ exports.FraudLookupAffiliateToJSON = FraudLookupAffiliateToJSON;
@@ -0,0 +1,43 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface FraudLookupGateway
16
+ */
17
+ export interface FraudLookupGateway {
18
+ /**
19
+ * Code of the rotating transaction gateway.
20
+ * @type {string}
21
+ * @memberof FraudLookupGateway
22
+ */
23
+ code?: string;
24
+ /**
25
+ * Display name of the rotating transaction gateway.
26
+ * @type {string}
27
+ * @memberof FraudLookupGateway
28
+ */
29
+ name?: string;
30
+ /**
31
+ * Oid of the rotating transaction gateway. Use this value in rotating_transaction_gateway_filters on insert.
32
+ * @type {number}
33
+ * @memberof FraudLookupGateway
34
+ */
35
+ rotating_transaction_gateway_oid?: number;
36
+ }
37
+ /**
38
+ * Check if a given object implements the FraudLookupGateway interface.
39
+ */
40
+ export declare function instanceOfFraudLookupGateway(value: object): boolean;
41
+ export declare function FraudLookupGatewayFromJSON(json: any): FraudLookupGateway;
42
+ export declare function FraudLookupGatewayFromJSONTyped(json: any, ignoreDiscriminator: boolean): FraudLookupGateway;
43
+ export declare function FraudLookupGatewayToJSON(value?: FraudLookupGateway | null): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.FraudLookupGatewayToJSON = exports.FraudLookupGatewayFromJSONTyped = exports.FraudLookupGatewayFromJSON = exports.instanceOfFraudLookupGateway = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the FraudLookupGateway interface.
20
+ */
21
+ function instanceOfFraudLookupGateway(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfFraudLookupGateway = instanceOfFraudLookupGateway;
26
+ function FraudLookupGatewayFromJSON(json) {
27
+ return FraudLookupGatewayFromJSONTyped(json, false);
28
+ }
29
+ exports.FraudLookupGatewayFromJSON = FraudLookupGatewayFromJSON;
30
+ function FraudLookupGatewayFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'code': !(0, runtime_1.exists)(json, 'code') ? undefined : json['code'],
36
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
37
+ 'rotating_transaction_gateway_oid': !(0, runtime_1.exists)(json, 'rotating_transaction_gateway_oid') ? undefined : json['rotating_transaction_gateway_oid'],
38
+ };
39
+ }
40
+ exports.FraudLookupGatewayFromJSONTyped = FraudLookupGatewayFromJSONTyped;
41
+ function FraudLookupGatewayToJSON(value) {
42
+ if (value === undefined) {
43
+ return undefined;
44
+ }
45
+ if (value === null) {
46
+ return null;
47
+ }
48
+ return {
49
+ 'code': value.code,
50
+ 'name': value.name,
51
+ 'rotating_transaction_gateway_oid': value.rotating_transaction_gateway_oid,
52
+ };
53
+ }
54
+ exports.FraudLookupGatewayToJSON = FraudLookupGatewayToJSON;
@@ -0,0 +1,43 @@
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface FraudLookupTheme
16
+ */
17
+ export interface FraudLookupTheme {
18
+ /**
19
+ * Code of the screen branding theme.
20
+ * @type {string}
21
+ * @memberof FraudLookupTheme
22
+ */
23
+ code?: string;
24
+ /**
25
+ * Oid of the screen branding theme. Use this value in screen_branding_theme_filters on insert.
26
+ * @type {number}
27
+ * @memberof FraudLookupTheme
28
+ */
29
+ screen_branding_theme_oid?: number;
30
+ /**
31
+ * Storefront hostname associated with this theme, when available.
32
+ * @type {string}
33
+ * @memberof FraudLookupTheme
34
+ */
35
+ storefront_hostname?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the FraudLookupTheme interface.
39
+ */
40
+ export declare function instanceOfFraudLookupTheme(value: object): boolean;
41
+ export declare function FraudLookupThemeFromJSON(json: any): FraudLookupTheme;
42
+ export declare function FraudLookupThemeFromJSONTyped(json: any, ignoreDiscriminator: boolean): FraudLookupTheme;
43
+ export declare function FraudLookupThemeToJSON(value?: FraudLookupTheme | null): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.FraudLookupThemeToJSON = exports.FraudLookupThemeFromJSONTyped = exports.FraudLookupThemeFromJSON = exports.instanceOfFraudLookupTheme = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the FraudLookupTheme interface.
20
+ */
21
+ function instanceOfFraudLookupTheme(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfFraudLookupTheme = instanceOfFraudLookupTheme;
26
+ function FraudLookupThemeFromJSON(json) {
27
+ return FraudLookupThemeFromJSONTyped(json, false);
28
+ }
29
+ exports.FraudLookupThemeFromJSON = FraudLookupThemeFromJSON;
30
+ function FraudLookupThemeFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'code': !(0, runtime_1.exists)(json, 'code') ? undefined : json['code'],
36
+ 'screen_branding_theme_oid': !(0, runtime_1.exists)(json, 'screen_branding_theme_oid') ? undefined : json['screen_branding_theme_oid'],
37
+ 'storefront_hostname': !(0, runtime_1.exists)(json, 'storefront_hostname') ? undefined : json['storefront_hostname'],
38
+ };
39
+ }
40
+ exports.FraudLookupThemeFromJSONTyped = FraudLookupThemeFromJSONTyped;
41
+ function FraudLookupThemeToJSON(value) {
42
+ if (value === undefined) {
43
+ return undefined;
44
+ }
45
+ if (value === null) {
46
+ return null;
47
+ }
48
+ return {
49
+ 'code': value.code,
50
+ 'screen_branding_theme_oid': value.screen_branding_theme_oid,
51
+ 'storefront_hostname': value.storefront_hostname,
52
+ };
53
+ }
54
+ exports.FraudLookupThemeToJSON = FraudLookupThemeToJSON;
@@ -9,6 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { FraudLookupAffiliate } from './FraudLookupAffiliate';
13
+ import { FraudLookupGateway } from './FraudLookupGateway';
14
+ import { FraudLookupTheme } from './FraudLookupTheme';
12
15
  /**
13
16
  *
14
17
  * @export
@@ -17,40 +20,70 @@
17
20
  export interface FraudLookupValues {
18
21
  /**
19
22
  * Affiliates with non-empty email, sorted by email.
20
- * @type {object}
23
+ * @type {Array<FraudLookupAffiliate>}
21
24
  * @memberof FraudLookupValues
22
25
  */
23
- affiliates?: object;
26
+ affiliates?: Array<FraudLookupAffiliate>;
27
+ /**
28
+ * Valid values for avs_match_type on the 'address street and zip avs' rule type.
29
+ * @type {Array<string>}
30
+ * @memberof FraudLookupValues
31
+ */
32
+ avs_match_types?: Array<string>;
24
33
  /**
25
34
  * ISO country codes available to this merchant.
26
- * @type {object}
35
+ * @type {Array<string>}
36
+ * @memberof FraudLookupValues
37
+ */
38
+ countries?: Array<string>;
39
+ /**
40
+ * Valid values for failure_action on insert and search requests.
41
+ * @type {Array<string>}
27
42
  * @memberof FraudLookupValues
28
43
  */
29
- countries?: object;
44
+ failure_actions?: Array<string>;
30
45
  /**
31
46
  * Valid values for ip_range_type on IP-based rules.
32
- * @type {object}
47
+ * @type {Array<string>}
33
48
  * @memberof FraudLookupValues
34
49
  */
35
- ip_range_types?: object;
50
+ ip_range_types?: Array<string>;
36
51
  /**
37
52
  * True when this merchant has at least one linked merchant account.
38
53
  * @type {boolean}
39
54
  * @memberof FraudLookupValues
40
55
  */
41
56
  linked_accounts?: boolean;
57
+ /**
58
+ * Rotating transaction gateways configured for this merchant. Use the oid as a value in rotating_transaction_gateway_filters on insert.
59
+ * @type {Array<FraudLookupGateway>}
60
+ * @memberof FraudLookupValues
61
+ */
62
+ rotating_transaction_gateways?: Array<FraudLookupGateway>;
42
63
  /**
43
64
  * Valid values for rule_group on search requests.
44
- * @type {object}
65
+ * @type {Array<string>}
45
66
  * @memberof FraudLookupValues
46
67
  */
47
- rule_groups?: object;
68
+ rule_groups?: Array<string>;
48
69
  /**
49
70
  * Valid values for rule_type on insert and search requests.
50
- * @type {object}
71
+ * @type {Array<string>}
72
+ * @memberof FraudLookupValues
73
+ */
74
+ rule_types?: Array<string>;
75
+ /**
76
+ * Screen branding themes configured for this merchant. Use the oid as a value in screen_branding_theme_filters on insert.
77
+ * @type {Array<FraudLookupTheme>}
78
+ * @memberof FraudLookupValues
79
+ */
80
+ screen_branding_themes?: Array<FraudLookupTheme>;
81
+ /**
82
+ * Valid values for user_action on rule types that distinguish between attempted and approved transactions.
83
+ * @type {Array<string>}
51
84
  * @memberof FraudLookupValues
52
85
  */
53
- rule_types?: object;
86
+ user_actions?: Array<string>;
54
87
  }
55
88
  /**
56
89
  * Check if a given object implements the FraudLookupValues interface.
@@ -15,6 +15,9 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.FraudLookupValuesToJSON = exports.FraudLookupValuesFromJSONTyped = exports.FraudLookupValuesFromJSON = exports.instanceOfFraudLookupValues = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ var FraudLookupAffiliate_1 = require("./FraudLookupAffiliate");
19
+ var FraudLookupGateway_1 = require("./FraudLookupGateway");
20
+ var FraudLookupTheme_1 = require("./FraudLookupTheme");
18
21
  /**
19
22
  * Check if a given object implements the FraudLookupValues interface.
20
23
  */
@@ -32,12 +35,17 @@ function FraudLookupValuesFromJSONTyped(json, ignoreDiscriminator) {
32
35
  return json;
33
36
  }
34
37
  return {
35
- 'affiliates': !(0, runtime_1.exists)(json, 'affiliates') ? undefined : json['affiliates'],
38
+ 'affiliates': !(0, runtime_1.exists)(json, 'affiliates') ? undefined : (json['affiliates'].map(FraudLookupAffiliate_1.FraudLookupAffiliateFromJSON)),
39
+ 'avs_match_types': !(0, runtime_1.exists)(json, 'avs_match_types') ? undefined : json['avs_match_types'],
36
40
  'countries': !(0, runtime_1.exists)(json, 'countries') ? undefined : json['countries'],
41
+ 'failure_actions': !(0, runtime_1.exists)(json, 'failure_actions') ? undefined : json['failure_actions'],
37
42
  'ip_range_types': !(0, runtime_1.exists)(json, 'ip_range_types') ? undefined : json['ip_range_types'],
38
43
  'linked_accounts': !(0, runtime_1.exists)(json, 'linked_accounts') ? undefined : json['linked_accounts'],
44
+ 'rotating_transaction_gateways': !(0, runtime_1.exists)(json, 'rotating_transaction_gateways') ? undefined : (json['rotating_transaction_gateways'].map(FraudLookupGateway_1.FraudLookupGatewayFromJSON)),
39
45
  'rule_groups': !(0, runtime_1.exists)(json, 'rule_groups') ? undefined : json['rule_groups'],
40
46
  'rule_types': !(0, runtime_1.exists)(json, 'rule_types') ? undefined : json['rule_types'],
47
+ 'screen_branding_themes': !(0, runtime_1.exists)(json, 'screen_branding_themes') ? undefined : (json['screen_branding_themes'].map(FraudLookupTheme_1.FraudLookupThemeFromJSON)),
48
+ 'user_actions': !(0, runtime_1.exists)(json, 'user_actions') ? undefined : json['user_actions'],
41
49
  };
42
50
  }
43
51
  exports.FraudLookupValuesFromJSONTyped = FraudLookupValuesFromJSONTyped;
@@ -49,12 +57,17 @@ function FraudLookupValuesToJSON(value) {
49
57
  return null;
50
58
  }
51
59
  return {
52
- 'affiliates': value.affiliates,
60
+ 'affiliates': value.affiliates === undefined ? undefined : (value.affiliates.map(FraudLookupAffiliate_1.FraudLookupAffiliateToJSON)),
61
+ 'avs_match_types': value.avs_match_types,
53
62
  'countries': value.countries,
63
+ 'failure_actions': value.failure_actions,
54
64
  'ip_range_types': value.ip_range_types,
55
65
  'linked_accounts': value.linked_accounts,
66
+ 'rotating_transaction_gateways': value.rotating_transaction_gateways === undefined ? undefined : (value.rotating_transaction_gateways.map(FraudLookupGateway_1.FraudLookupGatewayToJSON)),
56
67
  'rule_groups': value.rule_groups,
57
68
  'rule_types': value.rule_types,
69
+ 'screen_branding_themes': value.screen_branding_themes === undefined ? undefined : (value.screen_branding_themes.map(FraudLookupTheme_1.FraudLookupThemeToJSON)),
70
+ 'user_actions': value.user_actions,
58
71
  };
59
72
  }
60
73
  exports.FraudLookupValuesToJSON = FraudLookupValuesToJSON;