ultracart_rest_api_v2_typescript 3.11.20 → 3.11.21

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.11.20
1
+ ## ultracart_rest_api_v2_typescript@3.11.21
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.11.20 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.11.21 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.11.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
57
58
  | 3.11.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
58
59
  | 3.11.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
59
60
  | 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
package/api.ts CHANGED
@@ -14857,6 +14857,12 @@ export interface CustomReportAccountConfig {
14857
14857
  * @memberof CustomReportAccountConfig
14858
14858
  */
14859
14859
  opt_in_date?: string;
14860
+ /**
14861
+ *
14862
+ * @type {boolean}
14863
+ * @memberof CustomReportAccountConfig
14864
+ */
14865
+ read_only?: boolean;
14860
14866
  /**
14861
14867
  *
14862
14868
  * @type {number}
@@ -14909,6 +14915,108 @@ export interface CustomReportAccountConfigResponse {
14909
14915
  warning?: Warning;
14910
14916
  }
14911
14917
 
14918
+ /**
14919
+ *
14920
+ * @export
14921
+ * @interface CustomReportAnalysisRequest
14922
+ */
14923
+ export interface CustomReportAnalysisRequest {
14924
+ /**
14925
+ *
14926
+ * @type {string}
14927
+ * @memberof CustomReportAnalysisRequest
14928
+ */
14929
+ png_url?: string;
14930
+ /**
14931
+ *
14932
+ * @type {string}
14933
+ * @memberof CustomReportAnalysisRequest
14934
+ */
14935
+ result_url?: string;
14936
+ }
14937
+
14938
+ /**
14939
+ *
14940
+ * @export
14941
+ * @interface CustomReportAnalysisResponse
14942
+ */
14943
+ export interface CustomReportAnalysisResponse {
14944
+ /**
14945
+ *
14946
+ * @type {ModelError}
14947
+ * @memberof CustomReportAnalysisResponse
14948
+ */
14949
+ error?: ModelError;
14950
+ /**
14951
+ *
14952
+ * @type {string}
14953
+ * @memberof CustomReportAnalysisResponse
14954
+ */
14955
+ html?: string;
14956
+ /**
14957
+ *
14958
+ * @type {ResponseMetadata}
14959
+ * @memberof CustomReportAnalysisResponse
14960
+ */
14961
+ metadata?: ResponseMetadata;
14962
+ /**
14963
+ * Indicates if API call was successful
14964
+ * @type {boolean}
14965
+ * @memberof CustomReportAnalysisResponse
14966
+ */
14967
+ success?: boolean;
14968
+ /**
14969
+ *
14970
+ * @type {Warning}
14971
+ * @memberof CustomReportAnalysisResponse
14972
+ */
14973
+ warning?: Warning;
14974
+ }
14975
+
14976
+ /**
14977
+ *
14978
+ * @export
14979
+ * @interface CustomReportChartPngUploadResponse
14980
+ */
14981
+ export interface CustomReportChartPngUploadResponse {
14982
+ /**
14983
+ *
14984
+ * @type {ModelError}
14985
+ * @memberof CustomReportChartPngUploadResponse
14986
+ */
14987
+ error?: ModelError;
14988
+ /**
14989
+ *
14990
+ * @type {ResponseMetadata}
14991
+ * @memberof CustomReportChartPngUploadResponse
14992
+ */
14993
+ metadata?: ResponseMetadata;
14994
+ /**
14995
+ *
14996
+ * @type {string}
14997
+ * @memberof CustomReportChartPngUploadResponse
14998
+ */
14999
+ signed_download_url?: string;
15000
+ /**
15001
+ *
15002
+ * @type {string}
15003
+ * @memberof CustomReportChartPngUploadResponse
15004
+ */
15005
+ signed_upload_url?: string;
15006
+ /**
15007
+ * Indicates if API call was successful
15008
+ * @type {boolean}
15009
+ * @memberof CustomReportChartPngUploadResponse
15010
+ */
15011
+ success?: boolean;
15012
+ /**
15013
+ *
15014
+ * @type {Warning}
15015
+ * @memberof CustomReportChartPngUploadResponse
15016
+ */
15017
+ warning?: Warning;
15018
+ }
15019
+
14912
15020
  /**
14913
15021
  *
14914
15022
  * @export
@@ -31444,7 +31552,7 @@ export interface ItemShippingPackageRequirement {
31444
31552
  */
31445
31553
  export interface ItemTag {
31446
31554
  /**
31447
- * tag_tpe
31555
+ * tag_type
31448
31556
  * @type {string}
31449
31557
  * @memberof ItemTag
31450
31558
  */
@@ -38483,6 +38591,38 @@ export interface RegisterAffiliateClickResponse {
38483
38591
  registered?: boolean;
38484
38592
  }
38485
38593
 
38594
+ /**
38595
+ *
38596
+ * @export
38597
+ * @interface ReplaceOrderItemIdRequest
38598
+ */
38599
+ export interface ReplaceOrderItemIdRequest {
38600
+ /**
38601
+ * Index of the item on the order (one based index)
38602
+ * @type {number}
38603
+ * @memberof ReplaceOrderItemIdRequest
38604
+ */
38605
+ item_index?: number;
38606
+ /**
38607
+ * Item ID
38608
+ * @type {string}
38609
+ * @memberof ReplaceOrderItemIdRequest
38610
+ */
38611
+ merchant_item_id?: string;
38612
+ /**
38613
+ * Order ID
38614
+ * @type {string}
38615
+ * @memberof ReplaceOrderItemIdRequest
38616
+ */
38617
+ order_id?: string;
38618
+ /**
38619
+ * Replacement Item ID
38620
+ * @type {string}
38621
+ * @memberof ReplaceOrderItemIdRequest
38622
+ */
38623
+ replacement_merchant_item_id?: string;
38624
+ }
38625
+
38486
38626
  /**
38487
38627
  *
38488
38628
  * @export
@@ -67176,6 +67316,67 @@ export class CustomerApi extends BaseAPI implements CustomerApiInterface {
67176
67316
  */
67177
67317
  export const DatawarehouseApiFetchParamCreator = function (configuration?: Configuration) {
67178
67318
  return {
67319
+ /**
67320
+ * Analyze a custom report on the UltraCart account.
67321
+ * @summary Analyze a custom report
67322
+ * @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
67323
+ * @param {number} custom_report_oid The report oid to analyze.
67324
+ * @param {*} [options] Override http request option.
67325
+ * @throws {RequiredError}
67326
+ */
67327
+ analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options: any = {}): FetchArgs {
67328
+ // verify required parameter 'analyze_request' is not null or undefined
67329
+ if (analyze_request === null || analyze_request === undefined) {
67330
+ throw new RequiredError('analyze_request','Required parameter analyze_request was null or undefined when calling analyzeCustomReport.');
67331
+ }
67332
+ // verify required parameter 'custom_report_oid' is not null or undefined
67333
+ if (custom_report_oid === null || custom_report_oid === undefined) {
67334
+ throw new RequiredError('custom_report_oid','Required parameter custom_report_oid was null or undefined when calling analyzeCustomReport.');
67335
+ }
67336
+ const localVarPath = `/datawarehouse/custom_reports/{custom_report_oid}/analysis`
67337
+ .replace(`{${"custom_report_oid"}}`, encodeURIComponent(String(custom_report_oid)));
67338
+ const localVarUrlObj = url.parse(localVarPath, true);
67339
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
67340
+ const localVarHeaderParameter = {} as any;
67341
+ const localVarQueryParameter = {} as any;
67342
+
67343
+ if(configuration && configuration.apiVersion) {
67344
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
67345
+ }
67346
+
67347
+
67348
+
67349
+ // authentication ultraCartOauth required
67350
+ // oauth required
67351
+ if (configuration && configuration.accessToken) {
67352
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
67353
+ ? configuration.accessToken("ultraCartOauth", [])
67354
+ : configuration.accessToken;
67355
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
67356
+ }
67357
+
67358
+ // authentication ultraCartSimpleApiKey required
67359
+ if (configuration && configuration.apiKey) {
67360
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
67361
+ ? configuration.apiKey("x-ultracart-simple-key")
67362
+ : configuration.apiKey;
67363
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
67364
+ }
67365
+
67366
+ localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
67367
+
67368
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
67369
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
67370
+ delete localVarUrlObj.search;
67371
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
67372
+ const needsSerialization = (<any>"CustomReportAnalysisRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
67373
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(analyze_request || {}) : (analyze_request || "");
67374
+
67375
+ return {
67376
+ url: url.format(localVarUrlObj),
67377
+ options: localVarRequestOptions,
67378
+ };
67379
+ },
67179
67380
  /**
67180
67381
  * Delete a custom dashboard on the UltraCart account.
67181
67382
  * @summary Delete a custom dashboard
@@ -67837,6 +68038,58 @@ export const DatawarehouseApiFetchParamCreator = function (configuration?: Confi
67837
68038
 
67838
68039
 
67839
68040
 
68041
+ // authentication ultraCartOauth required
68042
+ // oauth required
68043
+ if (configuration && configuration.accessToken) {
68044
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
68045
+ ? configuration.accessToken("ultraCartOauth", [])
68046
+ : configuration.accessToken;
68047
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
68048
+ }
68049
+
68050
+ // authentication ultraCartSimpleApiKey required
68051
+ if (configuration && configuration.apiKey) {
68052
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
68053
+ ? configuration.apiKey("x-ultracart-simple-key")
68054
+ : configuration.apiKey;
68055
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
68056
+ }
68057
+
68058
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
68059
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
68060
+ delete localVarUrlObj.search;
68061
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
68062
+
68063
+ return {
68064
+ url: url.format(localVarUrlObj),
68065
+ options: localVarRequestOptions,
68066
+ };
68067
+ },
68068
+ /**
68069
+ * Upload a PNG of a custom report chart
68070
+ * @summary Upload a PNG of a custom report chart
68071
+ * @param {number} custom_report_oid The report oid to upload a chart PNG for.
68072
+ * @param {*} [options] Override http request option.
68073
+ * @throws {RequiredError}
68074
+ */
68075
+ getCustomReportChartPngUploadUrl(custom_report_oid: number, options: any = {}): FetchArgs {
68076
+ // verify required parameter 'custom_report_oid' is not null or undefined
68077
+ if (custom_report_oid === null || custom_report_oid === undefined) {
68078
+ throw new RequiredError('custom_report_oid','Required parameter custom_report_oid was null or undefined when calling getCustomReportChartPngUploadUrl.');
68079
+ }
68080
+ const localVarPath = `/datawarehouse/custom_reports/{custom_report_oid}/chart_png`
68081
+ .replace(`{${"custom_report_oid"}}`, encodeURIComponent(String(custom_report_oid)));
68082
+ const localVarUrlObj = url.parse(localVarPath, true);
68083
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
68084
+ const localVarHeaderParameter = {} as any;
68085
+ const localVarQueryParameter = {} as any;
68086
+
68087
+ if(configuration && configuration.apiVersion) {
68088
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
68089
+ }
68090
+
68091
+
68092
+
67840
68093
  // authentication ultraCartOauth required
67841
68094
  // oauth required
67842
68095
  if (configuration && configuration.accessToken) {
@@ -68704,6 +68957,28 @@ export const DatawarehouseApiFetchParamCreator = function (configuration?: Confi
68704
68957
  */
68705
68958
  export const DatawarehouseApiFp = function(configuration?: Configuration) {
68706
68959
  return {
68960
+ /**
68961
+ * Analyze a custom report on the UltraCart account.
68962
+ * @summary Analyze a custom report
68963
+ * @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
68964
+ * @param {number} custom_report_oid The report oid to analyze.
68965
+ * @param {*} [options] Override http request option.
68966
+ * @throws {RequiredError}
68967
+ */
68968
+ analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomReportAnalysisResponse> {
68969
+ const localVarFetchArgs = DatawarehouseApiFetchParamCreator(configuration).analyzeCustomReport(analyze_request, custom_report_oid, options);
68970
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
68971
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
68972
+
68973
+ if (response.status >= 200 && response.status < 300) {
68974
+ return response.json();
68975
+
68976
+ } else {
68977
+ throw response;
68978
+ }
68979
+ });
68980
+ };
68981
+ },
68707
68982
  /**
68708
68983
  * Delete a custom dashboard on the UltraCart account.
68709
68984
  * @summary Delete a custom dashboard
@@ -68977,6 +69252,27 @@ export const DatawarehouseApiFp = function(configuration?: Configuration) {
68977
69252
  });
68978
69253
  };
68979
69254
  },
69255
+ /**
69256
+ * Upload a PNG of a custom report chart
69257
+ * @summary Upload a PNG of a custom report chart
69258
+ * @param {number} custom_report_oid The report oid to upload a chart PNG for.
69259
+ * @param {*} [options] Override http request option.
69260
+ * @throws {RequiredError}
69261
+ */
69262
+ getCustomReportChartPngUploadUrl(custom_report_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomReportChartPngUploadResponse> {
69263
+ const localVarFetchArgs = DatawarehouseApiFetchParamCreator(configuration).getCustomReportChartPngUploadUrl(custom_report_oid, options);
69264
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
69265
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
69266
+
69267
+ if (response.status >= 200 && response.status < 300) {
69268
+ return response.json();
69269
+
69270
+ } else {
69271
+ throw response;
69272
+ }
69273
+ });
69274
+ };
69275
+ },
68980
69276
  /**
68981
69277
  * Retrieve a custom reports
68982
69278
  * @summary Get custom reports
@@ -69305,6 +69601,17 @@ export const DatawarehouseApiFp = function(configuration?: Configuration) {
69305
69601
  */
69306
69602
  export const DatawarehouseApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
69307
69603
  return {
69604
+ /**
69605
+ * Analyze a custom report on the UltraCart account.
69606
+ * @summary Analyze a custom report
69607
+ * @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
69608
+ * @param {number} custom_report_oid The report oid to analyze.
69609
+ * @param {*} [options] Override http request option.
69610
+ * @throws {RequiredError}
69611
+ */
69612
+ analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options?: any) {
69613
+ return DatawarehouseApiFp(configuration).analyzeCustomReport(analyze_request, custom_report_oid, options)(fetch, basePath);
69614
+ },
69308
69615
  /**
69309
69616
  * Delete a custom dashboard on the UltraCart account.
69310
69617
  * @summary Delete a custom dashboard
@@ -69435,6 +69742,16 @@ export const DatawarehouseApiFactory = function (configuration?: Configuration,
69435
69742
  getCustomReportAccountConfig(options?: any) {
69436
69743
  return DatawarehouseApiFp(configuration).getCustomReportAccountConfig(options)(fetch, basePath);
69437
69744
  },
69745
+ /**
69746
+ * Upload a PNG of a custom report chart
69747
+ * @summary Upload a PNG of a custom report chart
69748
+ * @param {number} custom_report_oid The report oid to upload a chart PNG for.
69749
+ * @param {*} [options] Override http request option.
69750
+ * @throws {RequiredError}
69751
+ */
69752
+ getCustomReportChartPngUploadUrl(custom_report_oid: number, options?: any) {
69753
+ return DatawarehouseApiFp(configuration).getCustomReportChartPngUploadUrl(custom_report_oid, options)(fetch, basePath);
69754
+ },
69438
69755
  /**
69439
69756
  * Retrieve a custom reports
69440
69757
  * @summary Get custom reports
@@ -69598,6 +69915,17 @@ export const DatawarehouseApiFactory = function (configuration?: Configuration,
69598
69915
  * @interface DatawarehouseApi
69599
69916
  */
69600
69917
  export interface DatawarehouseApiInterface {
69918
+ /**
69919
+ * Analyze a custom report on the UltraCart account.
69920
+ * @summary Analyze a custom report
69921
+ * @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
69922
+ * @param {number} custom_report_oid The report oid to analyze.
69923
+ * @param {*} [options] Override http request option.
69924
+ * @throws {RequiredError}
69925
+ * @memberof DatawarehouseApiInterface
69926
+ */
69927
+ analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options?: any): Promise<CustomReportAnalysisResponse>;
69928
+
69601
69929
  /**
69602
69930
  * Delete a custom dashboard on the UltraCart account.
69603
69931
  * @summary Delete a custom dashboard
@@ -69728,6 +70056,16 @@ export interface DatawarehouseApiInterface {
69728
70056
  */
69729
70057
  getCustomReportAccountConfig(options?: any): Promise<CustomReportAccountConfigResponse>;
69730
70058
 
70059
+ /**
70060
+ * Upload a PNG of a custom report chart
70061
+ * @summary Upload a PNG of a custom report chart
70062
+ * @param {number} custom_report_oid The report oid to upload a chart PNG for.
70063
+ * @param {*} [options] Override http request option.
70064
+ * @throws {RequiredError}
70065
+ * @memberof DatawarehouseApiInterface
70066
+ */
70067
+ getCustomReportChartPngUploadUrl(custom_report_oid: number, options?: any): Promise<CustomReportChartPngUploadResponse>;
70068
+
69731
70069
  /**
69732
70070
  * Retrieve a custom reports
69733
70071
  * @summary Get custom reports
@@ -69891,6 +70229,19 @@ export interface DatawarehouseApiInterface {
69891
70229
  * @extends {BaseAPI}
69892
70230
  */
69893
70231
  export class DatawarehouseApi extends BaseAPI implements DatawarehouseApiInterface {
70232
+ /**
70233
+ * Analyze a custom report on the UltraCart account.
70234
+ * @summary Analyze a custom report
70235
+ * @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
70236
+ * @param {number} custom_report_oid The report oid to analyze.
70237
+ * @param {*} [options] Override http request option.
70238
+ * @throws {RequiredError}
70239
+ * @memberof DatawarehouseApi
70240
+ */
70241
+ public analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options?: any) {
70242
+ return DatawarehouseApiFp(this.configuration).analyzeCustomReport(analyze_request, custom_report_oid, options)(this.fetch, this.basePath);
70243
+ }
70244
+
69894
70245
  /**
69895
70246
  * Delete a custom dashboard on the UltraCart account.
69896
70247
  * @summary Delete a custom dashboard
@@ -70047,6 +70398,18 @@ export class DatawarehouseApi extends BaseAPI implements DatawarehouseApiInterfa
70047
70398
  return DatawarehouseApiFp(this.configuration).getCustomReportAccountConfig(options)(this.fetch, this.basePath);
70048
70399
  }
70049
70400
 
70401
+ /**
70402
+ * Upload a PNG of a custom report chart
70403
+ * @summary Upload a PNG of a custom report chart
70404
+ * @param {number} custom_report_oid The report oid to upload a chart PNG for.
70405
+ * @param {*} [options] Override http request option.
70406
+ * @throws {RequiredError}
70407
+ * @memberof DatawarehouseApi
70408
+ */
70409
+ public getCustomReportChartPngUploadUrl(custom_report_oid: number, options?: any) {
70410
+ return DatawarehouseApiFp(this.configuration).getCustomReportChartPngUploadUrl(custom_report_oid, options)(this.fetch, this.basePath);
70411
+ }
70412
+
70050
70413
  /**
70051
70414
  * Retrieve a custom reports
70052
70415
  * @summary Get custom reports
@@ -77152,6 +77515,72 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
77152
77515
  options: localVarRequestOptions,
77153
77516
  };
77154
77517
  },
77518
+ /**
77519
+ * Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
77520
+ * @summary Replaces an order item id
77521
+ * @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
77522
+ * @param {string} order_id The order id to update.
77523
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
77524
+ * @param {*} [options] Override http request option.
77525
+ * @throws {RequiredError}
77526
+ */
77527
+ replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options: any = {}): FetchArgs {
77528
+ // verify required parameter 'replace_order_item_id_request' is not null or undefined
77529
+ if (replace_order_item_id_request === null || replace_order_item_id_request === undefined) {
77530
+ throw new RequiredError('replace_order_item_id_request','Required parameter replace_order_item_id_request was null or undefined when calling replaceOrderItemMerchantItemId.');
77531
+ }
77532
+ // verify required parameter 'order_id' is not null or undefined
77533
+ if (order_id === null || order_id === undefined) {
77534
+ throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling replaceOrderItemMerchantItemId.');
77535
+ }
77536
+ const localVarPath = `/order/orders/{order_id}/replace_item_id`
77537
+ .replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
77538
+ const localVarUrlObj = url.parse(localVarPath, true);
77539
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
77540
+ const localVarHeaderParameter = {} as any;
77541
+ const localVarQueryParameter = {} as any;
77542
+
77543
+ if(configuration && configuration.apiVersion) {
77544
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
77545
+ }
77546
+
77547
+
77548
+
77549
+ // authentication ultraCartOauth required
77550
+ // oauth required
77551
+ if (configuration && configuration.accessToken) {
77552
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
77553
+ ? configuration.accessToken("ultraCartOauth", ["order_write"])
77554
+ : configuration.accessToken;
77555
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
77556
+ }
77557
+
77558
+ // authentication ultraCartSimpleApiKey required
77559
+ if (configuration && configuration.apiKey) {
77560
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
77561
+ ? configuration.apiKey("x-ultracart-simple-key")
77562
+ : configuration.apiKey;
77563
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
77564
+ }
77565
+
77566
+ if (_expand !== undefined) {
77567
+ localVarQueryParameter['_expand'] = _expand;
77568
+ }
77569
+
77570
+ localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
77571
+
77572
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
77573
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
77574
+ delete localVarUrlObj.search;
77575
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
77576
+ const needsSerialization = (<any>"ReplaceOrderItemIdRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
77577
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(replace_order_item_id_request || {}) : (replace_order_item_id_request || "");
77578
+
77579
+ return {
77580
+ url: url.format(localVarUrlObj),
77581
+ options: localVarRequestOptions,
77582
+ };
77583
+ },
77155
77584
  /**
77156
77585
  * Create a replacement order based upon a previous order
77157
77586
  * @summary Replacement order
@@ -78071,6 +78500,29 @@ export const OrderApiFp = function(configuration?: Configuration) {
78071
78500
  });
78072
78501
  };
78073
78502
  },
78503
+ /**
78504
+ * Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
78505
+ * @summary Replaces an order item id
78506
+ * @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
78507
+ * @param {string} order_id The order id to update.
78508
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
78509
+ * @param {*} [options] Override http request option.
78510
+ * @throws {RequiredError}
78511
+ */
78512
+ replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
78513
+ const localVarFetchArgs = OrderApiFetchParamCreator(configuration).replaceOrderItemMerchantItemId(replace_order_item_id_request, order_id, _expand, options);
78514
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
78515
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
78516
+
78517
+ if (response.status >= 200 && response.status < 300) {
78518
+ return response.json();
78519
+
78520
+ } else {
78521
+ throw response;
78522
+ }
78523
+ });
78524
+ };
78525
+ },
78074
78526
  /**
78075
78527
  * Create a replacement order based upon a previous order
78076
78528
  * @summary Replacement order
@@ -78505,6 +78957,18 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
78505
78957
  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) {
78506
78958
  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);
78507
78959
  },
78960
+ /**
78961
+ * Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
78962
+ * @summary Replaces an order item id
78963
+ * @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
78964
+ * @param {string} order_id The order id to update.
78965
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
78966
+ * @param {*} [options] Override http request option.
78967
+ * @throws {RequiredError}
78968
+ */
78969
+ replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options?: any) {
78970
+ return OrderApiFp(configuration).replaceOrderItemMerchantItemId(replace_order_item_id_request, order_id, _expand, options)(fetch, basePath);
78971
+ },
78508
78972
  /**
78509
78973
  * Create a replacement order based upon a previous order
78510
78974
  * @summary Replacement order
@@ -78862,6 +79326,18 @@ export interface OrderApiInterface {
78862
79326
  */
