ultracart_rest_api_v2_typescript 4.0.141 → 4.0.142

package/.openapi-generator/FILES

@@ -10,6 +10,7 @@ src/apis/CheckoutApi.ts
 src/apis/ConversationApi.ts
 src/apis/CouponApi.ts
 src/apis/CustomerApi.ts
+src/apis/DatawarehouseApi.ts
 src/apis/FulfillmentApi.ts
 src/apis/GiftCertificateApi.ts
 src/apis/IntegrationLogApi.ts
@@ -646,6 +647,28 @@ src/models/Property.ts
 src/models/PublishLibraryItemRequest.ts
 src/models/RegisterAffiliateClickRequest.ts
 src/models/RegisterAffiliateClickResponse.ts
+src/models/Report.ts
+src/models/ReportAuth.ts
+src/models/ReportAuthResponse.ts
+src/models/ReportDataSet.ts
+src/models/ReportDataSetColumn.ts
+src/models/ReportDataSetPage.ts
+src/models/ReportDataSetPageResponse.ts
+src/models/ReportDataSetQuery.ts
+src/models/ReportDataSetResponse.ts
+src/models/ReportDataSetRow.ts
+src/models/ReportDataSetSchema.ts
+src/models/ReportDataSource.ts
+src/models/ReportDataSourceSchema.ts
+src/models/ReportExecuteQueriesRequest.ts
+src/models/ReportFilter.ts
+src/models/ReportFilterConnection.ts
+src/models/ReportPage.ts
+src/models/ReportPageVisualization.ts
+src/models/ReportPageVisualizationDimension.ts
+src/models/ReportPageVisualizationMetric.ts
+src/models/ReportResponse.ts
+src/models/ReportsResponse.ts
 src/models/ResponseMetadata.ts
 src/models/ResultSet.ts
 src/models/RulerValidationRequest.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.141
+## ultracart_rest_api_v2_typescript@4.0.142
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.141 --save
+npm install ultracart_rest_api_v2_typescript@4.0.142 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.142 | 03/22/2023 | dw initial framework |
 | 4.0.141 | 03/22/2023 | order api - refundable response added manual_because_multiple_charges boolean field |
 | 4.0.140 | 03/21/2023 | order api - new stage named Hold |
 | 4.0.139 | 03/14/2023 | order.getOrderEdiDocuments |

package/dist/apis/DatawarehouseApi.d.ts

