ultracart_rest_api_v2_typescript 3.10.212 → 3.10.214

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.212
1
+ ## ultracart_rest_api_v2_typescript@3.10.214
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.212 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.214 --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.214 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
58
+ | 3.10.213 | 06/24/2024 | conversation object cleanup |
57
59
  | 3.10.212 | 06/14/2024 | pbx menu - add say voice property |
58
60
  | 3.10.211 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
59
61
  | 3.10.210 | 06/03/2024 | conversationPbxPhoneNumber - fix serialized name for phone number UUID |
package/api.ts CHANGED
@@ -35106,6 +35106,27 @@ export interface OrderQueryBatch {
35106
35106
  * @memberof OrderQueryBatch
35107
35107
  */
35108
35108
  order_ids?: Array<string>;
35109
+ /**
35110
+ * Query Target
35111
+ * @type {string}
35112
+ * @memberof OrderQueryBatch
35113
+ */
35114
+ query_target?: OrderQueryBatch.QueryTargetEnum;
35115
+ }
35116
+
35117
+ /**
35118
+ * @export
35119
+ * @namespace OrderQueryBatch
35120
+ */
35121
+ export namespace OrderQueryBatch {
35122
+ /**
35123
+ * @export
35124
+ * @enum {string}
35125
+ */
35126
+ export enum QueryTargetEnum {
35127
+ Origin = <any> 'origin',
35128
+ Cache = <any> 'cache'
35129
+ }
35109
35130
  }
35110
35131
 
35111
35132
  /**
@@ -41129,6 +41150,18 @@ export interface ScreenshotsResponse {
41129
41150
  * @interface SelfConfig
41130
41151
  */
