ultracart_rest_api_v2_typescript 4.0.238 → 4.0.241

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.
@@ -642,6 +642,7 @@ src/models/OrderByTokenQuery.ts
642
642
  src/models/OrderChannelPartner.ts
643
643
  src/models/OrderCheckout.ts
644
644
  src/models/OrderCoupon.ts
645
+ src/models/OrderCurrentStageHistory.ts
645
646
  src/models/OrderDigitalItem.ts
646
647
  src/models/OrderDigitalOrder.ts
647
648
  src/models/OrderEdi.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.238
1
+ ## ultracart_rest_api_v2_typescript@4.0.241
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install ultracart_rest_api_v2_typescript@4.0.238 --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.241 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 4.0.241 | 02/06/2025 | added storefront_host_name to channel partner order object |
58
+ | 4.0.240 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
59
+ | 4.0.239 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
57
60
  | 4.0.238 | 12/13/2024 | added user and group ids to conversation agent auth object |
58
61
  | 4.0.237 | 11/11/2024 | added seo properties to item.content object |
59
62
  | 4.0.236 | 11/07/2024 | Coupon - PercentOffWithItemsQuantityPurchase - added support for tags |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { ChannelPartnerCancelResponse, ChannelPartnerEstimateShippingResponse, ChannelPartnerEstimateTaxResponse, ChannelPartnerImportResponse, ChannelPartnerOrder, ChannelPartnerShipToPreference, ChannelPartnerShipToPreferenceResponse, ChannelPartnerShipToPreferencesResponse, ChannelPartnersResponse } from '../models';
13
+ import { ChannelPartnerCancelResponse, ChannelPartnerEstimateShippingResponse, ChannelPartnerEstimateTaxResponse, ChannelPartnerImportResponse, ChannelPartnerOrder, ChannelPartnerShipToPreference, ChannelPartnerShipToPreferenceResponse, ChannelPartnerShipToPreferencesResponse, ChannelPartnersResponse, Order, OrderResponse } from '../models';
14
14
  export interface CancelOrderByChannelPartnerOrderIdRequest {
15
15
  orderId: string;
16
16
  }
