ultracart_rest_api_v2_typescript 4.0.142 → 4.0.144

package/.openapi-generator/FILES

@@ -668,6 +668,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.144
 
 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.144 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.144 | 03/29/2023 | internal development |
+| 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/Experiment.d.ts

@@ -76,12 +76,42 @@ export interface Experiment {
      * @memberof Experiment
      */
     objective_parameter?: string;
+    /**
+     * The current iteration of the OpenAI related experiment
+     * @type {number}
+     * @memberof Experiment
+     */
+    openai_current_iteration?: number;
+    /**
+     * The type of OpenAI element being experimented on
+     * @type {string}
+     * @memberof Experiment
+     */
+    openai_element_type?: ExperimentOpenaiElementTypeEnum;
+    /**
+     * The type of OpenAI model used
+     * @type {string}
+     * @memberof Experiment
+     */
+    openai_model?: string;
+    /**
+     * The total number of iterations to perform on the experiment
+     * @type {number}
+     * @memberof Experiment
+     */
+    openai_total_iterations?: number;
     /**
      * Type of optimization
      * @type {string}
      * @memberof Experiment
      */
     optimization_type?: string;
+    /**
+     * Statistics p-value for the experiment
+     * @type {number}
+     * @memberof Experiment
+     */
+    p_value?: number;
     /**
      * Total number of sessions in the experiment
      * @type {number}
@@ -125,6 +155,15 @@ export interface Experiment {
      */
     variations?: Array<ExperimentVariation>;
 }
+/**
+ * @export
+ */
+export declare const ExperimentOpenaiElementTypeEnum: {
+    readonly Headline: "headline";
+    readonly Text: "text";
+    readonly Textblock: "textblock";
+};
+export type ExperimentOpenaiElementTypeEnum = typeof ExperimentOpenaiElementTypeEnum[keyof typeof ExperimentOpenaiElementTypeEnum];
 /**
  * @export
  */

package/dist/models/Experiment.js

@@ -13,9 +13,17 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExperimentToJSON = exports.ExperimentFromJSONTyped = exports.ExperimentFromJSON = exports.ExperimentStatusEnum = void 0;
+exports.ExperimentToJSON = exports.ExperimentFromJSONTyped = exports.ExperimentFromJSON = exports.ExperimentStatusEnum = exports.ExperimentOpenaiElementTypeEnum = void 0;
 var runtime_1 = require("../runtime");
 var ExperimentVariation_1 = require("./ExperimentVariation");
+/**
+ * @export
+ */
+exports.ExperimentOpenaiElementTypeEnum = {
+    Headline: 'headline',
+    Text: 'text',
+    Textblock: 'textblock'
+};
 /**
  * @export
  */
@@ -43,7 +51,12 @@ function ExperimentFromJSONTyped(json, ignoreDiscriminator) {
         'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
         'objective': !(0, runtime_1.exists)(json, 'objective') ? undefined : json['objective'],
         'objective_parameter': !(0, runtime_1.exists)(json, 'objective_parameter') ? undefined : json['objective_parameter'],
+        'openai_current_iteration': !(0, runtime_1.exists)(json, 'openai_current_iteration') ? undefined : json['openai_current_iteration'],
+        'openai_element_type': !(0, runtime_1.exists)(json, 'openai_element_type') ? undefined : json['openai_element_type'],
+        'openai_model': !(0, runtime_1.exists)(json, 'openai_model') ? undefined : json['openai_model'],
+        'openai_total_iterations': !(0, runtime_1.exists)(json, 'openai_total_iterations') ? undefined : json['openai_total_iterations'],
         'optimization_type': !(0, runtime_1.exists)(json, 'optimization_type') ? undefined : json['optimization_type'],
+        'p_value': !(0, runtime_1.exists)(json, 'p_value') ? undefined : json['p_value'],
         'session_count': !(0, runtime_1.exists)(json, 'session_count') ? undefined : json['session_count'],
         'start_dts': !(0, runtime_1.exists)(json, 'start_dts') ? undefined : json['start_dts'],
         'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
@@ -72,7 +85,12 @@ function ExperimentToJSON(value) {
         'notes': value.notes,
         'objective': value.objective,
         'objective_parameter': value.objective_parameter,
+        'openai_current_iteration': value.openai_current_iteration,
+        'openai_element_type': value.openai_element_type,
+        'openai_model': value.openai_model,
+        'openai_total_iterations': value.openai_total_iterations,
         'optimization_type': value.optimization_type,
+        'p_value': value.p_value,
         'session_count': value.session_count,
         'start_dts': value.start_dts,
         'status': value.status,

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 { ReportDataSet } from './ReportDataSet';
+/**
+ *
+ * @export
+ * @interface ReportWebsocketEvent
+ */
+export interface ReportWebsocketEvent {
+    /**
+     * Event type
+     * @type {string}
+     * @memberof ReportWebsocketEvent
+     */
+    event_type?: ReportWebsocketEventEventTypeEnum;
+    /**
+     *
+     * @type {ReportDataSet}
+     * @memberof ReportWebsocketEvent
+     */
+    query_completion?: ReportDataSet;
+}
+/**
+ * @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 ReportDataSet_1 = require("./ReportDataSet");
+/**
+ * @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, ReportDataSet_1.ReportDataSetFromJSON)(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, ReportDataSet_1.ReportDataSetToJSON)(value.query_completion),
+    };
+}
+exports.ReportWebsocketEventToJSON = ReportWebsocketEventToJSON;

package/dist/models/index.d.ts

@@ -642,6 +642,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

@@ -660,6 +660,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.144",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/models/Experiment.ts

@@ -86,12 +86,42 @@ export interface Experiment {
      * @memberof Experiment
      */
     objective_parameter?: string;
+    /**
+     * The current iteration of the OpenAI related experiment
+     * @type {number}
+     * @memberof Experiment
+     */
+    openai_current_iteration?: number;
+    /**
+     * The type of OpenAI element being experimented on
+     * @type {string}
+     * @memberof Experiment
+     */
+    openai_element_type?: ExperimentOpenaiElementTypeEnum;
+    /**
+     * The type of OpenAI model used
+     * @type {string}
+     * @memberof Experiment
+     */
+    openai_model?: string;
+    /**
+     * The total number of iterations to perform on the experiment
+     * @type {number}
+     * @memberof Experiment
+     */
+    openai_total_iterations?: number;
     /**
      * Type of optimization
      * @type {string}
      * @memberof Experiment
      */
     optimization_type?: string;
+    /**
+     * Statistics p-value for the experiment
+     * @type {number}
+     * @memberof Experiment
+     */
+    p_value?: number;
     /**
      * Total number of sessions in the experiment
      * @type {number}
@@ -137,6 +167,16 @@ export interface Experiment {
 }
 
 
+/**
+ * @export
+ */
+export const ExperimentOpenaiElementTypeEnum = {
+    Headline: 'headline',
+    Text: 'text',
+    Textblock: 'textblock'
+} as const;
+export type ExperimentOpenaiElementTypeEnum = typeof ExperimentOpenaiElementTypeEnum[keyof typeof ExperimentOpenaiElementTypeEnum];
+
 /**
  * @export
  */
@@ -168,7 +208,12 @@ export function ExperimentFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'notes': !exists(json, 'notes') ? undefined : json['notes'],
         'objective': !exists(json, 'objective') ? undefined : json['objective'],
         'objective_parameter': !exists(json, 'objective_parameter') ? undefined : json['objective_parameter'],
+        'openai_current_iteration': !exists(json, 'openai_current_iteration') ? undefined : json['openai_current_iteration'],
+        'openai_element_type': !exists(json, 'openai_element_type') ? undefined : json['openai_element_type'],
+        'openai_model': !exists(json, 'openai_model') ? undefined : json['openai_model'],
+        'openai_total_iterations': !exists(json, 'openai_total_iterations') ? undefined : json['openai_total_iterations'],
         'optimization_type': !exists(json, 'optimization_type') ? undefined : json['optimization_type'],
+        'p_value': !exists(json, 'p_value') ? undefined : json['p_value'],
         'session_count': !exists(json, 'session_count') ? undefined : json['session_count'],
         'start_dts': !exists(json, 'start_dts') ? undefined : json['start_dts'],
         'status': !exists(json, 'status') ? undefined : json['status'],
@@ -198,7 +243,12 @@ export function ExperimentToJSON(value?: Experiment | null): any {
         'notes': value.notes,
         'objective': value.objective,
         'objective_parameter': value.objective_parameter,
+        'openai_current_iteration': value.openai_current_iteration,
+        'openai_element_type': value.openai_element_type,
+        'openai_model': value.openai_model,
+        'openai_total_iterations': value.openai_total_iterations,
         'optimization_type': value.optimization_type,
+        'p_value': value.p_value,
         'session_count': value.session_count,
         'start_dts': value.start_dts,
         'status': value.status,

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 {
+    ReportDataSet,
+    ReportDataSetFromJSON,
+    ReportDataSetFromJSONTyped,
+    ReportDataSetToJSON,
+} from './ReportDataSet';
+
+/**
+ * 
+ * @export
+ * @interface ReportWebsocketEvent
+ */
+export interface ReportWebsocketEvent {
+    /**
+     * Event type
+     * @type {string}
+     * @memberof ReportWebsocketEvent
+     */
+    event_type?: ReportWebsocketEventEventTypeEnum;
+    /**
+     * 
+     * @type {ReportDataSet}
+     * @memberof ReportWebsocketEvent
+     */
+    query_completion?: ReportDataSet;
+}
+
+
+/**
+ * @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 : ReportDataSetFromJSON(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': ReportDataSetToJSON(value.query_completion),
+    };
+}
+

package/src/models/index.ts

@@ -644,6 +644,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';