ultracart_rest_api_v2_typescript 4.0.99-RC → 4.0.100-RC

package/.openapi-generator/FILES

@@ -155,6 +155,9 @@ src/models/ConversationDepartment.ts
 src/models/ConversationDepartmentResponse.ts
 src/models/ConversationDepartmentsResponse.ts
 src/models/ConversationEngagement.ts
+src/models/ConversationEngagementEquation.ts
+src/models/ConversationEngagementEquationFunction.ts
+src/models/ConversationEngagementEquationGroup.ts
 src/models/ConversationEngagementResponse.ts
 src/models/ConversationEngagementsResponse.ts
 src/models/ConversationEventAddCoupon.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.99-RC
+## ultracart_rest_api_v2_typescript@4.0.100-RC
 
 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.99-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.100-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.100-RC | 12/20/2022 | conversation engagement update |
 | 4.0.99-RC | 12/15/2022 | conversation search - added start date filtering |
 | 4.0.98-RC | 12/15/2022 | conversation searching |
 | 4.0.97-RC | 12/13/2022 | conversations - add email and sms_phone to participant object |

package/dist/models/ConversationEngagement.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ConversationEngagementEquation } from './ConversationEngagementEquation';
 /**
  *
  * @export
@@ -41,10 +42,10 @@ export interface ConversationEngagement {
     engagement_name?: string;
     /**
      *
-     * @type {object}
+     * @type {ConversationEngagementEquation}
      * @memberof ConversationEngagement
      */
-    equation?: object;
+    equation?: ConversationEngagementEquation;
     /**
      *
      * @type {number}
@@ -52,12 +53,21 @@ export interface ConversationEngagement {
      */
     time_on_page?: number;
     /**
-     *
+     * The type of visitor
      * @type {string}
      * @memberof ConversationEngagement
      */
-    visitor_type?: string;
+    visitor_type?: ConversationEngagementVisitorTypeEnum;
 }
+/**
+ * @export
+ */
+export declare const ConversationEngagementVisitorTypeEnum: {
+    readonly All: "all";
+    readonly FirstTime: "first time";
+    readonly Returning: "returning";
+};
+export type ConversationEngagementVisitorTypeEnum = typeof ConversationEngagementVisitorTypeEnum[keyof typeof ConversationEngagementVisitorTypeEnum];
 export declare function ConversationEngagementFromJSON(json: any): ConversationEngagement;
 export declare function ConversationEngagementFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEngagement;
 export declare function ConversationEngagementToJSON(value?: ConversationEngagement | null): any;

package/dist/models/ConversationEngagement.js

@@ -13,8 +13,17 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationEngagementToJSON = exports.ConversationEngagementFromJSONTyped = exports.ConversationEngagementFromJSON = void 0;
+exports.ConversationEngagementToJSON = exports.ConversationEngagementFromJSONTyped = exports.ConversationEngagementFromJSON = exports.ConversationEngagementVisitorTypeEnum = void 0;
 var runtime_1 = require("../runtime");
+var ConversationEngagementEquation_1 = require("./ConversationEngagementEquation");
+/**
+ * @export
+ */
+exports.ConversationEngagementVisitorTypeEnum = {
+    All: 'all',
+    FirstTime: 'first time',
+    Returning: 'returning'
+};
 function ConversationEngagementFromJSON(json) {
     return ConversationEngagementFromJSONTyped(json, false);
 }
@@ -28,7 +37,7 @@ function ConversationEngagementFromJSONTyped(json, ignoreDiscriminator) {
         'customer_greeting': !(0, runtime_1.exists)(json, 'customer_greeting') ? undefined : json['customer_greeting'],
         'department_oids': !(0, runtime_1.exists)(json, 'department_oids') ? undefined : json['department_oids'],
         'engagement_name': !(0, runtime_1.exists)(json, 'engagement_name') ? undefined : json['engagement_name'],
-        'equation': !(0, runtime_1.exists)(json, 'equation') ? undefined : json['equation'],
+        'equation': !(0, runtime_1.exists)(json, 'equation') ? undefined : (0, ConversationEngagementEquation_1.ConversationEngagementEquationFromJSON)(json['equation']),
         'time_on_page': !(0, runtime_1.exists)(json, 'time_on_page') ? undefined : json['time_on_page'],
         'visitor_type': !(0, runtime_1.exists)(json, 'visitor_type') ? undefined : json['visitor_type'],
     };
@@ -46,7 +55,7 @@ function ConversationEngagementToJSON(value) {
         'customer_greeting': value.customer_greeting,
         'department_oids': value.department_oids,
         'engagement_name': value.engagement_name,
-        'equation': value.equation,
+        'equation': (0, ConversationEngagementEquation_1.ConversationEngagementEquationToJSON)(value.equation),
         'time_on_page': value.time_on_page,
         'visitor_type': value.visitor_type,
     };

package/dist/models/ConversationEngagementEquation.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { ConversationEngagementEquationGroup } from './ConversationEngagementEquationGroup';
+/**
+ *
+ * @export
+ * @interface ConversationEngagementEquation
+ */
+export interface ConversationEngagementEquation {
+    /**
+     *
+     * @type {Array<ConversationEngagementEquationGroup>}
+     * @memberof ConversationEngagementEquation
+     */
+    groups?: Array<ConversationEngagementEquationGroup>;
+}
+export declare function ConversationEngagementEquationFromJSON(json: any): ConversationEngagementEquation;
+export declare function ConversationEngagementEquationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEngagementEquation;
+export declare function ConversationEngagementEquationToJSON(value?: ConversationEngagementEquation | null): any;

package/dist/models/ConversationEngagementEquation.js

@@ -0,0 +1,43 @@
+"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.ConversationEngagementEquationToJSON = exports.ConversationEngagementEquationFromJSONTyped = exports.ConversationEngagementEquationFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ConversationEngagementEquationGroup_1 = require("./ConversationEngagementEquationGroup");
+function ConversationEngagementEquationFromJSON(json) {
+    return ConversationEngagementEquationFromJSONTyped(json, false);
+}
+exports.ConversationEngagementEquationFromJSON = ConversationEngagementEquationFromJSON;
+function ConversationEngagementEquationFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'groups': !(0, runtime_1.exists)(json, 'groups') ? undefined : (json['groups'].map(ConversationEngagementEquationGroup_1.ConversationEngagementEquationGroupFromJSON)),
+    };
+}
+exports.ConversationEngagementEquationFromJSONTyped = ConversationEngagementEquationFromJSONTyped;
+function ConversationEngagementEquationToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'groups': value.groups === undefined ? undefined : (value.groups.map(ConversationEngagementEquationGroup_1.ConversationEngagementEquationGroupToJSON)),
+    };
+}
+exports.ConversationEngagementEquationToJSON = ConversationEngagementEquationToJSON;

package/dist/models/ConversationEngagementEquationFunction.d.ts

@@ -0,0 +1,175 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ConversationEngagementEquationFunction
+ */
+export interface ConversationEngagementEquationFunction {
+    /**
+     * Logic operation to perform on an any page url function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    any_page_url_logic?: ConversationEngagementEquationFunctionAnyPageUrlLogicEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    any_page_url_value?: string;
+    /**
+     * Logic operation to perform on a current page url function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    current_page_url_logic?: ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    current_page_url_value?: string;
+    /**
+     * Logic operation to perform on a customer's browsing time function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_browsing_time_logic?: ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_browsing_time_seconds?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_location_country?: string;
+    /**
+     * Logic operation to perform on a customer's location function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_location_logic?: ConversationEngagementEquationFunctionCustomersLocationLogicEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_location_state?: string;
+    /**
+     * Logic operation to perform on a customer's browsing time function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    number_of_viewed_pages_logic?: ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    number_of_viewed_pages_value?: number;
+    /**
+     * Logic operation to perform on a referring website function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    referring_website_logic?: ConversationEngagementEquationFunctionReferringWebsiteLogicEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    referring_website_value?: string;
+    /**
+     * Type of function
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    type?: ConversationEngagementEquationFunctionTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const ConversationEngagementEquationFunctionAnyPageUrlLogicEnum: {
+    readonly Contains: "contains";
+    readonly DoesNotContain: "does not contain";
+    readonly IsExactly: "is exactly";
+    readonly IsNot: "is not";
+};
+export type ConversationEngagementEquationFunctionAnyPageUrlLogicEnum = typeof ConversationEngagementEquationFunctionAnyPageUrlLogicEnum[keyof typeof ConversationEngagementEquationFunctionAnyPageUrlLogicEnum];
+/**
+ * @export
+ */
+export declare const ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum: {
+    readonly Contains: "contains";
+    readonly DoesNotContain: "does not contain";
+    readonly IsExactly: "is exactly";
+    readonly IsNot: "is not";
+};
+export type ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum = typeof ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum[keyof typeof ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum];
+/**
+ * @export
+ */
+export declare const ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum: {
+    readonly AtLeast: "is at least";
+    readonly MoreThan: "is more than";
+    readonly LessThan: "is less than";
+    readonly AtMost: "is at most";
+};
+export type ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum = typeof ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum[keyof typeof ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum];
+/**
+ * @export
+ */
+export declare const ConversationEngagementEquationFunctionCustomersLocationLogicEnum: {
+    readonly Is: "is";
+    readonly IsNot: "is not";
+};
+export type ConversationEngagementEquationFunctionCustomersLocationLogicEnum = typeof ConversationEngagementEquationFunctionCustomersLocationLogicEnum[keyof typeof ConversationEngagementEquationFunctionCustomersLocationLogicEnum];
+/**
+ * @export
+ */
+export declare const ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum: {
+    readonly AtLeast: "is at least";
+    readonly MoreThan: "is more than";
+    readonly LessThan: "is less than";
+    readonly AtMost: "is at most";
+};
+export type ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum = typeof ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum[keyof typeof ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum];
+/**
+ * @export
+ */
+export declare const ConversationEngagementEquationFunctionReferringWebsiteLogicEnum: {
+    readonly Contains: "contains";
+    readonly DoesNotContain: "does not contain";
+    readonly IsExactly: "is exactly";
+    readonly IsNot: "is not";
+};
+export type ConversationEngagementEquationFunctionReferringWebsiteLogicEnum = typeof ConversationEngagementEquationFunctionReferringWebsiteLogicEnum[keyof typeof ConversationEngagementEquationFunctionReferringWebsiteLogicEnum];
+/**
+ * @export
+ */
+export declare const ConversationEngagementEquationFunctionTypeEnum: {
+    readonly CurrentPageUrl: "current page url";
+    readonly CustomersLocation: "customer's location";
+    readonly CustomersBrowsingTime: "customer's browsing time";
+    readonly NumberOfViewedPages: "number of viewed pages";
+    readonly ReferringWebsiteAddress: "referring website address";
+    readonly AnyPageFromSession: "any page from session";
+};
+export type ConversationEngagementEquationFunctionTypeEnum = typeof ConversationEngagementEquationFunctionTypeEnum[keyof typeof ConversationEngagementEquationFunctionTypeEnum];
+export declare function ConversationEngagementEquationFunctionFromJSON(json: any): ConversationEngagementEquationFunction;
+export declare function ConversationEngagementEquationFunctionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEngagementEquationFunction;
+export declare function ConversationEngagementEquationFunctionToJSON(value?: ConversationEngagementEquationFunction | null): any;

package/dist/models/ConversationEngagementEquationFunction.js

@@ -0,0 +1,131 @@
+"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.ConversationEngagementEquationFunctionToJSON = exports.ConversationEngagementEquationFunctionFromJSONTyped = exports.ConversationEngagementEquationFunctionFromJSON = exports.ConversationEngagementEquationFunctionTypeEnum = exports.ConversationEngagementEquationFunctionReferringWebsiteLogicEnum = exports.ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum = exports.ConversationEngagementEquationFunctionCustomersLocationLogicEnum = exports.ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum = exports.ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum = exports.ConversationEngagementEquationFunctionAnyPageUrlLogicEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.ConversationEngagementEquationFunctionAnyPageUrlLogicEnum = {
+    Contains: 'contains',
+    DoesNotContain: 'does not contain',
+    IsExactly: 'is exactly',
+    IsNot: 'is not'
+};
+/**
+ * @export
+ */
+exports.ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum = {
+    Contains: 'contains',
+    DoesNotContain: 'does not contain',
+    IsExactly: 'is exactly',
+    IsNot: 'is not'
+};
+/**
+ * @export
+ */
+exports.ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum = {
+    AtLeast: 'is at least',
+    MoreThan: 'is more than',
+    LessThan: 'is less than',
+    AtMost: 'is at most'
+};
+/**
+ * @export
+ */
+exports.ConversationEngagementEquationFunctionCustomersLocationLogicEnum = {
+    Is: 'is',
+    IsNot: 'is not'
+};
+/**
+ * @export
+ */
+exports.ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum = {
+    AtLeast: 'is at least',
+    MoreThan: 'is more than',
+    LessThan: 'is less than',
+    AtMost: 'is at most'
+};
+/**
+ * @export
+ */
+exports.ConversationEngagementEquationFunctionReferringWebsiteLogicEnum = {
+    Contains: 'contains',
+    DoesNotContain: 'does not contain',
+    IsExactly: 'is exactly',
+    IsNot: 'is not'
+};
+/**
+ * @export
+ */
+exports.ConversationEngagementEquationFunctionTypeEnum = {
+    CurrentPageUrl: 'current page url',
+    CustomersLocation: 'customer\'s location',
+    CustomersBrowsingTime: 'customer\'s browsing time',
+    NumberOfViewedPages: 'number of viewed pages',
+    ReferringWebsiteAddress: 'referring website address',
+    AnyPageFromSession: 'any page from session'
+};
+function ConversationEngagementEquationFunctionFromJSON(json) {
+    return ConversationEngagementEquationFunctionFromJSONTyped(json, false);
+}
+exports.ConversationEngagementEquationFunctionFromJSON = ConversationEngagementEquationFunctionFromJSON;
+function ConversationEngagementEquationFunctionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'any_page_url_logic': !(0, runtime_1.exists)(json, 'any_page_url_logic') ? undefined : json['any_page_url_logic'],
+        'any_page_url_value': !(0, runtime_1.exists)(json, 'any_page_url_value') ? undefined : json['any_page_url_value'],
+        'current_page_url_logic': !(0, runtime_1.exists)(json, 'current_page_url_logic') ? undefined : json['current_page_url_logic'],
+        'current_page_url_value': !(0, runtime_1.exists)(json, 'current_page_url_value') ? undefined : json['current_page_url_value'],
+        'customers_browsing_time_logic': !(0, runtime_1.exists)(json, 'customers_browsing_time_logic') ? undefined : json['customers_browsing_time_logic'],
+        'customers_browsing_time_seconds': !(0, runtime_1.exists)(json, 'customers_browsing_time_seconds') ? undefined : json['customers_browsing_time_seconds'],
+        'customers_location_country': !(0, runtime_1.exists)(json, 'customers_location_country') ? undefined : json['customers_location_country'],
+        'customers_location_logic': !(0, runtime_1.exists)(json, 'customers_location_logic') ? undefined : json['customers_location_logic'],
+        'customers_location_state': !(0, runtime_1.exists)(json, 'customers_location_state') ? undefined : json['customers_location_state'],
+        'number_of_viewed_pages_logic': !(0, runtime_1.exists)(json, 'number_of_viewed_pages_logic') ? undefined : json['number_of_viewed_pages_logic'],
+        'number_of_viewed_pages_value': !(0, runtime_1.exists)(json, 'number_of_viewed_pages_value') ? undefined : json['number_of_viewed_pages_value'],
+        'referring_website_logic': !(0, runtime_1.exists)(json, 'referring_website_logic') ? undefined : json['referring_website_logic'],
+        'referring_website_value': !(0, runtime_1.exists)(json, 'referring_website_value') ? undefined : json['referring_website_value'],
+        'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
+    };
+}
+exports.ConversationEngagementEquationFunctionFromJSONTyped = ConversationEngagementEquationFunctionFromJSONTyped;
+function ConversationEngagementEquationFunctionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'any_page_url_logic': value.any_page_url_logic,
+        'any_page_url_value': value.any_page_url_value,
+        'current_page_url_logic': value.current_page_url_logic,
+        'current_page_url_value': value.current_page_url_value,
+        'customers_browsing_time_logic': value.customers_browsing_time_logic,
+        'customers_browsing_time_seconds': value.customers_browsing_time_seconds,
+        'customers_location_country': value.customers_location_country,
+        'customers_location_logic': value.customers_location_logic,
+        'customers_location_state': value.customers_location_state,
+        'number_of_viewed_pages_logic': value.number_of_viewed_pages_logic,
+        'number_of_viewed_pages_value': value.number_of_viewed_pages_value,
+        'referring_website_logic': value.referring_website_logic,
+        'referring_website_value': value.referring_website_value,
+        'type': value.type,
+    };
+}
+exports.ConversationEngagementEquationFunctionToJSON = ConversationEngagementEquationFunctionToJSON;

package/dist/models/ConversationEngagementEquationGroup.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { ConversationEngagementEquationFunction } from './ConversationEngagementEquationFunction';
+/**
+ *
+ * @export
+ * @interface ConversationEngagementEquationGroup
+ */
+export interface ConversationEngagementEquationGroup {
+    /**
+     *
+     * @type {Array<ConversationEngagementEquationFunction>}
+     * @memberof ConversationEngagementEquationGroup
+     */
+    functions?: Array<ConversationEngagementEquationFunction>;
+}
+export declare function ConversationEngagementEquationGroupFromJSON(json: any): ConversationEngagementEquationGroup;
+export declare function ConversationEngagementEquationGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEngagementEquationGroup;
+export declare function ConversationEngagementEquationGroupToJSON(value?: ConversationEngagementEquationGroup | null): any;

package/dist/models/ConversationEngagementEquationGroup.js

@@ -0,0 +1,43 @@
+"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.ConversationEngagementEquationGroupToJSON = exports.ConversationEngagementEquationGroupFromJSONTyped = exports.ConversationEngagementEquationGroupFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ConversationEngagementEquationFunction_1 = require("./ConversationEngagementEquationFunction");
+function ConversationEngagementEquationGroupFromJSON(json) {
+    return ConversationEngagementEquationGroupFromJSONTyped(json, false);
+}
+exports.ConversationEngagementEquationGroupFromJSON = ConversationEngagementEquationGroupFromJSON;
+function ConversationEngagementEquationGroupFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'functions': !(0, runtime_1.exists)(json, 'functions') ? undefined : (json['functions'].map(ConversationEngagementEquationFunction_1.ConversationEngagementEquationFunctionFromJSON)),
+    };
+}
+exports.ConversationEngagementEquationGroupFromJSONTyped = ConversationEngagementEquationGroupFromJSONTyped;
+function ConversationEngagementEquationGroupToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'functions': value.functions === undefined ? undefined : (value.functions.map(ConversationEngagementEquationFunction_1.ConversationEngagementEquationFunctionToJSON)),
+    };
+}
+exports.ConversationEngagementEquationGroupToJSON = ConversationEngagementEquationGroupToJSON;

package/dist/models/index.d.ts

@@ -130,6 +130,9 @@ export * from './ConversationDepartment';
 export * from './ConversationDepartmentResponse';
 export * from './ConversationDepartmentsResponse';
 export * from './ConversationEngagement';
+export * from './ConversationEngagementEquation';
+export * from './ConversationEngagementEquationFunction';
+export * from './ConversationEngagementEquationGroup';
 export * from './ConversationEngagementResponse';
 export * from './ConversationEngagementsResponse';
 export * from './ConversationEventAddCoupon';

package/dist/models/index.js

@@ -148,6 +148,9 @@ __exportStar(require("./ConversationDepartment"), exports);
 __exportStar(require("./ConversationDepartmentResponse"), exports);
 __exportStar(require("./ConversationDepartmentsResponse"), exports);
 __exportStar(require("./ConversationEngagement"), exports);
+__exportStar(require("./ConversationEngagementEquation"), exports);
+__exportStar(require("./ConversationEngagementEquationFunction"), exports);
+__exportStar(require("./ConversationEngagementEquationGroup"), exports);
 __exportStar(require("./ConversationEngagementResponse"), exports);
 __exportStar(require("./ConversationEngagementsResponse"), exports);
 __exportStar(require("./ConversationEventAddCoupon"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.99-RC",
+  "version": "4.0.100-RC",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/models/ConversationEngagement.ts

@@ -13,6 +13,13 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import {
+    ConversationEngagementEquation,
+    ConversationEngagementEquationFromJSON,
+    ConversationEngagementEquationFromJSONTyped,
+    ConversationEngagementEquationToJSON,
+} from './ConversationEngagementEquation';
+
 /**
  * 
  * @export
@@ -45,10 +52,10 @@ export interface ConversationEngagement {
     engagement_name?: string;
     /**
      * 
-     * @type {object}
+     * @type {ConversationEngagementEquation}
      * @memberof ConversationEngagement
      */
-    equation?: object;
+    equation?: ConversationEngagementEquation;
     /**
      * 
      * @type {number}
@@ -56,13 +63,25 @@ export interface ConversationEngagement {
      */
     time_on_page?: number;
     /**
-     * 
+     * The type of visitor
      * @type {string}
      * @memberof ConversationEngagement
      */
-    visitor_type?: string;
+    visitor_type?: ConversationEngagementVisitorTypeEnum;
 }
 
+
+/**
+ * @export
+ */
+export const ConversationEngagementVisitorTypeEnum = {
+    All: 'all',
+    FirstTime: 'first time',
+    Returning: 'returning'
+} as const;
+export type ConversationEngagementVisitorTypeEnum = typeof ConversationEngagementVisitorTypeEnum[keyof typeof ConversationEngagementVisitorTypeEnum];
+
+
 export function ConversationEngagementFromJSON(json: any): ConversationEngagement {
     return ConversationEngagementFromJSONTyped(json, false);
 }
@@ -77,7 +96,7 @@ export function ConversationEngagementFromJSONTyped(json: any, ignoreDiscriminat
         'customer_greeting': !exists(json, 'customer_greeting') ? undefined : json['customer_greeting'],
         'department_oids': !exists(json, 'department_oids') ? undefined : json['department_oids'],
         'engagement_name': !exists(json, 'engagement_name') ? undefined : json['engagement_name'],
-        'equation': !exists(json, 'equation') ? undefined : json['equation'],
+        'equation': !exists(json, 'equation') ? undefined : ConversationEngagementEquationFromJSON(json['equation']),
         'time_on_page': !exists(json, 'time_on_page') ? undefined : json['time_on_page'],
         'visitor_type': !exists(json, 'visitor_type') ? undefined : json['visitor_type'],
     };
@@ -96,7 +115,7 @@ export function ConversationEngagementToJSON(value?: ConversationEngagement | nu
         'customer_greeting': value.customer_greeting,
         'department_oids': value.department_oids,
         'engagement_name': value.engagement_name,
-        'equation': value.equation,
+        'equation': ConversationEngagementEquationToJSON(value.equation),
         'time_on_page': value.time_on_page,
         'visitor_type': value.visitor_type,
     };

package/src/models/ConversationEngagementEquation.ts

@@ -0,0 +1,63 @@
+/* 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 {
+    ConversationEngagementEquationGroup,
+    ConversationEngagementEquationGroupFromJSON,
+    ConversationEngagementEquationGroupFromJSONTyped,
+    ConversationEngagementEquationGroupToJSON,
+} from './ConversationEngagementEquationGroup';
+
+/**
+ * 
+ * @export
+ * @interface ConversationEngagementEquation
+ */
+export interface ConversationEngagementEquation {
+    /**
+     * 
+     * @type {Array<ConversationEngagementEquationGroup>}
+     * @memberof ConversationEngagementEquation
+     */
+    groups?: Array<ConversationEngagementEquationGroup>;
+}
+
+export function ConversationEngagementEquationFromJSON(json: any): ConversationEngagementEquation {
+    return ConversationEngagementEquationFromJSONTyped(json, false);
+}
+
+export function ConversationEngagementEquationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEngagementEquation {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'groups': !exists(json, 'groups') ? undefined : ((json['groups'] as Array<any>).map(ConversationEngagementEquationGroupFromJSON)),
+    };
+}
+
+export function ConversationEngagementEquationToJSON(value?: ConversationEngagementEquation | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'groups': value.groups === undefined ? undefined : ((value.groups as Array<any>).map(ConversationEngagementEquationGroupToJSON)),
+    };
+}
+

package/src/models/ConversationEngagementEquationFunction.ts

@@ -0,0 +1,239 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface ConversationEngagementEquationFunction
+ */
+export interface ConversationEngagementEquationFunction {
+    /**
+     * Logic operation to perform on an any page url function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    any_page_url_logic?: ConversationEngagementEquationFunctionAnyPageUrlLogicEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    any_page_url_value?: string;
+    /**
+     * Logic operation to perform on a current page url function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    current_page_url_logic?: ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    current_page_url_value?: string;
+    /**
+     * Logic operation to perform on a customer's browsing time function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_browsing_time_logic?: ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_browsing_time_seconds?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_location_country?: string;
+    /**
+     * Logic operation to perform on a customer's location function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_location_logic?: ConversationEngagementEquationFunctionCustomersLocationLogicEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    customers_location_state?: string;
+    /**
+     * Logic operation to perform on a customer's browsing time function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    number_of_viewed_pages_logic?: ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    number_of_viewed_pages_value?: number;
+    /**
+     * Logic operation to perform on a referring website function type
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    referring_website_logic?: ConversationEngagementEquationFunctionReferringWebsiteLogicEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    referring_website_value?: string;
+    /**
+     * Type of function
+     * @type {string}
+     * @memberof ConversationEngagementEquationFunction
+     */
+    type?: ConversationEngagementEquationFunctionTypeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ConversationEngagementEquationFunctionAnyPageUrlLogicEnum = {
+    Contains: 'contains',
+    DoesNotContain: 'does not contain',
+    IsExactly: 'is exactly',
+    IsNot: 'is not'
+} as const;
+export type ConversationEngagementEquationFunctionAnyPageUrlLogicEnum = typeof ConversationEngagementEquationFunctionAnyPageUrlLogicEnum[keyof typeof ConversationEngagementEquationFunctionAnyPageUrlLogicEnum];
+
+/**
+ * @export
+ */
+export const ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum = {
+    Contains: 'contains',
+    DoesNotContain: 'does not contain',
+    IsExactly: 'is exactly',
+    IsNot: 'is not'
+} as const;
+export type ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum = typeof ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum[keyof typeof ConversationEngagementEquationFunctionCurrentPageUrlLogicEnum];
+
+/**
+ * @export
+ */
+export const ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum = {
+    AtLeast: 'is at least',
+    MoreThan: 'is more than',
+    LessThan: 'is less than',
+    AtMost: 'is at most'
+} as const;
+export type ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum = typeof ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum[keyof typeof ConversationEngagementEquationFunctionCustomersBrowsingTimeLogicEnum];
+
+/**
+ * @export
+ */
+export const ConversationEngagementEquationFunctionCustomersLocationLogicEnum = {
+    Is: 'is',
+    IsNot: 'is not'
+} as const;
+export type ConversationEngagementEquationFunctionCustomersLocationLogicEnum = typeof ConversationEngagementEquationFunctionCustomersLocationLogicEnum[keyof typeof ConversationEngagementEquationFunctionCustomersLocationLogicEnum];
+
+/**
+ * @export
+ */
+export const ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum = {
+    AtLeast: 'is at least',
+    MoreThan: 'is more than',
+    LessThan: 'is less than',
+    AtMost: 'is at most'
+} as const;
+export type ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum = typeof ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum[keyof typeof ConversationEngagementEquationFunctionNumberOfViewedPagesLogicEnum];
+
+/**
+ * @export
+ */
+export const ConversationEngagementEquationFunctionReferringWebsiteLogicEnum = {
+    Contains: 'contains',
+    DoesNotContain: 'does not contain',
+    IsExactly: 'is exactly',
+    IsNot: 'is not'
+} as const;
+export type ConversationEngagementEquationFunctionReferringWebsiteLogicEnum = typeof ConversationEngagementEquationFunctionReferringWebsiteLogicEnum[keyof typeof ConversationEngagementEquationFunctionReferringWebsiteLogicEnum];
+
+/**
+ * @export
+ */
+export const ConversationEngagementEquationFunctionTypeEnum = {
+    CurrentPageUrl: 'current page url',
+    CustomersLocation: 'customer\'s location',
+    CustomersBrowsingTime: 'customer\'s browsing time',
+    NumberOfViewedPages: 'number of viewed pages',
+    ReferringWebsiteAddress: 'referring website address',
+    AnyPageFromSession: 'any page from session'
+} as const;
+export type ConversationEngagementEquationFunctionTypeEnum = typeof ConversationEngagementEquationFunctionTypeEnum[keyof typeof ConversationEngagementEquationFunctionTypeEnum];
+
+
+export function ConversationEngagementEquationFunctionFromJSON(json: any): ConversationEngagementEquationFunction {
+    return ConversationEngagementEquationFunctionFromJSONTyped(json, false);
+}
+
+export function ConversationEngagementEquationFunctionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEngagementEquationFunction {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'any_page_url_logic': !exists(json, 'any_page_url_logic') ? undefined : json['any_page_url_logic'],
+        'any_page_url_value': !exists(json, 'any_page_url_value') ? undefined : json['any_page_url_value'],
+        'current_page_url_logic': !exists(json, 'current_page_url_logic') ? undefined : json['current_page_url_logic'],
+        'current_page_url_value': !exists(json, 'current_page_url_value') ? undefined : json['current_page_url_value'],
+        'customers_browsing_time_logic': !exists(json, 'customers_browsing_time_logic') ? undefined : json['customers_browsing_time_logic'],
+        'customers_browsing_time_seconds': !exists(json, 'customers_browsing_time_seconds') ? undefined : json['customers_browsing_time_seconds'],
+        'customers_location_country': !exists(json, 'customers_location_country') ? undefined : json['customers_location_country'],
+        'customers_location_logic': !exists(json, 'customers_location_logic') ? undefined : json['customers_location_logic'],
+        'customers_location_state': !exists(json, 'customers_location_state') ? undefined : json['customers_location_state'],
+        'number_of_viewed_pages_logic': !exists(json, 'number_of_viewed_pages_logic') ? undefined : json['number_of_viewed_pages_logic'],
+        'number_of_viewed_pages_value': !exists(json, 'number_of_viewed_pages_value') ? undefined : json['number_of_viewed_pages_value'],
+        'referring_website_logic': !exists(json, 'referring_website_logic') ? undefined : json['referring_website_logic'],
+        'referring_website_value': !exists(json, 'referring_website_value') ? undefined : json['referring_website_value'],
+        'type': !exists(json, 'type') ? undefined : json['type'],
+    };
+}
+
+export function ConversationEngagementEquationFunctionToJSON(value?: ConversationEngagementEquationFunction | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'any_page_url_logic': value.any_page_url_logic,
+        'any_page_url_value': value.any_page_url_value,
+        'current_page_url_logic': value.current_page_url_logic,
+        'current_page_url_value': value.current_page_url_value,
+        'customers_browsing_time_logic': value.customers_browsing_time_logic,
+        'customers_browsing_time_seconds': value.customers_browsing_time_seconds,
+        'customers_location_country': value.customers_location_country,
+        'customers_location_logic': value.customers_location_logic,
+        'customers_location_state': value.customers_location_state,
+        'number_of_viewed_pages_logic': value.number_of_viewed_pages_logic,
+        'number_of_viewed_pages_value': value.number_of_viewed_pages_value,
+        'referring_website_logic': value.referring_website_logic,
+        'referring_website_value': value.referring_website_value,
+        'type': value.type,
+    };
+}
+

package/src/models/ConversationEngagementEquationGroup.ts

@@ -0,0 +1,63 @@
+/* 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 {
+    ConversationEngagementEquationFunction,
+    ConversationEngagementEquationFunctionFromJSON,
+    ConversationEngagementEquationFunctionFromJSONTyped,
+    ConversationEngagementEquationFunctionToJSON,
+} from './ConversationEngagementEquationFunction';
+
+/**
+ * 
+ * @export
+ * @interface ConversationEngagementEquationGroup
+ */
+export interface ConversationEngagementEquationGroup {
+    /**
+     * 
+     * @type {Array<ConversationEngagementEquationFunction>}
+     * @memberof ConversationEngagementEquationGroup
+     */
+    functions?: Array<ConversationEngagementEquationFunction>;
+}
+
+export function ConversationEngagementEquationGroupFromJSON(json: any): ConversationEngagementEquationGroup {
+    return ConversationEngagementEquationGroupFromJSONTyped(json, false);
+}
+
+export function ConversationEngagementEquationGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEngagementEquationGroup {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'functions': !exists(json, 'functions') ? undefined : ((json['functions'] as Array<any>).map(ConversationEngagementEquationFunctionFromJSON)),
+    };
+}
+
+export function ConversationEngagementEquationGroupToJSON(value?: ConversationEngagementEquationGroup | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'functions': value.functions === undefined ? undefined : ((value.functions as Array<any>).map(ConversationEngagementEquationFunctionToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -132,6 +132,9 @@ export * from './ConversationDepartment';
 export * from './ConversationDepartmentResponse';
 export * from './ConversationDepartmentsResponse';
 export * from './ConversationEngagement';
+export * from './ConversationEngagementEquation';
+export * from './ConversationEngagementEquationFunction';
+export * from './ConversationEngagementEquationGroup';
 export * from './ConversationEngagementResponse';
 export * from './ConversationEngagementsResponse';
 export * from './ConversationEventAddCoupon';