ultracart_rest_api_v2_typescript 3.10.213 → 3.10.215

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.10.213
1
+ ## ultracart_rest_api_v2_typescript@3.10.215
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@3.10.213 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.215 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.215 | 08/29/2024 | add hold_for_transmission to item shipping object |
58
+ | 3.10.214 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
57
59
  | 3.10.213 | 06/24/2024 | conversation object cleanup |
58
60
  | 3.10.212 | 06/14/2024 | pbx menu - add say voice property |
59
61
  | 3.10.211 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
package/api.ts CHANGED
@@ -29685,6 +29685,12 @@ export interface ItemShipping {
29685
29685
  * @memberof ItemShipping
29686
29686
  */
29687
29687
  hazmat?: boolean;
29688
+ /**
29689
+ * Hold for transmission
29690
+ * @type {boolean}
29691
+ * @memberof ItemShipping
29692
+ */
29693
+ hold_for_transmission?: boolean;
29688
29694
  /**
29689
29695
  * True if this item is made to order
29690
29696
  * @type {boolean}
@@ -35106,6 +35112,27 @@ export interface OrderQueryBatch {
35106
35112
  * @memberof OrderQueryBatch
35107
35113
  */
35108
35114
  order_ids?: Array<string>;
35115
+ /**
35116
+ * Query Target
35117
+ * @type {string}
35118
+ * @memberof OrderQueryBatch
35119
+ */
35120
+ query_target?: OrderQueryBatch.QueryTargetEnum;
35121
+ }
35122
+
35123
+ /**
35124
+ * @export
35125
+ * @namespace OrderQueryBatch
35126
+ */
35127
+ export namespace OrderQueryBatch {
35128
+ /**
35129
+ * @export
35130
+ * @enum {string}
35131
+ */
35132
+ export enum QueryTargetEnum {
35133
+ Origin = <any> 'origin',
35134
+ Cache = <any> 'cache'
35135
+ }
35109
35136
  }
35110
35137
 
35111
35138
  /**
@@ -41129,6 +41156,18 @@ export interface ScreenshotsResponse {
41129
41156
  * @interface SelfConfig
41130
41157
  */
