ultracart_rest_api_v2_typescript 4.1.20 → 4.1.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.
@@ -338,6 +338,9 @@ src/models/CustomDashboardsResponse.ts
338
338
  src/models/CustomReport.ts
339
339
  src/models/CustomReportAccountConfig.ts
340
340
  src/models/CustomReportAccountConfigResponse.ts
341
+ src/models/CustomReportAnalysisRequest.ts
342
+ src/models/CustomReportAnalysisResponse.ts
343
+ src/models/CustomReportChartPngUploadResponse.ts
341
344
  src/models/CustomReportExecutionParameter.ts
342
345
  src/models/CustomReportExecutionRequest.ts
343
346
  src/models/CustomReportExecutionResponse.ts
@@ -744,6 +747,7 @@ src/models/Property.ts
744
747
  src/models/PublishLibraryItemRequest.ts
745
748
  src/models/RegisterAffiliateClickRequest.ts
746
749
  src/models/RegisterAffiliateClickResponse.ts
750
+ src/models/ReplaceOrderItemIdRequest.ts
747
751
  src/models/Report.ts
748
752
  src/models/ReportAuth.ts
749
753
  src/models/ReportAuthResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.20
2
+ ## ultracart_rest_api_v2_typescript@4.1.21
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.20 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.21 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
88
89
  | 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
89
90
  | 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
90
91
  | 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
