ultracart_rest_api_v2_typescript 4.1.20 → 4.1.22

package/.openapi-generator/FILES

@@ -338,6 +338,9 @@ src/models/CustomDashboardsResponse.ts
 src/models/CustomReport.ts
 src/models/CustomReportAccountConfig.ts
 src/models/CustomReportAccountConfigResponse.ts
+src/models/CustomReportAnalysisRequest.ts
+src/models/CustomReportAnalysisResponse.ts
+src/models/CustomReportChartPngUploadResponse.ts
 src/models/CustomReportExecutionParameter.ts
 src/models/CustomReportExecutionRequest.ts
 src/models/CustomReportExecutionResponse.ts
@@ -744,6 +747,7 @@ src/models/Property.ts
 src/models/PublishLibraryItemRequest.ts
 src/models/RegisterAffiliateClickRequest.ts
 src/models/RegisterAffiliateClickResponse.ts
+src/models/ReplaceOrderItemIdRequest.ts
 src/models/Report.ts
 src/models/ReportAuth.ts
 src/models/ReportAuthResponse.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.20
+## ultracart_rest_api_v2_typescript@4.1.22
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.20 --save
+npm install ultracart_rest_api_v2_typescript@4.1.22 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.22 | 10/06/2025 | added Customer.fax back into object model |
+| 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
 | 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
 | 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
 | 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |

package/dist/apis/DatawarehouseApi.d.ts

@@ -10,7 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-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';
+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';
+export interface AnalyzeCustomReportRequest {
+    customReportOid: number;
+    analyzeRequest: CustomReportAnalysisRequest;
+}
 export interface DeleteCustomDashboardRequest {
     customDashboardOid: number;
 }
