@talqing/sdk 0.4.3 → 0.4.5

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

@@ -208,6 +208,10 @@ export type AgentOverride = {
     analysis?: AnalysisSpecOverride | null;
     avatar?: AvatarSpecOverride | null;
     background_audio?: BackgroundAudioSpecOverride | null;
+    /**
+     * Channel
+     */
+    channel?: 'voice' | 'video' | 'text' | null;
     conversation?: ConversationSpecOverride | null;
     /**
      * Greeting
@@ -627,6 +631,10 @@ export type AvatarCatalogEntryResponse = {
      * Label
      */
     label: string | null;
+    /**
+     * Logo Url
+     */
+    logo_url: string | null;
     /**
      * Model
      */
@@ -2567,7 +2575,9 @@ export type CreateEmailBatchRequest = {
  *
  * Send these rows. **This is the call that mails real people.**
  *
- * Name ``recipient_ids`` or pass ``selection: "all_drafts"``. Everything else
+ * ``scope: "selected"`` sends exactly ``recipient_ids``. ``scope: "all"`` is a
+ * standing send: every row of the batch as it reaches `draft`, including rows
+ * not drafted yet — so it mails drafts nobody has read. Everything else
  * defaults to the batch's own setting; ``window`` and ``send_daily_cap`` accept
  * an explicit ``null`` to mean "no window" and "uncapped" rather than
  * "inherit", so the service reads ``model_fields_set``.
@@ -2592,9 +2602,11 @@ export type CreateEmailSendRequest = {
      */
     reply_to?: string | null;
     /**
-     * Selection
+     * Scope
+     *
+     * `selected` sends `recipient_ids`; `all` sends every row as it is drafted.
      */
-    selection?: 'all_drafts' | null;
+    scope: 'all' | 'selected';
     /**
      * Send Attempts
      */
@@ -3107,6 +3119,21 @@ export type DeliveryResultResponse = {
      */
     webhook_id: string;
 };
+/**
+ * DraftFailure
+ *
+ * One reason drafts failed, and how many rows it holds.
+ */
+export type DraftFailure = {
+    /**
+     * Count
+     */
+    count: number;
+    /**
+     * Reason
+     */
+    reason: string;
+};
 /**
  * DraftedVersion
  *
@@ -3128,6 +3155,9 @@ export type DraftedVersion = {
 };
 /**
  * EmailBatchCounts
+ *
+ * Rows by the status a reader sees. `draft` is drafts no live send covers
+ * yet; `queued` is drafts one does.
  */
 export type EmailBatchCounts = {
     /**
@@ -3196,6 +3226,10 @@ export type EmailBatchResponse = {
      * Draft Concurrency
      */
     draft_concurrency: number;
+    /**
+     * Draft Failures
+     */
+    draft_failures: Array<DraftFailure>;
     /**
      * Draft Gap Seconds
      */
@@ -3289,10 +3323,15 @@ export type EmailBatchResponse = {
      * Sent Today
      */
     sent_today: number;
+    skips: EmailBatchSkips;
     /**
      * Stale Redraftable
      */
     stale_redraftable: number;
+    /**
+     * Stale Sent
+     */
+    stale_sent: number;
     /**
      * Start At
      */
@@ -3319,6 +3358,25 @@ export type EmailBatchResponse = {
     timezone: string;
     window: TimeWindow | null;
 };
+/**
+ * EmailBatchSkips
+ *
+ * `counts.skipped`, by who decided it.
+ */
+export type EmailBatchSkips = {
+    /**
+     * Duplicate Recipient
+     */
+    duplicate_recipient: number;
+    /**
+     * Operator
+     */
+    operator: number;
+    /**
+     * Unfillable
+     */
+    unfillable: number;
+};
 /**
  * EmailRecipientInput
  *
@@ -3410,11 +3468,11 @@ export type EmailRecipientResponse = {
     /**
      * Skip Reason
      */
-    skip_reason: string | null;
+    skip_reason: 'operator' | 'duplicate_recipient' | 'unfillable' | null;
     /**
      * Status
      */
-    status: 'pending' | 'drafting' | 'draft' | 'draft_failed' | 'skipped' | 'queued' | 'sending' | 'sent' | 'send_failed' | 'canceled';
+    status: 'pending' | 'drafting' | 'draft' | 'draft_failed' | 'skipped' | 'sending' | 'sent' | 'send_failed' | 'queued' | 'canceled';
     /**
      * Task Run Id
      */
@@ -3437,19 +3495,20 @@ export type EmailRecipientResponse = {
  *
  * Where this send's rows are.
  *
- * ``total`` is what the send was created with and never changes — a send's row
- * set is immutable — so ``returned`` is what is left once every other bucket is
- * accounted for: the rows a cancel or a failure handed back as drafts.
+ * ``total`` is the rows a `selected` send was created with, and null for an
+ * `all` send, which cannot know it while drafting runs. ``queued`` and
+ * ``drafting`` are what it still covers — drafts ready to go, and rows still
+ * being written — so both are 0 once it has ended.
  */
 export type EmailSendCounts = {
     /**
-     * Queued
+     * Drafting
      */
-    queued: number;
+    drafting: number;
     /**
-     * Returned
+     * Queued
      */
-    returned: number;
+    queued: number;
     /**
      * Send Failed
      */
@@ -3469,7 +3528,7 @@ export type EmailSendCounts = {
     /**
      * Total
      */
-    total: number;
+    total: number | null;
 };
 /**
  * EmailSendResponse
@@ -3511,11 +3570,15 @@ export type EmailSendResponse = {
     /**
      * Next Send Reason
      */
-    next_send_reason: 'start' | 'window' | 'daily_cap' | 'retry' | 'gap' | null;
+    next_send_reason: 'start' | 'window' | 'daily_cap' | 'retry' | 'gap' | 'drafting' | null;
     /**
      * Reply To
      */
     reply_to: string | null;
+    /**
+     * Scope
+     */
+    scope: 'all' | 'selected';
     /**
      * Send Attempts
      */
@@ -3890,7 +3953,12 @@ export type HandoffTarget = {
  * Liveness of the API process itself.
  */
 export type HealthResponse = {
-    model_registry?: ModelRegistryHealth | null;
+    /**
+     * Model Registry
+     */
+    model_registry?: {
+        [key: string]: ModelRegistryHealth;
+    } | null;
     /**
      * Status
      */
@@ -5196,6 +5264,10 @@ export type LLMCatalogEntryResponse = {
      * Label
      */
     label: string | null;
+    /**
+     * Logo Url
+     */
+    logo_url: string | null;
     /**
      * Model
      */
@@ -5225,6 +5297,30 @@ export type LLMCatalogEntryResponse = {
     vision: boolean;
     [key: string]: unknown;
 };
+/**
+ * LLMModelSearchResponse
+ *
+ * One page of a searched provider's language models — never the whole
+ * registry.
+ *
+ * Ordered by real-world popularity when `q` is empty (OpenRouter ranks its own
+ * list by tokens processed, so the first screen is the models people actually
+ * run) and by match quality when it is not, popularity breaking the ties.
+ */
+export type LLMModelSearchResponse = {
+    /**
+     * Kind
+     */
+    kind: 'llm';
+    /**
+     * Models
+     */
+    models: Array<LLMCatalogEntryResponse>;
+    /**
+     * Next Cursor
+     */
+    next_cursor: string | null;
+};
 /**
  * LLMModelSpec
  */
@@ -5233,6 +5329,12 @@ export type LLMModelSpec = {
      * Builtin Tools
      */
     builtin_tools?: Array<BuiltinToolSpec>;
+    /**
+     * Hosts
+     *
+     * OpenRouter only: the hosts allowed to serve this model, from list_model_hosts; the fastest of them answers. Unset lets OpenRouter use any host.
+     */
+    hosts?: Array<string> | null;
     /**
      * Model
      */
@@ -5264,6 +5366,12 @@ export type LLMModelSpecOverride = {
      * Builtin Tools
      */
     builtin_tools?: Array<BuiltinToolSpec> | null;
+    /**
+     * Hosts
+     *
+     * OpenRouter only: the hosts allowed to serve this model, from list_model_hosts; the fastest of them answers. Unset lets OpenRouter use any host.
+     */
+    hosts?: Array<string> | null;
     /**
      * Model
      */
@@ -5365,6 +5473,12 @@ export type LLMSpec = {
      */
     builtin_tools?: Array<BuiltinToolSpec>;
     fallback?: LLMModelSpec | null;
+    /**
+     * Hosts
+     *
+     * OpenRouter only: the hosts allowed to serve this model, from list_model_hosts; the fastest of them answers. Unset lets OpenRouter use any host.
+     */
+    hosts?: Array<string> | null;
     /**
      * Model
      */
@@ -5397,6 +5511,12 @@ export type LLMSpecOverride = {
      */
     builtin_tools?: Array<BuiltinToolSpec> | null;
     fallback?: LLMModelSpecOverride | null;
+    /**
+     * Hosts
+     *
+     * OpenRouter only: the hosts allowed to serve this model, from list_model_hosts; the fastest of them answers. Unset lets OpenRouter use any host.
+     */
+    hosts?: Array<string> | null;
     /**
      * Model
      */
@@ -5545,6 +5665,63 @@ export type McpSelection = {
     integration_id?: string | null;
     mcp?: InlineMcpServer | null;
 };
+/**
+ * ModelHostResponse
+ *
+ * One endpoint that can serve an OpenRouter language model.
+ */
+export type ModelHostResponse = {
+    /**
+     * All Endpoints
+     */
+    all_endpoints: boolean;
+    /**
+     * Context Length
+     */
+    context_length: number | null;
+    /**
+     * Host
+     */
+    host: string;
+    /**
+     * Latency P50 Ms
+     */
+    latency_p50_ms: number | null;
+    /**
+     * Logo Url
+     */
+    logo_url: string | null;
+    /**
+     * Name
+     */
+    name: string;
+    pricing: LLMPricing;
+    /**
+     * Quantization
+     */
+    quantization: string | null;
+    /**
+     * Throughput P50
+     */
+    throughput_p50: number | null;
+    /**
+     * Uptime 30M
+     */
+    uptime_30m: number | null;
+};
+/**
+ * ModelHostsResponse
+ */
+export type ModelHostsResponse = {
+    /**
+     * Hosts
+     */
+    hosts: Array<ModelHostResponse>;
+    /**
+     * Model
+     */
+    model: string;
+};
 /**
  * ModelMetadata
  *
@@ -5564,7 +5741,7 @@ export type ModelMetadata = {
 /**
  * ModelRegistryHealth
  *
- * How fresh this process's searched-provider model list is.
+ * How fresh one kind of this process's searched-provider model list is.
  *
  * A silently stale registry is the one failure this design trades for
  * freshness — a refresh that keeps failing holds the last good snapshot
@@ -5586,25 +5763,6 @@ export type ModelRegistryHealth = {
      */
     models: number;
 };
-/**
- * ModelSearchResponse
- *
- * One page of a searched provider's models — never the whole registry.
- *
- * Ordered by real-world popularity when `q` is empty (OpenRouter ranks its own
- * list by tokens processed, so the first screen is the models people actually
- * run) and by match quality when it is not, popularity breaking the ties.
- */
-export type ModelSearchResponse = {
-    /**
-     * Models
-     */
-    models: Array<LLMCatalogEntryResponse>;
-    /**
-     * Next Cursor
-     */
-    next_cursor: string | null;
-};
 /**
  * NodeContentResponse
  */
@@ -5654,6 +5812,10 @@ export type NoiseCancellationCatalogEntryResponse = {
      * Label
      */
     label: string | null;
+    /**
+     * Logo Url
+     */
+    logo_url: string | null;
     /**
      * Model
      */
@@ -7132,11 +7294,10 @@ export type PatchEmailRecipientRequest = {
  *
  * Re-steer one send: its pacing, its hours, its ceiling, its start time.
  *
- * It never edits the sender, and it never edits the row set in either
- * direction. To change what a scheduled send contains, cancel it — every unsent
- * row comes back as a draft — and create another. A second way to move a row
- * out of a send would be a second state machine to keep correct for something
- * cancel already covers.
+ * Never its sender and never its scope — "re-steer the pacing, never the
+ * contents". Widening a send is another send; narrowing one has no defensible
+ * answer to "which rows does it keep?". To change what a send covers, cancel it
+ * — its unsent rows simply stay drafts — and create another.
  */
 export type PatchEmailSendRequest = {
     /**
@@ -7310,12 +7471,12 @@ export type PatchStreamConnectionRequest = {
 };
 /**
  * PatchTaskRequest
- *
- * The whole config, replaced. A task is one small object and a field-level
- * patch would only invite half-sent `output` lists.
  */
 export type PatchTaskRequest = {
-    config: TaskConfig;
+    /**
+     * Only the fields to change: the same shape as TaskConfig, every field optional.
+     */
+    config: TaskPatch;
 };
 /**
  * PatchTelephonyAccountRequest
@@ -7699,6 +7860,10 @@ export type ProviderEntryResponse = {
      * Logo Url
      */
     logo_url: string;
+    /**
+     * Searched Kinds
+     */
+    searched_kinds: Array<'llm' | 'stt'>;
 };
 /**
  * ProviderKeyResponse
@@ -7919,6 +8084,10 @@ export type RealtimeCatalogEntryResponse = {
      * Languages
      */
     languages: Array<LanguageOption>;
+    /**
+     * Logo Url
+     */
+    logo_url: string | null;
     /**
      * Model
      */
@@ -7945,6 +8114,10 @@ export type RealtimeCatalogEntryResponse = {
      * Speed Min
      */
     speed_min: number;
+    /**
+     * Supports Instruction Update
+     */
+    supports_instruction_update: boolean;
     /**
      * Supports Speed
      */
@@ -8326,11 +8499,10 @@ export type RecordingState = 'none' | 'available' | 'pending' | 'expired' | 'fai
  * Four selections, and they differ in what they REFUSE as much as in what they
  * move, because a redraft discards a draft the tenant has already paid for:
  *
- * - ``all`` — every row in the batch. Rows already sent or queued come back in
+ * - ``all`` — every row in the batch. Rows already sent or mid-send come back in
  * ``rejected``, by name, so a bulk press cannot quietly do less than it said.
  * - ``failed`` — rows whose drafting failed.
- * - ``not_sent`` — every row that has not left and is not about to, with
- * nothing rejected.
+ * - ``not_sent`` — every row that has not left, with nothing rejected.
  * - ``stale_version`` — rows drafted by a task version older than the one
  * published now. The selection that makes "watch the output, improve the
  * task, publish, redraft the rest" a workflow rather than a wish.
@@ -8559,6 +8731,10 @@ export type STTCatalogEntryResponse = {
      * Languages
      */
     languages: Array<LanguageOption>;
+    /**
+     * Logo Url
+     */
+    logo_url: string | null;
     /**
      * Model
      */
@@ -8583,6 +8759,26 @@ export type STTCatalogEntryResponse = {
     streaming: boolean;
     [key: string]: unknown;
 };
+/**
+ * STTModelSearchResponse
+ *
+ * One page of a searched provider's speech-to-text models, ordered as the
+ * provider lists them.
+ */
+export type STTModelSearchResponse = {
+    /**
+     * Kind
+     */
+    kind: 'stt';
+    /**
+     * Models
+     */
+    models: Array<STTCatalogEntryResponse>;
+    /**
+     * Next Cursor
+     */
+    next_cursor: string | null;
+};
 /**
  * STTModelSpec
  */
@@ -8643,6 +8839,10 @@ export type STTPriceLine = {
      * Provider
      */
     provider: string;
+    /**
+     * Provider Reported
+     */
+    provider_reported: boolean;
     rates: STTPricing | null;
 };
 /**
@@ -8716,6 +8916,10 @@ export type STTUsage = {
      * Provider
      */
     provider: string;
+    /**
+     * Reported Cost
+     */
+    reported_cost: string | null;
 };
 /**
  * STTUsageResponse
@@ -8826,7 +9030,7 @@ export type SelectRecipientsRequest = {
     /**
      * Selection
      *
-     * Every row this verb can act on: `draft` for skip, `skipped` for restore.
+     * Every row this verb can act on: drafts for skip, rows a person skipped for restore.
      */
     selection?: 'all_eligible' | null;
 };
@@ -9249,6 +9453,10 @@ export type TTSCatalogEntryResponse = {
      * Languages
      */
     languages: Array<LanguageOption>;
+    /**
+     * Logo Url
+     */
+    logo_url: string | null;
     /**
      * Model
      */
@@ -9683,6 +9891,89 @@ export type TaskOutputField = {
      */
     type?: 'string' | 'boolean' | 'integer' | 'number';
 };
+/**
+ * TaskPatch
+ *
+ * A partial TaskConfig: only the fields this call changes. Absent keeps the base value, an explicit null clears it, objects deep-merge and lists replace.
+ */
+export type TaskPatch = {
+    /**
+     * Finish Without Result Description
+     *
+     * Description of `finish_without_result`, the tool that abandons a task an agent entered. Narrow it if the task gives up too readily. Unused by a standalone run.
+     */
+    finish_without_result_description?: string | null;
+    /**
+     * Kb Ids
+     *
+     * Knowledge bases to read from: their outline goes into the prompt and pages are fetched on demand.
+     */
+    kb_ids?: Array<string> | null;
+    llm?: LLMSpecOverride | null;
+    /**
+     * Max Steps
+     *
+     * How many LLM -> tools -> LLM rounds a standalone run may take. A round, not a tool call: four tools in one reply cost one step. Entered by an agent, the calling call's own limit applies instead.
+     */
+    max_steps?: number | null;
+    /**
+     * Mcps
+     *
+     * MCP servers whose tools may be called — each named by the integration that holds its credential, or defined inline. Which of a named server's tools may be called is the integration's own `allowed_tools`, not this list.
+     */
+    mcps?: Array<McpSelection> | null;
+    /**
+     * Name
+     *
+     * Unique in the workspace.
+     */
+    name?: string | null;
+    on_enter?: ToolSelection | null;
+    on_exit?: ToolSelection | null;
+    on_user_turn_completed?: ToolSelection | null;
+    /**
+     * Output
+     *
+     * The typed value this task produces. The model is given a `submit_result` tool built from these fields and told that calling it is how the run finishes. Publishing needs at least one; a draft may be empty.
+     */
+    output?: Array<TaskOutputField> | null;
+    /**
+     * Prompt
+     *
+     * The system prompt. `{{vars.name}}` is substituted from the values the run was started with — or, entered by an agent, from the call's own values and the arguments the model supplied.
+     */
+    prompt?: string | null;
+    /**
+     * Submit Result Description
+     *
+     * Description of the generated `submit_result` tool - what the call is, where the output fields describe the values.
+     */
+    submit_result_description?: string | null;
+    /**
+     * Timeout Seconds
+     *
+     * How long this may take before it is abandoned. Entered by an agent it is the only bound on how long the caller is held, so keep it short on a voice agent.
+     */
+    timeout_seconds?: number | null;
+    /**
+     * Timezone
+     *
+     * The IANA timezone this clock runs on, e.g. 'Asia/Kolkata'. Set it and the prompt and tools can read {{system_vars.now}}, {{system_vars.date}} and {{system_vars.time}}. Required only if one of those is used.
+     */
+    timezone?: string | null;
+    /**
+     * Tools
+     *
+     * Tools the model may call. Publishing pins each one to the tool version live at that moment, so republishing a tool does not change this until it is published again.
+     */
+    tools?: Array<ToolSelection> | null;
+    /**
+     * Vars
+     *
+     * The inputs this task takes, read as {{vars.name}} in the prompt and in its tools. Declare only what the caller or the model must supply: anything the task can read for itself ({{userdata.*}}, {{system_vars.*}}) it should read in its prompt instead.
+     */
+    vars?: Array<VarDeclaration> | null;
+};
 /**
  * TaskResponse
  */
@@ -10773,7 +11064,10 @@ export type TurnPayload = {
  * UpdateAgentRequest
  */
 export type UpdateAgentRequest = {
-    config: AgentConfig;
+    /**
+     * Only the fields to change.
+     */
+    config: AgentOverride;
 };
 /**
  * UsageResponse
@@ -12813,6 +13107,10 @@ export type CatalogModelsSearchData = {
          * Cursor
          */
         cursor?: string;
+        /**
+         * Kind
+         */
+        kind?: 'llm' | 'stt';
     };
     url: '/v1/catalog/models';
 };
@@ -12833,11 +13131,50 @@ export type CatalogModelsSearchErrors = {
 export type CatalogModelsSearchError = CatalogModelsSearchErrors[keyof CatalogModelsSearchErrors];
 export type CatalogModelsSearchResults = {
     /**
+     * Response Catalog.Models.Search
+     *
      * Successful Response
      */
-    200: ModelSearchResponse;
+    200: ({
+        kind: 'llm';
+    } & LLMModelSearchResponse) | ({
+        kind: 'stt';
+    } & STTModelSearchResponse);
 };
 export type CatalogModelsSearchResult = CatalogModelsSearchResults[keyof CatalogModelsSearchResults];
+export type CatalogModelsHostsData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Model
+         */
+        model: string;
+    };
+    url: '/v1/catalog/models/hosts';
+};
+export type CatalogModelsHostsErrors = {
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: 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 CatalogModelsHostsError = CatalogModelsHostsErrors[keyof CatalogModelsHostsErrors];
+export type CatalogModelsHostsResults = {
+    /**
+     * Successful Response
+     */
+    200: ModelHostsResponse;
+};
+export type CatalogModelsHostsResult = CatalogModelsHostsResults[keyof CatalogModelsHostsResults];
 export type CatalogVoicesListData = {
     body?: never;
     path?: never;