ultracart_rest_api_v2_typescript 4.1.117 → 4.1.119

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.
@@ -852,6 +852,7 @@ src/models/OrderProcessPaymentResponse.ts
852
852
  src/models/OrderProperty.ts
853
853
  src/models/OrderQuery.ts
854
854
  src/models/OrderQueryBatch.ts
855
+ src/models/OrderQueryPaymentTransactionFilter.ts
855
856
  src/models/OrderQuote.ts
856
857
  src/models/OrderReason.ts
857
858
  src/models/OrderRefundableResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.117
2
+ ## ultracart_rest_api_v2_typescript@4.1.119
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.117 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.119 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.119 | 07/15/2026 | order api - query transaction details for cache target |
89
+ | 4.1.118 | 07/14/2026 | affiliate - send welcome letter method |
88
90
  | 4.1.117 | 07/14/2026 | conversation - join method resolve_only flag added |
89
91
  | 4.1.116 | 07/10/2026 | customer - method to search quickbooks online customers |
90
92
  | 4.1.115 | 07/10/2026 | customer profile birthday |
@@ -38,8 +38,12 @@ export interface GetLedgersByQueryRequest {
38
38
  }
39
39
  export interface InsertAffiliateRequest {
40
40
  affiliate: Affiliate;
41
+ sendWelcomeEmail?: boolean;
41
42
  expand?: string;
42
43
  }
