ultracart_rest_api_v2_typescript 4.0.142 → 4.0.143

package/.openapi-generator/FILES

@@ -658,6 +658,7 @@ src/models/ReportDataSetQuery.ts
 src/models/ReportDataSetResponse.ts
 src/models/ReportDataSetRow.ts
 src/models/ReportDataSetSchema.ts
+src/models/ReportDataSetSummary.ts
 src/models/ReportDataSource.ts
 src/models/ReportDataSourceSchema.ts
 src/models/ReportExecuteQueriesRequest.ts
@@ -668,6 +669,7 @@ src/models/ReportPageVisualization.ts
 src/models/ReportPageVisualizationDimension.ts
 src/models/ReportPageVisualizationMetric.ts
 src/models/ReportResponse.ts
+src/models/ReportWebsocketEvent.ts
 src/models/ReportsResponse.ts
 src/models/ResponseMetadata.ts
 src/models/ResultSet.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.142
+## ultracart_rest_api_v2_typescript@4.0.143
 
 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.142 --save
+npm install ultracart_rest_api_v2_typescript@4.0.143 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.143 | 03/22/2023 | data warehouse internal dev |
 | 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 |

package/dist/models/ReportDataSetSummary.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { ReportDataSetSchema } from './ReportDataSetSchema';
+/**
+ *
+ * @export
+ * @interface ReportDataSetSummary
+ */
+export interface ReportDataSetSummary {
+    /**
+     * A unique identifier assigned to the data set that is returned.
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    data_set_uuid?: string;
+    /**
+     * Error message if the query failed.
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    error_message?: string;
+    /**
+     * An identifier that can be used to help match up the returned data set
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    for_object_id?: string;
+    /**
+     * The type of object this data set is for
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    for_object_type?: ReportDataSetSummaryForObjectTypeEnum;
+    /**
+     * The total number of results
+     * @type {number}
+     * @memberof ReportDataSetSummary
+     */
+    max_results?: number;
+    /**
+     * The schema associated with the data set.
+     * @type {Array<ReportDataSetSchema>}
+     * @memberof ReportDataSetSummary
+     */
+    schema?: Array<ReportDataSetSchema>;
+    /**
+     * Any other data that needs to be returned with the response to help the UI
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    user_data?: string;
+}
+/**
+ * @export
+ */
+export declare const ReportDataSetSummaryForObjectTypeEnum: {
+    readonly Schema: "schema";
+    readonly Filter: "filter";
+    readonly Visualization: "visualization";
+};
+export type ReportDataSetSummaryForObjectTypeEnum = typeof ReportDataSetSummaryForObjectTypeEnum[keyof typeof ReportDataSetSummaryForObjectTypeEnum];
+export declare function ReportDataSetSummaryFromJSON(json: any): ReportDataSetSummary;
+export declare function ReportDataSetSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDataSetSummary;
+export declare function ReportDataSetSummaryToJSON(value?: ReportDataSetSummary | null): any;

package/dist/models/ReportDataSetSummary.js

@@ -0,0 +1,63 @@
+"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.ReportDataSetSummaryToJSON = exports.ReportDataSetSummaryFromJSONTyped = exports.ReportDataSetSummaryFromJSON = exports.ReportDataSetSummaryForObjectTypeEnum = void 0;
+var runtime_1 = require("../runtime");
+var ReportDataSetSchema_1 = require("./ReportDataSetSchema");
+/**
+ * @export
+ */
+exports.ReportDataSetSummaryForObjectTypeEnum = {
+    Schema: 'schema',
+    Filter: 'filter',
+    Visualization: 'visualization'
+};
+function ReportDataSetSummaryFromJSON(json) {
+    return ReportDataSetSummaryFromJSONTyped(json, false);
+}
+exports.ReportDataSetSummaryFromJSON = ReportDataSetSummaryFromJSON;
+function ReportDataSetSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data_set_uuid': !(0, runtime_1.exists)(json, 'data_set_uuid') ? undefined : json['data_set_uuid'],
+        'error_message': !(0, runtime_1.exists)(json, 'error_message') ? undefined : json['error_message'],
+        'for_object_id': !(0, runtime_1.exists)(json, 'for_object_id') ? undefined : json['for_object_id'],
+        'for_object_type': !(0, runtime_1.exists)(json, 'for_object_type') ? undefined : json['for_object_type'],
+        'max_results': !(0, runtime_1.exists)(json, 'max_results') ? undefined : json['max_results'],
+        'schema': !(0, runtime_1.exists)(json, 'schema') ? undefined : (json['schema'].map(ReportDataSetSchema_1.ReportDataSetSchemaFromJSON)),
+        'user_data': !(0, runtime_1.exists)(json, 'user_data') ? undefined : json['user_data'],
+    };
+}
+exports.ReportDataSetSummaryFromJSONTyped = ReportDataSetSummaryFromJSONTyped;
+function ReportDataSetSummaryToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data_set_uuid': value.data_set_uuid,
+        'error_message': value.error_message,
+        'for_object_id': value.for_object_id,
+        'for_object_type': value.for_object_type,
+        'max_results': value.max_results,
+        'schema': value.schema === undefined ? undefined : (value.schema.map(ReportDataSetSchema_1.ReportDataSetSchemaToJSON)),
+        'user_data': value.user_data,
+    };
+}
+exports.ReportDataSetSummaryToJSON = ReportDataSetSummaryToJSON;

