ultracart_rest_api_v2_typescript 4.1.15 → 4.1.17

package/.openapi-generator/FILES

@@ -329,16 +329,26 @@ src/models/CouponType.ts
 src/models/CouponsRequest.ts
 src/models/CouponsResponse.ts
 src/models/Currency.ts
+src/models/CustomDashboard.ts
+src/models/CustomDashboardPage.ts
+src/models/CustomDashboardPageReport.ts
+src/models/CustomDashboardResponse.ts
+src/models/CustomDashboardsResponse.ts
 src/models/CustomReport.ts
 src/models/CustomReportAccountConfig.ts
 src/models/CustomReportAccountConfigResponse.ts
 src/models/CustomReportExecutionParameter.ts
 src/models/CustomReportExecutionRequest.ts
+src/models/CustomReportExecutionResponse.ts
 src/models/CustomReportParameter.ts
 src/models/CustomReportParameterOption.ts
 src/models/CustomReportQuery.ts
 src/models/CustomReportResponse.ts
 src/models/CustomReportTooltip.ts
+src/models/CustomReportsExecutionReportData.ts
+src/models/CustomReportsExecutionRequest.ts
+src/models/CustomReportsExecutionResponse.ts
+src/models/CustomReportsResponse.ts
 src/models/Customer.ts
 src/models/CustomerActivity.ts
 src/models/CustomerAffiliate.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.15
+## ultracart_rest_api_v2_typescript@4.1.17
 
 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.15 --save
+npm install ultracart_rest_api_v2_typescript@4.1.17 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
+| 4.1.16 | 07/28/2025 | updated doc samples |
 | 4.1.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
 | 4.1.14 | 07/10/2025 | automation test |
 | 4.1.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |

package/dist/apis/DatawarehouseApi.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { CustomReport, CustomReportAccountConfig, CustomReportAccountConfigResponse, CustomReportExecutionRequest, CustomReportResponse, Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
+import { CustomDashboard, CustomDashboardResponse, CustomDashboardsResponse, CustomReport, CustomReportAccountConfig, CustomReportAccountConfigResponse, CustomReportExecutionRequest, CustomReportExecutionResponse, CustomReportResponse, CustomReportsExecutionRequest, CustomReportsExecutionResponse, CustomReportsResponse, Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
+export interface DeleteCustomDashboardRequest {
+    customDashboardOid: number;
+}
 export interface DeleteCustomReportRequest {
     customReportOid: number;
 }
@@ -24,9 +27,15 @@ export interface ExecuteCustomReportRequest {
     customReportOid: number;
     executionRequest: CustomReportExecutionRequest;
 }
+export interface ExecuteCustomReportsRequest {
+    executionRequest: CustomReportsExecutionRequest;
+}
 export interface ExecuteReportQueriesRequest {
     queryRequest: ReportExecuteQueriesRequest;
 }
+export interface GetCustomDashboardRequest {
+    customDashboardOid: number;
+}
 export interface GetCustomReportRequest {
     customReportOid: number;
 }
@@ -40,12 +49,19 @@ export interface GetReportDataSetPageRequest {
     datasetUuid: string;
     pageNumber: number;
 }
+export interface InsertCustomDashboardRequest {
+    dashboard: CustomDashboard;
+}
 export interface InsertCustomReportRequest {
     report: CustomReport;
 }
 export interface InsertReportRequest {
     report: Report;
 }
+export interface UpdateCustomDashboardRequest {
+    customDashboardOid: number;
+    dashboard: CustomDashboard;
+}
 export interface UpdateCustomReportRequest {
     customReportOid: number;
     report: CustomReport;
@@ -64,6 +80,20 @@ export interface UpdateReportRequest {
  * @interface DatawarehouseApiInterface
  */
 export interface DatawarehouseApiInterface {
+    /**
+     * Delete a custom dashboard on the UltraCart account.
+     * @summary Delete a custom dashboard
+     * @param {number} customDashboardOid The dashboard oid to delete.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    deleteCustomDashboardRaw(requestParameters: DeleteCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a custom dashboard on the UltraCart account.
+     * Delete a custom dashboard
+     */
+    deleteCustomDashboard(requestParameters: DeleteCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Delete a custom report on the UltraCart account.
      * @summary Delete a custom report
@@ -115,12 +145,26 @@ export interface DatawarehouseApiInterface {
      * @throws {RequiredError}
      * @memberof DatawarehouseApiInterface
      */
-    executeCustomReportRaw(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    executeCustomReportRaw(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportExecutionResponse>>;
     /**
      * Execute a custom report on the UltraCart account.
      * Execute a custom report
      */
-    executeCustomReport(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
+    executeCustomReport(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportExecutionResponse>;
+    /**
+     * Execute a custom reports on the UltraCart account.
+     * @summary Execute a custom reports
+     * @param {CustomReportsExecutionRequest} executionRequest Request to execute custom reports
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    executeCustomReportsRaw(requestParameters: ExecuteCustomReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportsExecutionResponse>>;
+    /**
+     * Execute a custom reports on the UltraCart account.
+     * Execute a custom reports
+     */
+    executeCustomReports(requestParameters: ExecuteCustomReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportsExecutionResponse>;
     /**
      * Execute the report queries
      * @summary Execute the report queries
@@ -135,6 +179,33 @@ export interface DatawarehouseApiInterface {
      * Execute the report queries
      */
     executeReportQueries(requestParameters: ExecuteReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve a custom dashboard
+     * @summary Get a custom dashboard
+     * @param {number} customDashboardOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getCustomDashboardRaw(requestParameters: GetCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
+    /**
+     * Retrieve a custom dashboard
+     * Get a custom dashboard
+     */
+    getCustomDashboard(requestParameters: GetCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
+    /**
+     * Retrieve a custom dashboards
+     * @summary Get custom dashboards
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getCustomDashboardsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardsResponse>>;
+    /**
+     * Retrieve a custom dashboards
+     * Get custom dashboards
+     */
+    getCustomDashboards(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardsResponse>;
     /**
      * Retrieve a custom report
      * @summary Get a custom report
@@ -162,6 +233,19 @@ export interface DatawarehouseApiInterface {
      * Get custom report account configuration
      */
     getCustomReportAccountConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAccountConfigResponse>;
+    /**
+     * Retrieve a custom reports
+     * @summary Get custom reports
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getCustomReportsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportsResponse>>;
+    /**
+     * Retrieve a custom reports
+     * Get custom reports
+     */
+    getCustomReports(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportsResponse>;
     /**
      * Retrieve a report
      * @summary Get a report
@@ -231,6 +315,20 @@ export interface DatawarehouseApiInterface {
      * Get list of reports available
      */
     getReports(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportsResponse>;
+    /**
+     * Create a new custom dashboard on the UltraCart account.
+     * @summary Create a custom dashboard
+     * @param {CustomDashboard} dashboard Dashboard to create
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    insertCustomDashboardRaw(requestParameters: InsertCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
+    /**
+     * Create a new custom dashboard on the UltraCart account.
+     * Create a custom dashboard
+     */
+    insertCustomDashboard(requestParameters: InsertCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
     /**
      * Create a new custom report on the UltraCart account.
      * @summary Create a custom report
@@ -259,6 +357,21 @@ export interface DatawarehouseApiInterface {
      * Create a report
      */
     insertReport(requestParameters: InsertReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+    /**
+     * Update a custom dashboard on the UltraCart account.
+     * @summary Update a custom dashboard
+     * @param {number} customDashboardOid The dashboard oid to custom update.
+     * @param {CustomDashboard} dashboard Dashboard to custom update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    updateCustomDashboardRaw(requestParameters: UpdateCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
+    /**
+     * Update a custom dashboard on the UltraCart account.
+     * Update a custom dashboard
+     */
+    updateCustomDashboard(requestParameters: UpdateCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
     /**
      * Update a custom report on the UltraCart account.
      * @summary Update a custom report
@@ -308,6 +421,16 @@ export interface DatawarehouseApiInterface {
  *
  */
 export declare class DatawarehouseApi extends runtime.BaseAPI implements DatawarehouseApiInterface {
+    /**
+     * Delete a custom dashboard on the UltraCart account.
+     * Delete a custom dashboard
+     */
+    deleteCustomDashboardRaw(requestParameters: DeleteCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a custom dashboard on the UltraCart account.
+     * Delete a custom dashboard
+     */
+    deleteCustomDashboard(requestParameters: DeleteCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Delete a custom report on the UltraCart account.
      * Delete a custom report
@@ -342,12 +465,22 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Execute a custom report on the UltraCart account.
      * Execute a custom report
      */
-    executeCustomReportRaw(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    executeCustomReportRaw(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportExecutionResponse>>;
     /**
      * Execute a custom report on the UltraCart account.
      * Execute a custom report
      */
-    executeCustomReport(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
+    executeCustomReport(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportExecutionResponse>;
+    /**
+     * Execute a custom reports on the UltraCart account.
+     * Execute a custom reports
+     */
+    executeCustomReportsRaw(requestParameters: ExecuteCustomReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportsExecutionResponse>>;
+    /**
+     * Execute a custom reports on the UltraCart account.
+     * Execute a custom reports
+     */
+    executeCustomReports(requestParameters: ExecuteCustomReportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportsExecutionResponse>;
     /**
      * Execute the report queries
      * Execute the report queries
@@ -358,6 +491,26 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Execute the report queries
      */
     executeReportQueries(requestParameters: ExecuteReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve a custom dashboard
+     * Get a custom dashboard
+     */
+    getCustomDashboardRaw(requestParameters: GetCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
+    /**
+     * Retrieve a custom dashboard
+     * Get a custom dashboard
+     */
+    getCustomDashboard(requestParameters: GetCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
+    /**
+     * Retrieve a custom dashboards
+     * Get custom dashboards
+     */
+    getCustomDashboardsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardsResponse>>;
+    /**
+     * Retrieve a custom dashboards
+     * Get custom dashboards
+     */
+    getCustomDashboards(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardsResponse>;
     /**
      * Retrieve a custom report
      * Get a custom report
@@ -378,6 +531,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Get custom report account configuration
      */
     getCustomReportAccountConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAccountConfigResponse>;
+    /**
+     * Retrieve a custom reports
+     * Get custom reports
+     */
+    getCustomReportsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportsResponse>>;
+    /**
+     * Retrieve a custom reports
+     * Get custom reports
+     */
+    getCustomReports(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportsResponse>;
     /**
      * Retrieve a report
      * Get a report
@@ -428,6 +591,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Get list of reports available
      */
     getReports(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportsResponse>;
+    /**
+     * Create a new custom dashboard on the UltraCart account.
+     * Create a custom dashboard
+     */
+    insertCustomDashboardRaw(requestParameters: InsertCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
+    /**
+     * Create a new custom dashboard on the UltraCart account.
+     * Create a custom dashboard
+     */
+    insertCustomDashboard(requestParameters: InsertCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
     /**
      * Create a new custom report on the UltraCart account.
      * Create a custom report
@@ -448,6 +621,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Create a report
      */
     insertReport(requestParameters: InsertReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+    /**
+     * Update a custom dashboard on the UltraCart account.
+     * Update a custom dashboard
+     */
+    updateCustomDashboardRaw(requestParameters: UpdateCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDashboardResponse>>;
+    /**
+     * Update a custom dashboard on the UltraCart account.
+     * Update a custom dashboard
+     */
+    updateCustomDashboard(requestParameters: UpdateCustomDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDashboardResponse>;
     /**
      * Update a custom report on the UltraCart account.
      * Update a custom report