@@ -27,6 +27,14 @@ export interface EstimateShippingForChannelPartnerOrderRequest {
27
27
  export interface EstimateTaxForChannelPartnerOrderRequest {
28
28
  channelPartnerOrder: ChannelPartnerOrder;
29
29
  }
30
+ export interface GetChannelPartnerOrderRequest {
31
+ orderId: string;
32
+ expand?: string;
33
+ }
34
+ export interface GetChannelPartnerOrderByChannelPartnerOrderIdRequest {
35
+ orderId: string;
36
+ expand?: string;
37
+ }
30
38
  export interface GetChannelPartnerShipToPreferenceRequest {
31
39
  channelPartnerOid: number;
32
40
  channelPartnerShipToPreferenceOid: number;
@@ -41,6 +49,18 @@ export interface InsertChannelPartnerShipToPreferenceRequest {
41
49
  channelPartnerOid: number;
42
50
  shipToPreference: ChannelPartnerShipToPreference;
43
51
  }
52
+ export interface RefundChannelPartnerOrderRequest {
53
+ orderId: string;
54
+ order: Order;
55
+ rejectAfterRefund?: boolean;
56
+ skipCustomerNotification?: boolean;
57
+ autoOrderCancel?: boolean;
58
+ manualRefund?: boolean;
59
+ reverseAffiliateTransactions?: boolean;
60
+ issueStoreCredit?: boolean;
61
+ autoOrderCancelReason?: string;
62
+ expand?: string;
63
+ }
44
64
  export interface UpdateChannelPartnerShipToPreferenceRequest {
45
65
  channelPartnerOid: number;
46
66
  channelPartnerShipToPreferenceOid: number;
@@ -124,6 +144,36 @@ export interface ChannelPartnerApiInterface {
124
144
  * Estimate tax for channel partner order
125
145
  */
126
146
  estimateTaxForChannelPartnerOrder(requestParameters: EstimateTaxForChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChannelPartnerEstimateTaxResponse>;
147
+ /**
148
+ * Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
149
+ * @summary Retrieve a channel partner order
150
+ * @param {string} orderId The order id to retrieve.
151
+ * @param {string} [expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
152
+ * @param {*} [options] Override http request option.
153
+ * @throws {RequiredError}
154
+ * @memberof ChannelPartnerApiInterface
155
+ */
156
+ getChannelPartnerOrderRaw(requestParameters: GetChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
157
+ /**
158
+ * Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
159
+ * Retrieve a channel partner order
160
+ */
161
+ getChannelPartnerOrder(requestParameters: GetChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
162
+ /**
163
+ * Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
164
+ * @summary Retrieve a channel partner order by the channel partner order id
165
+ * @param {string} orderId The channel partner order id to retrieve.
166
+ * @param {string} [expand] The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
167
+ * @param {*} [options] Override http request option.
168
+ * @throws {RequiredError}
169
+ * @memberof ChannelPartnerApiInterface
170
+ */
171
+ getChannelPartnerOrderByChannelPartnerOrderIdRaw(requestParameters: GetChannelPartnerOrderByChannelPartnerOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
172
+ /**
173
+ * Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
174
+ * Retrieve a channel partner order by the channel partner order id
175
+ */
176
+ getChannelPartnerOrderByChannelPartnerOrderId(requestParameters: GetChannelPartnerOrderByChannelPartnerOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
127
177
  /**
128
178
  * Retrieve the ship to preference associated with the channel partner and the specific id.
129
179
  * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -195,6 +245,29 @@ export interface ChannelPartnerApiInterface {
195
245
  * Insert a ship to preference record for the channel partner.
196
246
  */
197
247
  insertChannelPartnerShipToPreference(requestParameters: InsertChannelPartnerShipToPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChannelPartnerShipToPreferenceResponse>;
248
+ /**
249
+ * Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
250
+ * @summary Refund a channel partner order
251
+ * @param {string} orderId The order id to refund.
252
+ * @param {Order} order Order to refund
253
+ * @param {boolean} [rejectAfterRefund] Reject order after refund
254
+ * @param {boolean} [skipCustomerNotification] Skip customer email notification
255
+ * @param {boolean} [autoOrderCancel] Cancel associated auto orders
256
+ * @param {boolean} [manualRefund] Consider a manual refund done externally
257
+ * @param {boolean} [reverseAffiliateTransactions] Reverse affiliate transactions
258
+ * @param {boolean} [issueStoreCredit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
259
+ * @param {string} [autoOrderCancelReason] Reason for auto orders cancellation
260
+ * @param {string} [expand] The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
261
+ * @param {*} [options] Override http request option.
262
+ * @throws {RequiredError}
263
+ * @memberof ChannelPartnerApiInterface
264
+ */
265
+ refundChannelPartnerOrderRaw(requestParameters: RefundChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
266
+ /**
267
+ * Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
268
+ * Refund a channel partner order
269
+ */
270
+ refundChannelPartnerOrder(requestParameters: RefundChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
198
271
  /**
199
272
  * Update a ship to preference record for the channel partner.
200
273
  * @summary Update a ship to preference record for the channel partner.
@@ -266,6 +339,26 @@ export declare class ChannelPartnerApi extends runtime.BaseAPI implements Channe
266
339
  * Estimate tax for channel partner order
267
340
  */
268
341
  estimateTaxForChannelPartnerOrder(requestParameters: EstimateTaxForChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChannelPartnerEstimateTaxResponse>;
342
+ /**
343
+ * Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
344
+ * Retrieve a channel partner order
345
+ */
346
+ getChannelPartnerOrderRaw(requestParameters: GetChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
347
+ /**
348
+ * Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
349
+ * Retrieve a channel partner order
350
+ */
351
+ getChannelPartnerOrder(requestParameters: GetChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
352
+ /**
353
+ * Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
354
+ * Retrieve a channel partner order by the channel partner order id
355
+ */
356
+ getChannelPartnerOrderByChannelPartnerOrderIdRaw(requestParameters: GetChannelPartnerOrderByChannelPartnerOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
357
+ /**
358
+ * Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
359
+ * Retrieve a channel partner order by the channel partner order id
360
+ */
361
+ getChannelPartnerOrderByChannelPartnerOrderId(requestParameters: GetChannelPartnerOrderByChannelPartnerOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
269
362
  /**
270
363
  * Retrieve the ship to preference associated with the channel partner and the specific id.
271
364
  * Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -316,6 +409,16 @@ export declare class ChannelPartnerApi extends runtime.BaseAPI implements Channe
316
409
  * Insert a ship to preference record for the channel partner.
317
410
  */
318
411
  insertChannelPartnerShipToPreference(requestParameters: InsertChannelPartnerShipToPreferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChannelPartnerShipToPreferenceResponse>;
412
+ /**
413
+ * Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
414
+ * Refund a channel partner order
415
+ */
416
+ refundChannelPartnerOrderRaw(requestParameters: RefundChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
417
+ /**
418
+ * Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
419
+ * Refund a channel partner order
420
+ */
421
+ refundChannelPartnerOrder(requestParameters: RefundChannelPartnerOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
319
422
  /**
320
423
  * Update a ship to preference record for the channel partner.
321
424
  * Update a ship to preference record for the channel partner.
@@ -375,6 +375,130 @@ var ChannelPartnerApi = /** @class */ (function (_super) {
375
375
  });
376
376
  });
377
377
  };
378
+ /**
379
+ * Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
380
+ * Retrieve a channel partner order
381
+ */
382
+ ChannelPartnerApi.prototype.getChannelPartnerOrderRaw = function (requestParameters, initOverrides) {
383
+ return __awaiter(this, void 0, void 0, function () {
384
+ var queryParameters, headerParameters, _a, _b, response;
385
+ return __generator(this, function (_c) {
386
+ switch (_c.label) {
387
+ case 0:
388
+ if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
389
+ throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling getChannelPartnerOrder.');
390
+ }
391
+ queryParameters = {};
392
+ if (requestParameters.expand !== undefined) {
393
+ queryParameters['_expand'] = requestParameters.expand;
394
+ }
395
+ headerParameters = {};
396
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
397
+ // oauth required
398
+ _a = headerParameters;
399
+ _b = "Authorization";
400
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["channel_partner_read"])];
401
+ case 1:
402
+ // oauth required
403
+ _a[_b] = _c.sent();
404
+ _c.label = 2;
405
+ case 2:
406
+ if (this.configuration && this.configuration.apiKey) {
407
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
408
+ }
409
+ return [4 /*yield*/, this.request({
410
+ path: "/channel_partner/orders/{order_id}".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
411
+ method: 'GET',
412
+ headers: headerParameters,
413
+ query: queryParameters,
414
+ }, initOverrides)];
415
+ case 3:
416
+ response = _c.sent();
417
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderResponseFromJSON)(jsonValue); })];
418
+ }
419
+ });
420
+ });
421
+ };
422
+ /**
423
+ * Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
424
+ * Retrieve a channel partner order
425
+ */
426
+ ChannelPartnerApi.prototype.getChannelPartnerOrder = function (requestParameters, initOverrides) {
427
+ return __awaiter(this, void 0, void 0, function () {
428
+ var response;
429
+ return __generator(this, function (_a) {
430
+ switch (_a.label) {
431
+ case 0: return [4 /*yield*/, this.getChannelPartnerOrderRaw(requestParameters, initOverrides)];
432
+ case 1:
433
+ response = _a.sent();
434
+ return [4 /*yield*/, response.value()];
435
+ case 2: return [2 /*return*/, _a.sent()];
436
+ }
437
+ });
438
+ });
439
+ };
440
+ /**
441
+ * Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
442
+ * Retrieve a channel partner order by the channel partner order id
443
+ */
444
+ ChannelPartnerApi.prototype.getChannelPartnerOrderByChannelPartnerOrderIdRaw = function (requestParameters, initOverrides) {
445
+ return __awaiter(this, void 0, void 0, function () {
446
+ var queryParameters, headerParameters, _a, _b, response;
447
+ return __generator(this, function (_c) {
448
+ switch (_c.label) {
449
+ case 0:
450
+ if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
451
+ throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling getChannelPartnerOrderByChannelPartnerOrderId.');
452
+ }
453
+ queryParameters = {};
454
+ if (requestParameters.expand !== undefined) {
455
+ queryParameters['_expand'] = requestParameters.expand;
456
+ }
457
+ headerParameters = {};
458
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
459
+ // oauth required
460
+ _a = headerParameters;
461
+ _b = "Authorization";
462
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["channel_partner_read"])];
463
+ case 1:
464
+ // oauth required
465
+ _a[_b] = _c.sent();
466
+ _c.label = 2;
467
+ case 2:
468
+ if (this.configuration && this.configuration.apiKey) {
469
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
470
+ }
471
+ return [4 /*yield*/, this.request({
472
+ path: "/channel_partner/orders/by_channel_partner_order_id/{order_id}".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
473
+ method: 'GET',
474
+ headers: headerParameters,
475
+ query: queryParameters,
476
+ }, initOverrides)];
477
+ case 3:
478
+ response = _c.sent();
479
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderResponseFromJSON)(jsonValue); })];
480
+ }
481
+ });
482
+ });
483
+ };
484
+ /**
485
+ * Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
486
+ * Retrieve a channel partner order by the channel partner order id
487
+ */
488
+ ChannelPartnerApi.prototype.getChannelPartnerOrderByChannelPartnerOrderId = function (requestParameters, initOverrides) {
489
+ return __awaiter(this, void 0, void 0, function () {
490
+ var response;
491
+ return __generator(this, function (_a) {
492
+ switch (_a.label) {
493
+ case 0: return [4 /*yield*/, this.getChannelPartnerOrderByChannelPartnerOrderIdRaw(requestParameters, initOverrides)];
494
+ case 1:
495
+ response = _a.sent();
496
+ return [4 /*yield*/, response.value()];
497
+ case 2: return [2 /*return*/, _a.sent()];
498
+ }
499
+ });
500
+ });
501
+ };
378
502
  /**
379
503
  * Retrieve the ship to preference associated with the channel partner and the specific id.
380
504
  * Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -677,6 +801,94 @@ var ChannelPartnerApi = /** @class */ (function (_super) {
677
801
  });
678
802
  });
679
803
  };