41131
41152
  export interface SelfConfig {
41153
+ /**
41154
+ * True if the Colorado Retail Delivery Fee should not be collected
41155
+ * @type {boolean}
41156
+ * @memberof SelfConfig
41157
+ */
41158
+ exempt_from_colorado_retail_delivery_fee?: boolean;
41159
+ /**
41160
+ * True if the Minnesota Retail Delivery Fee should not be collected
41161
+ * @type {boolean}
41162
+ * @memberof SelfConfig
41163
+ */
41164
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
41132
41165
  /**
41133
41166
  * True if sales tax should be collected based on billing address instead of shipping address
41134
41167
  * @type {boolean}
@@ -42816,12 +42849,6 @@ export interface Twilio {
42816
42849
  * @memberof Twilio
42817
42850
  */
42818
42851
  api_key_name?: string;
42819
- /**
42820
- *
42821
- * @type {string}
42822
- * @memberof Twilio
42823
- */
42824
- api_key_secret?: string;
42825
42852
  /**
42826
42853
  *
42827
42854
  * @type {string}
@@ -42852,24 +42879,6 @@ export interface Twilio {
42852
42879
  * @memberof Twilio
42853
42880
  */
42854
42881
  phone_numbers?: Array<string>;
42855
- /**
42856
- *
42857
- * @type {string}
42858
- * @memberof Twilio
42859
- */
42860
- private_key_pem?: string;
42861
- /**
42862
- *
42863
- * @type {string}
42864
- * @memberof Twilio
42865
- */
42866
- public_key_pem?: string;
42867
- /**
42868
- *
42869
- * @type {string}
42870
- * @memberof Twilio
42871
- */
42872
- public_key_sid?: string;
42873
42882
  /**
42874
42883
  *
42875
42884
  * @type {string}
@@ -42966,6 +42975,18 @@ export interface TwiliosResponse {
42966
42975
  * @interface UltraCartConfig
42967
42976
  */
42968
42977
  export interface UltraCartConfig {
42978
+ /**
42979
+ * True if the Colorado Retail Delivery Fee should not be collected
42980
+ * @type {boolean}
42981
+ * @memberof UltraCartConfig
42982
+ */
42983
+ exempt_from_colorado_retail_delivery_fee?: boolean;
42984
+ /**
42985
+ * True if the Minnesota Retail Delivery Fee should not be collected
42986
+ * @type {boolean}
42987
+ * @memberof UltraCartConfig
42988
+ */
42989
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
42969
42990
  /**
42970
42991
  * True if sales tax should be collected based on billing address instead of shipping address
42971
42992
  * @type {boolean}
@@ -73146,11 +73167,12 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
73146
73167
  * @param {boolean} [manual_refund] Consider a manual refund done externally
73147
73168
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
73148
73169
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
73170
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
73149
73171
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
73150
73172
  * @param {*} [options] Override http request option.
73151
73173
  * @throws {RequiredError}
73152
73174
  */
73153
- 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 {
73175
+ 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 {
73154
73176
  // verify required parameter 'order' is not null or undefined
73155
73177
  if (order === null || order === undefined) {
73156
73178
  throw new RequiredError('order','Required parameter order was null or undefined when calling refundOrder.');
@@ -73213,6 +73235,10 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
73213
73235
  localVarQueryParameter['issue_store_credit'] = issue_store_credit;
73214
73236
  }
73215
73237
 
73238
+ if (auto_order_cancel_reason !== undefined) {
73239
+ localVarQueryParameter['auto_order_cancel_reason'] = auto_order_cancel_reason;
73240
+ }
73241
+
73216
73242
  if (_expand !== undefined) {
73217
73243
  localVarQueryParameter['_expand'] = _expand;
73218
73244
  }
@@ -74057,12 +74083,13 @@ export const OrderApiFp = function(configuration?: Configuration) {
74057
74083
  * @param {boolean} [manual_refund] Consider a manual refund done externally
74058
74084
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
74059
74085
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
74086
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
74060
74087
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
74061
74088
  * @param {*} [options] Override http request option.
74062
74089
  * @throws {RequiredError}
74063
74090
  */
74064
- 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> {
74065
- 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);
74091
+ 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> {
74092
+ 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);
74066
74093
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
74067
74094
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
74068
74095
 
@@ -74469,12 +74496,13 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
74469
74496
  * @param {boolean} [manual_refund] Consider a manual refund done externally
74470
74497
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
74471
74498
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
74499
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
74472
74500
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
74473
74501
  * @param {*} [options] Override http request option.
74474
74502
  * @throws {RequiredError}
74475
74503
  */
74476
- 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) {
74477
- 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);
74504
+ 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) {
74505
+ 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);
74478
74506
  },
74479
74507
  /**
74480
74508
  * Create a replacement order based upon a previous order
@@ -74804,12 +74832,13 @@ export interface OrderApiInterface {
74804
74832
  * @param {boolean} [manual_refund] Consider a manual refund done externally
74805
74833
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
74806
74834
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
74835
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
74807
74836
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
74808
74837
  * @param {*} [options] Override http request option.
74809
74838
  * @throws {RequiredError}
74810
74839
  * @memberof OrderApiInterface
74811
74840
  */
74812
- 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>;
74841
+ 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>;
74813
74842
 
74814
74843
  /**
74815
74844
  * Create a replacement order based upon a previous order
@@ -75179,13 +75208,14 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
75179
75208
  * @param {boolean} [manual_refund] Consider a manual refund done externally
75180
75209
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
75181
75210
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
75211
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
75182
75212
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
75183
75213
  * @param {*} [options] Override http request option.
75184
75214
  * @throws {RequiredError}
75185
75215
  * @memberof OrderApi
75186
75216
  */
75187
- 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) {
75188
- 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);
75217
+ 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) {
75218
+ 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);
75189
75219
  }
75190
75220
 