41131
41158
  export interface SelfConfig {
41159
+ /**
41160
+ * True if the Colorado Retail Delivery Fee should not be collected
41161
+ * @type {boolean}
41162
+ * @memberof SelfConfig
41163
+ */
41164
+ exempt_from_colorado_retail_delivery_fee?: boolean;
41165
+ /**
41166
+ * True if the Minnesota Retail Delivery Fee should not be collected
41167
+ * @type {boolean}
41168
+ * @memberof SelfConfig
41169
+ */
41170
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
41132
41171
  /**
41133
41172
  * True if sales tax should be collected based on billing address instead of shipping address
41134
41173
  * @type {boolean}
@@ -42942,6 +42981,18 @@ export interface TwiliosResponse {
42942
42981
  * @interface UltraCartConfig
42943
42982
  */
42944
42983
  export interface UltraCartConfig {
42984
+ /**
42985
+ * True if the Colorado Retail Delivery Fee should not be collected
42986
+ * @type {boolean}
42987
+ * @memberof UltraCartConfig
42988
+ */
42989
+ exempt_from_colorado_retail_delivery_fee?: boolean;
42990
+ /**
42991
+ * True if the Minnesota Retail Delivery Fee should not be collected
42992
+ * @type {boolean}
42993
+ * @memberof UltraCartConfig
42994
+ */
42995
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
42945
42996
  /**
42946
42997
  * True if sales tax should be collected based on billing address instead of shipping address
42947
42998
  * @type {boolean}
@@ -73122,11 +73173,12 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
73122
73173
  * @param {boolean} [manual_refund] Consider a manual refund done externally
73123
73174
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
73124
73175
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
73176
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
73125
73177
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
73126
73178
  * @param {*} [options] Override http request option.
73127
73179
  * @throws {RequiredError}
73128
73180
  */
73129
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options: any = {}): FetchArgs {
73181
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options: any = {}): FetchArgs {
73130
73182
  // verify required parameter 'order' is not null or undefined
73131
73183
  if (order === null || order === undefined) {
73132
73184
  throw new RequiredError('order','Required parameter order was null or undefined when calling refundOrder.');
@@ -73189,6 +73241,10 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
73189
73241
  localVarQueryParameter['issue_store_credit'] = issue_store_credit;
73190
73242
  }
73191
73243
 
73244
+ if (auto_order_cancel_reason !== undefined) {
73245
+ localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
73246
+ }
73247
+
73192
73248
  if (_expand !== undefined) {
73193
73249
  localVarQueryParameter['_expand'] = _expand;
73194
73250
  }
@@ -74033,12 +74089,13 @@ export const OrderApiFp = function(configuration?: Configuration) {
74033
74089
  * @param {boolean} [manual_refund] Consider a manual refund done externally
74034
74090
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
74035
74091
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
74092
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
74036
74093
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
74037
74094
  * @param {*} [options] Override http request option.
74038
74095
  * @throws {RequiredError}
74039
74096
  */
74040
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
74041
- const localVarFetchArgs = OrderApiFetchParamCreator(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options);
74097
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
74098
+ const localVarFetchArgs = OrderApiFetchParamCreator(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options);
74042
74099
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
74043
74100
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
74044
74101
 
@@ -74445,12 +74502,13 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
74445
74502
  * @param {boolean} [manual_refund] Consider a manual refund done externally
74446
74503
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
74447
74504
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
74505
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
74448
74506
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
74449
74507
  * @param {*} [options] Override http request option.
74450
74508
  * @throws {RequiredError}
74451
74509
  */
74452
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any) {
74453
- return OrderApiFp(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(fetch, basePath);
74510
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any) {
74511
+ return OrderApiFp(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(fetch, basePath);
74454
74512
  },
74455
74513
  /**
74456
74514
  * Create a replacement order based upon a previous order
@@ -74780,12 +74838,13 @@ export interface OrderApiInterface {
74780
74838
  * @param {boolean} [manual_refund] Consider a manual refund done externally
74781
74839
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
74782
74840
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
74841
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
74783
74842
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
74784
74843
  * @param {*} [options] Override http request option.
74785
74844
  * @throws {RequiredError}
74786
74845
  * @memberof OrderApiInterface
74787
74846
  */
74788
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
74847
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
74789
74848
 
74790
74849
  /**
74791
74850
  * Create a replacement order based upon a previous order
@@ -75155,13 +75214,14 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
75155
75214
  * @param {boolean} [manual_refund] Consider a manual refund done externally
75156
75215
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
75157
75216
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
75217
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
75158
75218
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
75159
75219
  * @param {*} [options] Override http request option.
75160
75220
  * @throws {RequiredError}
75161
75221
  * @memberof OrderApi
75162
75222
  */
75163
- public refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any) {
75164
- return OrderApiFp(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(this.fetch, this.basePath);
75223
+ public refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any) {
75224
+ return OrderApiFp(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(this.fetch, this.basePath);
75165
75225
  }
75166
75226
 
75167
75227
  /**
package/dist/api.d.ts CHANGED
@@ -29058,6 +29058,12 @@ export interface ItemShipping {
29058
29058
  * @memberof ItemShipping
29059
29059
  */
29060
29060
  hazmat?: boolean;
29061
+ /**
29062
+ * Hold for transmission
29063
+ * @type {boolean}
29064
+ * @memberof ItemShipping
29065
+ */
29066
+ hold_for_transmission?: boolean;
29061
29067
  /**
29062
29068
  * True if this item is made to order
29063
29069
  * @type {boolean}
@@ -34370,6 +34376,26 @@ export interface OrderQueryBatch {
34370
34376
  * @memberof OrderQueryBatch
34371
34377
  */
34372
34378
  order_ids?: Array<string>;
34379
+ /**
34380
+ * Query Target
34381
+ * @type {string}
34382
+ * @memberof OrderQueryBatch
34383
+ */
34384
+ query_target?: OrderQueryBatch.QueryTargetEnum;
34385
+ }
34386
+ /**
34387
+ * @export
34388
+ * @namespace OrderQueryBatch
34389
+ */
34390
+ export declare namespace OrderQueryBatch {
34391
+ /**
34392
+ * @export
34393
+ * @enum {string}
34394
+ */
34395
+ enum QueryTargetEnum {
34396
+ Origin,
34397
+ Cache
34398
+ }
34373
34399
  }
34374
34400
  /**
34375
34401
  *
@@ -40269,6 +40295,18 @@ export interface ScreenshotsResponse {
40269
40295
  * @interface SelfConfig
40270
40296
  */
40271
40297
  export interface SelfConfig {
40298
+ /**
40299
+ * True if the Colorado Retail Delivery Fee should not be collected
40300
+ * @type {boolean}
40301
+ * @memberof SelfConfig
40302
+ */
40303
+ exempt_from_colorado_retail_delivery_fee?: boolean;
40304
+ /**
40305
+ * True if the Minnesota Retail Delivery Fee should not be collected
40306
+ * @type {boolean}
40307
+ * @memberof SelfConfig
40308
+ */
40309
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
40272
40310
  /**
40273
40311
  * True if sales tax should be collected based on billing address instead of shipping address
40274
40312
  * @type {boolean}
@@ -42038,6 +42076,18 @@ export interface TwiliosResponse {
42038
42076
  * @interface UltraCartConfig
42039
42077
  */
42040
42078
  export interface UltraCartConfig {
42079
+ /**
42080
+ * True if the Colorado Retail Delivery Fee should not be collected
42081
+ * @type {boolean}
42082
+ * @memberof UltraCartConfig
42083
+ */
42084
+ exempt_from_colorado_retail_delivery_fee?: boolean;
42085
+ /**
42086
+ * True if the Minnesota Retail Delivery Fee should not be collected
42087
+ * @type {boolean}
42088
+ * @memberof UltraCartConfig
42089
+ */
42090
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
42041
42091
  /**
42042
42092
  * True if sales tax should be collected based on billing address instead of shipping address
42043
42093
  * @type {boolean}
@@ -55278,11 +55328,12 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
55278
55328
  * @param {boolean} [manual_refund] Consider a manual refund done externally
55279
55329
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
55280
55330
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
55331
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
55281
55332
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
55282
55333
  * @param {*} [options] Override http request option.
55283
55334
  * @throws {RequiredError}
55284
55335
  */
55285
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): FetchArgs;
55336
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): FetchArgs;
55286
55337
  /**
55287
55338
  * Create a replacement order based upon a previous order
55288
55339
  * @summary Replacement order
@@ -55556,11 +55607,12 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
55556
55607
  * @param {boolean} [manual_refund] Consider a manual refund done externally
55557
55608
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
55558
55609
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
55610
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
55559
55611
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
55560
55612
  * @param {*} [options] Override http request option.
55561
55613
  * @throws {RequiredError}
55562
55614
  */
55563
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
55615
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
55564
55616
  /**
55565
55617
  * Create a replacement order based upon a previous order
55566
55618
  * @summary Replacement order
@@ -55834,11 +55886,12 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
55834
55886
  * @param {boolean} [manual_refund] Consider a manual refund done externally
55835
55887
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
55836
55888
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
55889
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
55837
55890
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
55838
55891
  * @param {*} [options] Override http request option.
55839
55892
  * @throws {RequiredError}
55840
55893
  */
55841
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
55894
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
55842
55895
  /**
55843
55896
  * Create a replacement order based upon a previous order
55844
55897
  * @summary Replacement order
@@ -56133,12 +56186,13 @@ export interface OrderApiInterface {
56133
56186
  * @param {boolean} [manual_refund] Consider a manual refund done externally
56134
56187
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
56135
56188
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
56189
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
56136
56190
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
56137
56191
  * @param {*} [options] Override http request option.
56138
56192
  * @throws {RequiredError}
56139
56193
  * @memberof OrderApiInterface
56140
56194
  */
56141
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
56195
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
56142
56196
  /**
56143
56197
  * Create a replacement order based upon a previous order
56144
56198
  * @summary Replacement order
@@ -56440,12 +56494,13 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
56440
56494
  * @param {boolean} [manual_refund] Consider a manual refund done externally
56441
56495
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
56442
56496
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
56497
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
56443
56498
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
56444
56499
  * @param {*} [options] Override http request option.
56445
56500
  * @throws {RequiredError}
56446
56501
  * @memberof OrderApi
56447
56502
  */
56448
- refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, _expand?: string, options?: any): Promise<OrderResponse>;
56503
+ refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
56449
56504
  /**
56450
56505
  * Create a replacement order based upon a previous order
56451
56506
  * @summary Replacement order
package/dist/api.js CHANGED
@@ -29,9 +29,9 @@ var __extends = (this && this.__extends) || (function () {
29
29
  })();
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
31
  exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.Coupon = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationPbxVoicemailMessageSummary = exports.ConversationPbxVoicemailMessage = exports.ConversationPbxVoicemailMailbox = exports.ConversationPbxTimeBasedMapping = exports.ConversationPbxPhoneNumber = exports.ConversationPbxMenuMapping = exports.ConversationPbxMenu = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
- exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = void 0;
33
- exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = void 0;
34
- exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = void 0;
32
+ exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQueryBatch = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = void 0;
33
+ exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = void 0;
34
+ exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = void 0;
35
35
  var url = require("url");
36
36
  var portableFetch = require("portable-fetch");
37
37
  var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -1474,6 +1474,22 @@ var OrderQuery;
1474
1474
  QueryTargetEnum[QueryTargetEnum["Cache"] = 'cache'] = "Cache";
1475
1475
  })(QueryTargetEnum = OrderQuery.QueryTargetEnum || (OrderQuery.QueryTargetEnum = {}));
1476
1476
  })(OrderQuery = exports.OrderQuery || (exports.OrderQuery = {}));
1477
+ /**
1478
+ * @export
1479
+ * @namespace OrderQueryBatch
1480
+ */
1481
+ var OrderQueryBatch;
1482
+ (function (OrderQueryBatch) {
1483
+ /**
1484
+ * @export
1485
+ * @enum {string}
1486
+ */
1487
+ var QueryTargetEnum;
1488
+ (function (QueryTargetEnum) {
1489
+ QueryTargetEnum[QueryTargetEnum["Origin"] = 'origin'] = "Origin";
1490
+ QueryTargetEnum[QueryTargetEnum["Cache"] = 'cache'] = "Cache";
1491
+ })(QueryTargetEnum = OrderQueryBatch.QueryTargetEnum || (OrderQueryBatch.QueryTargetEnum = {}));
1492
+ })(OrderQueryBatch = exports.OrderQueryBatch || (exports.OrderQueryBatch = {}));
1477
1493
  /**
1478
1494
  * @export
1479
1495
  * @namespace PointOfSaleReader
@@ -25649,11 +25665,12 @@ var OrderApiFetchParamCreator = function (configuration) {
25649
25665
  * @param {boolean} [manual_refund] Consider a manual refund done externally
25650
25666
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
25651
25667
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
25668
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
25652
25669
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
25653
25670
  * @param {*} [options] Override http request option.
25654
25671
  * @throws {RequiredError}
25655
25672
  */
25656
- refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
25673
+ refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options) {
25657
25674
  if (options === void 0) { options = {}; }
25658
25675
  // verify required parameter 'order' is not null or undefined
25659
25676
  if (order === null || order === undefined) {
@@ -25705,6 +25722,9 @@ var OrderApiFetchParamCreator = function (configuration) {
25705
25722
  if (issue_store_credit !== undefined) {
25706
25723
  localVarQueryParameter['issue_store_credit'] = issue_store_credit;
25707
25724
  }
25725
+ if (auto_order_cancel_reason !== undefined) {
25726
+ localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
25727
+ }
25708
25728
  if (_expand !== undefined) {
25709
25729
  localVarQueryParameter['_expand'] = _expand;
25710
25730
  }
@@ -26525,12 +26545,13 @@ var OrderApiFp = function (configuration) {
26525
26545
  * @param {boolean} [manual_refund] Consider a manual refund done externally
26526
26546
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
26527
26547
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
26548
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
26528
26549
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
26529
26550
  * @param {*} [options] Override http request option.
26530
26551
  * @throws {RequiredError}
26531
26552
  */
26532
- refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
26533
- var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options);
26553
+ refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options) {
26554
+ var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options);
26534
26555
  return function (fetch, basePath) {
26535
26556
  if (fetch === void 0) { fetch = portableFetch; }
26536
26557
  if (basePath === void 0) { basePath = BASE_PATH; }
@@ -26944,12 +26965,13 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
26944
26965
  * @param {boolean} [manual_refund] Consider a manual refund done externally
26945
26966
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
26946
26967
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
26968
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
26947
26969
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
26948
26970
  * @param {*} [options] Override http request option.
26949
26971
  * @throws {RequiredError}
26950
26972
  */
26951
- refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
26952
- return (0, exports.OrderApiFp)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(fetch, basePath);
26973
+ refundOrder: function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options) {
26974
+ return (0, exports.OrderApiFp)(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(fetch, basePath);
26953
26975
  },
26954
26976
  /**
26955
26977
  * Create a replacement order based upon a previous order
@@ -27304,13 +27326,14 @@ var OrderApi = /** @class */ (function (_super) {
27304
27326
  * @param {boolean} [manual_refund] Consider a manual refund done externally
27305
27327
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
27306
27328
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
27329
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
27307
27330
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
27308
27331
  * @param {*} [options] Override http request option.
27309
27332
  * @throws {RequiredError}
27310
27333
  * @memberof OrderApi
27311
27334
  */
27312
- OrderApi.prototype.refundOrder = function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options) {
27313
- return (0, exports.OrderApiFp)(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, _expand, options)(this.fetch, this.basePath);
27335
+ OrderApi.prototype.refundOrder = function (order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options) {
27336
+ return (0, exports.OrderApiFp)(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(this.fetch, this.basePath);
27314
27337
  };
27315
27338
  /**
27316
27339
  * Create a replacement order based upon a previous order
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.213",
3
+ "version": "3.10.215",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [