stentor-models 1.58.38 → 1.58.59

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.38",
+  "version": "1.58.59",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -33,5 +33,5 @@
   "dependencies": {
     "@xapp/patterns": "2.0.1"
   },
-  "gitHead": "26572ec0fa2dbfe17c6b3f3c0cab40ae6aac4c69"
+  "gitHead": "5fa53a917406762b7a45499494f63352b3575133"
 }