75191
75221
  /**
@@ -85675,6 +85705,72 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
85675
85705
  options: localVarRequestOptions,
85676
85706
  };
85677
85707
  },
85708
+ /**
85709
+ *
85710
+ * @summary Sunset email segment
85711
+ * @param {number} storefront_oid
85712
+ * @param {string} email_segment_uuid
85713
+ * @param {*} [options] Override http request option.
85714
+ * @throws {RequiredError}
85715
+ */
85716
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options: any = {}): FetchArgs {
85717
+ // verify required parameter 'storefront_oid' is not null or undefined
85718
+ if (storefront_oid === null || storefront_oid === undefined) {
85719
+ throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling sunsetEmailSegment.');
85720
+ }
85721
+ // verify required parameter 'email_segment_uuid' is not null or undefined
85722
+ if (email_segment_uuid === null || email_segment_uuid === undefined) {
85723
+ throw new RequiredError('email_segment_uuid','Required parameter email_segment_uuid was null or undefined when calling sunsetEmailSegment.');
85724
+ }
85725
+ const localVarPath = `/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset`
85726
+ .replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
85727
+ .replace(`{${"email_segment_uuid"}}`, encodeURIComponent(String(email_segment_uuid)));
85728
+ const localVarUrlObj = url.parse(localVarPath, true);
85729
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
85730
+ const localVarHeaderParameter = {} as any;
85731
+ const localVarQueryParameter = {} as any;
85732
+
85733
+ if(configuration && configuration.apiVersion) {
85734
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
85735
+ }
85736
+
85737
+
85738
+
85739
+ // authentication ultraCartBrowserApiKey required
85740
+ if (configuration && configuration.apiKey) {
85741
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
85742
+ ? configuration.apiKey("x-ultracart-browser-key")
85743
+ : configuration.apiKey;
85744
+ localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
85745
+ }
85746
+
85747
+ // authentication ultraCartOauth required
85748
+ // oauth required
85749
+ if (configuration && configuration.accessToken) {
85750
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
85751
+ ? configuration.accessToken("ultraCartOauth", ["storefront_write"])
85752
+ : configuration.accessToken;
85753
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
85754
+ }
85755
+
85756
+ // authentication ultraCartSimpleApiKey required
85757
+ if (configuration && configuration.apiKey) {
85758
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
85759
+ ? configuration.apiKey("x-ultracart-simple-key")
85760
+ : configuration.apiKey;
85761
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
85762
+ }
85763
+
85764
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
85765
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
85766
+ delete localVarUrlObj.search;
85767
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
85768
+
85769
+ return {
85770
+ url: url.format(localVarUrlObj),
85771
+ options: localVarRequestOptions,
85772
+ };
85773
+ },
85678
85774
  /**
85679
85775
  * Remove favorite flag on screen recording
85680
85776
  * @summary Remove favorite flag on screen recording
@@ -90850,6 +90946,28 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
90850
90946
  });
90851
90947
  };
90852
90948
  },
90949
+ /**
90950
+ *
90951
+ * @summary Sunset email segment
90952
+ * @param {number} storefront_oid
90953
+ * @param {string} email_segment_uuid
90954
+ * @param {*} [options] Override http request option.
90955
+ * @throws {RequiredError}
90956
+ */
90957
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
90958
+ const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).sunsetEmailSegment(storefront_oid, email_segment_uuid, options);
90959
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
90960
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
90961
+
90962
+ if (response.status >= 200 && response.status < 300) {
90963
+ return response;
90964
+
90965
+ } else {
90966
+ throw response;
90967
+ }
90968
+ });
90969
+ };
90970
+ },
90853
90971
  /**
90854
90972
  * Remove favorite flag on screen recording
90855
90973
  * @summary Remove favorite flag on screen recording
@@ -93110,6 +93228,17 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
93110
93228
  subscribeToEmailList(storefront_oid: number, email_list_uuid: string, customers: Array<EmailCustomer>, options?: any) {
93111
93229
  return StorefrontApiFp(configuration).subscribeToEmailList(storefront_oid, email_list_uuid, customers, options)(fetch, basePath);
93112
93230
  },
93231
+ /**
93232
+ *
93233
+ * @summary Sunset email segment
93234
+ * @param {number} storefront_oid
93235
+ * @param {string} email_segment_uuid
93236
+ * @param {*} [options] Override http request option.
93237
+ * @throws {RequiredError}
93238
+ */
93239
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any) {
93240
+ return StorefrontApiFp(configuration).sunsetEmailSegment(storefront_oid, email_segment_uuid, options)(fetch, basePath);
93241
+ },
93113
93242
  /**
93114
93243
  * Remove favorite flag on screen recording
93115
93244
  * @summary Remove favorite flag on screen recording
@@ -95084,6 +95213,17 @@ export interface StorefrontApiInterface {
95084
95213
  */
