ultracart_rest_api_v2_typescript 4.0.136 → 4.0.138

package/.openapi-generator/FILES

@@ -192,6 +192,7 @@ src/models/ConversationPermissionsResponse.ts
 src/models/ConversationResponse.ts
 src/models/ConversationSearchRequest.ts
 src/models/ConversationSearchResponse.ts
+src/models/ConversationSentiment.ts
 src/models/ConversationStartRequest.ts
 src/models/ConversationStartResponse.ts
 src/models/ConversationSummary.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.136
+## ultracart_rest_api_v2_typescript@4.0.138
 
 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.136 --save
+npm install ultracart_rest_api_v2_typescript@4.0.138 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.138 | 03/01/2023 | convo - add sentiment record to conversation obj |
+| 4.0.137 | 02/22/2023 | convo - customer initiated flag on engagement |
 | 4.0.136 | 02/20/2023 | refund reasons |
 | 4.0.135 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
 | 4.0.134 | 02/15/2023 | added auto order sorting by next_shipment_dts |

package/dist/models/Conversation.d.ts

@@ -11,6 +11,7 @@
  */
 import { ConversationMessage } from './ConversationMessage';
 import { ConversationParticipant } from './ConversationParticipant';
+import { ConversationSentiment } from './ConversationSentiment';
 /**
  *
  * @export
@@ -107,6 +108,12 @@ export interface Conversation {
      * @memberof Conversation
      */
     participants?: Array<ConversationParticipant>;
+    /**
+     *
+     * @type {ConversationSentiment}
+     * @memberof Conversation
+     */
+    sentiment?: ConversationSentiment;
     /**
      * Start of the conversation date/time
      * @type {string}

package/dist/models/Conversation.js

@@ -17,6 +17,7 @@ exports.ConversationToJSON = exports.ConversationFromJSONTyped = exports.Convers
 var runtime_1 = require("../runtime");
 var ConversationMessage_1 = require("./ConversationMessage");
 var ConversationParticipant_1 = require("./ConversationParticipant");
+var ConversationSentiment_1 = require("./ConversationSentiment");
 /**
  * @export
  */
