ultracart_rest_api_v2_typescript 4.1.14 → 4.1.16

package/.openapi-generator/FILES

@@ -329,6 +329,17 @@ src/models/CouponType.ts
 src/models/CouponsRequest.ts
 src/models/CouponsResponse.ts
 src/models/Currency.ts
+src/models/CustomReport.ts
+src/models/CustomReportAccountConfig.ts
+src/models/CustomReportAccountConfigResponse.ts
+src/models/CustomReportExecutionParameter.ts
+src/models/CustomReportExecutionRequest.ts
+src/models/CustomReportParameter.ts
+src/models/CustomReportParameterOption.ts
+src/models/CustomReportQuery.ts
+src/models/CustomReportResponse.ts
+src/models/CustomReportTooltip.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.14
+## ultracart_rest_api_v2_typescript@4.1.16
 
 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.14 --save
+npm install ultracart_rest_api_v2_typescript@4.1.16 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.1.12 | 05/19/2025 | conversations - AI agent capabilities method |

package/dist/apis/DatawarehouseApi.d.ts

@@ -10,16 +10,26 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
+import { CustomReport, CustomReportAccountConfig, CustomReportAccountConfigResponse, CustomReportExecutionRequest, CustomReportResponse, CustomReportsResponse, Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
+export interface DeleteCustomReportRequest {
+    customReportOid: number;
+}
 export interface DeleteReportRequest {
     reportOid: number;
 }
 export interface DryRunReportQueriesRequest {
     queryRequest: ReportDryRunQueriesRequest;
 }
+export interface ExecuteCustomReportRequest {
+    customReportOid: number;
+    executionRequest: CustomReportExecutionRequest;
+}
 export interface ExecuteReportQueriesRequest {
     queryRequest: ReportExecuteQueriesRequest;
 }
+export interface GetCustomReportRequest {
+    customReportOid: number;
+}
 export interface GetReportRequest {
     reportOid: number;
 }
@@ -30,9 +40,19 @@ export interface GetReportDataSetPageRequest {
     datasetUuid: string;
     pageNumber: number;
 }
+export interface InsertCustomReportRequest {
+    report: CustomReport;
+}
 export interface InsertReportRequest {
     report: Report;
 }
+export interface UpdateCustomReportRequest {
+    customReportOid: number;
+    report: CustomReport;
+}
+export interface UpdateCustomReportAccountConfigRequest {
+    accountConfig: CustomReportAccountConfig;
+}
 export interface UpdateReportRequest {
     reportOid: number;
     report: Report;
@@ -44,6 +64,20 @@ export interface UpdateReportRequest {
  * @interface DatawarehouseApiInterface
  */
 export interface DatawarehouseApiInterface {
+    /**
+     * Delete a custom report on the UltraCart account.
+     * @summary Delete a custom report
+     * @param {number} customReportOid The report oid to delete.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    deleteCustomReportRaw(requestParameters: DeleteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a custom report on the UltraCart account.
+     * Delete a custom report
+     */
+    deleteCustomReport(requestParameters: DeleteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Delete a report on the UltraCart account.
      * @summary Delete a report
@@ -72,6 +106,21 @@ export interface DatawarehouseApiInterface {
      * Dry run the report queries
      */
     dryRunReportQueries(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDryRunQueriesResponse>;
+    /**
+     * Execute a custom report on the UltraCart account.
+     * @summary Execute a custom report
+     * @param {number} customReportOid The report oid to execute.
+     * @param {CustomReportExecutionRequest} executionRequest Request to execute custom report
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    executeCustomReportRaw(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    /**
+     * Execute a custom report on the UltraCart account.
+     * Execute a custom report
+     */
+    executeCustomReport(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
     /**
      * Execute the report queries
      * @summary Execute the report queries
@@ -86,6 +135,46 @@ export interface DatawarehouseApiInterface {
      * Execute the report queries
      */
     executeReportQueries(requestParameters: ExecuteReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve a custom report
+     * @summary Get a custom report
+     * @param {number} customReportOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getCustomReportRaw(requestParameters: GetCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    /**
+     * Retrieve a custom report
+     * Get a custom report
+     */
+    getCustomReport(requestParameters: GetCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
+    /**
+     * Retrieve a custom report account configuration
+     * @summary Get custom report account configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getCustomReportAccountConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportAccountConfigResponse>>;
+    /**
+     * Retrieve a custom report account configuration
+     * 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
@@ -155,6 +244,20 @@ export interface DatawarehouseApiInterface {
      * Get list of reports available
      */
     getReports(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportsResponse>;
+    /**
+     * Create a new custom report on the UltraCart account.
+     * @summary Create a custom report
+     * @param {CustomReport} report Report to create
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    insertCustomReportRaw(requestParameters: InsertCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    /**
+     * Create a new custom report on the UltraCart account.
+     * Create a custom report
+     */
+    insertCustomReport(requestParameters: InsertCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
     /**
      * Create a new report on the UltraCart account.
      * @summary Create a report
@@ -169,6 +272,35 @@ export interface DatawarehouseApiInterface {
      * Create a report
      */
     insertReport(requestParameters: InsertReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+    /**
+     * Update a custom report on the UltraCart account.
+     * @summary Update a custom report
+     * @param {number} customReportOid The report oid to custom update.
+     * @param {CustomReport} report Report to custom update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    updateCustomReportRaw(requestParameters: UpdateCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    /**
+     * Update a custom report on the UltraCart account.
+     * Update a custom report
+     */
+    updateCustomReport(requestParameters: UpdateCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
+    /**
+     * Update custom report account config.
+     * @summary Update custom report account config
+     * @param {CustomReportAccountConfig} accountConfig Account config to update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    updateCustomReportAccountConfigRaw(requestParameters: UpdateCustomReportAccountConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportAccountConfigResponse>>;
+    /**
+     * Update custom report account config.
+     * Update custom report account config
+     */
+    updateCustomReportAccountConfig(requestParameters: UpdateCustomReportAccountConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAccountConfigResponse>;
     /**
      * Update a report on the UltraCart account.
      * @summary Update a report
@@ -189,6 +321,16 @@ export interface DatawarehouseApiInterface {
  *
  */
 export declare class DatawarehouseApi extends runtime.BaseAPI implements DatawarehouseApiInterface {
+    /**
+     * Delete a custom report on the UltraCart account.
+     * Delete a custom report
+     */
+    deleteCustomReportRaw(requestParameters: DeleteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a custom report on the UltraCart account.
+     * Delete a custom report
+     */
+    deleteCustomReport(requestParameters: DeleteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Delete a report on the UltraCart account.
      * Delete a report
@@ -209,6 +351,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Dry run the report queries
      */
     dryRunReportQueries(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDryRunQueriesResponse>;
+    /**
+     * Execute a custom report on the UltraCart account.
+     * Execute a custom report
+     */
+    executeCustomReportRaw(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    /**
+     * Execute a custom report on the UltraCart account.
+     * Execute a custom report
+     */
+    executeCustomReport(requestParameters: ExecuteCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
     /**
      * Execute the report queries
      * Execute the report queries
@@ -219,6 +371,36 @@ 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 report
+     * Get a custom report
+     */
+    getCustomReportRaw(requestParameters: GetCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    /**
+     * Retrieve a custom report
+     * Get a custom report
+     */
+    getCustomReport(requestParameters: GetCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
+    /**
+     * Retrieve a custom report account configuration
+     * Get custom report account configuration
+     */
+    getCustomReportAccountConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportAccountConfigResponse>>;
+    /**
+     * Retrieve a custom report account configuration
+     * 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
@@ -269,6 +451,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 report on the UltraCart account.
+     * Create a custom report
+     */
+    insertCustomReportRaw(requestParameters: InsertCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    /**
+     * Create a new custom report on the UltraCart account.
+     * Create a custom report
+     */
+    insertCustomReport(requestParameters: InsertCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
     /**
      * Create a new report on the UltraCart account.
      * Create a report
@@ -279,6 +471,26 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Create a report
      */
     insertReport(requestParameters: InsertReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+    /**
+     * Update a custom report on the UltraCart account.
+     * Update a custom report
+     */
+    updateCustomReportRaw(requestParameters: UpdateCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportResponse>>;
+    /**
+     * Update a custom report on the UltraCart account.
+     * Update a custom report
+     */
+    updateCustomReport(requestParameters: UpdateCustomReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportResponse>;
+    /**
+     * Update custom report account config.
+     * Update custom report account config
+     */
+    updateCustomReportAccountConfigRaw(requestParameters: UpdateCustomReportAccountConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomReportAccountConfigResponse>>;
+    /**
+     * Update custom report account config.
+     * Update custom report account config
+     */
+    updateCustomReportAccountConfig(requestParameters: UpdateCustomReportAccountConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomReportAccountConfigResponse>;
     /**
      * Update a report on the UltraCart account.
      * Update a report