95085
95214
  subscribeToEmailList(storefront_oid: number, email_list_uuid: string, customers: Array<EmailCustomer>, options?: any): Promise<EmailListSubscribeResponse>;
95086
95215
 
95216
+ /**
95217
+ *
95218
+ * @summary Sunset email segment
95219
+ * @param {number} storefront_oid
95220
+ * @param {string} email_segment_uuid
95221
+ * @param {*} [options] Override http request option.
95222
+ * @throws {RequiredError}
95223
+ * @memberof StorefrontApiInterface
95224
+ */
95225
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any): Promise<{}>;
95226
+
95087
95227
  /**
95088
95228
  * Remove favorite flag on screen recording
95089
95229
  * @summary Remove favorite flag on screen recording
@@ -97358,6 +97498,19 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
97358
97498
  return StorefrontApiFp(this.configuration).subscribeToEmailList(storefront_oid, email_list_uuid, customers, options)(this.fetch, this.basePath);
97359
97499
  }
97360
97500
 
97501
+ /**
97502
+ *
97503
+ * @summary Sunset email segment
97504
+ * @param {number} storefront_oid
97505
+ * @param {string} email_segment_uuid
97506
+ * @param {*} [options] Override http request option.
97507
+ * @throws {RequiredError}
97508
+ * @memberof StorefrontApi
97509
+ */
97510
+ public sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any) {
97511
+ return StorefrontApiFp(this.configuration).sunsetEmailSegment(storefront_oid, email_segment_uuid, options)(this.fetch, this.basePath);
97512
+ }
97513
+
97361
97514
  /**
97362
97515
  * Remove favorite flag on screen recording
97363
97516
  * @summary Remove favorite flag on screen recording
package/dist/api.d.ts CHANGED
@@ -34370,6 +34370,26 @@ export interface OrderQueryBatch {
34370
34370
  * @memberof OrderQueryBatch
34371
34371
  */
34372
34372
  order_ids?: Array<string>;
34373
+ /**
34374
+ * Query Target
34375
+ * @type {string}
34376
+ * @memberof OrderQueryBatch
34377
+ */
34378
+ query_target?: OrderQueryBatch.QueryTargetEnum;
34379
+ }
34380
+ /**
34381
+ * @export
34382
+ * @namespace OrderQueryBatch
34383
+ */
34384
+ export declare namespace OrderQueryBatch {
34385
+ /**
34386
+ * @export
34387
+ * @enum {string}
34388
+ */
34389
+ enum QueryTargetEnum {
34390
+ Origin,
34391
+ Cache
34392
+ }
34373
34393
  }
34374
34394
  /**
34375
34395
  *
@@ -40269,6 +40289,18 @@ export interface ScreenshotsResponse {
40269
40289
  * @interface SelfConfig
40270
40290
  */
40271
40291
  export interface SelfConfig {
40292
+ /**
40293
+ * True if the Colorado Retail Delivery Fee should not be collected
40294
+ * @type {boolean}
40295
+ * @memberof SelfConfig
40296
+ */
40297
+ exempt_from_colorado_retail_delivery_fee?: boolean;
40298
+ /**
40299
+ * True if the Minnesota Retail Delivery Fee should not be collected
40300
+ * @type {boolean}
40301
+ * @memberof SelfConfig
40302
+ */
40303
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
40272
40304
  /**
40273
40305
  * True if sales tax should be collected based on billing address instead of shipping address
40274
40306
  * @type {boolean}
@@ -41915,12 +41947,6 @@ export interface Twilio {
41915
41947
  * @memberof Twilio
41916
41948
  */
41917
41949
  api_key_name?: string;
41918
- /**
41919
- *
41920
- * @type {string}
41921
- * @memberof Twilio
41922
- */
41923
- api_key_secret?: string;
41924
41950
  /**
41925
41951
  *
41926
41952
  * @type {string}
@@ -41951,24 +41977,6 @@ export interface Twilio {
41951
41977
  * @memberof Twilio
41952
41978
  */
41953
41979
  phone_numbers?: Array<string>;
41954
- /**
41955
- *
41956
- * @type {string}
41957
- * @memberof Twilio
41958
- */
41959
- private_key_pem?: string;
41960
- /**
41961
- *
41962
- * @type {string}
41963
- * @memberof Twilio
41964
- */
41965
- public_key_pem?: string;
41966
- /**
41967
- *
41968
- * @type {string}
41969
- * @memberof Twilio
41970
- */
41971
- public_key_sid?: string;
41972
41980
  /**
41973
41981
  *
41974
41982
  * @type {string}
@@ -42062,6 +42070,18 @@ export interface TwiliosResponse {
42062
42070
  * @interface UltraCartConfig
42063
42071
  */
42064
42072
  export interface UltraCartConfig {
42073
+ /**
42074
+ * True if the Colorado Retail Delivery Fee should not be collected
42075
+ * @type {boolean}
42076
+ * @memberof UltraCartConfig
42077
+ */
42078
+ exempt_from_colorado_retail_delivery_fee?: boolean;
42079
+ /**
42080
+ * True if the Minnesota Retail Delivery Fee should not be collected
42081
+ * @type {boolean}
42082
+ * @memberof UltraCartConfig
42083
+ */
42084
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
42065
42085
  /**
42066
42086
  * True if sales tax should be collected based on billing address instead of shipping address
42067
42087
  * @type {boolean}
@@ -55302,11 +55322,12 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
55302
55322
  * @param {boolean} [manual_refund] Consider a manual refund done externally
55303
55323
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
55304
55324
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
55325
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
55305
55326
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
55306
55327
  * @param {*} [options] Override http request option.
55307
55328
  * @throws {RequiredError}
55308
55329
  */
55309
- 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;
55330
+ 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;
55310
55331
  /**
55311
55332
  * Create a replacement order based upon a previous order
55312
55333
  * @summary Replacement order
@@ -55580,11 +55601,12 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
55580
55601
  * @param {boolean} [manual_refund] Consider a manual refund done externally
55581
55602
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
55582
55603
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
55604
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
55583
55605
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
55584
55606
  * @param {*} [options] Override http request option.
55585
55607
  * @throws {RequiredError}
55586
55608
  */
55587
- 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>;
55609
+ 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>;
55588
55610
  /**
55589
55611
  * Create a replacement order based upon a previous order
55590
55612
  * @summary Replacement order
@@ -55858,11 +55880,12 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
55858
55880
  * @param {boolean} [manual_refund] Consider a manual refund done externally
55859
55881
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
55860
55882
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
55883
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
55861
55884
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
55862
55885
  * @param {*} [options] Override http request option.
55863
55886
  * @throws {RequiredError}
55864
55887
  */
55865
- 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>;
55888
+ 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>;
55866
55889
  /**
55867
55890
  * Create a replacement order based upon a previous order
55868
55891
  * @summary Replacement order
@@ -56157,12 +56180,13 @@ export interface OrderApiInterface {
56157
56180
  * @param {boolean} [manual_refund] Consider a manual refund done externally
56158
56181
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
56159
56182
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
56183
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
56160
56184
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
56161
56185
  * @param {*} [options] Override http request option.
56162
56186
  * @throws {RequiredError}
56163
56187
  * @memberof OrderApiInterface
56164
56188
  */
56165
- 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>;
56189
+ 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>;
56166
56190
  /**
56167
56191
  * Create a replacement order based upon a previous order
56168
56192
  * @summary Replacement order
@@ -56464,12 +56488,13 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
56464
56488
  * @param {boolean} [manual_refund] Consider a manual refund done externally
56465
56489
  * @param {boolean} [reverse_affiliate_transactions] Reverse affiliate transactions
56466
56490
  * @param {boolean} [issue_store_credit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
56491
+ * @param {string} [auto_order_cancel_reason] Reason for auto orders cancellation
56467
56492
  * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
56468
56493
  * @param {*} [options] Override http request option.
56469
56494
  * @throws {RequiredError}
56470
56495
  * @memberof OrderApi
56471
56496
  */
56472
- 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>;
56497
+ 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>;
56473
56498
  /**
56474
56499
  * Create a replacement order based upon a previous order
56475
56500
  * @summary Replacement order
@@ -58089,6 +58114,15 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
58089
58114
  * @throws {RequiredError}
58090
58115
  */
58091
58116
  subscribeToEmailList(storefront_oid: number, email_list_uuid: string, customers: Array<EmailCustomer>, options?: any): FetchArgs;
58117
+ /**
58118
+ *
58119
+ * @summary Sunset email segment
58120
+ * @param {number} storefront_oid
58121
+ * @param {string} email_segment_uuid
58122
+ * @param {*} [options] Override http request option.
58123
+ * @throws {RequiredError}
58124
+ */
58125
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any): FetchArgs;
58092
58126
  /**
58093
58127
  * Remove favorite flag on screen recording
58094
58128
  * @summary Remove favorite flag on screen recording
@@ -59708,6 +59742,15 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
59708
59742
  * @throws {RequiredError}
59709
59743
  */
59710
59744
  subscribeToEmailList(storefront_oid: number, email_list_uuid: string, customers: Array<EmailCustomer>, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailListSubscribeResponse>;
59745
+ /**
59746
+ *
59747
+ * @summary Sunset email segment
59748
+ * @param {number} storefront_oid
59749
+ * @param {string} email_segment_uuid
59750
+ * @param {*} [options] Override http request option.
59751
+ * @throws {RequiredError}
59752
+ */
59753
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
59711
59754
  /**
59712
59755
  * Remove favorite flag on screen recording
59713
59756
  * @summary Remove favorite flag on screen recording
@@ -61327,6 +61370,15 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
61327
61370
  * @throws {RequiredError}
61328
61371
  */
61329
61372
  subscribeToEmailList(storefront_oid: number, email_list_uuid: string, customers: Array<EmailCustomer>, options?: any): Promise<EmailListSubscribeResponse>;
61373
+ /**
61374
+ *
61375
+ * @summary Sunset email segment
61376
+ * @param {number} storefront_oid
61377
+ * @param {string} email_segment_uuid
61378
+ * @param {*} [options] Override http request option.
61379
+ * @throws {RequiredError}
61380
+ */
61381
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any): Promise<Response>;
61330
61382
  /**
61331
61383
  * Remove favorite flag on screen recording
61332
61384
  * @summary Remove favorite flag on screen recording
@@ -63097,6 +63149,16 @@ export interface StorefrontApiInterface {
63097
63149
  * @memberof StorefrontApiInterface
63098
63150
  */
63099
63151
  subscribeToEmailList(storefront_oid: number, email_list_uuid: string, customers: Array<EmailCustomer>, options?: any): Promise<EmailListSubscribeResponse>;
63152
+ /**
63153
+ *
63154
+ * @summary Sunset email segment
63155
+ * @param {number} storefront_oid
63156
+ * @param {string} email_segment_uuid
63157
+ * @param {*} [options] Override http request option.
63158
+ * @throws {RequiredError}
63159
+ * @memberof StorefrontApiInterface
63160
+ */
63161
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any): Promise<{}>;
63100
63162
  /**
63101
63163
  * Remove favorite flag on screen recording
63102
63164
  * @summary Remove favorite flag on screen recording
@@ -64894,6 +64956,16 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
64894
64956
  * @memberof StorefrontApi
64895
64957
  */