@@ -48,6 +49,7 @@ function ConversationFromJSONTyped(json, ignoreDiscriminator) {
         'message_count': !(0, runtime_1.exists)(json, 'message_count') ? undefined : json['message_count'],
         'messages': !(0, runtime_1.exists)(json, 'messages') ? undefined : (json['messages'].map(ConversationMessage_1.ConversationMessageFromJSON)),
         'participants': !(0, runtime_1.exists)(json, 'participants') ? undefined : (json['participants'].map(ConversationParticipant_1.ConversationParticipantFromJSON)),
+        'sentiment': !(0, runtime_1.exists)(json, 'sentiment') ? undefined : (0, ConversationSentiment_1.ConversationSentimentFromJSON)(json['sentiment']),
         'start_dts': !(0, runtime_1.exists)(json, 'start_dts') ? undefined : json['start_dts'],
         'unread_messages': !(0, runtime_1.exists)(json, 'unread_messages') ? undefined : json['unread_messages'],
         'visible': !(0, runtime_1.exists)(json, 'visible') ? undefined : json['visible'],
@@ -77,6 +79,7 @@ function ConversationToJSON(value) {
         'message_count': value.message_count,
         'messages': value.messages === undefined ? undefined : (value.messages.map(ConversationMessage_1.ConversationMessageToJSON)),
         'participants': value.participants === undefined ? undefined : (value.participants.map(ConversationParticipant_1.ConversationParticipantToJSON)),
+        'sentiment': (0, ConversationSentiment_1.ConversationSentimentToJSON)(value.sentiment),
         'start_dts': value.start_dts,
         'unread_messages': value.unread_messages,
         'visible': value.visible,

package/dist/models/ConversationEngagement.d.ts

@@ -34,6 +34,12 @@ export interface ConversationEngagement {
      * @memberof ConversationEngagement
      */
     customer_greeting?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ConversationEngagement
+     */
+    customer_initiated?: boolean;
     /**
      *
      * @type {Array<number>}

package/dist/models/ConversationEngagement.js

@@ -36,6 +36,7 @@ function ConversationEngagementFromJSONTyped(json, ignoreDiscriminator) {
         'active': !(0, runtime_1.exists)(json, 'active') ? undefined : json['active'],
         'conversation_engagement_oid': !(0, runtime_1.exists)(json, 'conversation_engagement_oid') ? undefined : json['conversation_engagement_oid'],
         'customer_greeting': !(0, runtime_1.exists)(json, 'customer_greeting') ? undefined : json['customer_greeting'],
+        'customer_initiated': !(0, runtime_1.exists)(json, 'customer_initiated') ? undefined : json['customer_initiated'],
         '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 : (0, ConversationEngagementEquation_1.ConversationEngagementEquationFromJSON)(json['equation']),
@@ -55,6 +56,7 @@ function ConversationEngagementToJSON(value) {
         'active': value.active,
         'conversation_engagement_oid': value.conversation_engagement_oid,
         'customer_greeting': value.customer_greeting,
+        'customer_initiated': value.customer_initiated,
         'department_oids': value.department_oids,
         'engagement_name': value.engagement_name,
         'equation': (0, ConversationEngagementEquation_1.ConversationEngagementEquationToJSON)(value.equation),

package/dist/models/ConversationSentiment.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 ConversationSentiment
+ */
+export interface ConversationSentiment {
+    /**
+     * The last time the detect sentiment was run on this conversation
+     * @type {string}
+     * @memberof ConversationSentiment
+     */
+    last_detect_sentiment?: string;
+    /**
+     * The mixed score
+     * @type {number}
+     * @memberof ConversationSentiment
+     */
+    mixed?: number;
+    /**
+     * The negative score
+     * @type {number}
+     * @memberof ConversationSentiment
+     */
+    negative?: number;
+    /**
+     * The neutral score
+     * @type {number}
+     * @memberof ConversationSentiment
+     */
+    neutral?: number;
+    /**
+     * The positive score
+     * @type {number}
+     * @memberof ConversationSentiment
+     */
+    positive?: number;
+    /**
+     * The overall sentiment
+     * @type {string}
+     * @memberof ConversationSentiment
+     */
+    sentiment?: ConversationSentimentSentimentEnum;
+}
+/**
+ * @export
+ */
+export declare const ConversationSentimentSentimentEnum: {
+    readonly Positive: "POSITIVE";
+    readonly Neutral: "NEUTRAL";
+    readonly Negative: "NEGATIVE";
+    readonly Mixed: "MIXED";
+};
+export type ConversationSentimentSentimentEnum = typeof ConversationSentimentSentimentEnum[keyof typeof ConversationSentimentSentimentEnum];
+export declare function ConversationSentimentFromJSON(json: any): ConversationSentiment;
+export declare function ConversationSentimentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationSentiment;
+export declare function ConversationSentimentToJSON(value?: ConversationSentiment | null): any;

package/dist/models/ConversationSentiment.js

@@ -0,0 +1,61 @@
+"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.ConversationSentimentToJSON = exports.ConversationSentimentFromJSONTyped = exports.ConversationSentimentFromJSON = exports.ConversationSentimentSentimentEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.ConversationSentimentSentimentEnum = {
+    Positive: 'POSITIVE',
+    Neutral: 'NEUTRAL',
+    Negative: 'NEGATIVE',
+    Mixed: 'MIXED'
+};
+function ConversationSentimentFromJSON(json) {
+    return ConversationSentimentFromJSONTyped(json, false);
+}
+exports.ConversationSentimentFromJSON = ConversationSentimentFromJSON;
+function ConversationSentimentFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'last_detect_sentiment': !(0, runtime_1.exists)(json, 'last_detect_sentiment') ? undefined : json['last_detect_sentiment'],
+        'mixed': !(0, runtime_1.exists)(json, 'mixed') ? undefined : json['mixed'],
+        'negative': !(0, runtime_1.exists)(json, 'negative') ? undefined : json['negative'],
+        'neutral': !(0, runtime_1.exists)(json, 'neutral') ? undefined : json['neutral'],
+        'positive': !(0, runtime_1.exists)(json, 'positive') ? undefined : json['positive'],
+        'sentiment': !(0, runtime_1.exists)(json, 'sentiment') ? undefined : json['sentiment'],
+    };
+}
+exports.ConversationSentimentFromJSONTyped = ConversationSentimentFromJSONTyped;
+function ConversationSentimentToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'last_detect_sentiment': value.last_detect_sentiment,
+        'mixed': value.mixed,
+        'negative': value.negative,
+        'neutral': value.neutral,
+        'positive': value.positive,
+        'sentiment': value.sentiment,
+    };
+}
+exports.ConversationSentimentToJSON = ConversationSentimentToJSON;

package/dist/models/ConversationSummary.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { ConversationParticipant } from './ConversationParticipant';
+import { ConversationSentiment } from './ConversationSentiment';
 /**
  *
  * @export
@@ -94,6 +95,12 @@ export interface ConversationSummary {
      * @memberof ConversationSummary
      */
     participants?: Array<ConversationParticipant>;
+    /**
+     *
+     * @type {ConversationSentiment}
+     * @memberof ConversationSummary
+     */
+    sentiment?: ConversationSentiment;
     /**
      * Start of the conversation date/time
      * @type {string}

package/dist/models/ConversationSummary.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationSummaryToJSON = exports.ConversationSummaryFromJSONTyped = exports.ConversationSummaryFromJSON = exports.ConversationSummaryMediumEnum = void 0;
 var runtime_1 = require("../runtime");
 var ConversationParticipant_1 = require("./ConversationParticipant");
+var ConversationSentiment_1 = require("./ConversationSentiment");
 /**
  * @export
  */
@@ -45,6 +46,7 @@ function ConversationSummaryFromJSONTyped(json, ignoreDiscriminator) {
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
         'message_count': !(0, runtime_1.exists)(json, 'message_count') ? undefined : json['message_count'],
         'participants': !(0, runtime_1.exists)(json, 'participants') ? undefined : (json['participants'].map(ConversationParticipant_1.ConversationParticipantFromJSON)),
+        'sentiment': !(0, runtime_1.exists)(json, 'sentiment') ? undefined : (0, ConversationSentiment_1.ConversationSentimentFromJSON)(json['sentiment']),
         'start_dts': !(0, runtime_1.exists)(json, 'start_dts') ? undefined : json['start_dts'],
         'unread_messages': !(0, runtime_1.exists)(json, 'unread_messages') ? undefined : json['unread_messages'],
         'visible': !(0, runtime_1.exists)(json, 'visible') ? undefined : json['visible'],
@@ -72,6 +74,7 @@ function ConversationSummaryToJSON(value) {
         'merchant_id': value.merchant_id,
         'message_count': value.message_count,
         'participants': value.participants === undefined ? undefined : (value.participants.map(ConversationParticipant_1.ConversationParticipantToJSON)),
+        'sentiment': (0, ConversationSentiment_1.ConversationSentimentToJSON)(value.sentiment),
         'start_dts': value.start_dts,
         'unread_messages': value.unread_messages,
         'visible': value.visible,

package/dist/models/index.d.ts

@@ -167,6 +167,7 @@ export * from './ConversationPermissionsResponse';
 export * from './ConversationResponse';
 export * from './ConversationSearchRequest';
 export * from './ConversationSearchResponse';
+export * from './ConversationSentiment';
 export * from './ConversationStartRequest';
 export * from './ConversationStartResponse';
 export * from './ConversationSummary';

package/dist/models/index.js

@@ -185,6 +185,7 @@ __exportStar(require("./ConversationPermissionsResponse"), exports);
 __exportStar(require("./ConversationResponse"), exports);
 __exportStar(require("./ConversationSearchRequest"), exports);
 __exportStar(require("./ConversationSearchResponse"), exports);
+__exportStar(require("./ConversationSentiment"), exports);
 __exportStar(require("./ConversationStartRequest"), exports);
 __exportStar(require("./ConversationStartResponse"), exports);
 __exportStar(require("./ConversationSummary"), exports);

package/package.json

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

package/src/models/Conversation.ts

@@ -25,6 +25,12 @@ import {
     ConversationParticipantFromJSONTyped,
     ConversationParticipantToJSON,
 } from './ConversationParticipant';
+import {
+    ConversationSentiment,
+    ConversationSentimentFromJSON,
+    ConversationSentimentFromJSONTyped,
+    ConversationSentimentToJSON,
+} from './ConversationSentiment';
 
 /**
  * 
@@ -122,6 +128,12 @@ export interface Conversation {
      * @memberof Conversation
      */
     participants?: Array<ConversationParticipant>;
+    /**
+     * 
+     * @type {ConversationSentiment}
+     * @memberof Conversation
+     */
+    sentiment?: ConversationSentiment;
     /**
      * Start of the conversation date/time
      * @type {string}
@@ -178,6 +190,7 @@ export function ConversationFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'message_count': !exists(json, 'message_count') ? undefined : json['message_count'],
         'messages': !exists(json, 'messages') ? undefined : ((json['messages'] as Array<any>).map(ConversationMessageFromJSON)),
         'participants': !exists(json, 'participants') ? undefined : ((json['participants'] as Array<any>).map(ConversationParticipantFromJSON)),
+        'sentiment': !exists(json, 'sentiment') ? undefined : ConversationSentimentFromJSON(json['sentiment']),
         'start_dts': !exists(json, 'start_dts') ? undefined : json['start_dts'],
         'unread_messages': !exists(json, 'unread_messages') ? undefined : json['unread_messages'],
         'visible': !exists(json, 'visible') ? undefined : json['visible'],
@@ -208,6 +221,7 @@ export function ConversationToJSON(value?: Conversation | null): any {
         'message_count': value.message_count,
         'messages': value.messages === undefined ? undefined : ((value.messages as Array<any>).map(ConversationMessageToJSON)),
         'participants': value.participants === undefined ? undefined : ((value.participants as Array<any>).map(ConversationParticipantToJSON)),
+        'sentiment': ConversationSentimentToJSON(value.sentiment),
         'start_dts': value.start_dts,
         'unread_messages': value.unread_messages,
         'visible': value.visible,

package/src/models/ConversationEngagement.ts

@@ -44,6 +44,12 @@ export interface ConversationEngagement {
      * @memberof ConversationEngagement
      */
     customer_greeting?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ConversationEngagement
+     */
+    customer_initiated?: boolean;
     /**
      * 
      * @type {Array<number>}
@@ -101,6 +107,7 @@ export function ConversationEngagementFromJSONTyped(json: any, ignoreDiscriminat
         'active': !exists(json, 'active') ? undefined : json['active'],
         'conversation_engagement_oid': !exists(json, 'conversation_engagement_oid') ? undefined : json['conversation_engagement_oid'],
         'customer_greeting': !exists(json, 'customer_greeting') ? undefined : json['customer_greeting'],
+        'customer_initiated': !exists(json, 'customer_initiated') ? undefined : json['customer_initiated'],
         '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 : ConversationEngagementEquationFromJSON(json['equation']),
@@ -121,6 +128,7 @@ export function ConversationEngagementToJSON(value?: ConversationEngagement | nu
         'active': value.active,
         'conversation_engagement_oid': value.conversation_engagement_oid,
         'customer_greeting': value.customer_greeting,
+        'customer_initiated': value.customer_initiated,
         'department_oids': value.department_oids,
         'engagement_name': value.engagement_name,
         'equation': ConversationEngagementEquationToJSON(value.equation),

package/src/models/ConversationSentiment.ts

@@ -0,0 +1,109 @@
+/* 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 ConversationSentiment
+ */
+export interface ConversationSentiment {
+    /**
+     * The last time the detect sentiment was run on this conversation
+     * @type {string}
+     * @memberof ConversationSentiment
+     */
+    last_detect_sentiment?: string;
+    /**
+     * The mixed score
+     * @type {number}
+     * @memberof ConversationSentiment
+     */
+    mixed?: number;
+    /**
+     * The negative score
+     * @type {number}
+     * @memberof ConversationSentiment
+     */
+    negative?: number;
+    /**
+     * The neutral score
+     * @type {number}
+     * @memberof ConversationSentiment
+     */
+    neutral?: number;
+    /**
+     * The positive score
+     * @type {number}
+     * @memberof ConversationSentiment
+     */
+    positive?: number;
+    /**
+     * The overall sentiment
+     * @type {string}
+     * @memberof ConversationSentiment
+     */
+    sentiment?: ConversationSentimentSentimentEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ConversationSentimentSentimentEnum = {
+    Positive: 'POSITIVE',
+    Neutral: 'NEUTRAL',
+    Negative: 'NEGATIVE',
+    Mixed: 'MIXED'
+} as const;
+export type ConversationSentimentSentimentEnum = typeof ConversationSentimentSentimentEnum[keyof typeof ConversationSentimentSentimentEnum];
+
+
+export function ConversationSentimentFromJSON(json: any): ConversationSentiment {
+    return ConversationSentimentFromJSONTyped(json, false);
+}
+
+export function ConversationSentimentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationSentiment {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'last_detect_sentiment': !exists(json, 'last_detect_sentiment') ? undefined : json['last_detect_sentiment'],
+        'mixed': !exists(json, 'mixed') ? undefined : json['mixed'],
+        'negative': !exists(json, 'negative') ? undefined : json['negative'],
+        'neutral': !exists(json, 'neutral') ? undefined : json['neutral'],
+        'positive': !exists(json, 'positive') ? undefined : json['positive'],
+        'sentiment': !exists(json, 'sentiment') ? undefined : json['sentiment'],
+    };
+}
+
+export function ConversationSentimentToJSON(value?: ConversationSentiment | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'last_detect_sentiment': value.last_detect_sentiment,
+        'mixed': value.mixed,
+        'negative': value.negative,
+        'neutral': value.neutral,
+        'positive': value.positive,
+        'sentiment': value.sentiment,
+    };
+}
+

package/src/models/ConversationSummary.ts

@@ -19,6 +19,12 @@ import {
     ConversationParticipantFromJSONTyped,
     ConversationParticipantToJSON,
 } from './ConversationParticipant';
+import {
+    ConversationSentiment,
+    ConversationSentimentFromJSON,
+    ConversationSentimentFromJSONTyped,
+    ConversationSentimentToJSON,
+} from './ConversationSentiment';
 
 /**
  * 
@@ -104,6 +110,12 @@ export interface ConversationSummary {
      * @memberof ConversationSummary
      */
     participants?: Array<ConversationParticipant>;
+    /**
+     * 
+     * @type {ConversationSentiment}
+     * @memberof ConversationSummary
+     */
+    sentiment?: ConversationSentiment;
     /**
      * Start of the conversation date/time
      * @type {string}
@@ -158,6 +170,7 @@ export function ConversationSummaryFromJSONTyped(json: any, ignoreDiscriminator:
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
         'message_count': !exists(json, 'message_count') ? undefined : json['message_count'],
         'participants': !exists(json, 'participants') ? undefined : ((json['participants'] as Array<any>).map(ConversationParticipantFromJSON)),
+        'sentiment': !exists(json, 'sentiment') ? undefined : ConversationSentimentFromJSON(json['sentiment']),
         'start_dts': !exists(json, 'start_dts') ? undefined : json['start_dts'],
         'unread_messages': !exists(json, 'unread_messages') ? undefined : json['unread_messages'],
         'visible': !exists(json, 'visible') ? undefined : json['visible'],
@@ -186,6 +199,7 @@ export function ConversationSummaryToJSON(value?: ConversationSummary | null): a
         'merchant_id': value.merchant_id,
         'message_count': value.message_count,
         'participants': value.participants === undefined ? undefined : ((value.participants as Array<any>).map(ConversationParticipantToJSON)),
+        'sentiment': ConversationSentimentToJSON(value.sentiment),
         'start_dts': value.start_dts,
         'unread_messages': value.unread_messages,
         'visible': value.visible,

package/src/models/index.ts

@@ -169,6 +169,7 @@ export * from './ConversationPermissionsResponse';
 export * from './ConversationResponse';
 export * from './ConversationSearchRequest';
 export * from './ConversationSearchResponse';
+export * from './ConversationSentiment';
 export * from './ConversationStartRequest';
 export * from './ConversationStartResponse';
 export * from './ConversationSummary';