package/dist/models/ReportWebsocketEvent.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { ReportDataSetSummary } from './ReportDataSetSummary';
+/**
+ *
+ * @export
+ * @interface ReportWebsocketEvent
+ */
+export interface ReportWebsocketEvent {
+    /**
+     * Event type
+     * @type {string}
+     * @memberof ReportWebsocketEvent
+     */
+    event_type?: ReportWebsocketEventEventTypeEnum;
+    /**
+     *
+     * @type {ReportDataSetSummary}
+     * @memberof ReportWebsocketEvent
+     */
+    query_completion?: ReportDataSetSummary;
+}
+/**
+ * @export
+ */
+export declare const ReportWebsocketEventEventTypeEnum: {
+    readonly Ping: "ping";
+    readonly QueryCompletion: "query completion";
+};
+export type ReportWebsocketEventEventTypeEnum = typeof ReportWebsocketEventEventTypeEnum[keyof typeof ReportWebsocketEventEventTypeEnum];
+export declare function ReportWebsocketEventFromJSON(json: any): ReportWebsocketEvent;
+export declare function ReportWebsocketEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportWebsocketEvent;
+export declare function ReportWebsocketEventToJSON(value?: ReportWebsocketEvent | null): any;

package/dist/models/ReportWebsocketEvent.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.ReportWebsocketEventToJSON = exports.ReportWebsocketEventFromJSONTyped = exports.ReportWebsocketEventFromJSON = exports.ReportWebsocketEventEventTypeEnum = void 0;
+var runtime_1 = require("../runtime");
+var ReportDataSetSummary_1 = require("./ReportDataSetSummary");
+/**
+ * @export
+ */
+exports.ReportWebsocketEventEventTypeEnum = {
+    Ping: 'ping',
+    QueryCompletion: 'query completion'
+};
+function ReportWebsocketEventFromJSON(json) {
+    return ReportWebsocketEventFromJSONTyped(json, false);
+}
+exports.ReportWebsocketEventFromJSON = ReportWebsocketEventFromJSON;
+function ReportWebsocketEventFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'event_type': !(0, runtime_1.exists)(json, 'event_type') ? undefined : json['event_type'],
+        'query_completion': !(0, runtime_1.exists)(json, 'query_completion') ? undefined : (0, ReportDataSetSummary_1.ReportDataSetSummaryFromJSON)(json['query_completion']),
+    };
+}
+exports.ReportWebsocketEventFromJSONTyped = ReportWebsocketEventFromJSONTyped;
+function ReportWebsocketEventToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'event_type': value.event_type,
+        'query_completion': (0, ReportDataSetSummary_1.ReportDataSetSummaryToJSON)(value.query_completion),
+    };
+}
+exports.ReportWebsocketEventToJSON = ReportWebsocketEventToJSON;

package/dist/models/index.d.ts

@@ -632,6 +632,7 @@ export * from './ReportDataSetQuery';
 export * from './ReportDataSetResponse';
 export * from './ReportDataSetRow';
 export * from './ReportDataSetSchema';
+export * from './ReportDataSetSummary';
 export * from './ReportDataSource';
 export * from './ReportDataSourceSchema';
 export * from './ReportExecuteQueriesRequest';
@@ -642,6 +643,7 @@ export * from './ReportPageVisualization';
 export * from './ReportPageVisualizationDimension';
 export * from './ReportPageVisualizationMetric';
 export * from './ReportResponse';
+export * from './ReportWebsocketEvent';
 export * from './ReportsResponse';
 export * from './ResponseMetadata';
 export * from './ResultSet';

package/dist/models/index.js

@@ -650,6 +650,7 @@ __exportStar(require("./ReportDataSetQuery"), exports);
 __exportStar(require("./ReportDataSetResponse"), exports);
 __exportStar(require("./ReportDataSetRow"), exports);
 __exportStar(require("./ReportDataSetSchema"), exports);
+__exportStar(require("./ReportDataSetSummary"), exports);
 __exportStar(require("./ReportDataSource"), exports);
 __exportStar(require("./ReportDataSourceSchema"), exports);
 __exportStar(require("./ReportExecuteQueriesRequest"), exports);
@@ -660,6 +661,7 @@ __exportStar(require("./ReportPageVisualization"), exports);
 __exportStar(require("./ReportPageVisualizationDimension"), exports);
 __exportStar(require("./ReportPageVisualizationMetric"), exports);
 __exportStar(require("./ReportResponse"), exports);
+__exportStar(require("./ReportWebsocketEvent"), exports);
 __exportStar(require("./ReportsResponse"), exports);
 __exportStar(require("./ResponseMetadata"), exports);
 __exportStar(require("./ResultSet"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.142",
+  "version": "4.0.143",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/models/ReportDataSetSummary.ts

@@ -0,0 +1,123 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ReportDataSetSchema,
+    ReportDataSetSchemaFromJSON,
+    ReportDataSetSchemaFromJSONTyped,
+    ReportDataSetSchemaToJSON,
+} from './ReportDataSetSchema';
+
+/**
+ * 
+ * @export
+ * @interface ReportDataSetSummary
+ */
+export interface ReportDataSetSummary {
+    /**
+     * A unique identifier assigned to the data set that is returned.
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    data_set_uuid?: string;
+    /**
+     * Error message if the query failed.
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    error_message?: string;
+    /**
+     * An identifier that can be used to help match up the returned data set
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    for_object_id?: string;
+    /**
+     * The type of object this data set is for
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    for_object_type?: ReportDataSetSummaryForObjectTypeEnum;
+    /**
+     * The total number of results
+     * @type {number}
+     * @memberof ReportDataSetSummary
+     */
+    max_results?: number;
+    /**
+     * The schema associated with the data set.
+     * @type {Array<ReportDataSetSchema>}
+     * @memberof ReportDataSetSummary
+     */
+    schema?: Array<ReportDataSetSchema>;
+    /**
+     * Any other data that needs to be returned with the response to help the UI
+     * @type {string}
+     * @memberof ReportDataSetSummary
+     */
+    user_data?: string;
+}
+
+
+/**
+ * @export
+ */
+export const ReportDataSetSummaryForObjectTypeEnum = {
+    Schema: 'schema',
+    Filter: 'filter',
+    Visualization: 'visualization'
+} as const;
+export type ReportDataSetSummaryForObjectTypeEnum = typeof ReportDataSetSummaryForObjectTypeEnum[keyof typeof ReportDataSetSummaryForObjectTypeEnum];
+
+
+export function ReportDataSetSummaryFromJSON(json: any): ReportDataSetSummary {
+    return ReportDataSetSummaryFromJSONTyped(json, false);
+}
+
+export function ReportDataSetSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDataSetSummary {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'data_set_uuid': !exists(json, 'data_set_uuid') ? undefined : json['data_set_uuid'],
+        'error_message': !exists(json, 'error_message') ? undefined : json['error_message'],
+        'for_object_id': !exists(json, 'for_object_id') ? undefined : json['for_object_id'],
+        'for_object_type': !exists(json, 'for_object_type') ? undefined : json['for_object_type'],
+        'max_results': !exists(json, 'max_results') ? undefined : json['max_results'],
+        'schema': !exists(json, 'schema') ? undefined : ((json['schema'] as Array<any>).map(ReportDataSetSchemaFromJSON)),
+        'user_data': !exists(json, 'user_data') ? undefined : json['user_data'],
+    };
+}
+
+export function ReportDataSetSummaryToJSON(value?: ReportDataSetSummary | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'data_set_uuid': value.data_set_uuid,
+        'error_message': value.error_message,
+        'for_object_id': value.for_object_id,
+        'for_object_type': value.for_object_type,
+        'max_results': value.max_results,
+        'schema': value.schema === undefined ? undefined : ((value.schema as Array<any>).map(ReportDataSetSchemaToJSON)),
+        'user_data': value.user_data,
+    };
+}
+