64896
64958
  subscribeToEmailList(storefront_oid: number, email_list_uuid: string, customers: Array<EmailCustomer>, options?: any): Promise<EmailListSubscribeResponse>;
64959
+ /**
64960
+ *
64961
+ * @summary Sunset email segment
64962
+ * @param {number} storefront_oid
64963
+ * @param {string} email_segment_uuid
64964
+ * @param {*} [options] Override http request option.
64965
+ * @throws {RequiredError}
64966
+ * @memberof StorefrontApi
64967
+ */
64968
+ sunsetEmailSegment(storefront_oid: number, email_segment_uuid: string, options?: any): Promise<Response>;
64897
64969
  /**
64898
64970
  * Remove favorite flag on screen recording
64899
64971
  * @summary Remove favorite flag on screen recording
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
@@ -36591,6 +36614,65 @@ var StorefrontApiFetchParamCreator = function (configuration) {
36591
36614
  options: localVarRequestOptions,
36592
36615
  };
36593
36616
  },
36617
+ /**
36618
+ *
36619
+ * @summary Sunset email segment
36620
+ * @param {number} storefront_oid
36621
+ * @param {string} email_segment_uuid
36622
+ * @param {*} [options] Override http request option.
36623
+ * @throws {RequiredError}
36624
+ */
36625
+ sunsetEmailSegment: function (storefront_oid, email_segment_uuid, options) {
36626
+ if (options === void 0) { options = {}; }
36627
+ // verify required parameter 'storefront_oid' is not null or undefined
36628
+ if (storefront_oid === null || storefront_oid === undefined) {
36629
+ throw new RequiredError('storefront_oid', 'Required parameter storefront_oid was null or undefined when calling sunsetEmailSegment.');
36630
+ }
36631
+ // verify required parameter 'email_segment_uuid' is not null or undefined
36632
+ if (email_segment_uuid === null || email_segment_uuid === undefined) {
36633
+ throw new RequiredError('email_segment_uuid', 'Required parameter email_segment_uuid was null or undefined when calling sunsetEmailSegment.');
36634
+ }
36635
+ var localVarPath = "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset"
36636
+ .replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
36637
+ .replace("{".concat("email_segment_uuid", "}"), encodeURIComponent(String(email_segment_uuid)));
36638
+ var localVarUrlObj = url.parse(localVarPath, true);
36639
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
36640
+ var localVarHeaderParameter = {};
36641
+ var localVarQueryParameter = {};
36642
+ if (configuration && configuration.apiVersion) {
36643
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
36644
+ }
36645
+ // authentication ultraCartBrowserApiKey required
36646
+ if (configuration && configuration.apiKey) {
36647
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
36648
+ ? configuration.apiKey("x-ultracart-browser-key")
36649
+ : configuration.apiKey;
36650
+ localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
36651
+ }
36652
+ // authentication ultraCartOauth required
36653
+ // oauth required
36654
+ if (configuration && configuration.accessToken) {
36655
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
36656
+ ? configuration.accessToken("ultraCartOauth", ["storefront_write"])
36657
+ : configuration.accessToken;
36658
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
36659
+ }
36660
+ // authentication ultraCartSimpleApiKey required
36661
+ if (configuration && configuration.apiKey) {
36662
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
36663
+ ? configuration.apiKey("x-ultracart-simple-key")
36664
+ : configuration.apiKey;
36665
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
36666
+ }
36667
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
36668
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
36669
+ delete localVarUrlObj.search;
36670
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
36671
+ return {
36672
+ url: url.format(localVarUrlObj),
36673
+ options: localVarRequestOptions,
36674
+ };
36675
+ },
36594
36676
  /**
36595
36677
  * Remove favorite flag on screen recording
36596
36678
  * @summary Remove favorite flag on screen recording
@@ -41712,6 +41794,29 @@ var StorefrontApiFp = function (configuration) {
41712
41794
  });
41713
41795
  };
41714
41796
  },
41797
+ /**
41798
+ *
41799
+ * @summary Sunset email segment
41800
+ * @param {number} storefront_oid
41801
+ * @param {string} email_segment_uuid
41802
+ * @param {*} [options] Override http request option.
41803
+ * @throws {RequiredError}
41804
+ */
41805
+ sunsetEmailSegment: function (storefront_oid, email_segment_uuid, options) {
41806
+ var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).sunsetEmailSegment(storefront_oid, email_segment_uuid, options);
41807
+ return function (fetch, basePath) {
41808
+ if (fetch === void 0) { fetch = portableFetch; }
41809
+ if (basePath === void 0) { basePath = BASE_PATH; }
41810
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
41811
+ if (response.status >= 200 && response.status < 300) {
41812
+ return response;
41813
+ }
41814
+ else {
41815
+ throw response;
41816
+ }
41817
+ });
41818
+ };
41819
+ },
41715
41820
  /**
41716
41821
  * Remove favorite flag on screen recording
41717
41822
  * @summary Remove favorite flag on screen recording
@@ -43998,6 +44103,17 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
43998
44103
  subscribeToEmailList: function (storefront_oid, email_list_uuid, customers, options) {
43999
44104
  return (0, exports.StorefrontApiFp)(configuration).subscribeToEmailList(storefront_oid, email_list_uuid, customers, options)(fetch, basePath);
44000
44105
  },
44106
+ /**
44107
+ *
44108
+ * @summary Sunset email segment
44109
+ * @param {number} storefront_oid
44110
+ * @param {string} email_segment_uuid
44111
+ * @param {*} [options] Override http request option.
44112
+ * @throws {RequiredError}
44113
+ */
44114
+ sunsetEmailSegment: function (storefront_oid, email_segment_uuid, options) {
44115
+ return (0, exports.StorefrontApiFp)(configuration).sunsetEmailSegment(storefront_oid, email_segment_uuid, options)(fetch, basePath);
44116
+ },
44001
44117
  /**
44002
44118
  * Remove favorite flag on screen recording
44003
44119
  * @summary Remove favorite flag on screen recording
@@ -46127,6 +46243,18 @@ var StorefrontApi = /** @class */ (function (_super) {
46127
46243
  StorefrontApi.prototype.subscribeToEmailList = function (storefront_oid, email_list_uuid, customers, options) {
46128
46244
  return (0, exports.StorefrontApiFp)(this.configuration).subscribeToEmailList(storefront_oid, email_list_uuid, customers, options)(this.fetch, this.basePath);
46129
46245
  };
46246
+ /**
46247
+ *
46248
+ * @summary Sunset email segment
46249
+ * @param {number} storefront_oid
46250
+ * @param {string} email_segment_uuid
46251
+ * @param {*} [options] Override http request option.
46252
+ * @throws {RequiredError}
46253
+ * @memberof StorefrontApi
46254
+ */
46255
+ StorefrontApi.prototype.sunsetEmailSegment = function (storefront_oid, email_segment_uuid, options) {
46256
+ return (0, exports.StorefrontApiFp)(this.configuration).sunsetEmailSegment(storefront_oid, email_segment_uuid, options)(this.fetch, this.basePath);
46257
+ };
46130
46258
  /**
46131
46259
  * Remove favorite flag on screen recording
46132
46260
  * @summary Remove favorite flag on screen recording
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.212",
3
+ "version": "3.10.214",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [