stentor-models 1.58.33 → 1.58.43

package/lib/App/AppStatus.d.ts

@@ -11,6 +11,8 @@ export type AppStatusInCertification = "In Certification";
 export declare const APP_STATUS_IN_CERTIFICATION: AppStatusInCertification;
 export type AppStatusRequiresPublish = "Needs publish";
 export declare const APP_STATUS_REQUIRES_PUBLISH: AppStatusRequiresPublish;
+export type AppStatusReadyForInstall = "Ready for Install";
+export declare const APP_STATUS_READY_FOR_INSTALL: AppStatusReadyForInstall;
 export type AppStatusLive = "Live";
 export declare const APP_STATUS_LIVE: AppStatusLive;
 export type AppStatusRequiresAttention = "Requires Attention";

package/lib/App/AppStatus.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.APP_STATUS_LIVE_AND_REQUIRES_ATTENTION = exports.APP_STATUS_LIVE_AND_REQUIRES_PUBLISH = exports.APP_STATUS_LIVE_AND_IN_CERT = exports.APP_STATUS_LIVE_AND_REQUIRES_CERT = exports.APP_STATUS_CANCELLED = exports.APP_STATUS_ARCHIVED = exports.APP_STATUS_REQUIRES_ATTENTION = exports.APP_STATUS_LIVE = exports.APP_STATUS_REQUIRES_PUBLISH = exports.APP_STATUS_IN_CERTIFICATION = exports.APP_STATUS_UNDER_REVIEW = exports.APP_STATUS_SUBMITTED_FOR_REVIEW = exports.APP_STATUS_INCOMPLETE = exports.APP_STATUS_UNKNOWN = void 0;
+exports.APP_STATUS_LIVE_AND_REQUIRES_ATTENTION = exports.APP_STATUS_LIVE_AND_REQUIRES_PUBLISH = exports.APP_STATUS_LIVE_AND_IN_CERT = exports.APP_STATUS_LIVE_AND_REQUIRES_CERT = exports.APP_STATUS_CANCELLED = exports.APP_STATUS_ARCHIVED = exports.APP_STATUS_REQUIRES_ATTENTION = exports.APP_STATUS_LIVE = exports.APP_STATUS_READY_FOR_INSTALL = exports.APP_STATUS_REQUIRES_PUBLISH = exports.APP_STATUS_IN_CERTIFICATION = exports.APP_STATUS_UNDER_REVIEW = exports.APP_STATUS_SUBMITTED_FOR_REVIEW = exports.APP_STATUS_INCOMPLETE = exports.APP_STATUS_UNKNOWN = void 0;
 exports.APP_STATUS_UNKNOWN = "Unknown";
 exports.APP_STATUS_INCOMPLETE = "Incomplete";
 exports.APP_STATUS_SUBMITTED_FOR_REVIEW = "Submitted For Review";
 exports.APP_STATUS_UNDER_REVIEW = "Under Review";
 exports.APP_STATUS_IN_CERTIFICATION = "In Certification";
 exports.APP_STATUS_REQUIRES_PUBLISH = "Needs publish";
+exports.APP_STATUS_READY_FOR_INSTALL = "Ready for Install";
 exports.APP_STATUS_LIVE = "Live";
 exports.APP_STATUS_REQUIRES_ATTENTION = "Requires Attention";
 exports.APP_STATUS_ARCHIVED = "Archived";

package/lib/App/AppStatus.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppStatus.js","sourceRoot":"","sources":["../../src/App/AppStatus.ts"],"names":[],"mappings":";;;AAGa,QAAA,kBAAkB,GAAqB,SAAS,CAAC;AAGjD,QAAA,qBAAqB,GAAwB,YAAY,CAAC;AAG1D,QAAA,+BAA+B,GAAgC,sBAAsB,CAAC;AAGtF,QAAA,uBAAuB,GAAyB,cAAc,CAAC;AAG/D,QAAA,2BAA2B,GAA6B,kBAAkB,CAAC;AAG3E,QAAA,2BAA2B,GAA6B,eAAe,CAAC;AAGxE,QAAA,eAAe,GAAkB,MAAM,CAAC;AAGxC,QAAA,6BAA6B,GAA+B,oBAAoB,CAAC;AAGjF,QAAA,mBAAmB,GAAsB,UAAU,CAAC;AAGpD,QAAA,oBAAoB,GAAuB,WAAW,CAAC;AAGvD,QAAA,iCAAiC,GAA8B,qBAAqB,CAAC;AAGrF,QAAA,2BAA2B,GAAwB,wBAAwB,CAAC;AAG5E,QAAA,oCAAoC,GAAoC,wBAAwB,CAAC;AAGjG,QAAA,sCAAsC,GAAsC,0BAA0B,CAAC"}
+{"version":3,"file":"AppStatus.js","sourceRoot":"","sources":["../../src/App/AppStatus.ts"],"names":[],"mappings":";;;AAGa,QAAA,kBAAkB,GAAqB,SAAS,CAAC;AAGjD,QAAA,qBAAqB,GAAwB,YAAY,CAAC;AAG1D,QAAA,+BAA+B,GAAgC,sBAAsB,CAAC;AAGtF,QAAA,uBAAuB,GAAyB,cAAc,CAAC;AAG/D,QAAA,2BAA2B,GAA6B,kBAAkB,CAAC;AAG3E,QAAA,2BAA2B,GAA6B,eAAe,CAAC;AAGxE,QAAA,4BAA4B,GAA6B,mBAAmB,CAAC;AAG7E,QAAA,eAAe,GAAkB,MAAM,CAAC;AAGxC,QAAA,6BAA6B,GAA+B,oBAAoB,CAAC;AAGjF,QAAA,mBAAmB,GAAsB,UAAU,CAAC;AAGpD,QAAA,oBAAoB,GAAuB,WAAW,CAAC;AAGvD,QAAA,iCAAiC,GAA8B,qBAAqB,CAAC;AAGrF,QAAA,2BAA2B,GAAwB,wBAAwB,CAAC;AAG5E,QAAA,oCAAoC,GAAoC,wBAAwB,CAAC;AAGjG,QAAA,sCAAsC,GAAsC,0BAA0B,CAAC"}

package/lib/Crm.d.ts

@@ -5,12 +5,33 @@ export interface LeadFormField {
     value: string;
 }
 export interface ExternalLead {
+    /**
+     * Fields such as name and email
+     */
     fields: LeadFormField[];
     source?: string;
     company?: string;
+    /**
+     * Transcript of the conversation
+     *
+     */
     transcript?: Message[];
+    /**
+     * Optional reference ID
+     */
+    refId?: string;
 }
 export interface CrmResponse {
+    /**
+     * Was the lead creation request successful
+     */
     status: "Success" | "Failure";
+    /**
+     * Potentially helpful message if there was a failure
+     */
     message?: string;
+    /**
+     * A reference to the lead in the CRM
+     */
+    refId?: string;
 }

package/lib/Services/CrmService.d.ts

@@ -2,7 +2,11 @@
 import { CrmResponse, ExternalLead } from "../Crm";
 export interface CrmService {
     /**
-     * Send the lead to the CRM
+     * Send information about a lead to the CRM.
+     *
+     * This can be used to either create a lead or append data to an existing lead.
+     *
+     * The existing lead can be determined by the refId on the ExternalLead information or by attempting to match data such as email or phone number.
      *
      * @param externalLead Lead information
      * @param extras Optional additional metadata to pass to the CRM

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.58.33",
+  "version": "1.58.43",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "2.0.1"
   },
-  "gitHead": "1421557eb52d3b06aa752840fd2cdeef79123189"
+  "gitHead": "fdd11462ee2b9b0b3ca8bf7ee56f8ef472351b02"
 }