@@ -0,0 +1,265 @@
+/**
+ * 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 * as runtime from '../runtime';
+import { Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
+export interface DeleteReportRequest {
+    reportOid: number;
+}
+export interface ExecuteReportQueriesRequest {
+    queryRequest: ReportExecuteQueriesRequest;
+}
+export interface GetReportRequest {
+    reportOid: number;
+}
+export interface GetReportDataSetRequest {
+    datasetUuid: string;
+}
+export interface GetReportDataSetPageRequest {
+    datasetUuid: string;
+    pageNumber: number;
+}
+export interface InsertReportRequest {
+    report: Report;
+}
+export interface UpdateReportRequest {
+    reportOid: number;
+    report: Report;
+}
+/**
+ * DatawarehouseApi - interface
+ *
+ * @export
+ * @interface DatawarehouseApiInterface
+ */
+export interface DatawarehouseApiInterface {
+    /**
+     * Delete a report on the UltraCart account.
+     * @summary Delete a report
+     * @param {number} reportOid The report oid to delete.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    deleteReportRaw(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a report on the UltraCart account.
+     * Delete a report
+     */
+    deleteReport(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Execute the report queries
+     * @summary Execute the report queries
+     * @param {ReportExecuteQueriesRequest} queryRequest Query request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    executeReportQueriesRaw(requestParameters: ExecuteReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Execute the report queries
+     * Execute the report queries
+     */
+    executeReportQueries(requestParameters: ExecuteReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve a report
+     * @summary Get a report
+     * @param {number} reportOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getReportRaw(requestParameters: GetReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportResponse>>;
+    /**
+     * Retrieve a report
+     * Get a report
+     */
+    getReport(requestParameters: GetReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+    /**
+     * Retrieve a report data set
+     * @summary Get a report data set
+     * @param {string} datasetUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getReportDataSetRaw(requestParameters: GetReportDataSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportDataSetResponse>>;
+    /**
+     * Retrieve a report data set
+     * Get a report data set
+     */
+    getReportDataSet(requestParameters: GetReportDataSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDataSetResponse>;
+    /**
+     * Retrieve a report data set page
+     * @summary Get a report data set page
+     * @param {string} datasetUuid
+     * @param {number} pageNumber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getReportDataSetPageRaw(requestParameters: GetReportDataSetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportDataSetPageResponse>>;
+    /**
+     * Retrieve a report data set page
+     * Get a report data set page
+     */
+    getReportDataSetPage(requestParameters: GetReportDataSetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDataSetPageResponse>;
+    /**
+     * Retrieve a JWT to authorize a report to make a websocket connection.
+     * @summary Get report websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getReportWebsocketAuthorizationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportAuthResponse>>;
+    /**
+     * Retrieve a JWT to authorize a report to make a websocket connection.
+     * Get report websocket authorization
+     */
+    getReportWebsocketAuthorization(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportAuthResponse>;
+    /**
+     * Retrieve a list of reports available
+     * @summary Get list of reports available
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    getReportsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportsResponse>>;
+    /**
+     * Retrieve a list of reports available
+     * Get list of reports available
+     */
+    getReports(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportsResponse>;
+    /**
+     * Create a new report on the UltraCart account.
+     * @summary Create a report
+     * @param {Report} report Report to create
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    insertReportRaw(requestParameters: InsertReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportResponse>>;
+    /**
+     * Create a new report on the UltraCart account.
+     * Create a report
+     */
+    insertReport(requestParameters: InsertReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+    /**
+     * Update a report on the UltraCart account.
+     * @summary Update a report
+     * @param {number} reportOid The report oid to update.
+     * @param {Report} report Report to update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    updateReportRaw(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportResponse>>;
+    /**
+     * Update a report on the UltraCart account.
+     * Update a report
+     */
+    updateReport(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+}
+/**
+ *
+ */
+export declare class DatawarehouseApi extends runtime.BaseAPI implements DatawarehouseApiInterface {
+    /**
+     * Delete a report on the UltraCart account.
+     * Delete a report
+     */
+    deleteReportRaw(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a report on the UltraCart account.
+     * Delete a report
+     */
+    deleteReport(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Execute the report queries
+     * Execute the report queries
+     */
+    executeReportQueriesRaw(requestParameters: ExecuteReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Execute the report queries
+     * Execute the report queries
+     */
+    executeReportQueries(requestParameters: ExecuteReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve a report
+     * Get a report
+     */
+    getReportRaw(requestParameters: GetReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportResponse>>;
+    /**
+     * Retrieve a report
+     * Get a report
+     */
+    getReport(requestParameters: GetReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+    /**
+     * Retrieve a report data set
+     * Get a report data set
+     */
+    getReportDataSetRaw(requestParameters: GetReportDataSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportDataSetResponse>>;
+    /**
+     * Retrieve a report data set
+     * Get a report data set
+     */
+    getReportDataSet(requestParameters: GetReportDataSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDataSetResponse>;
+    /**
+     * Retrieve a report data set page
+     * Get a report data set page
+     */
+    getReportDataSetPageRaw(requestParameters: GetReportDataSetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportDataSetPageResponse>>;
+    /**
+     * Retrieve a report data set page
+     * Get a report data set page
+     */
+    getReportDataSetPage(requestParameters: GetReportDataSetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDataSetPageResponse>;
+    /**
+     * Retrieve a JWT to authorize a report to make a websocket connection.
+     * Get report websocket authorization
+     */
+    getReportWebsocketAuthorizationRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportAuthResponse>>;
+    /**
+     * Retrieve a JWT to authorize a report to make a websocket connection.
+     * Get report websocket authorization
+     */
+    getReportWebsocketAuthorization(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportAuthResponse>;
+    /**
+     * Retrieve a list of reports available
+     * Get list of reports available
+     */
+    getReportsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportsResponse>>;
+    /**
+     * Retrieve a list of reports available
+     * Get list of reports available
+     */
+    getReports(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportsResponse>;
+    /**
+     * Create a new report on the UltraCart account.
+     * Create a report
+     */
+    insertReportRaw(requestParameters: InsertReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportResponse>>;
+    /**
+     * Create a new report on the UltraCart account.
+     * Create a report
+     */
+    insertReport(requestParameters: InsertReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+    /**
+     * Update a report on the UltraCart account.
+     * Update a report
+     */
+    updateReportRaw(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportResponse>>;
+    /**
+     * Update a report on the UltraCart account.
+     * Update a report
+     */
+    updateReport(requestParameters: UpdateReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportResponse>;
+}