@@ -10,7 +10,11 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { CustomDashboard, CustomDashboardResponse, CustomDashboardSchedule, CustomDashboardScheduleResponse, CustomDashboardSchedulesResponse, CustomDashboardsResponse, CustomReport, CustomReportAccountConfig, CustomReportAccountConfigResponse, CustomReportExecutionRequest, CustomReportExecutionResponse, CustomReportResponse, CustomReportsExecutionRequest, CustomReportsExecutionResponse, CustomReportsResponse, Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
13
+ import { CustomDashboard, CustomDashboardResponse, CustomDashboardSchedule, CustomDashboardScheduleResponse, CustomDashboardSchedulesResponse, CustomDashboardsResponse, CustomReport, CustomReportAccountConfig, CustomReportAccountConfigResponse, CustomReportAnalysisRequest, CustomReportAnalysisResponse, CustomReportChartPngUploadResponse, CustomReportExecutionRequest, CustomReportExecutionResponse, CustomReportResponse, CustomReportsExecutionRequest, CustomReportsExecutionResponse, CustomReportsResponse, Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
14
+ export interface AnalyzeCustomReportRequest {
15
+ customReportOid: number;
16
+ analyzeRequest: CustomReportAnalysisRequest;
17
+ }
14
18
  export interface DeleteCustomDashboardRequest {
15
19
  customDashboardOid: number;
16
20
  }
@@ -46,6 +50,9 @@ export interface GetCustomDashboardSchedulesRequest {
46
50
  export interface GetCustomReportRequest {
47
51
  customReportOid: number;
48
52
  }
53
+ export interface GetCustomReportChartPngUploadUrlRequest {
54
+ customReportOid: number;
55
+ }
49
56
  export interface GetReportRequest {
50
57
  reportOid: number;
51
58
  }
@@ -96,6 +103,21 @@ export interface UpdateReportRequest {
96
103
  * @interface DatawarehouseApiInterface
97
104
  */
98
105
  export interface DatawarehouseApiInterface {
106
+ /**
107
+ * Analyze a custom report on the UltraCart account.
108
+ * @summary Analyze a custom report
109
+ * @param {number} customReportOid The report oid to analyze.
110
+ * @param {CustomReportAnalysisRequest} analyzeRequest Request to analyze custom report
111
+ * @param {*} [options] Override http request option.
112
+ * @throws {RequiredError}
113
+ * @memberof DatawarehouseApiInterface
114
+ */
115
+ analyzeCustomReportRaw(requestParameters: AnalyzeCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportAnalysisResponse>>;
116
+ /**
117
+ * Analyze a custom report on the UltraCart account.
118
+ * Analyze a custom report
119
+ */
120
+ analyzeCustomReport(requestParameters: AnalyzeCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAnalysisResponse>;
99
121
  /**
100
122
  * Delete a custom dashboard on the UltraCart account.
101
123
  * @summary Delete a custom dashboard
@@ -278,6 +300,20 @@ export interface DatawarehouseApiInterface {
278
300
  * Get custom report account configuration
279
301
  */
280
302
  getCustomReportAccountConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAccountConfigResponse>;
303
+ /**
304
+ * Upload a PNG of a custom report chart
305
+ * @summary Upload a PNG of a custom report chart
306
+ * @param {number} customReportOid The report oid to upload a chart PNG for.
307
+ * @param {*} [options] Override http request option.
308
+ * @throws {RequiredError}
309
+ * @memberof DatawarehouseApiInterface
310
+ */
311
+ getCustomReportChartPngUploadUrlRaw(requestParameters: GetCustomReportChartPngUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportChartPngUploadResponse>>;
312
+ /**
313
+ * Upload a PNG of a custom report chart
314
+ * Upload a PNG of a custom report chart
315
+ */
316
+ getCustomReportChartPngUploadUrl(requestParameters: GetCustomReportChartPngUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportChartPngUploadResponse>;
281
317
  /**
282
318
  * Retrieve a custom reports
283
319
  * @summary Get custom reports
@@ -497,6 +533,16 @@ export interface DatawarehouseApiInterface {
497
533
  *
498
534
  */
499
535
  export declare class DatawarehouseApi extends runtime.BaseAPI implements DatawarehouseApiInterface {
536
+ /**
537
+ * Analyze a custom report on the UltraCart account.
538
+ * Analyze a custom report
539
+ */
540
+ analyzeCustomReportRaw(requestParameters: AnalyzeCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportAnalysisResponse>>;
541
+ /**
542
+ * Analyze a custom report on the UltraCart account.
543
+ * Analyze a custom report
544
+ */
545
+ analyzeCustomReport(requestParameters: AnalyzeCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAnalysisResponse>;
500
546
  /**
501
547
  * Delete a custom dashboard on the UltraCart account.
502
548
  * Delete a custom dashboard
@@ -627,6 +673,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
627
673
  * Get custom report account configuration
628
674
  */
629
675
  getCustomReportAccountConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAccountConfigResponse>;
676
+ /**
677
+ * Upload a PNG of a custom report chart
678
+ * Upload a PNG of a custom report chart
679
+ */
680
+ getCustomReportChartPngUploadUrlRaw(requestParameters: GetCustomReportChartPngUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportChartPngUploadResponse>>;
681
+ /**
682
+ * Upload a PNG of a custom report chart
683
+ * Upload a PNG of a custom report chart
684
+ */
685
+ getCustomReportChartPngUploadUrl(requestParameters: GetCustomReportChartPngUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportChartPngUploadResponse>;
630
686
  /**
631
687
  * Retrieve a custom reports
632
688
  * Get custom reports
@@ -75,6 +75,70 @@ var DatawarehouseApi = /** @class */ (function (_super) {
75
75
  function DatawarehouseApi() {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
+ /**
79
+ * Analyze a custom report on the UltraCart account.
80
+ * Analyze a custom report
81
+ */
82
+ DatawarehouseApi.prototype.analyzeCustomReportRaw = function (requestParameters, initOverrides) {
83
+ return __awaiter(this, void 0, void 0, function () {
84
+ var queryParameters, headerParameters, _a, _b, response;
85
+ return __generator(this, function (_c) {
86
+ switch (_c.label) {
87
+ case 0:
88
+ if (requestParameters.customReportOid === null || requestParameters.customReportOid === undefined) {
89
+ throw new runtime.RequiredError('customReportOid', 'Required parameter requestParameters.customReportOid was null or undefined when calling analyzeCustomReport.');
90
+ }
91
+ if (requestParameters.analyzeRequest === null || requestParameters.analyzeRequest === undefined) {
92
+ throw new runtime.RequiredError('analyzeRequest', 'Required parameter requestParameters.analyzeRequest was null or undefined when calling analyzeCustomReport.');
93
+ }
94
+ queryParameters = {};
95
+ headerParameters = {};
96
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
97
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
98
+ // oauth required
99
+ _a = headerParameters;
100
+ _b = "Authorization";
101
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
102
+ case 1:
103
+ // oauth required
104
+ _a[_b] = _c.sent();
105
+ _c.label = 2;
106
+ case 2:
107
+ if (this.configuration && this.configuration.apiKey) {
108
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
109
+ }
110
+ return [4 /*yield*/, this.request({
111
+ path: "/datawarehouse/custom_reports/{custom_report_oid}/analysis".replace("{".concat("custom_report_oid", "}"), encodeURIComponent(String(requestParameters.customReportOid))),
112
+ method: 'PUT',
113
+ headers: headerParameters,
114
+ query: queryParameters,
115
+ body: (0, models_1.CustomReportAnalysisRequestToJSON)(requestParameters.analyzeRequest),
116
+ }, initOverrides)];
117
+ case 3:
118
+ response = _c.sent();
119
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomReportAnalysisResponseFromJSON)(jsonValue); })];
120
+ }
121
+ });
122
+ });
123
+ };
124
+ /**
125
+ * Analyze a custom report on the UltraCart account.
126
+ * Analyze a custom report
127
+ */
128
+ DatawarehouseApi.prototype.analyzeCustomReport = function (requestParameters, initOverrides) {
129
+ return __awaiter(this, void 0, void 0, function () {
130
+ var response;
131
+ return __generator(this, function (_a) {
132
+ switch (_a.label) {
133
+ case 0: return [4 /*yield*/, this.analyzeCustomReportRaw(requestParameters, initOverrides)];
134
+ case 1:
135
+ response = _a.sent();
136
+ return [4 /*yield*/, response.value()];
137
+ case 2: return [2 /*return*/, _a.sent()];
138
+ }
139
+ });
140
+ });
141
+ };
78
142
  /**
79
143
  * Delete a custom dashboard on the UltraCart account.
80
144
  * Delete a custom dashboard
@@ -840,6 +904,65 @@ var DatawarehouseApi = /** @class */ (function (_super) {
840
904
  });
841
905
  });
842
906
  };
907
+ /**
908
+ * Upload a PNG of a custom report chart
909
+ * Upload a PNG of a custom report chart
910
+ */
911
+ DatawarehouseApi.prototype.getCustomReportChartPngUploadUrlRaw = function (requestParameters, initOverrides) {
912
+ return __awaiter(this, void 0, void 0, function () {
913
+ var queryParameters, headerParameters, _a, _b, response;
914
+ return __generator(this, function (_c) {
915
+ switch (_c.label) {
916
+ case 0:
917
+ if (requestParameters.customReportOid === null || requestParameters.customReportOid === undefined) {
918
+ throw new runtime.RequiredError('customReportOid', 'Required parameter requestParameters.customReportOid was null or undefined when calling getCustomReportChartPngUploadUrl.');
919
+ }
920
+ queryParameters = {};
921
+ headerParameters = {};
922
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
923
+ // oauth required
924
+ _a = headerParameters;
925
+ _b = "Authorization";
926
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
927
+ case 1:
928
+ // oauth required
929
+ _a[_b] = _c.sent();
930
+ _c.label = 2;
931
+ case 2:
932
+ if (this.configuration && this.configuration.apiKey) {
933
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
934
+ }
935
+ return [4 /*yield*/, this.request({
936
+ path: "/datawarehouse/custom_reports/{custom_report_oid}/chart_png".replace("{".concat("custom_report_oid", "}"), encodeURIComponent(String(requestParameters.customReportOid))),
937
+ method: 'GET',
938
+ headers: headerParameters,
939
+ query: queryParameters,
940
+ }, initOverrides)];
941
+ case 3:
942
+ response = _c.sent();
943
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomReportChartPngUploadResponseFromJSON)(jsonValue); })];
944
+ }
945
+ });
946
+ });
947
+ };
948
+ /**
949
+ * Upload a PNG of a custom report chart
950
+ * Upload a PNG of a custom report chart
951
+ */
952
+ DatawarehouseApi.prototype.getCustomReportChartPngUploadUrl = function (requestParameters, initOverrides) {
953
+ return __awaiter(this, void 0, void 0, function () {
954
+ var response;
955
+ return __generator(this, function (_a) {
956
+ switch (_a.label) {
957
+ case 0: return [4 /*yield*/, this.getCustomReportChartPngUploadUrlRaw(requestParameters, initOverrides)];
958
+ case 1:
959
+ response = _a.sent();
960
+ return [4 /*yield*/, response.value()];
961
+ case 2: return [2 /*return*/, _a.sent()];
962
+ }
963
+ });
964
+ });
965
+ };
843
966
  /**
844
967
  * Retrieve a custom reports
845
968
  * Get custom reports
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderValidationRequest, OrderValidationResponse, OrdersResponse } from '../models';
13
+ import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
14
14
  export interface AdjustOrderTotalRequest {
15
15
  orderId: string;
16
16
  desiredTotal: string;
@@ -130,6 +130,11 @@ export interface RefundOrderRequest {
130
130
  autoOrderCancelReason?: string;
131
131
  expand?: string;
132
132
  }
133
+ export interface ReplaceOrderItemMerchantItemIdRequest {
134
+ orderId: string;
135
+ replaceOrderItemIdRequest: ReplaceOrderItemIdRequest;
136
+ expand?: string;
137
+ }
133
138
  export interface ReplacementRequest {
134
139
  orderId: string;
135
140
  replacement: OrderReplacement;
@@ -524,6 +529,22 @@ export interface OrderApiInterface {
524
529
  * Refund an order
525
530
  */
526
531
  refundOrder(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
532
+ /**
533
+ * 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.
534
+ * @summary Replaces an order item id
535
+ * @param {string} orderId The order id to update.
536
+ * @param {ReplaceOrderItemIdRequest} replaceOrderItemIdRequest Replacement Request
537
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
538
+ * @param {*} [options] Override http request option.
539
+ * @throws {RequiredError}
540
+ * @memberof OrderApiInterface
541
+ */
542
+ replaceOrderItemMerchantItemIdRaw(requestParameters: ReplaceOrderItemMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
543
+ /**
544
+ * 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.
545
+ * Replaces an order item id
546
+ */
547
+ replaceOrderItemMerchantItemId(requestParameters: ReplaceOrderItemMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
527
548
  /**
528
549
  * Create a replacement order based upon a previous order
529
550
  * @summary Replacement order
@@ -850,6 +871,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
850
871
  * Refund an order
851
872
  */
852
873
  refundOrder(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
874
+ /**
875
+ * 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.
876
+ * Replaces an order item id
877
+ */
878
+ replaceOrderItemMerchantItemIdRaw(requestParameters: ReplaceOrderItemMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
879
+ /**
880
+ * 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.
881
+ * Replaces an order item id
882
+ */
883
+ replaceOrderItemMerchantItemId(requestParameters: ReplaceOrderItemMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
853
884
  /**
854
885
  * Create a replacement order based upon a previous order
855
886
  * Replacement order
@@ -1550,6 +1550,73 @@ var OrderApi = /** @class */ (function (_super) {
1550
1550
  });
1551
1551
  });
1552
1552
  };
1553
+ /**
1554
+ * 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.
1555
+ * Replaces an order item id
1556
+ */
1557
+ OrderApi.prototype.replaceOrderItemMerchantItemIdRaw = function (requestParameters, initOverrides) {
1558
+ return __awaiter(this, void 0, void 0, function () {
1559
+ var queryParameters, headerParameters, _a, _b, response;
1560
+ return __generator(this, function (_c) {
1561
+ switch (_c.label) {
1562
+ case 0:
1563
+ if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
1564
+ throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling replaceOrderItemMerchantItemId.');
1565
+ }
1566
+ if (requestParameters.replaceOrderItemIdRequest === null || requestParameters.replaceOrderItemIdRequest === undefined) {
1567
+ throw new runtime.RequiredError('replaceOrderItemIdRequest', 'Required parameter requestParameters.replaceOrderItemIdRequest was null or undefined when calling replaceOrderItemMerchantItemId.');
1568
+ }
1569
+ queryParameters = {};
1570
+ if (requestParameters.expand !== undefined) {
1571
+ queryParameters['_expand'] = requestParameters.expand;
1572
+ }
1573
+ headerParameters = {};
1574
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
1575
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1576
+ // oauth required
1577
+ _a = headerParameters;
1578
+ _b = "Authorization";
1579
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_write"])];
1580
+ case 1:
1581
+ // oauth required
1582
+ _a[_b] = _c.sent();
1583
+ _c.label = 2;
1584
+ case 2:
1585
+ if (this.configuration && this.configuration.apiKey) {
1586
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1587
+ }
1588
+ return [4 /*yield*/, this.request({
1589
+ path: "/order/orders/{order_id}/replace_item_id".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
1590
+ method: 'PUT',
1591
+ headers: headerParameters,
1592
+ query: queryParameters,
1593
+ body: (0, models_1.ReplaceOrderItemIdRequestToJSON)(requestParameters.replaceOrderItemIdRequest),
1594
+ }, initOverrides)];
1595
+ case 3:
1596
+ response = _c.sent();
1597
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderResponseFromJSON)(jsonValue); })];
1598
+ }
1599
+ });
1600
+ });
1601
+ };
1602
+ /**
1603
+ * 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.
1604
+ * Replaces an order item id
1605
+ */
1606
+ OrderApi.prototype.replaceOrderItemMerchantItemId = function (requestParameters, initOverrides) {
1607
+ return __awaiter(this, void 0, void 0, function () {
1608
+ var response;
1609
+ return __generator(this, function (_a) {
1610
+ switch (_a.label) {
1611
+ case 0: return [4 /*yield*/, this.replaceOrderItemMerchantItemIdRaw(requestParameters, initOverrides)];
1612
+ case 1:
1613
+ response = _a.sent();
1614
+ return [4 /*yield*/, response.value()];
1615
+ case 2: return [2 /*return*/, _a.sent()];
1616
+ }
1617
+ });
1618
+ });
1619
+ };
1553
1620
  /**
1554
1621
  * Create a replacement order based upon a previous order
1555
1622
  * Replacement order
@@ -57,6 +57,12 @@ export interface CustomReportAccountConfig {
57
57
  * @memberof CustomReportAccountConfig
58
58
  */
59
59
  opt_in_date?: string;
60
+ /**
61
+ *
62
+ * @type {boolean}
63
+ * @memberof CustomReportAccountConfig
64
+ */
65
+ read_only?: boolean;
60
66
  /**
61
67
  *
62
68
  * @type {number}
@@ -39,6 +39,7 @@ function CustomReportAccountConfigFromJSONTyped(json, ignoreDiscriminator) {
39
39
  'opt_in': !(0, runtime_1.exists)(json, 'opt_in') ? undefined : json['opt_in'],
40
40
  'opt_in_by_user': !(0, runtime_1.exists)(json, 'opt_in_by_user') ? undefined : json['opt_in_by_user'],
41
41
  'opt_in_date': !(0, runtime_1.exists)(json, 'opt_in_date') ? undefined : json['opt_in_date'],
42
+ 'read_only': !(0, runtime_1.exists)(json, 'read_only') ? undefined : json['read_only'],
42
43
  'sql_budget': !(0, runtime_1.exists)(json, 'sql_budget') ? undefined : json['sql_budget'],
43
44
  'sql_usage': !(0, runtime_1.exists)(json, 'sql_usage') ? undefined : json['sql_usage'],
44
45
  };
@@ -59,6 +60,7 @@ function CustomReportAccountConfigToJSON(value) {
59
60
  'opt_in': value.opt_in,
60
61
  'opt_in_by_user': value.opt_in_by_user,
61
62
  'opt_in_date': value.opt_in_date,
63
+ 'read_only': value.read_only,
62
64
  'sql_budget': value.sql_budget,
63
65
  'sql_usage': value.sql_usage,
64
66
  };
@@ -0,0 +1,37 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CustomReportAnalysisRequest
16
+ */
17
+ export interface CustomReportAnalysisRequest {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof CustomReportAnalysisRequest
22
+ */
23
+ png_url?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof CustomReportAnalysisRequest
28
+ */
29
+ result_url?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the CustomReportAnalysisRequest interface.
33
+ */
34
+ export declare function instanceOfCustomReportAnalysisRequest(value: object): boolean;
35
+ export declare function CustomReportAnalysisRequestFromJSON(json: any): CustomReportAnalysisRequest;
36
+ export declare function CustomReportAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomReportAnalysisRequest;
37
+ export declare function CustomReportAnalysisRequestToJSON(value?: CustomReportAnalysisRequest | null): any;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CustomReportAnalysisRequestToJSON = exports.CustomReportAnalysisRequestFromJSONTyped = exports.CustomReportAnalysisRequestFromJSON = exports.instanceOfCustomReportAnalysisRequest = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the CustomReportAnalysisRequest interface.
20
+ */
21
+ function instanceOfCustomReportAnalysisRequest(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfCustomReportAnalysisRequest = instanceOfCustomReportAnalysisRequest;
26
+ function CustomReportAnalysisRequestFromJSON(json) {
27
+ return CustomReportAnalysisRequestFromJSONTyped(json, false);
28
+ }
29
+ exports.CustomReportAnalysisRequestFromJSON = CustomReportAnalysisRequestFromJSON;
30
+ function CustomReportAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'png_url': !(0, runtime_1.exists)(json, 'png_url') ? undefined : json['png_url'],
36
+ 'result_url': !(0, runtime_1.exists)(json, 'result_url') ? undefined : json['result_url'],
37
+ };
38
+ }
39
+ exports.CustomReportAnalysisRequestFromJSONTyped = CustomReportAnalysisRequestFromJSONTyped;
40
+ function CustomReportAnalysisRequestToJSON(value) {
41
+ if (value === undefined) {
42
+ return undefined;
43
+ }
44
+ if (value === null) {
45
+ return null;
46
+ }
47
+ return {
48
+ 'png_url': value.png_url,
49
+ 'result_url': value.result_url,
50
+ };
51
+ }
52
+ exports.CustomReportAnalysisRequestToJSON = CustomReportAnalysisRequestToJSON;
@@ -0,0 +1,58 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ModelError } from './ModelError';
13
+ import { ResponseMetadata } from './ResponseMetadata';
14
+ import { Warning } from './Warning';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface CustomReportAnalysisResponse
19
+ */
20
+ export interface CustomReportAnalysisResponse {
21
+ /**
22
+ *
23
+ * @type {ModelError}
24
+ * @memberof CustomReportAnalysisResponse
25
+ */
26
+ error?: ModelError;
27
+ /**
28
+ *
29
+ * @type {string}
30
+ * @memberof CustomReportAnalysisResponse
31
+ */
32
+ html?: string;
33
+ /**
34
+ *
35
+ * @type {ResponseMetadata}
36
+ * @memberof CustomReportAnalysisResponse
37
+ */
38
+ metadata?: ResponseMetadata;
39
+ /**
40
+ * Indicates if API call was successful
41
+ * @type {boolean}
42
+ * @memberof CustomReportAnalysisResponse
43
+ */
44
+ success?: boolean;
45
+ /**
46
+ *
47
+ * @type {Warning}
48
+ * @memberof CustomReportAnalysisResponse
49
+ */
50
+ warning?: Warning;
51
+ }
52
+ /**
53
+ * Check if a given object implements the CustomReportAnalysisResponse interface.
54
+ */
55
+ export declare function instanceOfCustomReportAnalysisResponse(value: object): boolean;
56
+ export declare function CustomReportAnalysisResponseFromJSON(json: any): CustomReportAnalysisResponse;
57
+ export declare function CustomReportAnalysisResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomReportAnalysisResponse;
58
+ export declare function CustomReportAnalysisResponseToJSON(value?: CustomReportAnalysisResponse | null): any;
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CustomReportAnalysisResponseToJSON = exports.CustomReportAnalysisResponseFromJSONTyped = exports.CustomReportAnalysisResponseFromJSON = exports.instanceOfCustomReportAnalysisResponse = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var ModelError_1 = require("./ModelError");
19
+ var ResponseMetadata_1 = require("./ResponseMetadata");
20
+ var Warning_1 = require("./Warning");
21
+ /**
22
+ * Check if a given object implements the CustomReportAnalysisResponse interface.
23
+ */
24
+ function instanceOfCustomReportAnalysisResponse(value) {
25
+ var isInstance = true;
26
+ return isInstance;
27
+ }
28
+ exports.instanceOfCustomReportAnalysisResponse = instanceOfCustomReportAnalysisResponse;
29
+ function CustomReportAnalysisResponseFromJSON(json) {
30
+ return CustomReportAnalysisResponseFromJSONTyped(json, false);
31
+ }
32
+ exports.CustomReportAnalysisResponseFromJSON = CustomReportAnalysisResponseFromJSON;
33
+ function CustomReportAnalysisResponseFromJSONTyped(json, ignoreDiscriminator) {
34
+ if ((json === undefined) || (json === null)) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
39
+ 'html': !(0, runtime_1.exists)(json, 'html') ? undefined : json['html'],
40
+ 'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
41
+ 'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
42
+ 'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
43
+ };
44
+ }
45
+ exports.CustomReportAnalysisResponseFromJSONTyped = CustomReportAnalysisResponseFromJSONTyped;
46
+ function CustomReportAnalysisResponseToJSON(value) {
47
+ if (value === undefined) {
48
+ return undefined;
49
+ }
50
+ if (value === null) {
51
+ return null;
52
+ }
53
+ return {
54
+ 'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
55
+ 'html': value.html,
56
+ 'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
57
+ 'success': value.success,
58
+ 'warning': (0, Warning_1.WarningToJSON)(value.warning),
59
+ };
60
+ }
61
+ exports.CustomReportAnalysisResponseToJSON = CustomReportAnalysisResponseToJSON;