804
+ /**
805
+ * Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
806
+ * Refund a channel partner order
807
+ */
808
+ ChannelPartnerApi.prototype.refundChannelPartnerOrderRaw = function (requestParameters, initOverrides) {
809
+ return __awaiter(this, void 0, void 0, function () {
810
+ var queryParameters, headerParameters, _a, _b, response;
811
+ return __generator(this, function (_c) {
812
+ switch (_c.label) {
813
+ case 0:
814
+ if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
815
+ throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling refundChannelPartnerOrder.');
816
+ }
817
+ if (requestParameters.order === null || requestParameters.order === undefined) {
818
+ throw new runtime.RequiredError('order', 'Required parameter requestParameters.order was null or undefined when calling refundChannelPartnerOrder.');
819
+ }
820
+ queryParameters = {};
821
+ if (requestParameters.rejectAfterRefund !== undefined) {
822
+ queryParameters['reject_after_refund'] = requestParameters.rejectAfterRefund;
823
+ }
824
+ if (requestParameters.skipCustomerNotification !== undefined) {
825
+ queryParameters['skip_customer_notification'] = requestParameters.skipCustomerNotification;
826
+ }
827
+ if (requestParameters.autoOrderCancel !== undefined) {
828
+ queryParameters['auto_order_cancel'] = requestParameters.autoOrderCancel;
829
+ }
830
+ if (requestParameters.manualRefund !== undefined) {
831
+ queryParameters['manual_refund'] = requestParameters.manualRefund;
832
+ }
833
+ if (requestParameters.reverseAffiliateTransactions !== undefined) {
834
+ queryParameters['reverse_affiliate_transactions'] = requestParameters.reverseAffiliateTransactions;
835
+ }
836
+ if (requestParameters.issueStoreCredit !== undefined) {
837
+ queryParameters['issue_store_credit'] = requestParameters.issueStoreCredit;
838
+ }
839
+ if (requestParameters.autoOrderCancelReason !== undefined) {
840
+ queryParameters['auto_order_cancel_reason'] = requestParameters.autoOrderCancelReason;
841
+ }
842
+ if (requestParameters.expand !== undefined) {
843
+ queryParameters['_expand'] = requestParameters.expand;
844
+ }
845
+ headerParameters = {};
846
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
847
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
848
+ // oauth required
849
+ _a = headerParameters;
850
+ _b = "Authorization";
851
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["channel_partner_write"])];
852
+ case 1:
853
+ // oauth required
854
+ _a[_b] = _c.sent();
855
+ _c.label = 2;
856
+ case 2:
857
+ if (this.configuration && this.configuration.apiKey) {
858
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
859
+ }
860
+ return [4 /*yield*/, this.request({
861
+ path: "/channel_partner/orders/{order_id}/refund".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
862
+ method: 'PUT',
863
+ headers: headerParameters,
864
+ query: queryParameters,
865
+ body: (0, models_1.OrderToJSON)(requestParameters.order),
866
+ }, initOverrides)];
867
+ case 3:
868
+ response = _c.sent();
869
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderResponseFromJSON)(jsonValue); })];
870
+ }
871
+ });
872
+ });
873
+ };
874
+ /**
875
+ * Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
876
+ * Refund a channel partner order
877
+ */
878
+ ChannelPartnerApi.prototype.refundChannelPartnerOrder = function (requestParameters, initOverrides) {
879
+ return __awaiter(this, void 0, void 0, function () {
880
+ var response;
881
+ return __generator(this, function (_a) {
882
+ switch (_a.label) {
883
+ case 0: return [4 /*yield*/, this.refundChannelPartnerOrderRaw(requestParameters, initOverrides)];
884
+ case 1:
885
+ response = _a.sent();
886
+ return [4 /*yield*/, response.value()];
887
+ case 2: return [2 /*return*/, _a.sent()];
888
+ }
889
+ });
890
+ });
891
+ };
680
892
  /**
681
893
  * Update a ship to preference record for the channel partner.
682
894
  * Update a ship to preference record for the channel partner.
@@ -539,6 +539,12 @@ export interface ChannelPartnerOrder {
539
539
  * @memberof ChannelPartnerOrder
540
540
  */
