ultracart_rest_api_v2_typescript 4.1.19 → 4.1.21

package/.openapi-generator/FILES

@@ -5,7 +5,6 @@ package.json
 src/apis/AffiliateApi.ts
 src/apis/AutoOrderApi.ts
 src/apis/ChannelPartnerApi.ts
-src/apis/ChargebackApi.ts
 src/apis/CheckoutApi.ts
 src/apis/ConversationApi.ts
 src/apis/CouponApi.ts
@@ -145,9 +144,6 @@ src/models/ChannelPartnerShipToPreferenceResponse.ts
 src/models/ChannelPartnerShipToPreferencesResponse.ts
 src/models/ChannelPartnerShippingEstimate.ts
 src/models/ChannelPartnersResponse.ts
-src/models/ChargebackDispute.ts
-src/models/ChargebackDisputeResponse.ts
-src/models/ChargebackDisputesResponse.ts
 src/models/CheckoutAllowedCountriesResponse.ts
 src/models/CheckoutHandoffRequest.ts
 src/models/CheckoutHandoffResponse.ts
@@ -335,10 +331,16 @@ src/models/CustomDashboardExecutionParameter.ts
 src/models/CustomDashboardPage.ts
 src/models/CustomDashboardPageReport.ts
 src/models/CustomDashboardResponse.ts
+src/models/CustomDashboardSchedule.ts
+src/models/CustomDashboardScheduleResponse.ts
+src/models/CustomDashboardSchedulesResponse.ts
 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
@@ -745,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.19
+## ultracart_rest_api_v2_typescript@4.1.21
 
 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.19 --save
+npm install ultracart_rest_api_v2_typescript@4.1.21 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |

package/dist/apis/DatawarehouseApi.d.ts

@@ -10,10 +10,18 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { CustomDashboard, CustomDashboardResponse, 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;
 }
+export interface DeleteCustomDashboardScheduleRequest {
+    customDashboardScheduleOid: number;
+    customDashboardOid: number;
+}
 export interface DeleteCustomReportRequest {
     customReportOid: number;
 }
