@talqing/sdk 0.5.0 → 0.7.0

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

@@ -1,6 +1,39 @@
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };
+/**
+ * AddEmailRecipientsRequest
+ */
+export type AddEmailRecipientsRequest = {
+    /**
+     * Recipients
+     */
+    recipients: Array<EmailRecipientInput>;
+};
+/**
+ * AddEmailRecipientsResponse
+ *
+ * `standing_send_id` is the send of every row that will mail the new rows
+ * without review, or null when they wait for review.
+ */
+export type AddEmailRecipientsResponse = {
+    /**
+     * Added
+     */
+    added: number;
+    /**
+     * Skipped
+     */
+    skipped: Array<SkippedEmailRecipient>;
+    /**
+     * Standing Send Id
+     */
+    standing_send_id: string | null;
+    /**
+     * Total Recipients
+     */
+    total_recipients: number;
+};
 /**
  * AddMessageConfig
  */
@@ -38,9 +71,10 @@ export type AddRecipientsRequest = {
  *
  * What appending to a batch did.
  *
- * Numbers already in the batch are skipped and reported rather than rejected:
- * re-uploading a list the operator re-exported is the normal case, and the
- * never-call-twice guarantee doing its job is not a user error.
+ * Numbers already in the batch, or repeated in the request, are skipped and
+ * reported rather than rejected: re-uploading a list the operator re-exported
+ * is the normal case, and the never-call-twice guarantee doing its job is not a
+ * user error.
  */
 export type AddRecipientsResponse = {
     /**
@@ -82,6 +116,32 @@ export type AddVoiceResponse = {
      */
     voice_id: string;
 };
+/**
+ * AddWhatsAppRecipientsRequest
+ */
+export type AddWhatsAppRecipientsRequest = {
+    /**
+     * Recipients
+     */
+    recipients: Array<WhatsAppRecipientInput>;
+};
+/**
+ * AddWhatsAppRecipientsResponse
+ */
+export type AddWhatsAppRecipientsResponse = {
+    /**
+     * Added
+     */
+    added: number;
+    /**
+     * Skipped
+     */
+    skipped: Array<SkippedWhatsAppRecipient>;
+    /**
+     * Total Recipients
+     */
+    total_recipients: number;
+};
 /**
  * AgentConfig
  *
@@ -1311,7 +1371,7 @@ export type CallDetailResponse = {
     /**
      * Transcript
      */
-    transcript: Array<TranscriptItemResponse>;
+    transcript: Array<ConversationItemResponse>;
     usage: UsageResponse;
     /**
      * Vars
@@ -1717,6 +1777,26 @@ export type CatalogResponse = {
      */
     turn_detector_languages: Array<LanguageOption>;
 };
+/**
+ * ChatDetailResponse
+ *
+ * One chat with what explains it: health, priced lines, vars and trace.
+ */
+export type ChatDetailResponse = {
+    chat: ChatResponse;
+    cost: CostDetailResponse | null;
+    /**
+     * Events
+     */
+    events: Array<SessionEventResponse>;
+    snapshot: HealthSnapshotResponse;
+    /**
+     * Vars
+     */
+    vars: {
+        [key: string]: string;
+    };
+};
 /**
  * ChatMessageRequest
  *
@@ -2017,7 +2097,7 @@ export type ConversationItemResponse = {
     /**
      * Agent Version
      */
-    agent_version: number | null;
+    agent_version: number | 'draft' | null;
     /**
      * Attachments
      */
@@ -2047,6 +2127,7 @@ export type ConversationItemResponse = {
      * Id
      */
     id: string;
+    latency: ReplyLatency | null;
     /**
      * Metadata
      */
@@ -2054,6 +2135,10 @@ export type ConversationItemResponse = {
         [key: string]: unknown;
     };
     metrics: TurnMetrics | null;
+    /**
+     * Origin
+     */
+    origin: 'speech' | 'typed' | 'keypad' | null;
     /**
      * Provider Message Id
      */
@@ -2212,14 +2297,16 @@ export type ConversationResponse = {
  * One agent execution within a conversation: a call, or a chat.
  */
 export type ConversationSessionResponse = {
+    agent: AgentMetadata;
     /**
-     * Agent Id
+     * Agent Version
      */
-    agent_id: string | null;
+    agent_version: number | 'draft' | null;
     /**
      * Agent Version Id
      */
     agent_version_id: string | null;
+    analysis: AnalysisResponse;
     /**
      * Channel
      */
@@ -2228,6 +2315,10 @@ export type ConversationSessionResponse = {
      * Close Reason
      */
     close_reason: string | null;
+    /**
+     * Close Reason Label
+     */
+    close_reason_label: string | null;
     /**
      * Conversation Id
      */
@@ -2236,11 +2327,15 @@ export type ConversationSessionResponse = {
      * Conversation Ref Id
      */
     conversation_ref_id: string | null;
-    cost: SessionCostResponse | null;
+    cost: CostResponse | null;
     /**
      * Created At
      */
     created_at: string;
+    /**
+     * Duration S
+     */
+    duration_s: number | null;
     /**
      * Ended At
      */
@@ -2255,18 +2350,6 @@ export type ConversationSessionResponse = {
      */
     integration_id: string | null;
     metrics: SessionMetrics;
-    /**
-     * Outcome
-     */
-    outcome: 'success' | 'failure' | 'unknown' | null;
-    /**
-     * Output Item Ids
-     */
-    output_item_ids: Array<string>;
-    /**
-     * Session Id
-     */
-    session_id: string | null;
     /**
      * Started At
      */
@@ -2275,18 +2358,10 @@ export type ConversationSessionResponse = {
      * Status
      */
     status: string;
-    /**
-     * Summary
-     */
-    summary: string | null;
     /**
      * Trigger Id
      */
     trigger_id: string | null;
-    /**
-     * Trigger Item Ids
-     */
-    trigger_item_ids: Array<string>;
     /**
      * Type
      */
@@ -2370,6 +2445,46 @@ export type ConversationSpecOverride = {
      */
     summary_limit?: number | null;
 };
+/**
+ * ConversationTraceEventResponse
+ *
+ * One trace row of a conversation, and the session it belongs to.
+ */
+export type ConversationTraceEventResponse = {
+    /**
+     * Created At
+     */
+    created_at: string;
+    /**
+     * Payload
+     */
+    payload: {
+        [key: string]: unknown;
+    };
+    /**
+     * Seq
+     */
+    seq: number;
+    /**
+     * Session Id
+     */
+    session_id: string;
+    /**
+     * Type
+     */
+    type: string;
+};
+/**
+ * ConversationTraceResponse
+ *
+ * A conversation's trace over one window, oldest first.
+ */
+export type ConversationTraceResponse = {
+    /**
+     * Events
+     */
+    events: Array<ConversationTraceEventResponse>;
+};
 /**
  * CopilotFunctionCallItem
  *
@@ -4257,6 +4372,21 @@ export type HandoffTarget = {
      */
     summary_prompt?: string | null;
 };
+/**
+ * HealthIssue
+ *
+ * One problem found, and what kind it is.
+ */
+export type HealthIssue = {
+    /**
+     * Kind
+     */
+    kind: 'failed' | 'never_ready' | 'provider_errors' | 'provider_failover' | 'tool_failures' | 'tools_unfinished' | 'slow_tools' | 'slow_responses' | 'slow_after_filler' | 'connection' | 'noise_cancellation' | 'unpriceable';
+    /**
+     * Message
+     */
+    message: string;
+};
 /**
  * HealthResponse
  *
@@ -4305,10 +4435,6 @@ export type HealthSnapshotResponse = {
      * Duration Seconds
      */
     duration_seconds: number | null;
-    /**
-     * End Of Turn Avg Ms
-     */
-    end_of_turn_avg_ms: number | null;
     /**
      * Errors
      */
@@ -4332,7 +4458,7 @@ export type HealthSnapshotResponse = {
     /**
      * Issues
      */
-    issues: Array<string>;
+    issues: Array<HealthIssue>;
     /**
      * Noise Cancellation Failed
      */
@@ -4359,6 +4485,14 @@ export type HealthSnapshotResponse = {
      */
     providers: Array<string>;
     response_latency: LatencyStats;
+    /**
+     * Response Stages
+     */
+    response_stages: Array<LatencyStage>;
+    /**
+     * Slow Replies After Filler
+     */
+    slow_replies_after_filler: number;
     /**
      * Slow Response Threshold Ms
      */
@@ -4395,18 +4529,6 @@ export type HealthSnapshotResponse = {
      * Total Cost Usd
      */
     total_cost_usd: number | null;
-    /**
-     * Transcription Avg Ms
-     */
-    transcription_avg_ms: number | null;
-    /**
-     * Ttfb Avg Ms
-     */
-    ttfb_avg_ms: number | null;
-    /**
-     * Ttft Avg Ms
-     */
-    ttft_avg_ms: number | null;
     /**
      * Tts Audio Ms
      */
@@ -5081,7 +5203,7 @@ export type ItemCreatedEvent = {
     /**
      * Agent Version
      */
-    agent_version: number | null;
+    agent_version: number | 'draft' | null;
     /**
      * Attachments
      */
@@ -5115,6 +5237,7 @@ export type ItemCreatedEvent = {
      * Id
      */
     id: string;
+    latency: ReplyLatency | null;
     /**
      * Metadata
      */
@@ -5122,6 +5245,10 @@ export type ItemCreatedEvent = {
         [key: string]: unknown;
     };
     metrics: TurnMetrics | null;
+    /**
+     * Origin
+     */
+    origin: 'speech' | 'typed' | 'keypad' | null;
     /**
      * Provider Message Id
      */
@@ -5946,6 +6073,25 @@ export type LanguageOption = {
      */
     name: string;
 };
+/**
+ * LatencyStage
+ *
+ * One leg of a wait: what the time went on.
+ */
+export type LatencyStage = {
+    /**
+     * Kind
+     */
+    kind: 'stt' | 'endpoint' | 'hook' | 'llm_step' | 'tool' | 'llm' | 'tts' | 'other';
+    /**
+     * Label
+     */
+    label: string;
+    /**
+     * Ms
+     */
+    ms: number;
+};
 /**
  * LatencyStats
  */
@@ -7514,7 +7660,7 @@ export type PageWhatsAppRecipientResponse = {
 /**
  * PatchCallBatchRequest
  *
- * Policy edits, allowed while a batch is `scheduled`, `running` or `paused`.
+ * Policy edits, allowed while a batch is `scheduled`, `running`, `paused` or `completed`.
  *
  * ``calling_window`` and ``start_at`` accept an explicit ``null`` to *clear*
  * them — "dial at any hour", "start on the next pass" — which is why the
@@ -9021,6 +9167,25 @@ export type RemoteNumber = {
      */
     provider_number_id?: string | null;
 };
+/**
+ * ReplyLatency
+ *
+ * How long the caller waited for this reply, in the order it was spent.
+ */
+export type ReplyLatency = {
+    /**
+     * Kind
+     */
+    kind: 'response' | 'reply' | 'after_filler';
+    /**
+     * Stages
+     */
+    stages: Array<LatencyStage>;
+    /**
+     * Total Ms
+     */
+    total_ms: number;
+};
 /**
  * RunStepResponse
  *
@@ -9582,29 +9747,6 @@ export type SendWhatsAppBatchRequest = {
     timezone?: string | null;
     window?: TimeWindow | null;
 };
-/**
- * SessionCostResponse
- *
- * Priced money columns for one session. Absent when billing has not run.
- */
-export type SessionCostResponse = {
-    /**
-     * Duration S
-     */
-    duration_s?: number | null;
-    /**
-     * Platform Fee
-     */
-    platform_fee: number;
-    /**
-     * Provider Cost
-     */
-    provider_cost: number;
-    /**
-     * Total Charge
-     */
-    total_charge: number;
-};
 /**
  * SessionError
  *
@@ -9655,6 +9797,7 @@ export type SessionEventResponse = {
  * Latency averages are milliseconds over every message that reported the
  * metric (same rule as call detail / workspace observability). Turn-level
  * samples live on conversation_items.metrics for workspace daily aggregates.
+ * On a chat, `e2e_latency` is a message arriving → the first token back.
  */
 export type SessionMetrics = {
     /**
@@ -9803,6 +9946,26 @@ export type SilenceSpecOverride = {
      */
     timeout?: number | null;
 };
+/**
+ * SkippedEmailRecipient
+ *
+ * A row of the request that will not be drafted. `row_number` is its 1-based
+ * position in the request; `recipient_id` is null when it was not stored.
+ */
+export type SkippedEmailRecipient = {
+    /**
+     * Reason
+     */
+    reason: string;
+    /**
+     * Recipient Id
+     */
+    recipient_id: string | null;
+    /**
+     * Row Number
+     */
+    row_number: number;
+};
 /**
  * SkippedRecipient
  */
@@ -9820,6 +9983,26 @@ export type SkippedRecipient = {
      */
     to: string;
 };
+/**
+ * SkippedWhatsAppRecipient
+ *
+ * A row of the request that will not be sent. `row_number` is its 1-based
+ * position in the request; `recipient_id` is null when it was not stored.
+ */
+export type SkippedWhatsAppRecipient = {
+    /**
+     * Reason
+     */
+    reason: string;
+    /**
+     * Recipient Id
+     */
+    recipient_id: string | null;
+    /**
+     * Row Number
+     */
+    row_number: number;
+};
 /**
  * StoredAgentPlan
  *
@@ -11273,51 +11456,6 @@ export type TraceStepResponse = {
      */
     truncated?: boolean;
 };
-/**
- * TranscriptItemResponse
- */
-export type TranscriptItemResponse = {
-    /**
-     * Agent Id
-     */
-    agent_id: string | null;
-    /**
-     * Agent Version
-     */
-    agent_version: number | 'draft' | null;
-    /**
-     * Attachments
-     */
-    attachments: Array<ConversationAttachment>;
-    /**
-     * Data
-     */
-    data: {
-        [key: string]: unknown;
-    } | null;
-    /**
-     * Id
-     */
-    id: string;
-    /**
-     * Item Id
-     */
-    item_id: string;
-    /**
-     * Metrics
-     */
-    metrics: {
-        [key: string]: unknown;
-    } | null;
-    /**
-     * Timestamp
-     */
-    timestamp: string;
-    /**
-     * Type
-     */
-    type: 'message' | 'function_call' | 'function_call_output' | 'agent_handoff' | 'agent_config_update';
-};
 /**
  * TransferConfig
  */
@@ -14474,6 +14612,141 @@ export type ChatsGetResults = {
     200: ChatResponse;
 };
 export type ChatsGetResult = ChatsGetResults[keyof ChatsGetResults];
+export type ChatsAnalysisRerunData = {
+    body?: never;
+    path: {
+        /**
+         * Chat Id
+         */
+        chat_id: string;
+    };
+    query?: never;
+    url: '/v1/chats/{chat_id}/analysis';
+};
+export type ChatsAnalysisRerunErrors = {
+    /**
+     * 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;
+    /**
+     * No such resource in this organization.
+     */
+    404: 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 ChatsAnalysisRerunError = ChatsAnalysisRerunErrors[keyof ChatsAnalysisRerunErrors];
+export type ChatsAnalysisRerunResults = {
+    /**
+     * Successful Response
+     */
+    200: ChatResponse;
+};
+export type ChatsAnalysisRerunResult = ChatsAnalysisRerunResults[keyof ChatsAnalysisRerunResults];
+export type ChatsAnalysisPreviewData = {
+    body: PreviewAnalysisRequest;
+    path: {
+        /**
+         * Chat Id
+         */
+        chat_id: string;
+    };
+    query?: never;
+    url: '/v1/chats/{chat_id}/analysis/preview';
+};
+export type ChatsAnalysisPreviewErrors = {
+    /**
+     * 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;
+    /**
+     * No such resource in this organization.
+     */
+    404: 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 ChatsAnalysisPreviewError = ChatsAnalysisPreviewErrors[keyof ChatsAnalysisPreviewErrors];
+export type ChatsAnalysisPreviewResults = {
+    /**
+     * Successful Response
+     */
+    200: PreviewAnalysisResponse;
+};
+export type ChatsAnalysisPreviewResult = ChatsAnalysisPreviewResults[keyof ChatsAnalysisPreviewResults];
+export type ChatsDetailData = {
+    body?: never;
+    path: {
+        /**
+         * Chat Id
+         */
+        chat_id: string;
+    };
+    query?: never;
+    url: '/v1/chats/{chat_id}/detail';
+};
+export type ChatsDetailErrors = {
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * No such resource in this organization.
+     */
+    404: 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 ChatsDetailError = ChatsDetailErrors[keyof ChatsDetailErrors];
+export type ChatsDetailResults = {
+    /**
+     * Successful Response
+     */
+    200: ChatDetailResponse;
+};
+export type ChatsDetailResult = ChatsDetailResults[keyof ChatsDetailResults];
 export type ChatsEndData = {
     body?: never;
     path: {
@@ -15002,6 +15275,56 @@ export type ConversationsSnapshotResults = {
     200: HealthSnapshotResponse;
 };
 export type ConversationsSnapshotResult = ConversationsSnapshotResults[keyof ConversationsSnapshotResults];
+export type ConversationsTraceData = {
+    body?: never;
+    path: {
+        /**
+         * Conversation Id
+         */
+        conversation_id: string;
+    };
+    query?: {
+        /**
+         * After
+         *
+         * Only events at or after this.
+         */
+        after?: string | null;
+        /**
+         * Before
+         *
+         * Only events before this.
+         */
+        before?: string | null;
+    };
+    url: '/v1/conversations/{conversation_id}/trace';
+};
+export type ConversationsTraceErrors = {
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * No such resource in this organization.
+     */
+    404: 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 ConversationsTraceError = ConversationsTraceErrors[keyof ConversationsTraceErrors];
+export type ConversationsTraceResults = {
+    /**
+     * Successful Response
+     */
+    200: ConversationTraceResponse;
+};
+export type ConversationsTraceResult = ConversationsTraceResults[keyof ConversationsTraceResults];
 export type CopilotAgentsSendData = {
     body: SendMessageRequest;
     path: {
@@ -15742,6 +16065,55 @@ export type EmailBatchesRecipientsListResults = {
     200: PageEmailRecipientResponse;
 };
 export type EmailBatchesRecipientsListResult = EmailBatchesRecipientsListResults[keyof EmailBatchesRecipientsListResults];
+export type EmailBatchesRecipientsAddData = {
+    body: AddEmailRecipientsRequest;
+    path: {
+        /**
+         * Batch Id
+         */
+        batch_id: string;
+    };
+    query?: never;
+    url: '/v1/email/batches/{batch_id}/recipients';
+};
+export type EmailBatchesRecipientsAddErrors = {
+    /**
+     * 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;
+    /**
+     * No such resource in this organization.
+     */
+    404: 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 EmailBatchesRecipientsAddError = EmailBatchesRecipientsAddErrors[keyof EmailBatchesRecipientsAddErrors];
+export type EmailBatchesRecipientsAddResults = {
+    /**
+     * Successful Response
+     */
+    200: AddEmailRecipientsResponse;
+};
+export type EmailBatchesRecipientsAddResult = EmailBatchesRecipientsAddResults[keyof EmailBatchesRecipientsAddResults];
 export type EmailBatchesRecipientsUpdateData = {
     body: PatchEmailRecipientRequest;
     path: {
@@ -20208,6 +20580,55 @@ export type WhatsappBatchesRecipientsListResults = {
     200: PageWhatsAppRecipientResponse;
 };
 export type WhatsappBatchesRecipientsListResult = WhatsappBatchesRecipientsListResults[keyof WhatsappBatchesRecipientsListResults];
+export type WhatsappBatchesRecipientsAddData = {
+    body: AddWhatsAppRecipientsRequest;
+    path: {
+        /**
+         * Batch Id
+         */
+        batch_id: string;
+    };
+    query?: never;
+    url: '/v1/whatsapp/batches/{batch_id}/recipients';
+};
+export type WhatsappBatchesRecipientsAddErrors = {
+    /**
+     * 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;
+    /**
+     * No such resource in this organization.
+     */
+    404: 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 WhatsappBatchesRecipientsAddError = WhatsappBatchesRecipientsAddErrors[keyof WhatsappBatchesRecipientsAddErrors];
+export type WhatsappBatchesRecipientsAddResults = {
+    /**
+     * Successful Response
+     */
+    200: AddWhatsAppRecipientsResponse;
+};
+export type WhatsappBatchesRecipientsAddResult = WhatsappBatchesRecipientsAddResults[keyof WhatsappBatchesRecipientsAddResults];
 export type WhatsappBatchesRecipientsRestoreData = {
     body: SelectRecipientsRequest;
     path: {