@@ -46,6 +50,9 @@ export interface GetCustomDashboardSchedulesRequest {
 export interface GetCustomReportRequest {
     customReportOid: number;
 }
+export interface GetCustomReportChartPngUploadUrlRequest {
+    customReportOid: number;
+}
 export interface GetReportRequest {
     reportOid: number;
 }
@@ -96,6 +103,21 @@ export interface UpdateReportRequest {
  * @interface DatawarehouseApiInterface
  */
 export interface DatawarehouseApiInterface {
+    /**
+     * Analyze a custom report on the UltraCart account.
+     * @summary Analyze a custom report
+     * @param {number} customReportOid The report oid to analyze.
+     * @param {CustomReportAnalysisRequest} analyzeRequest Request to analyze custom report
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    analyzeCustomReportRaw(requestParameters: AnalyzeCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportAnalysisResponse>>;
+    /**
+     * Analyze a custom report on the UltraCart account.
+     * Analyze a custom report
+     */
+    analyzeCustomReport(requestParameters: AnalyzeCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAnalysisResponse>;
     /**
      * Delete a custom dashboard on the UltraCart account.
      * @summary Delete a custom dashboard
@@ -278,6 +300,20 @@ export interface DatawarehouseApiInterface {
      * Get custom report account configuration
      */
     getCustomReportAccountConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAccountConfigResponse>;
+    /**
+     * Upload a PNG of a custom report chart
+     * @summary Upload a PNG of a custom report chart
+     * @param {number} customReportOid The report oid to upload a chart PNG for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getCustomReportChartPngUploadUrlRaw(requestParameters: GetCustomReportChartPngUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportChartPngUploadResponse>>;
+    /**
+     * Upload a PNG of a custom report chart
+     * Upload a PNG of a custom report chart
+     */
+    getCustomReportChartPngUploadUrl(requestParameters: GetCustomReportChartPngUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportChartPngUploadResponse>;
     /**
      * Retrieve a custom reports
      * @summary Get custom reports
@@ -497,6 +533,16 @@ export interface DatawarehouseApiInterface {
  *
  */
 export declare class DatawarehouseApi extends runtime.BaseAPI implements DatawarehouseApiInterface {
+    /**
+     * Analyze a custom report on the UltraCart account.
+     * Analyze a custom report
+     */
+    analyzeCustomReportRaw(requestParameters: AnalyzeCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportAnalysisResponse>>;
+    /**
+     * Analyze a custom report on the UltraCart account.
+     * Analyze a custom report
+     */
+    analyzeCustomReport(requestParameters: AnalyzeCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAnalysisResponse>;
     /**
      * Delete a custom dashboard on the UltraCart account.
      * Delete a custom dashboard
@@ -627,6 +673,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Get custom report account configuration
      */
     getCustomReportAccountConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAccountConfigResponse>;
+    /**
+     * Upload a PNG of a custom report chart
+     * Upload a PNG of a custom report chart
+     */
+    getCustomReportChartPngUploadUrlRaw(requestParameters: GetCustomReportChartPngUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportChartPngUploadResponse>>;
+    /**
+     * Upload a PNG of a custom report chart
+     * Upload a PNG of a custom report chart
+     */
+    getCustomReportChartPngUploadUrl(requestParameters: GetCustomReportChartPngUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportChartPngUploadResponse>;
     /**
      * Retrieve a custom reports
      * Get custom reports

package/dist/apis/DatawarehouseApi.js

@@ -75,6 +75,70 @@ var DatawarehouseApi = /** @class */ (function (_super) {
     function DatawarehouseApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Analyze a custom report on the UltraCart account.
+     * Analyze a custom report
+     */
+    DatawarehouseApi.prototype.analyzeCustomReportRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.customReportOid === null || requestParameters.customReportOid === undefined) {
+                            throw new runtime.RequiredError('customReportOid', 'Required parameter requestParameters.customReportOid was null or undefined when calling analyzeCustomReport.');
+                        }
+                        if (requestParameters.analyzeRequest === null || requestParameters.analyzeRequest === undefined) {
+                            throw new runtime.RequiredError('analyzeRequest', 'Required parameter requestParameters.analyzeRequest was null or undefined when calling analyzeCustomReport.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/datawarehouse/custom_reports/{custom_report_oid}/analysis".replace("{".concat("custom_report_oid", "}"), encodeURIComponent(String(requestParameters.customReportOid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.CustomReportAnalysisRequestToJSON)(requestParameters.analyzeRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomReportAnalysisResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Analyze a custom report on the UltraCart account.
+     * Analyze a custom report
+     */
+    DatawarehouseApi.prototype.analyzeCustomReport = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.analyzeCustomReportRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Delete a custom dashboard on the UltraCart account.
      * Delete a custom dashboard
@@ -840,6 +904,65 @@ var DatawarehouseApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Upload a PNG of a custom report chart
+     * Upload a PNG of a custom report chart
+     */
+    DatawarehouseApi.prototype.getCustomReportChartPngUploadUrlRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.customReportOid === null || requestParameters.customReportOid === undefined) {
+                            throw new runtime.RequiredError('customReportOid', 'Required parameter requestParameters.customReportOid was null or undefined when calling getCustomReportChartPngUploadUrl.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/datawarehouse/custom_reports/{custom_report_oid}/chart_png".replace("{".concat("custom_report_oid", "}"), encodeURIComponent(String(requestParameters.customReportOid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomReportChartPngUploadResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Upload a PNG of a custom report chart
+     * Upload a PNG of a custom report chart
+     */
+    DatawarehouseApi.prototype.getCustomReportChartPngUploadUrl = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getCustomReportChartPngUploadUrlRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieve a custom reports
      * Get custom reports

package/dist/apis/OrderApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-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';
+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';
 export interface AdjustOrderTotalRequest {
     orderId: string;
     desiredTotal: string;
@@ -130,6 +130,11 @@ export interface RefundOrderRequest {
     autoOrderCancelReason?: string;
     expand?: string;
 }
+export interface ReplaceOrderItemMerchantItemIdRequest {
+    orderId: string;
+    replaceOrderItemIdRequest: ReplaceOrderItemIdRequest;
+    expand?: string;
+}
 export interface ReplacementRequest {
     orderId: string;
     replacement: OrderReplacement;
@@ -524,6 +529,22 @@ export interface OrderApiInterface {
      * Refund an order
      */
     refundOrder(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
+    /**
+     * 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.
+     * @summary Replaces an order item id
+     * @param {string} orderId The order id to update.
+     * @param {ReplaceOrderItemIdRequest} replaceOrderItemIdRequest Replacement Request
+     * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    replaceOrderItemMerchantItemIdRaw(requestParameters: ReplaceOrderItemMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
+    /**
+     * 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.
+     * Replaces an order item id
+     */
+    replaceOrderItemMerchantItemId(requestParameters: ReplaceOrderItemMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
     /**
      * Create a replacement order based upon a previous order
      * @summary Replacement order
@@ -850,6 +871,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Refund an order
      */
     refundOrder(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
+    /**
+     * 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.
+     * Replaces an order item id
+     */
+    replaceOrderItemMerchantItemIdRaw(requestParameters: ReplaceOrderItemMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
+    /**
+     * 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.
+     * Replaces an order item id
+     */
+    replaceOrderItemMerchantItemId(requestParameters: ReplaceOrderItemMerchantItemIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
     /**
      * Create a replacement order based upon a previous order
      * Replacement order

package/dist/apis/OrderApi.js

@@ -1550,6 +1550,73 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Replaces an order item id
+     */
+    OrderApi.prototype.replaceOrderItemMerchantItemIdRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+                            throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling replaceOrderItemMerchantItemId.');
+                        }
+                        if (requestParameters.replaceOrderItemIdRequest === null || requestParameters.replaceOrderItemIdRequest === undefined) {
+                            throw new runtime.RequiredError('replaceOrderItemIdRequest', 'Required parameter requestParameters.replaceOrderItemIdRequest was null or undefined when calling replaceOrderItemMerchantItemId.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.expand !== undefined) {
+                            queryParameters['_expand'] = requestParameters.expand;
+                        }
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/order/orders/{order_id}/replace_item_id".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ReplaceOrderItemIdRequestToJSON)(requestParameters.replaceOrderItemIdRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Replaces an order item id
+     */
+    OrderApi.prototype.replaceOrderItemMerchantItemId = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.replaceOrderItemMerchantItemIdRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Create a replacement order based upon a previous order
      * Replacement order

package/dist/models/CustomReportAccountConfig.d.ts

@@ -57,6 +57,12 @@ export interface CustomReportAccountConfig {
      * @memberof CustomReportAccountConfig
      */
     opt_in_date?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CustomReportAccountConfig
+     */
+    read_only?: boolean;
     /**
      *
      * @type {number}

package/dist/models/CustomReportAccountConfig.js

@@ -39,6 +39,7 @@ function CustomReportAccountConfigFromJSONTyped(json, ignoreDiscriminator) {
         'opt_in': !(0, runtime_1.exists)(json, 'opt_in') ? undefined : json['opt_in'],
         'opt_in_by_user': !(0, runtime_1.exists)(json, 'opt_in_by_user') ? undefined : json['opt_in_by_user'],
         'opt_in_date': !(0, runtime_1.exists)(json, 'opt_in_date') ? undefined : json['opt_in_date'],
+        'read_only': !(0, runtime_1.exists)(json, 'read_only') ? undefined : json['read_only'],
         'sql_budget': !(0, runtime_1.exists)(json, 'sql_budget') ? undefined : json['sql_budget'],
         'sql_usage': !(0, runtime_1.exists)(json, 'sql_usage') ? undefined : json['sql_usage'],
     };
@@ -59,6 +60,7 @@ function CustomReportAccountConfigToJSON(value) {
         'opt_in': value.opt_in,
         'opt_in_by_user': value.opt_in_by_user,
         'opt_in_date': value.opt_in_date,
+        'read_only': value.read_only,
         'sql_budget': value.sql_budget,
         'sql_usage': value.sql_usage,
     };

package/dist/models/CustomReportAnalysisRequest.d.ts

@@ -0,0 +1,37 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CustomReportAnalysisRequest
+ */
+export interface CustomReportAnalysisRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CustomReportAnalysisRequest
+     */
+    png_url?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomReportAnalysisRequest
+     */
+    result_url?: string;
+}
+/**
+ * Check if a given object implements the CustomReportAnalysisRequest interface.
+ */
+export declare function instanceOfCustomReportAnalysisRequest(value: object): boolean;
+export declare function CustomReportAnalysisRequestFromJSON(json: any): CustomReportAnalysisRequest;
+export declare function CustomReportAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomReportAnalysisRequest;
+export declare function CustomReportAnalysisRequestToJSON(value?: CustomReportAnalysisRequest | null): any;

package/dist/models/CustomReportAnalysisRequest.js

@@ -0,0 +1,52 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomReportAnalysisRequestToJSON = exports.CustomReportAnalysisRequestFromJSONTyped = exports.CustomReportAnalysisRequestFromJSON = exports.instanceOfCustomReportAnalysisRequest = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the CustomReportAnalysisRequest interface.
+ */
+function instanceOfCustomReportAnalysisRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfCustomReportAnalysisRequest = instanceOfCustomReportAnalysisRequest;
+function CustomReportAnalysisRequestFromJSON(json) {
+    return CustomReportAnalysisRequestFromJSONTyped(json, false);
+}
+exports.CustomReportAnalysisRequestFromJSON = CustomReportAnalysisRequestFromJSON;
+function CustomReportAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'png_url': !(0, runtime_1.exists)(json, 'png_url') ? undefined : json['png_url'],
+        'result_url': !(0, runtime_1.exists)(json, 'result_url') ? undefined : json['result_url'],
+    };
+}
+exports.CustomReportAnalysisRequestFromJSONTyped = CustomReportAnalysisRequestFromJSONTyped;
+function CustomReportAnalysisRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'png_url': value.png_url,
+        'result_url': value.result_url,
+    };
+}
+exports.CustomReportAnalysisRequestToJSON = CustomReportAnalysisRequestToJSON;

package/dist/models/CustomReportAnalysisResponse.d.ts

@@ -0,0 +1,58 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface CustomReportAnalysisResponse
+ */
+export interface CustomReportAnalysisResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof CustomReportAnalysisResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {string}
+     * @memberof CustomReportAnalysisResponse
+     */
+    html?: string;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof CustomReportAnalysisResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof CustomReportAnalysisResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof CustomReportAnalysisResponse
+     */
+    warning?: Warning;
+}
+/**
+ * Check if a given object implements the CustomReportAnalysisResponse interface.
+ */
+export declare function instanceOfCustomReportAnalysisResponse(value: object): boolean;
+export declare function CustomReportAnalysisResponseFromJSON(json: any): CustomReportAnalysisResponse;
+export declare function CustomReportAnalysisResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomReportAnalysisResponse;
+export declare function CustomReportAnalysisResponseToJSON(value?: CustomReportAnalysisResponse | null): any;

package/dist/models/CustomReportAnalysisResponse.js

@@ -0,0 +1,61 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomReportAnalysisResponseToJSON = exports.CustomReportAnalysisResponseFromJSONTyped = exports.CustomReportAnalysisResponseFromJSON = exports.instanceOfCustomReportAnalysisResponse = void 0;
+var runtime_1 = require("../runtime");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+/**
+ * Check if a given object implements the CustomReportAnalysisResponse interface.
+ */
+function instanceOfCustomReportAnalysisResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfCustomReportAnalysisResponse = instanceOfCustomReportAnalysisResponse;
+function CustomReportAnalysisResponseFromJSON(json) {
+    return CustomReportAnalysisResponseFromJSONTyped(json, false);
+}
+exports.CustomReportAnalysisResponseFromJSON = CustomReportAnalysisResponseFromJSON;
+function CustomReportAnalysisResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'html': !(0, runtime_1.exists)(json, 'html') ? undefined : json['html'],
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.CustomReportAnalysisResponseFromJSONTyped = CustomReportAnalysisResponseFromJSONTyped;
+function CustomReportAnalysisResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'html': value.html,
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.CustomReportAnalysisResponseToJSON = CustomReportAnalysisResponseToJSON;