@@ -36,9 +44,15 @@ export interface ExecuteReportQueriesRequest {
 export interface GetCustomDashboardRequest {
     customDashboardOid: number;
 }
+export interface GetCustomDashboardSchedulesRequest {
+    customDashboardOid: number;
+}
 export interface GetCustomReportRequest {
     customReportOid: number;
 }
+export interface GetCustomReportChartPngUploadUrlRequest {
+    customReportOid: number;
+}
 export interface GetReportRequest {
     reportOid: number;
 }
@@ -52,6 +66,10 @@ export interface GetReportDataSetPageRequest {
 export interface InsertCustomDashboardRequest {
     dashboard: CustomDashboard;
 }
+export interface InsertCustomDashboardScheduleRequest {
+    customDashboardOid: number;
+    dashboardSchedule: CustomDashboardSchedule;
+}
 export interface InsertCustomReportRequest {
     report: CustomReport;
 }
@@ -62,6 +80,11 @@ export interface UpdateCustomDashboardRequest {
     customDashboardOid: number;
     dashboard: CustomDashboard;
 }
+export interface UpdateCustomDashboardScheduleRequest {
+    customDashboardScheduleOid: number;
+    customDashboardOid: number;
+    dashboardSchedule: CustomDashboardSchedule;
+}
 export interface UpdateCustomReportRequest {
     customReportOid: number;
     report: CustomReport;
@@ -80,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
@@ -94,6 +132,21 @@ export interface DatawarehouseApiInterface {
      * Delete a custom dashboard
      */
     deleteCustomDashboard(requestParameters: DeleteCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * delete a custom dashboard schedule on the UltraCart account.
+     * @summary Delete a custom dashboard schedule
+     * @param {number} customDashboardScheduleOid The dashboard schedule oid to delete.
+     * @param {number} customDashboardOid The dashboard oid that owns the schedule.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    deleteCustomDashboardScheduleRaw(requestParameters: DeleteCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * delete a custom dashboard schedule on the UltraCart account.
+     * Delete a custom dashboard schedule
+     */
+    deleteCustomDashboardSchedule(requestParameters: DeleteCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Delete a custom report on the UltraCart account.
      * @summary Delete a custom report
@@ -193,6 +246,20 @@ export interface DatawarehouseApiInterface {
      * Get a custom dashboard
      */
     getCustomDashboard(requestParameters: GetCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
+    /**
+     * Retrieve a custom dashboards
+     * @summary Get custom dashboards
+     * @param {number} customDashboardOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getCustomDashboardSchedulesRaw(requestParameters: GetCustomDashboardSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardSchedulesResponse>>;
+    /**
+     * Retrieve a custom dashboards
+     * Get custom dashboards
+     */
+    getCustomDashboardSchedules(requestParameters: GetCustomDashboardSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardSchedulesResponse>;
     /**
      * Retrieve a custom dashboards
      * @summary Get custom dashboards
@@ -233,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
@@ -329,6 +410,21 @@ export interface DatawarehouseApiInterface {
      * Create a custom dashboard
      */
     insertCustomDashboard(requestParameters: InsertCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
+    /**
+     * Create a new custom dashboard schedule on the UltraCart account.
+     * @summary Create a custom dashboard schedule
+     * @param {number} customDashboardOid
+     * @param {CustomDashboardSchedule} dashboardSchedule Dashboard schedule to create
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    insertCustomDashboardScheduleRaw(requestParameters: InsertCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardScheduleResponse>>;
+    /**
+     * Create a new custom dashboard schedule on the UltraCart account.
+     * Create a custom dashboard schedule
+     */
+    insertCustomDashboardSchedule(requestParameters: InsertCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardScheduleResponse>;
     /**
      * Create a new custom report on the UltraCart account.
      * @summary Create a custom report
@@ -372,6 +468,22 @@ export interface DatawarehouseApiInterface {
      * Update a custom dashboard
      */
     updateCustomDashboard(requestParameters: UpdateCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
+    /**
+     * Update a custom dashboard schedule on the UltraCart account.
+     * @summary Update a custom dashboard schedule
+     * @param {number} customDashboardScheduleOid The dashboard schedule oid to update.
+     * @param {number} customDashboardOid The dashboard oid to update.
+     * @param {CustomDashboardSchedule} dashboardSchedule Dashboard schedule to update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    updateCustomDashboardScheduleRaw(requestParameters: UpdateCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
+    /**
+     * Update a custom dashboard schedule on the UltraCart account.
+     * Update a custom dashboard schedule
+     */
+    updateCustomDashboardSchedule(requestParameters: UpdateCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
     /**
      * Update a custom report on the UltraCart account.
      * @summary Update a custom report
@@ -421,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
@@ -431,6 +553,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Delete a custom dashboard
      */
     deleteCustomDashboard(requestParameters: DeleteCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * delete a custom dashboard schedule on the UltraCart account.
+     * Delete a custom dashboard schedule
+     */
+    deleteCustomDashboardScheduleRaw(requestParameters: DeleteCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * delete a custom dashboard schedule on the UltraCart account.
+     * Delete a custom dashboard schedule
+     */
+    deleteCustomDashboardSchedule(requestParameters: DeleteCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Delete a custom report on the UltraCart account.
      * Delete a custom report
@@ -501,6 +633,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Get a custom dashboard
      */
     getCustomDashboard(requestParameters: GetCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
+    /**
+     * Retrieve a custom dashboards
+     * Get custom dashboards
+     */
+    getCustomDashboardSchedulesRaw(requestParameters: GetCustomDashboardSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardSchedulesResponse>>;
+    /**
+     * Retrieve a custom dashboards
+     * Get custom dashboards
+     */
+    getCustomDashboardSchedules(requestParameters: GetCustomDashboardSchedulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardSchedulesResponse>;
     /**
      * Retrieve a custom dashboards
      * Get custom dashboards
@@ -531,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
@@ -601,6 +753,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Create a custom dashboard
      */
     insertCustomDashboard(requestParameters: InsertCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
+    /**
+     * Create a new custom dashboard schedule on the UltraCart account.
+     * Create a custom dashboard schedule
+     */
+    insertCustomDashboardScheduleRaw(requestParameters: InsertCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardScheduleResponse>>;
+    /**
+     * Create a new custom dashboard schedule on the UltraCart account.
+     * Create a custom dashboard schedule
+     */
+    insertCustomDashboardSchedule(requestParameters: InsertCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardScheduleResponse>;
     /**
      * Create a new custom report on the UltraCart account.
      * Create a custom report
@@ -631,6 +793,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Update a custom dashboard
      */
     updateCustomDashboard(requestParameters: UpdateCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
+    /**
+     * Update a custom dashboard schedule on the UltraCart account.
+     * Update a custom dashboard schedule
+     */
+    updateCustomDashboardScheduleRaw(requestParameters: UpdateCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
+    /**
+     * Update a custom dashboard schedule on the UltraCart account.
+     * Update a custom dashboard schedule
+     */
+    updateCustomDashboardSchedule(requestParameters: UpdateCustomDashboardScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
     /**
      * Update a custom report on the UltraCart account.
      * Update a custom report