44
+ export interface SendAffiliateWelcomeEmailRequest {
45
+ affiliateOid: number;
46
+ }
43
47
  export interface UpdateAffiliateRequest {
44
48
  affiliateOid: number;
45
49
  affiliate: Affiliate;
@@ -136,6 +140,7 @@ export interface AffiliateApiInterface {
136
140
  * Insert an affiliate on the UltraCart account. The affiliate is created within the merchant\'s active affiliate program.
137
141
  * @summary Insert an affiliate
138
142
  * @param {Affiliate} affiliate Affiliate to insert
143
+ * @param {boolean} [sendWelcomeEmail] Whether to send a welcome email to the affiliate after it is created. Defaults to false.
139
144
  * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
140
145
  * @param {*} [options] Override http request option.
141
146
  * @throws {RequiredError}
@@ -147,6 +152,20 @@ export interface AffiliateApiInterface {
147
152
  * Insert an affiliate
148
153
  */
149
154
  insertAffiliate(requestParameters: InsertAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
155
+ /**
156
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
157
+ * @summary Send a welcome email to an affiliate
158
+ * @param {number} affiliateOid The affiliate oid to send the welcome email to.
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ * @memberof AffiliateApiInterface
162
+ */
163
+ sendAffiliateWelcomeEmailRaw(requestParameters: SendAffiliateWelcomeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
164
+ /**
165
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
166
+ * Send a welcome email to an affiliate
167
+ */
168
+ sendAffiliateWelcomeEmail(requestParameters: SendAffiliateWelcomeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
150
169
  /**
151
170
  * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
152
171
  * @summary Update an affiliate
@@ -228,6 +247,16 @@ export declare class AffiliateApi extends runtime.BaseAPI implements AffiliateAp
228
247
  * Insert an affiliate
229
248
  */
230
249
  insertAffiliate(requestParameters: InsertAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
250
+ /**
251
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
252
+ * Send a welcome email to an affiliate
253
+ */
254
+ sendAffiliateWelcomeEmailRaw(requestParameters: SendAffiliateWelcomeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
255
+ /**
256
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
257
+ * Send a welcome email to an affiliate
258
+ */
259
+ sendAffiliateWelcomeEmail(requestParameters: SendAffiliateWelcomeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
231
260
  /**
232
261
  * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
233
262
  * Update an affiliate
@@ -418,6 +418,9 @@ var AffiliateApi = /** @class */ (function (_super) {
418
418
  throw new runtime.RequiredError('affiliate', 'Required parameter requestParameters.affiliate was null or undefined when calling insertAffiliate.');
419
419
  }
420
420
  queryParameters = {};
421
+ if (requestParameters.sendWelcomeEmail !== undefined) {
422
+ queryParameters['send_welcome_email'] = requestParameters.sendWelcomeEmail;
423
+ }
421
424
  if (requestParameters.expand !== undefined) {
422
425
  queryParameters['_expand'] = requestParameters.expand;
423
426
  }
@@ -468,6 +471,63 @@ var AffiliateApi = /** @class */ (function (_super) {
468
471
  });
469
472
  });
470
473
  };
474
+ /**
475
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
476
+ * Send a welcome email to an affiliate
477
+ */
478
+ AffiliateApi.prototype.sendAffiliateWelcomeEmailRaw = function (requestParameters, initOverrides) {
479
+ return __awaiter(this, void 0, void 0, function () {
480
+ var queryParameters, headerParameters, _a, _b, response;
481
+ return __generator(this, function (_c) {
482
+ switch (_c.label) {
483
+ case 0:
484
+ if (requestParameters.affiliateOid === null || requestParameters.affiliateOid === undefined) {
485
+ throw new runtime.RequiredError('affiliateOid', 'Required parameter requestParameters.affiliateOid was null or undefined when calling sendAffiliateWelcomeEmail.');
486
+ }
487
+ queryParameters = {};
488
+ headerParameters = {};
489
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
490
+ // oauth required
491
+ _a = headerParameters;
492
+ _b = "Authorization";
493
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["affiliate_write"])];
494
+ case 1:
495
+ // oauth required
496
+ _a[_b] = _c.sent();
497
+ _c.label = 2;
498
+ case 2:
499
+ if (this.configuration && this.configuration.apiKey) {
500
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
501
+ }
502
+ return [4 /*yield*/, this.request({
503
+ path: "/affiliate/affiliates/{affiliate_oid}/welcome_email".replace("{".concat("affiliate_oid", "}"), encodeURIComponent(String(requestParameters.affiliateOid))),
504
+ method: 'POST',
505
+ headers: headerParameters,
506
+ query: queryParameters,
507
+ }, initOverrides)];
508
+ case 3:
509
+ response = _c.sent();
510
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
511
+ }
512
+ });
513
+ });
514
+ };
515
+ /**
516
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
517
+ * Send a welcome email to an affiliate
518
+ */
519
+ AffiliateApi.prototype.sendAffiliateWelcomeEmail = function (requestParameters, initOverrides) {
520
+ return __awaiter(this, void 0, void 0, function () {
521
+ return __generator(this, function (_a) {
522
+ switch (_a.label) {
523
+ case 0: return [4 /*yield*/, this.sendAffiliateWelcomeEmailRaw(requestParameters, initOverrides)];
524
+ case 1:
525
+ _a.sent();
526
+ return [2 /*return*/];
527
+ }
528
+ });
529
+ });
530
+ };
471
531
  /**
472
532
  * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
473
533
  * Update an affiliate
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { OrderQueryPaymentTransactionFilter } from './OrderQueryPaymentTransactionFilter';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -183,6 +184,12 @@ export interface OrderQuery {
183
184
  * @memberof OrderQuery
184
185
  */
185
186
  payment_method?: OrderQueryPaymentMethodEnum;
187
+ /**
188
+ * Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache which uses the ElasticSearch cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
189
+ * @type {Array<OrderQueryPaymentTransactionFilter>}
190
+ * @memberof OrderQuery
191
+ */
192
+ payment_transaction_filters?: Array<OrderQueryPaymentTransactionFilter>;
186
193
  /**
187
194
  * Phone
188
195
  * @type {string}
@@ -15,6 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.OrderQueryToJSON = exports.OrderQueryFromJSONTyped = exports.OrderQueryFromJSON = exports.instanceOfOrderQuery = exports.OrderQueryQueryTargetEnum = exports.OrderQueryPaymentMethodEnum = exports.OrderQueryCurrentStageEnum = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ var OrderQueryPaymentTransactionFilter_1 = require("./OrderQueryPaymentTransactionFilter");
18
19
  /**
19
20
  * @export
20
21
  */
@@ -107,6 +108,7 @@ function OrderQueryFromJSONTyped(json, ignoreDiscriminator) {
107
108
  'payment_date_begin': !(0, runtime_1.exists)(json, 'payment_date_begin') ? undefined : json['payment_date_begin'],
108
109
  'payment_date_end': !(0, runtime_1.exists)(json, 'payment_date_end') ? undefined : json['payment_date_end'],
109
110
  'payment_method': !(0, runtime_1.exists)(json, 'payment_method') ? undefined : json['payment_method'],
111
+ 'payment_transaction_filters': !(0, runtime_1.exists)(json, 'payment_transaction_filters') ? undefined : (json['payment_transaction_filters'].map(OrderQueryPaymentTransactionFilter_1.OrderQueryPaymentTransactionFilterFromJSON)),
110
112
  'phone': !(0, runtime_1.exists)(json, 'phone') ? undefined : json['phone'],
111
113
  'postal_code': !(0, runtime_1.exists)(json, 'postal_code') ? undefined : json['postal_code'],
112
114
  'purchase_order_number': !(0, runtime_1.exists)(json, 'purchase_order_number') ? undefined : json['purchase_order_number'],
@@ -161,6 +163,7 @@ function OrderQueryToJSON(value) {
161
163
  'payment_date_begin': value.payment_date_begin,
162
164
  'payment_date_end': value.payment_date_end,
163
165
  'payment_method': value.payment_method,
166
+ 'payment_transaction_filters': value.payment_transaction_filters === undefined ? undefined : (value.payment_transaction_filters.map(OrderQueryPaymentTransactionFilter_1.OrderQueryPaymentTransactionFilterToJSON)),
164
167
  'phone': value.phone,
165
168
  'postal_code': value.postal_code,
166
169
  'purchase_order_number': value.purchase_order_number,
@@ -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 OrderQueryPaymentTransactionFilter
16
+ */
17
+ export interface OrderQueryPaymentTransactionFilter {
18
+ /**
19
+ * Transaction detail name to match exactly. Optional, omit to match the value across any detail name.
20
+ * @type {string}
21
+ * @memberof OrderQueryPaymentTransactionFilter
22
+ */
23
+ name?: string;
24
+ /**
25
+ * Transaction detail value to match exactly. Required. Wildcards are not permitted.
26
+ * @type {string}
27
+ * @memberof OrderQueryPaymentTransactionFilter
28
+ */
29
+ value?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the OrderQueryPaymentTransactionFilter interface.
33
+ */
34
+ export declare function instanceOfOrderQueryPaymentTransactionFilter(value: object): boolean;
35
+ export declare function OrderQueryPaymentTransactionFilterFromJSON(json: any): OrderQueryPaymentTransactionFilter;
36
+ export declare function OrderQueryPaymentTransactionFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderQueryPaymentTransactionFilter;
37
+ export declare function OrderQueryPaymentTransactionFilterToJSON(value?: OrderQueryPaymentTransactionFilter | 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.OrderQueryPaymentTransactionFilterToJSON = exports.OrderQueryPaymentTransactionFilterFromJSONTyped = exports.OrderQueryPaymentTransactionFilterFromJSON = exports.instanceOfOrderQueryPaymentTransactionFilter = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the OrderQueryPaymentTransactionFilter interface.
20
+ */
21
+ function instanceOfOrderQueryPaymentTransactionFilter(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfOrderQueryPaymentTransactionFilter = instanceOfOrderQueryPaymentTransactionFilter;
26
+ function OrderQueryPaymentTransactionFilterFromJSON(json) {
27
+ return OrderQueryPaymentTransactionFilterFromJSONTyped(json, false);
28
+ }
29
+ exports.OrderQueryPaymentTransactionFilterFromJSON = OrderQueryPaymentTransactionFilterFromJSON;
30
+ function OrderQueryPaymentTransactionFilterFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
36
+ 'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
37
+ };
38
+ }
39
+ exports.OrderQueryPaymentTransactionFilterFromJSONTyped = OrderQueryPaymentTransactionFilterFromJSONTyped;
40
+ function OrderQueryPaymentTransactionFilterToJSON(value) {
41
+ if (value === undefined) {
42
+ return undefined;
43
+ }
44
+ if (value === null) {
45
+ return null;
46
+ }
47
+ return {
48
+ 'name': value.name,
49
+ 'value': value.value,
50
+ };
51
+ }
52
+ exports.OrderQueryPaymentTransactionFilterToJSON = OrderQueryPaymentTransactionFilterToJSON;
@@ -823,6 +823,7 @@ export * from './OrderProcessPaymentResponse';
823
823
  export * from './OrderProperty';
824
824
  export * from './OrderQuery';
825
825
  export * from './OrderQueryBatch';
826
+ export * from './OrderQueryPaymentTransactionFilter';
826
827
  export * from './OrderQuote';
827
828
  export * from './OrderReason';
828
829
  export * from './OrderRefundableResponse';
@@ -841,6 +841,7 @@ __exportStar(require("./OrderProcessPaymentResponse"), exports);
841
841
  __exportStar(require("./OrderProperty"), exports);
842
842
  __exportStar(require("./OrderQuery"), exports);
843
843
  __exportStar(require("./OrderQueryBatch"), exports);
844
+ __exportStar(require("./OrderQueryPaymentTransactionFilter"), exports);
844
845
  __exportStar(require("./OrderQuote"), exports);
845
846
  __exportStar(require("./OrderReason"), exports);
846
847
  __exportStar(require("./OrderRefundableResponse"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.117",
3
+ "version": "4.1.119",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -76,9 +76,14 @@ export interface GetLedgersByQueryRequest {
76
76
 
77
77
  export interface InsertAffiliateRequest {
78
78
  affiliate: Affiliate;
79
+ sendWelcomeEmail?: boolean;
79
80
  expand?: string;
80
81
  }
81
82
 
83
+ export interface SendAffiliateWelcomeEmailRequest {
84
+ affiliateOid: number;
85
+ }
86
+
82
87
  export interface UpdateAffiliateRequest {
83
88
  affiliateOid: number;
84
89
  affiliate: Affiliate;
@@ -186,6 +191,7 @@ export interface AffiliateApiInterface {
186
191
  * Insert an affiliate on the UltraCart account. The affiliate is created within the merchant\'s active affiliate program.
187
192
  * @summary Insert an affiliate
188
193
  * @param {Affiliate} affiliate Affiliate to insert
194
+ * @param {boolean} [sendWelcomeEmail] Whether to send a welcome email to the affiliate after it is created. Defaults to false.
189
195
  * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
190
196
  * @param {*} [options] Override http request option.
191
197
  * @throws {RequiredError}
@@ -199,6 +205,22 @@ export interface AffiliateApiInterface {
199
205
  */
200
206
  insertAffiliate(requestParameters: InsertAffiliateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AffiliateResponse>;
201
207
 
208
+ /**
209
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
210
+ * @summary Send a welcome email to an affiliate
211
+ * @param {number} affiliateOid The affiliate oid to send the welcome email to.
212
+ * @param {*} [options] Override http request option.
213
+ * @throws {RequiredError}
214
+ * @memberof AffiliateApiInterface
215
+ */
216
+ sendAffiliateWelcomeEmailRaw(requestParameters: SendAffiliateWelcomeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
217
+
218
+ /**
219
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
220
+ * Send a welcome email to an affiliate
221
+ */
222
+ sendAffiliateWelcomeEmail(requestParameters: SendAffiliateWelcomeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
223
+
202
224
  /**
203
225
  * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
204
226
  * @summary Update an affiliate
@@ -488,6 +510,10 @@ export class AffiliateApi extends runtime.BaseAPI implements AffiliateApiInterfa
488
510
 
489
511
  const queryParameters: any = {};
490
512
 
513
+ if (requestParameters.sendWelcomeEmail !== undefined) {
514
+ queryParameters['send_welcome_email'] = requestParameters.sendWelcomeEmail;
515
+ }
516
+
491
517
  if (requestParameters.expand !== undefined) {
492
518
  queryParameters['_expand'] = requestParameters.expand;
493
519
  }
@@ -525,6 +551,46 @@ export class AffiliateApi extends runtime.BaseAPI implements AffiliateApiInterfa
525
551
  return await response.value();
526
552
  }
527
553
 
554
+ /**
555
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
556
+ * Send a welcome email to an affiliate
557
+ */
558
+ async sendAffiliateWelcomeEmailRaw(requestParameters: SendAffiliateWelcomeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
559
+ if (requestParameters.affiliateOid === null || requestParameters.affiliateOid === undefined) {
560
+ throw new runtime.RequiredError('affiliateOid','Required parameter requestParameters.affiliateOid was null or undefined when calling sendAffiliateWelcomeEmail.');
561
+ }
562
+
563
+ const queryParameters: any = {};
564
+
565
+ const headerParameters: runtime.HTTPHeaders = {};
566
+
567
+ if (this.configuration && this.configuration.accessToken) {
568
+ // oauth required
569
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["affiliate_write"]);
570
+ }
571
+
572
+ if (this.configuration && this.configuration.apiKey) {
573
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
574
+ }
575
+
576
+ const response = await this.request({
577
+ path: `/affiliate/affiliates/{affiliate_oid}/welcome_email`.replace(`{${"affiliate_oid"}}`, encodeURIComponent(String(requestParameters.affiliateOid))),
578
+ method: 'POST',
579
+ headers: headerParameters,
580
+ query: queryParameters,
581
+ }, initOverrides);
582
+
583
+ return new runtime.VoidApiResponse(response);
584
+ }
585
+
586
+ /**
587
+ * Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant\'s active affiliate program.
588
+ * Send a welcome email to an affiliate
589
+ */
590
+ async sendAffiliateWelcomeEmail(requestParameters: SendAffiliateWelcomeEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
591
+ await this.sendAffiliateWelcomeEmailRaw(requestParameters, initOverrides);
592
+ }
593
+
528
594
  /**
529
595
  * Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
530
596
  * Update an affiliate
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { exists, mapValues } from '../runtime';
16
+ import {
17
+ OrderQueryPaymentTransactionFilter,
18
+ OrderQueryPaymentTransactionFilterFromJSON,
19
+ OrderQueryPaymentTransactionFilterFromJSONTyped,
20
+ OrderQueryPaymentTransactionFilterToJSON,
21
+ } from './OrderQueryPaymentTransactionFilter';
22
+
16
23
  /**
17
24
  *
18
25
  * @export
@@ -187,6 +194,12 @@ export interface OrderQuery {
187
194
  * @memberof OrderQuery
188
195
  */
189
196
  payment_method?: OrderQueryPaymentMethodEnum;
197
+ /**
198
+ * Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache which uses the ElasticSearch cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
199
+ * @type {Array<OrderQueryPaymentTransactionFilter>}
200
+ * @memberof OrderQuery
201
+ */
202
+ payment_transaction_filters?: Array<OrderQueryPaymentTransactionFilter>;
190
203
  /**
191
204
  * Phone
192
205
  * @type {string}
@@ -382,6 +395,7 @@ export function OrderQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean)
382
395
  'payment_date_begin': !exists(json, 'payment_date_begin') ? undefined : json['payment_date_begin'],
383
396
  'payment_date_end': !exists(json, 'payment_date_end') ? undefined : json['payment_date_end'],
384
397
  'payment_method': !exists(json, 'payment_method') ? undefined : json['payment_method'],
398
+ 'payment_transaction_filters': !exists(json, 'payment_transaction_filters') ? undefined : ((json['payment_transaction_filters'] as Array<any>).map(OrderQueryPaymentTransactionFilterFromJSON)),
385
399
  'phone': !exists(json, 'phone') ? undefined : json['phone'],
386
400
  'postal_code': !exists(json, 'postal_code') ? undefined : json['postal_code'],
387
401
  'purchase_order_number': !exists(json, 'purchase_order_number') ? undefined : json['purchase_order_number'],
@@ -437,6 +451,7 @@ export function OrderQueryToJSON(value?: OrderQuery | null): any {
437
451
  'payment_date_begin': value.payment_date_begin,
438
452
  'payment_date_end': value.payment_date_end,
439
453
  'payment_method': value.payment_method,
454
+ 'payment_transaction_filters': value.payment_transaction_filters === undefined ? undefined : ((value.payment_transaction_filters as Array<any>).map(OrderQueryPaymentTransactionFilterToJSON)),
440
455
  'phone': value.phone,
441
456
  'postal_code': value.postal_code,
442
457
  'purchase_order_number': value.purchase_order_number,
@@ -0,0 +1,75 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface OrderQueryPaymentTransactionFilter
20
+ */
21
+ export interface OrderQueryPaymentTransactionFilter {
22
+ /**
23
+ * Transaction detail name to match exactly. Optional, omit to match the value across any detail name.
24
+ * @type {string}
25
+ * @memberof OrderQueryPaymentTransactionFilter
26
+ */
27
+ name?: string;
28
+ /**
29
+ * Transaction detail value to match exactly. Required. Wildcards are not permitted.
30
+ * @type {string}
31
+ * @memberof OrderQueryPaymentTransactionFilter
32
+ */
33
+ value?: string;
34
+ }
35
+
36
+
37
+
38
+ /**
39
+ * Check if a given object implements the OrderQueryPaymentTransactionFilter interface.
40
+ */
41
+ export function instanceOfOrderQueryPaymentTransactionFilter(value: object): boolean {
42
+ let isInstance = true;
43
+
44
+ return isInstance;
45
+ }
46
+
47
+ export function OrderQueryPaymentTransactionFilterFromJSON(json: any): OrderQueryPaymentTransactionFilter {
48
+ return OrderQueryPaymentTransactionFilterFromJSONTyped(json, false);
49
+ }
50
+
51
+ export function OrderQueryPaymentTransactionFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderQueryPaymentTransactionFilter {
52
+ if ((json === undefined) || (json === null)) {
53
+ return json;
54
+ }
55
+ return {
56
+
57
+ 'name': !exists(json, 'name') ? undefined : json['name'],
58
+ 'value': !exists(json, 'value') ? undefined : json['value'],
59
+ };
60
+ }
61
+
62
+ export function OrderQueryPaymentTransactionFilterToJSON(value?: OrderQueryPaymentTransactionFilter | null): any {
63
+ if (value === undefined) {
64
+ return undefined;
65
+ }
66
+ if (value === null) {
67
+ return null;
68
+ }
69
+ return {
70
+
71
+ 'name': value.name,
72
+ 'value': value.value,
73
+ };
74
+ }
75
+
@@ -825,6 +825,7 @@ export * from './OrderProcessPaymentResponse';
825
825
  export * from './OrderProperty';
826
826
  export * from './OrderQuery';
827
827
  export * from './OrderQueryBatch';
828
+ export * from './OrderQueryPaymentTransactionFilter';
828
829
  export * from './OrderQuote';
829
830
  export * from './OrderReason';
830
831
  export * from './OrderRefundableResponse';