541
541
  store_if_payment_declines?: boolean;
542
+ /**
543
+ * StoreFront host name associated with the order
544
+ * @type {string}
545
+ * @memberof ChannelPartnerOrder
546
+ */
547
+ storefront_host_name?: string;
542
548
  /**
543
549
  * The optional shipping county used to determine exact taxes
544
550
  * @type {string}
@@ -144,6 +144,7 @@ function ChannelPartnerOrderFromJSONTyped(json, ignoreDiscriminator) {
144
144
  'special_instructions': !(0, runtime_1.exists)(json, 'special_instructions') ? undefined : json['special_instructions'],
145
145
  'store_completed': !(0, runtime_1.exists)(json, 'store_completed') ? undefined : json['store_completed'],
146
146
  'store_if_payment_declines': !(0, runtime_1.exists)(json, 'store_if_payment_declines') ? undefined : json['store_if_payment_declines'],
147
+ 'storefront_host_name': !(0, runtime_1.exists)(json, 'storefront_host_name') ? undefined : json['storefront_host_name'],
147
148
  'tax_county': !(0, runtime_1.exists)(json, 'tax_county') ? undefined : json['tax_county'],
148
149
  'tax_exempt': !(0, runtime_1.exists)(json, 'tax_exempt') ? undefined : json['tax_exempt'],
149
150
  'transaction': !(0, runtime_1.exists)(json, 'transaction') ? undefined : (0, ChannelPartnerOrderTransaction_1.ChannelPartnerOrderTransactionFromJSON)(json['transaction']),
@@ -246,6 +247,7 @@ function ChannelPartnerOrderToJSON(value) {
246
247
  'special_instructions': value.special_instructions,
247
248
  'store_completed': value.store_completed,
248
249
  'store_if_payment_declines': value.store_if_payment_declines,
250
+ 'storefront_host_name': value.storefront_host_name,
249
251
  'tax_county': value.tax_county,
250
252
  'tax_exempt': value.tax_exempt,
251
253
  'transaction': (0, ChannelPartnerOrderTransaction_1.ChannelPartnerOrderTransactionToJSON)(value.transaction),
@@ -34,7 +34,7 @@ export interface CustomerAttachment {
34
34
  */