package/src/models/ReportWebsocketEvent.ts

@@ -0,0 +1,82 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ReportDataSetSummary,
+    ReportDataSetSummaryFromJSON,
+    ReportDataSetSummaryFromJSONTyped,
+    ReportDataSetSummaryToJSON,
+} from './ReportDataSetSummary';
+
+/**
+ * 
+ * @export
+ * @interface ReportWebsocketEvent
+ */
+export interface ReportWebsocketEvent {
+    /**
+     * Event type
+     * @type {string}
+     * @memberof ReportWebsocketEvent
+     */
+    event_type?: ReportWebsocketEventEventTypeEnum;
+    /**
+     * 
+     * @type {ReportDataSetSummary}
+     * @memberof ReportWebsocketEvent
+     */
+    query_completion?: ReportDataSetSummary;
+}
+
+
+/**
+ * @export
+ */
+export const ReportWebsocketEventEventTypeEnum = {
+    Ping: 'ping',
+    QueryCompletion: 'query completion'
+} as const;
+export type ReportWebsocketEventEventTypeEnum = typeof ReportWebsocketEventEventTypeEnum[keyof typeof ReportWebsocketEventEventTypeEnum];
+
+
+export function ReportWebsocketEventFromJSON(json: any): ReportWebsocketEvent {
+    return ReportWebsocketEventFromJSONTyped(json, false);
+}
+
+export function ReportWebsocketEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportWebsocketEvent {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'event_type': !exists(json, 'event_type') ? undefined : json['event_type'],
+        'query_completion': !exists(json, 'query_completion') ? undefined : ReportDataSetSummaryFromJSON(json['query_completion']),
+    };
+}
+
+export function ReportWebsocketEventToJSON(value?: ReportWebsocketEvent | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'event_type': value.event_type,
+        'query_completion': ReportDataSetSummaryToJSON(value.query_completion),
+    };
+}
+

package/src/models/index.ts

@@ -634,6 +634,7 @@ export * from './ReportDataSetQuery';
 export * from './ReportDataSetResponse';
 export * from './ReportDataSetRow';
 export * from './ReportDataSetSchema';
+export * from './ReportDataSetSummary';
 export * from './ReportDataSource';
 export * from './ReportDataSourceSchema';
 export * from './ReportExecuteQueriesRequest';
@@ -644,6 +645,7 @@ export * from './ReportPageVisualization';
 export * from './ReportPageVisualizationDimension';
 export * from './ReportPageVisualizationMetric';
 export * from './ReportResponse';
+export * from './ReportWebsocketEvent';
 export * from './ReportsResponse';
 export * from './ResponseMetadata';
 export * from './ResultSet';