@aiqa/sdk 2.1.1 → 2.2.0-develop.2

package/README.md

@@ -230,6 +230,7 @@ change.
   | `agentId` / `agentName`     | `string`   | 64/128   |                                             |
   | `advisorId` / `advisorName` | `string`   | 64/128   |                                             |
   | `agentGroups`               | `string[]` | 32 × 128 | entries cannot contain a comma              |
+  | `externalStatus`            | `string`   | —        | see [`ExternalStatus`](#externalstatus)     |
 
   Every string (including each `agentGroups` entry) must be non-empty;
   surrounding whitespace is trimmed first, so a value of only spaces is
@@ -245,10 +246,16 @@ change.
 const result = await sdk.updateConversation({
   policyNumber: "POL-123",
   clientEmail: "jane@example.com",
+  externalStatus: ExternalStatus.COMPLETED,
 });
 console.log(result.success, result.conversation.policy_number);
 ```
 
+##### `ExternalStatus`
+
+User-provided application status: `draft`, `pending`, `completed`, `expired`,
+`closed`.
+
 ### Fact Management
 
 #### `addFact(fact)`
@@ -289,6 +296,8 @@ a timeout, a rejected payload.
     question: string;
     expected_answer: any;
     answer_format: { type: "STRING" }
+    /** Optional (default: `false`). Use `true` when the fact was collected before the conversation started. It is stored, not verified. */
+    prefilled?: boolean
     /**
      * Optional. Your own identifiers for this fact — a form field ID, a
      * section name, anything that lets your UI map the result back to the
@@ -499,6 +508,8 @@ Rules:
   `unmatched`). Show progress from the `FACT_VERIFIED` event, show the final
   result from the Promise.
 - **Handle a `verification_status` you don't recognize as `processing`.**
+- **A fact sent with `prefilled: true` is never verified**, so it gets no
+  `verification_status` and no `FACT_VERIFIED` event.
 - **`pending_confirmation_*` is never final.** The answer can still change,
   so don't show it as a decision.
 - **A fact can be revised after `addFact()` has resolved.** If you keep its
@@ -718,6 +729,8 @@ type ApplicationFactInput = {
   // and one of them sets status to "critical_errors".
   critical?: boolean;
   is_skipped?: boolean;
+  /** Optional (default: `false`). Use `true` when the fact was collected before the conversation started. It is stored, not verified. */
+  prefilled?: boolean;
   /**
    * Optional. Your own identifiers for this fact — a form field ID, a section
    * name, anything that lets your UI map the result back to the right place.
@@ -768,6 +781,7 @@ type UpdateConversationInput = {
   advisorId?: string;
   advisorName?: string;
   agentGroups?: string[];
+  externalStatus?: ExternalStatus | (string & {});
 };
 ```
 
@@ -791,6 +805,7 @@ type UpdateConversationResult = {
     advisor_id?: string;
     advisor_name?: string;
     agent_groups?: string[];
+    external_status?: string;
   };
 };
 ```

package/dist/browser/browser.d.ts

@@ -84,6 +84,14 @@ type SetConversationLanguageResult = {
     success: boolean;
     language: string;
 };
+/** User-provided application status. */
+declare enum ExternalStatus {
+    DRAFT = "draft",
+    PENDING = "pending",
+    COMPLETED = "completed",
+    EXPIRED = "expired",
+    CLOSED = "closed"
+}
 type UpdateConversationInput = {
     policyNumber?: string;
     insuredPhone?: string;
@@ -96,6 +104,7 @@ type UpdateConversationInput = {
     advisorId?: string;
     advisorName?: string;
     agentGroups?: string[];
+    externalStatus?: ExternalStatus | (string & {});
 };
 /** Only the fields you sent come back in `conversation`. */
 type UpdateConversationResult = {
@@ -112,6 +121,7 @@ type UpdateConversationResult = {
         advisor_id?: string;
         advisor_name?: string;
         agent_groups?: string[];
+        external_status?: string;
     };
 };
 declare enum ConversationLanguage {
@@ -160,6 +170,8 @@ type ApplicationFactInput = {
      */
     critical?: boolean;
     is_skipped?: boolean;
+    /** Optional (default: `false`). Use `true` when the fact was collected before the conversation started. It is stored, not verified. */
+    prefilled?: boolean;
     /**
      * Your own identifiers for this fact — a form field ID, a section name,
      * anything that lets your UI map the result back to the right place.
@@ -207,6 +219,7 @@ interface AddFactResult {
     answer_type?: string;
     agent_answer?: string;
     ai_answer?: string;
+    /** `false` for a fact that was never verified, such as a prefilled one. */
     is_valid_answer: boolean;
     question_asked?: boolean;
     /**
@@ -345,4 +358,4 @@ declare class AiQaSdk implements IAiqaSdk {
     private isManagerEvent;
 }
 
-export { type AddFactResult, AiQaSdk, type Application, type ApplicationFact, type ApplicationFactAnswerChoice, type ApplicationFactAnswerFormat, type ApplicationFactInput, type ApplicationVerificationStatus, type ApplicationVerificationSummary, ConversationLanguage, type DialogAct, type DialogActConfidence, FactAnswerFormatType, type FactVerifiedPayload, type FlagFactResult, IAiqaSdk, Methods, type QuestionStatus, type SdkError, type SdkEvent, type SetConversationLanguageResult, type SetConversationProductResult, type TranscriptionUpdate, type UpdateConversationInput, type UpdateConversationResult, type Utterance, type VerificationStatus };
+export { type AddFactResult, AiQaSdk, type Application, type ApplicationFact, type ApplicationFactAnswerChoice, type ApplicationFactAnswerFormat, type ApplicationFactInput, type ApplicationVerificationStatus, type ApplicationVerificationSummary, ConversationLanguage, type DialogAct, type DialogActConfidence, ExternalStatus, FactAnswerFormatType, type FactVerifiedPayload, type FlagFactResult, IAiqaSdk, Methods, type QuestionStatus, type SdkError, type SdkEvent, type SetConversationLanguageResult, type SetConversationProductResult, type TranscriptionUpdate, type UpdateConversationInput, type UpdateConversationResult, type Utterance, type VerificationStatus };

package/dist/browser/browser.js

@@ -3352,6 +3352,14 @@ var Methods = /* @__PURE__ */ ((Methods2) => {
   Methods2["UPDATE_CONVERSATION"] = "UPDATE_CONVERSATION";
   return Methods2;
 })(Methods || {});
+var ExternalStatus = /* @__PURE__ */ ((ExternalStatus2) => {
+  ExternalStatus2["DRAFT"] = "draft";
+  ExternalStatus2["PENDING"] = "pending";
+  ExternalStatus2["COMPLETED"] = "completed";
+  ExternalStatus2["EXPIRED"] = "expired";
+  ExternalStatus2["CLOSED"] = "closed";
+  return ExternalStatus2;
+})(ExternalStatus || {});
 var ConversationLanguage = /* @__PURE__ */ ((ConversationLanguage3) => {
   ConversationLanguage3["EN"] = "en";
   ConversationLanguage3["ES"] = "es";
@@ -3398,7 +3406,7 @@ var compareVersions = (left, right) => {
 // package.json
 var package_default = {
   name: "@aiqa/sdk",
-  version: "2.1.0-develop.5",
+  version: "2.2.0-develop.1",
   main: "dist/node/node.js",
   module: "dist/node/node.js",
   types: "dist/node/node.d.ts",
@@ -3808,6 +3816,7 @@ var shared_default = AiQaSdk;
 export {
   shared_default as AiQaSdk,
   ConversationLanguage,
+  ExternalStatus,
   FactAnswerFormatType,
   IAiqaSdk,
   Methods