35
35
  file_name?: string;
36
36
  /**
37
- * Mime typoe
37
+ * Mime type
38
38
  * @type {string}
39
39
  * @memberof CustomerAttachment
40
40
  */
@@ -87,6 +87,12 @@ export interface CustomerQuery {
87
87
  * @memberof CustomerQuery
88
88
  */
89
89
  email?: string;
90
+ /**
91
+ * Emails allows for searching on multiple email addresses and work with our without the single email variable. You may specify a single email address here or use the email property.
92
+ * @type {Array<string>}
93
+ * @memberof CustomerQuery
94
+ */
95
+ emails?: Array<string>;
90
96
  /**
91
97
  * Last modified date end
92
98
  * @type {string}
@@ -36,6 +36,7 @@ function CustomerQueryFromJSONTyped(json, ignoreDiscriminator) {
36
36
  'billing_postal_code': !(0, runtime_1.exists)(json, 'billing_postal_code') ? undefined : json['billing_postal_code'],
37
37
  'billing_state': !(0, runtime_1.exists)(json, 'billing_state') ? undefined : json['billing_state'],
38
38
  'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
39
+ 'emails': !(0, runtime_1.exists)(json, 'emails') ? undefined : json['emails'],
39
40
  'last_modified_dts_end': !(0, runtime_1.exists)(json, 'last_modified_dts_end') ? undefined : json['last_modified_dts_end'],
40
41
  'last_modified_dts_start': !(0, runtime_1.exists)(json, 'last_modified_dts_start') ? undefined : json['last_modified_dts_start'],
41
42
  'pricing_tier_name': !(0, runtime_1.exists)(json, 'pricing_tier_name') ? undefined : json['pricing_tier_name'],
@@ -76,6 +77,7 @@ function CustomerQueryToJSON(value) {
76
77
  'billing_postal_code': value.billing_postal_code,
77
78
  'billing_state': value.billing_state,
78
79
  'email': value.email,
80
+ 'emails': value.emails,
79
81
  'last_modified_dts_end': value.last_modified_dts_end,
80
82
  'last_modified_dts_start': value.last_modified_dts_start,
81
83
  'pricing_tier_name': value.pricing_tier_name,
@@ -39,6 +39,12 @@ export interface ItemReview {
39
39
  * @memberof ItemReview
40
40
  */
41
41
  helpful_yes_votes?: number;
42
+ /**
43
+ * Merchant Reply (set to an empty string to remove)
44
+ * @type {string}
45
+ * @memberof ItemReview
46
+ */
47
+ merchant_reply?: string;
42
48
  /**
43
49
  *
44
50
  * @type {string}
@@ -37,6 +37,7 @@ function ItemReviewFromJSONTyped(json, ignoreDiscriminator) {
37
37
  'featured': !(0, runtime_1.exists)(json, 'featured') ? undefined : json['featured'],
38
38
  'helperful_no_votes': !(0, runtime_1.exists)(json, 'helperful_no_votes') ? undefined : json['helperful_no_votes'],
39
39
  'helpful_yes_votes': !(0, runtime_1.exists)(json, 'helpful_yes_votes') ? undefined : json['helpful_yes_votes'],
40
+ 'merchant_reply': !(0, runtime_1.exists)(json, 'merchant_reply') ? undefined : json['merchant_reply'],
40
41
  'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
41
42
  'overall': !(0, runtime_1.exists)(json, 'overall') ? undefined : json['overall'],
42
43
  'rating_name1': !(0, runtime_1.exists)(json, 'rating_name1') ? undefined : json['rating_name1'],
@@ -85,6 +86,7 @@ function ItemReviewToJSON(value) {
85
86
  'featured': value.featured,
86
87
  'helperful_no_votes': value.helperful_no_votes,
87
88
  'helpful_yes_votes': value.helpful_yes_votes,
89
+ 'merchant_reply': value.merchant_reply,
88
90
  'order_id': value.order_id,
89
91
  'overall': value.overall,
90
92
  'rating_name1': value.rating_name1,
@@ -17,6 +17,7 @@ import { OrderBuysafe } from './OrderBuysafe';
17
17
  import { OrderChannelPartner } from './OrderChannelPartner';
18
18
  import { OrderCheckout } from './OrderCheckout';
19
19
  import { OrderCoupon } from './OrderCoupon';
20
+ import { OrderCurrentStageHistory } from './OrderCurrentStageHistory';
20
21
  import { OrderDigitalOrder } from './OrderDigitalOrder';
21
22
  import { OrderEdi } from './OrderEdi';
22
23
  import { OrderFraudScore } from './OrderFraudScore';
@@ -102,6 +103,12 @@ export interface Order {
102
103
  * @memberof Order
103
104
  */
104
105
  current_stage?: OrderCurrentStageEnum;
106
+ /**
107
+ * History of the changes to the current_stage field
108
+ * @type {Array<OrderCurrentStageHistory>}
109
+ * @memberof Order
110
+ */
111
+ current_stage_histories?: Array<OrderCurrentStageHistory>;
105
112
  /**
106
113
  *
107
114
  * @type {Customer}
@@ -23,6 +23,7 @@ var OrderBuysafe_1 = require("./OrderBuysafe");
23
23
  var OrderChannelPartner_1 = require("./OrderChannelPartner");
24
24
  var OrderCheckout_1 = require("./OrderCheckout");
25
25
  var OrderCoupon_1 = require("./OrderCoupon");
26
+ var OrderCurrentStageHistory_1 = require("./OrderCurrentStageHistory");
26
27
  var OrderDigitalOrder_1 = require("./OrderDigitalOrder");
27
28
  var OrderEdi_1 = require("./OrderEdi");
28
29
  var OrderFraudScore_1 = require("./OrderFraudScore");
@@ -79,6 +80,7 @@ function OrderFromJSONTyped(json, ignoreDiscriminator) {
79
80
  'creation_dts': !(0, runtime_1.exists)(json, 'creation_dts') ? undefined : json['creation_dts'],
80
81
  'currency_code': !(0, runtime_1.exists)(json, 'currency_code') ? undefined : json['currency_code'],
81
82
  'current_stage': !(0, runtime_1.exists)(json, 'current_stage') ? undefined : json['current_stage'],
83
+ 'current_stage_histories': !(0, runtime_1.exists)(json, 'current_stage_histories') ? undefined : (json['current_stage_histories'].map(OrderCurrentStageHistory_1.OrderCurrentStageHistoryFromJSON)),
82
84
  'customer_profile': !(0, runtime_1.exists)(json, 'customer_profile') ? undefined : (0, Customer_1.CustomerFromJSON)(json['customer_profile']),
83
85
  'digital_order': !(0, runtime_1.exists)(json, 'digital_order') ? undefined : (0, OrderDigitalOrder_1.OrderDigitalOrderFromJSON)(json['digital_order']),
84
86
  'edi': !(0, runtime_1.exists)(json, 'edi') ? undefined : (0, OrderEdi_1.OrderEdiFromJSON)(json['edi']),
@@ -128,6 +130,7 @@ function OrderToJSON(value) {
128
130
  'creation_dts': value.creation_dts,
129
131
  'currency_code': value.currency_code,
130
132
  'current_stage': value.current_stage,
133
+ 'current_stage_histories': value.current_stage_histories === undefined ? undefined : (value.current_stage_histories.map(OrderCurrentStageHistory_1.OrderCurrentStageHistoryToJSON)),
131
134
  'customer_profile': (0, Customer_1.CustomerToJSON)(value.customer_profile),
132
135
  'digital_order': (0, OrderDigitalOrder_1.OrderDigitalOrderToJSON)(value.digital_order),
133
136
  'edi': (0, OrderEdi_1.OrderEdiToJSON)(value.edi),
@@ -0,0 +1,77 @@
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 OrderCurrentStageHistory
16
+ */
17
+ export interface OrderCurrentStageHistory {
18
+ /**
19
+ * New stage that the order is in.
20
+ * @type {string}
21
+ * @memberof OrderCurrentStageHistory
22
+ */
23
+ after_stage?: OrderCurrentStageHistoryAfterStageEnum;
24
+ /**
25
+ * Previous stage that the order was in.
26
+ * @type {string}
27
+ * @memberof OrderCurrentStageHistory
28
+ */
29
+ before_stage?: OrderCurrentStageHistoryBeforeStageEnum;
30
+ /**
31
+ * Date/time that the stage transitioned
32
+ * @type {string}
33
+ * @memberof OrderCurrentStageHistory
34
+ */
35
+ transition_dts?: string;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const OrderCurrentStageHistoryAfterStageEnum: {
41
+ readonly AccountsReceivable: "Accounts Receivable";
42
+ readonly PendingClearance: "Pending Clearance";
43
+ readonly FraudReview: "Fraud Review";
44
+ readonly Rejected: "Rejected";
45
+ readonly ShippingDepartment: "Shipping Department";
46
+ readonly CompletedOrder: "Completed Order";
47
+ readonly QuoteRequest: "Quote Request";
48
+ readonly QuoteSent: "Quote Sent";
49
+ readonly LeastCostRouting: "Least Cost Routing";
50
+ readonly Unknown: "Unknown";
51
+ readonly PreOrdered: "Pre-ordered";
52
+ readonly AdvancedOrderRouting: "Advanced Order Routing";
53
+ readonly Hold: "Hold";
54
+ };
55
+ export type OrderCurrentStageHistoryAfterStageEnum = typeof OrderCurrentStageHistoryAfterStageEnum[keyof typeof OrderCurrentStageHistoryAfterStageEnum];
56
+ /**
57
+ * @export
58
+ */
59
+ export declare const OrderCurrentStageHistoryBeforeStageEnum: {
60
+ readonly AccountsReceivable: "Accounts Receivable";
61
+ readonly PendingClearance: "Pending Clearance";
62
+ readonly FraudReview: "Fraud Review";
63
+ readonly Rejected: "Rejected";
64
+ readonly ShippingDepartment: "Shipping Department";
65
+ readonly CompletedOrder: "Completed Order";
66
+ readonly QuoteRequest: "Quote Request";
67
+ readonly QuoteSent: "Quote Sent";
68
+ readonly LeastCostRouting: "Least Cost Routing";
69
+ readonly Unknown: "Unknown";
70
+ readonly PreOrdered: "Pre-ordered";
71
+ readonly AdvancedOrderRouting: "Advanced Order Routing";
72
+ readonly Hold: "Hold";
73
+ };
74
+ export type OrderCurrentStageHistoryBeforeStageEnum = typeof OrderCurrentStageHistoryBeforeStageEnum[keyof typeof OrderCurrentStageHistoryBeforeStageEnum];
75
+ export declare function OrderCurrentStageHistoryFromJSON(json: any): OrderCurrentStageHistory;
76
+ export declare function OrderCurrentStageHistoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCurrentStageHistory;
77
+ export declare function OrderCurrentStageHistoryToJSON(value?: OrderCurrentStageHistory | null): any;