78863
79327
  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>;
78864
79328
 
79329
+ /**
79330
+ * Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
79331
+ * @summary Replaces an order item id
79332
+ * @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
79333
+ * @param {string} order_id The order id to update.
79334
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
79335
+ * @param {*} [options] Override http request option.
79336
+ * @throws {RequiredError}
79337
+ * @memberof OrderApiInterface
79338
+ */
79339
+ replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
79340
+
78865
79341
  /**
78866
79342
  * Create a replacement order based upon a previous order
78867
79343
  * @summary Replacement order
@@ -79263,6 +79739,20 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
79263
79739
  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);
79264
79740
  }
79265
79741
 
79742
+ /**
79743
+ * Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
79744
+ * @summary Replaces an order item id
79745
+ * @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
79746
+ * @param {string} order_id The order id to update.
79747
+ * @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
79748
+ * @param {*} [options] Override http request option.
79749
+ * @throws {RequiredError}
79750
+ * @memberof OrderApi
79751
+ */
79752
+ public replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options?: any) {
79753
+ return OrderApiFp(this.configuration).replaceOrderItemMerchantItemId(replace_order_item_id_request, order_id, _expand, options)(this.fetch, this.basePath);
79754
+ }
79755
+
79266
79756
  /**
79267
79757
  * Create a replacement order based upon a previous order
79268
79758
  * @summary Replacement order