@talqing/sdk 0.16.1 → 0.18.0

package/dist/esm/gen/types.gen.d.ts

@@ -207,7 +207,7 @@ export type AgentConfig = {
     /**
      * Language
      *
-     * The one language the caller and the agent speak, shared by every model in the pipeline. Use a code from the provider catalog's language lists; null means Auto. Voice and video only.
+     * The one language the caller and the agent speak, shared by every model in the pipeline. Use a code from the provider catalog's language lists; null means Auto. On a text agent, only with `stt` set.
      */
     language?: string | null;
     llm?: LLMSpec | null;
@@ -248,6 +248,9 @@ export type AgentConfig = {
     realtime?: RealtimeSpec | null;
     recording?: RecordingSpec;
     silence?: SilenceSpec;
+    /**
+     * Text agents: transcribes voice notes; null = the agent can't listen to them.
+     */
     stt?: STTSpec | null;
     /**
      * Tasks
@@ -349,7 +352,7 @@ export type AgentOverride = {
     /**
      * Language
      *
-     * The one language the caller and the agent speak, shared by every model in the pipeline. Use a code from the provider catalog's language lists; null means Auto. Voice and video only.
+     * The one language the caller and the agent speak, shared by every model in the pipeline. Use a code from the provider catalog's language lists; null means Auto. On a text agent, only with `stt` set.
      */
     language?: string | null;
     llm?: LLMSpecOverride | null;
@@ -390,6 +393,9 @@ export type AgentOverride = {
     realtime?: RealtimeSpecOverride | null;
     recording?: RecordingSpecOverride | null;
     silence?: SilenceSpecOverride | null;
+    /**
+     * Text agents: transcribes voice notes; null = the agent can't listen to them.
+     */
     stt?: STTSpecOverride | null;
     /**
      * Tasks
@@ -2110,6 +2116,29 @@ export type ConnectionQuality = {
      */
     overall: string;
 };
+/**
+ * ContactCard
+ *
+ * One card in a shared contact file.
+ */
+export type ContactCard = {
+    /**
+     * Emails
+     */
+    emails: Array<string>;
+    /**
+     * Name
+     */
+    name: string | null;
+    /**
+     * Organization
+     */
+    organization: string | null;
+    /**
+     * Phones
+     */
+    phones: Array<string>;
+};
 /**
  * ConversationActivity
  *
@@ -2121,6 +2150,120 @@ export type ConversationActivity = {
      */
     state: 'running' | 'idle';
 };
+/**
+ * ConversationAudio
+ *
+ * A voice note or audio file the person sent, and what they said in it.
+ */
+export type ConversationAudio = {
+    /**
+     * Bytes
+     */
+    bytes: number;
+    /**
+     * Duration Seconds
+     */
+    duration_seconds: number | null;
+    /**
+     * Extension
+     *
+     * The type read from its bytes, e.g. `ogg` or `m4a`.
+     */
+    extension: string;
+    /**
+     * Failed Reason
+     *
+     * Why it could not be transcribed.
+     */
+    failed_reason: string | null;
+    /**
+     * Filename
+     */
+    filename: string | null;
+    /**
+     * Id
+     */
+    id: string;
+    /**
+     * Kind
+     */
+    kind?: 'audio';
+    /**
+     * Mime Type
+     */
+    mime_type: string;
+    /**
+     * Playable
+     *
+     * Whether `url` plays in an `<audio>` element.
+     */
+    playable: boolean;
+    /**
+     * Status
+     *
+     * `pending` until an agent with a speech-to-text model takes a turn.
+     */
+    status: 'pending' | 'transcribed' | 'failed';
+    /**
+     * Transcript
+     *
+     * What was said; empty when there was no speech.
+     */
+    transcript: string | null;
+    /**
+     * Url
+     *
+     * Signed link; valid until `url_expires_at`.
+     */
+    url: string;
+    /**
+     * Url Expires At
+     */
+    url_expires_at: string;
+};
+/**
+ * ConversationContact
+ *
+ * A contact card the person shared, as read from the vCard.
+ */
+export type ConversationContact = {
+    /**
+     * Bytes
+     */
+    bytes: number;
+    /**
+     * Contacts
+     *
+     * One per card in the file.
+     */
+    contacts: Array<ContactCard>;
+    /**
+     * Filename
+     */
+    filename: string | null;
+    /**
+     * Id
+     */
+    id: string;
+    /**
+     * Kind
+     */
+    kind?: 'contact';
+    /**
+     * Mime Type
+     */
+    mime_type?: 'text/vcard';
+    /**
+     * Url
+     *
+     * Signed download of the .vcf; valid until `url_expires_at`.
+     */
+    url: string;
+    /**
+     * Url Expires At
+     */
+    url_expires_at: string;
+};
 /**
  * ConversationDocument
  *
@@ -2211,9 +2354,9 @@ export type ConversationFile = {
     /**
      * Playable
      *
-     * Set when `url` plays in an `<audio>` or `<video>` element.
+     * Set when `url` plays in a `<video>` element.
      */
-    playable: 'audio' | 'video' | null;
+    playable: 'video' | null;
     /**
      * Url
      *
@@ -2285,7 +2428,7 @@ export type ConversationItemResponse = {
     /**
      * Attachments
      */
-    attachments: Array<ConversationImage | ConversationDocument | ConversationFile>;
+    attachments: Array<ConversationImage | ConversationDocument | ConversationAudio | ConversationContact | ConversationFile>;
     /**
      * Attachments Not Kept
      *
@@ -3158,6 +3301,9 @@ export type CreateChatRequest = {
 };
 /**
  * CreateEmailBatchRequest
+ *
+ * Each email is written either by an agent task (`task_id` + `field_map`) or by
+ * a fixed `template` filled from the row's columns.
  */
 export type CreateEmailBatchRequest = {
     /**
@@ -3182,7 +3328,10 @@ export type CreateEmailBatchRequest = {
      * Draft Retry After Minutes
      */
     draft_retry_after_minutes?: number;
-    field_map: FieldMap;
+    /**
+     * With `task_id` only.
+     */
+    field_map?: FieldMap | null;
     /**
      * From Email
      *
@@ -3244,7 +3393,11 @@ export type CreateEmailBatchRequest = {
      *
      * The agent task that drafts each row.
      */
-    task_id: string;
+    task_id?: string | null;
+    /**
+     * Instead of a task: no drafting, every row is ready at once.
+     */
+    template?: EmailTemplate | null;
     /**
      * Timezone
      */
@@ -4185,7 +4338,7 @@ export type EmailBatchResponse = {
      * Failure Reason
      */
     failure_reason: string | null;
-    field_map: FieldMap;
+    field_map: FieldMap | null;
     /**
      * From Email
      */
@@ -4295,6 +4448,7 @@ export type EmailBatchResponse = {
      * Task Name
      */
     task_name: string | null;
+    template: EmailTemplate | null;
     /**
      * Timezone
      */
@@ -4358,6 +4512,7 @@ export type EmailRecipientResponse = {
     columns: {
         [key: string]: unknown;
     };
+    email: ResolvedEmail | null;
     /**
      * Id
      */
@@ -4564,6 +4719,27 @@ export type EmailSendResponse = {
     timezone: string;
     window: TimeWindow | null;
 };
+/**
+ * EmailTemplate
+ *
+ * A fixed email, filled per row: `{{column}}` in subject or body takes that row's cell.
+ */
+export type EmailTemplate = {
+    /**
+     * Body
+     */
+    body: string;
+    /**
+     * Subject
+     */
+    subject: string;
+    /**
+     * To
+     *
+     * The list column holding the address.
+     */
+    to: string;
+};
 /**
  * EndCallConfig
  *
@@ -6009,7 +6185,7 @@ export type ItemCreatedEvent = {
     /**
      * Attachments
      */
-    attachments: Array<ConversationImage | ConversationDocument | ConversationFile>;
+    attachments: Array<ConversationImage | ConversationDocument | ConversationAudio | ConversationContact | ConversationFile>;
     /**
      * Attachments Not Kept
      *
@@ -8296,6 +8472,8 @@ export type PatchEmailBatchRequest = {
     draft_retry_after_minutes?: number;
     /**
      * Field Map
+     *
+     * Task batches only.
      */
     field_map?: FieldMap;
     /**
@@ -8338,6 +8516,12 @@ export type PatchEmailBatchRequest = {
      * Start At
      */
     start_at?: string | null;
+    /**
+     * Template
+     *
+     * Template batches only.
+     */
+    template?: EmailTemplate;
     /**
      * Timezone
      */
@@ -9889,6 +10073,25 @@ export type ReplyLatency = {
      */
     total_ms: number;
 };
+/**
+ * ResolvedEmail
+ *
+ * The email this row sends, as it stands now.
+ */
+export type ResolvedEmail = {
+    /**
+     * Body
+     */
+    body: string;
+    /**
+     * Subject
+     */
+    subject: string;
+    /**
+     * To
+     */
+    to: string;
+};
 /**
  * ResumeCallRequest
  */
@@ -10117,6 +10320,10 @@ export type STTCatalogEntryResponse = {
      * Default Language
      */
     default_language: string | null;
+    /**
+     * File Transcription
+     */
+    file_transcription: 'whole' | 'chunked' | null;
     /**
      * Label
      */
@@ -10463,6 +10670,62 @@ export type SendMessageResponse = {
      */
     turn_id: string;
 };
+/**
+ * SendTestEmailRequest
+ *
+ * One email to yourself, filled from `vars` the way a template batch fills a row.
+ */
+export type SendTestEmailRequest = {
+    /**
+     * Body
+     */
+    body: string;
+    /**
+     * Body Format
+     */
+    body_format?: 'text' | 'html';
+    /**
+     * From Email
+     */
+    from_email: string;
+    /**
+     * From Name
+     */
+    from_name?: string | null;
+    /**
+     * Integration Id
+     */
+    integration_id: string;
+    /**
+     * Reply To
+     */
+    reply_to?: string | null;
+    /**
+     * Subject
+     */
+    subject: string;
+    /**
+     * Vars
+     *
+     * One row's cells.
+     */
+    vars?: {
+        [key: string]: string;
+    };
+};
+/**
+ * SendTestEmailResponse
+ */
+export type SendTestEmailResponse = {
+    /**
+     * Provider Message Id
+     */
+    provider_message_id: string;
+    /**
+     * To
+     */
+    to: string;
+};
 /**
  * SendWhatsAppBatchRequest
  *
@@ -16800,6 +17063,10 @@ export type ConversationsAttachmentsGetResults = {
     } & ConversationImage) | ({
         kind: 'document';
     } & ConversationDocument) | ({
+        kind: 'audio';
+    } & ConversationAudio) | ({
+        kind: 'contact';
+    } & ConversationContact) | ({
         kind: 'file';
     } & ConversationFile);
 };
@@ -18322,6 +18589,46 @@ export type EmailSendersListResults = {
     200: VerifiedSendersResponse;
 };
 export type EmailSendersListResult = EmailSendersListResults[keyof EmailSendersListResults];
+export type EmailTestSendsCreateData = {
+    body: SendTestEmailRequest;
+    path?: never;
+    query?: never;
+    url: '/v1/email/test-sends';
+};
+export type EmailTestSendsCreateErrors = {
+    /**
+     * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
+     */
+    400: ErrorResponse;
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * Authenticated, but this organization role may not perform the operation.
+     */
+    403: ErrorResponse;
+    /**
+     * The resource's current state forbids this — a name already taken, a job already running.
+     */
+    409: ErrorResponse;
+    /**
+     * The request did not match this operation's schema; `detail.errors` lists each field.
+     */
+    422: ErrorResponse;
+    /**
+     * Unexpected error. Every error this API returns carries this body.
+     */
+    default: ErrorResponse;
+};
+export type EmailTestSendsCreateError = EmailTestSendsCreateErrors[keyof EmailTestSendsCreateErrors];
+export type EmailTestSendsCreateResults = {
+    /**
+     * Successful Response
+     */
+    200: SendTestEmailResponse;
+};
+export type EmailTestSendsCreateResult = EmailTestSendsCreateResults[keyof EmailTestSendsCreateResults];
 export type FaqsListData = {
     body?: never;
     path?: never;