@squidcloud/twilio-client 1.0.504 → 1.0.506

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -1 +1 @@
1
- (()=>{"use strict";const e={d:(t,i)=>{if(Array.isArray(i))for(var n=0;n<i.length;){var r=i[n++],o=i[n++];e.o(t,r)?0===o&&n++:0===o?Object.defineProperty(t,r,{enumerable:!0,value:i[n++]}):Object.defineProperty(t,r,{enumerable:!0,get:o})}else for(var r in i)e.o(i,r)&&!e.o(t,r)&&Object.defineProperty(t,r,{enumerable:!0,get:i[r]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}};let t={};e.r(t),e.d(t,{SMS_EVENT_TYPE:()=>i,SquidTwilioClient:()=>o,VOICE_ENGINES:()=>r,VOICE_MODES:()=>n});const i="twilio-sms-event",n=["relay","gather"],r=["twilio","elevenlabs","openai"];class o{constructor(e,t){this.squid=e,this.integrationId=t}async sendSms(e){return this.squid.executeFunction("sendSms",{...e,integrationId:this.integrationId})}async placeCall(e){return this.squid.executeFunction("placeCall",{...e,integrationId:this.integrationId})}async getCallTranscript(e){return this.squid.executeFunction("getCallTranscript",{...e,integrationId:this.integrationId})}async listPhoneNumbers(){return this.squid.executeFunction("twilioListPhoneNumbers",{integrationId:this.integrationId})}async provisionAgent(e){return this.squid.executeFunction("twilioProvisionAgent",{...e,integrationId:this.integrationId})}async createCustomerVoiceToken(e){return this.squid.executeFunction("twilioCreateCustomerVoiceToken",{...e,integrationId:this.integrationId})}async getCustomerVoiceCall(e){return this.squid.executeFunction("twilioGetCustomerVoiceCall",{...e,integrationId:this.integrationId})}async setHumanHandoff(e){return this.squid.executeFunction("twilioSetHumanHandoff",{...e,integrationId:this.integrationId})}}const s=exports;for(var a in t)s[a]=t[a];t.__esModule&&Object.defineProperty(s,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";const t={d:(e,i)=>{for(var n in i)t.o(i,n)&&!t.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:i[n]})},o:(t,e)=>Object.prototype.hasOwnProperty.call(t,e),r:t=>{Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})}};let e={};t.r(e),t.d(e,{SMS_EVENT_TYPE:()=>i,SquidTwilioClient:()=>r,VOICE_ENGINES:()=>o,VOICE_MODES:()=>n});const i="twilio-sms-event",n=["relay","gather"],o=["twilio","elevenlabs","openai"];class r{constructor(t,e){this.squid=t,this.integrationId=e}async sendSms(t){return this.squid.executeFunction("sendSms",{...t,integrationId:this.integrationId})}async placeCall(t){return this.squid.executeFunction("placeCall",{...t,integrationId:this.integrationId})}async getCallTranscript(t){return this.squid.executeFunction("getCallTranscript",{...t,integrationId:this.integrationId})}async listPhoneNumbers(){return this.squid.executeFunction("twilioListPhoneNumbers",{integrationId:this.integrationId})}async provisionAgent(t){return this.squid.executeFunction("twilioProvisionAgent",{...t,integrationId:this.integrationId})}async createCustomerVoiceToken(t){return this.squid.executeFunction("twilioCreateCustomerVoiceToken",{...t,integrationId:this.integrationId})}async getCustomerVoiceCall(t){return this.squid.executeFunction("twilioGetCustomerVoiceCall",{...t,integrationId:this.integrationId})}async setHumanHandoff(t){return this.squid.executeFunction("twilioSetHumanHandoff",{...t,integrationId:this.integrationId})}}const s=exports;for(var a in e)s[a]=e[a];e.__esModule&&Object.defineProperty(s,"__esModule",{value:!0})})();
@@ -422,16 +422,29 @@ export interface IntegrationModelSpec {
422
422
  */
423
423
  export type AiChatModelSelection = AiChatModelName | IntegrationModelSpec;
424
424
  /**
425
- * Lets a routing model pick which of several vendor models answers an `ask` or `chat` request. The routing model
426
- * sees the question, the agent's instructions and a card per candidate (price, tier, reasoning,
427
- * context window) and names the one that should answer; that model then serves the request.
425
+ * How demanding a routing model rated a question: `simple` goes to the first step of the routing ladder, `complex`
426
+ * to the last, `moderate` to the middle one.
427
+ * @category AI
428
+ */
429
+ export type AiModelRoutingLevel = 'simple' | 'moderate' | 'complex';
430
+ /**
431
+ * Lets a routing model pick which model of a ladder answers an `ask` or `chat` request. The routing model rates
432
+ * how demanding the question is, given the agent's instructions, and the ladder step for that rating serves it.
428
433
  * @category AI
429
434
  */
430
435
  export interface AiModelRoutingOptions {
431
- /** The vendor models the routing model chooses from; at least two, no duplicates. */
432
- models: VendorAiChatModelName[];
433
- /** The vendor model that makes the choice. */
436
+ /**
437
+ * The ladder of vendor models, cheapest first: two or three, no duplicates, each run at its default effort.
438
+ * Omitted, the platform's fast, medium and capable chat models form the ladder, at low, default and high effort.
439
+ */
440
+ models?: VendorAiChatModelName[];
441
+ /** The vendor model that rates the question. */
434
442
  routingModel: VendorAiChatModelName;
443
+ /**
444
+ * How to rate questions, in plain language: replaces the default rule, which takes the lower of two
445
+ * levels a question sits between. Up to 2000 characters.
446
+ */
447
+ instructions?: string;
435
448
  }
436
449
  /**
437
450
  * The model of an `ask` or `chat` request: a concrete model, or a set of models a routing model chooses from.
@@ -458,10 +471,19 @@ export type AiChatRequestOptions = Omit<AllAiAgentChatOptions, 'model'> & {
458
471
  * @category AI
459
472
  */
460
473
  export interface AiModelRoutingResult {
461
- /** The model the routing model chose and the request was sent to. A `backupModel` may still have served it. */
462
- model: VendorAiChatModelName;
463
- /** The model that made the choice. */
474
+ /** The ladder model the request was sent to. A `backupModel` may still have served it. */
475
+ model: AiChatModelName;
476
+ /**
477
+ * The reasoning effort the chosen model ran at: its ladder step's effort, or the request's or agent's
478
+ * effort resolved to a level the model accepts when one was set. Undefined is the model's default.
479
+ */
480
+ reasoningEffort?: AiReasoningEffort;
481
+ /** The model that rated the question. */
464
482
  routingModel: VendorAiChatModelName;
483
+ /** How demanding the routing model rated the question. */
484
+ level: AiModelRoutingLevel;
485
+ /** The routing model's one-line justification of the rating. */
486
+ reason: string;
465
487
  /** Input tokens the routing call consumed. */
466
488
  inputTokens: number;
467
489
  /** Output tokens the routing call generated. */
@@ -517,8 +539,8 @@ export interface BaseAiChatOptions {
517
539
  */
518
540
  maxTokens?: number;
519
541
  /**
520
- * The maximum number of tokens the model should output.
521
- * Passed directly to the AI model. Can be used to control the output verbosity.
542
+ * The maximum number of tokens the model should output. Can be used to control the output verbosity.
543
+ * For a model from an AI connector, the model's configured max output tokens is the ceiling.
522
544
  */
523
545
  maxOutputTokens?: number;
524
546
  /** The context ID to use for the request. If not provided, the agent's default context will be used. */
@@ -701,17 +723,16 @@ export interface BaseAiChatOptions {
701
723
  */
702
724
  verbosity?: AiVerbosityLevel;
703
725
  /**
704
- * Enable LLMs built-in code interpreter for executing Python code.
726
+ * Enables a code interpreter for executing Python code.
705
727
  * - 'none': Code interpreter is disabled (default).
706
- * - 'llm': Use LLM's native code interpreter to run Python code.
707
- *
708
- * Note: Only supported by OpenAI, Anthropic and Gemini models. Ignored for other providers.
728
+ * - 'llm': The model runs Python in Squid's sandbox through a tool call. Requires a model that supports tool calling.
709
729
  */
710
730
  useCodeInterpreter?: 'none' | 'llm';
711
731
  /**
712
732
  * File IDs to include in the chat context.
713
733
  * These are IDs returned from the AI provider's Files API after uploading files.
714
- * Files are attached to the conversation and can be read/analyzed by the AI.
734
+ * Files are attached to the conversation and can be read/analyzed by the AI. With `useCodeInterpreter: 'llm'`,
735
+ * the files are given to the code interpreter instead.
715
736
  */
716
737
  fileIds?: string[];
717
738
  /**
@@ -1161,11 +1182,12 @@ export interface UpsertContextStatusSuccess extends BaseUpsertContextStatus {
1161
1182
  }
1162
1183
  /**
1163
1184
  * Names an upsert failure; `DUPLICATE_CONTENT` identifies existing content when contextId is omitted.
1164
- * `CONTENT_IN_FLIGHT`, `EMBEDDING_FAILED`, `EXTRACTION_TIMED_OUT`, `PROVIDER_ACCESS_DENIED`, and
1165
- * `SOURCE_UNREACHABLE` may succeed on retry. Document faults carry `retryable: false` because the same bytes fail again.
1185
+ * `CONTENT_IN_FLIGHT`, `EMBEDDED_CHILDREN_NOT_RECONCILED`, `EMBEDDING_FAILED`, `EXTRACTION_TIMED_OUT`,
1186
+ * `PROVIDER_ACCESS_DENIED`, and `SOURCE_UNREACHABLE` may succeed on retry. Document faults carry `retryable: false`
1187
+ * because the same bytes fail again.
1166
1188
  * @category AI
1167
1189
  */
1168
- export type UpsertContextErrorCode = 'CONTENT_IN_FLIGHT' | 'CONTENT_TOO_LARGE' | 'DUPLICATE_CONTENT' | 'EMBEDDING_FAILED' | 'ENCRYPTED_DOCUMENT' | 'EXTRACTION_TIMED_OUT' | 'IMAGE_OVER_PROVIDER_LIMIT' | 'NO_EMBEDDABLE_CONTENT' | 'PROVIDER_ACCESS_DENIED' | 'SOURCE_OVER_PROVIDER_LIMIT' | 'SOURCE_UNREACHABLE' | 'UNREADABLE_DOCUMENT' | 'UNREADABLE_WORKBOOK' | 'UNSUPPORTED_FILE_TYPE';
1190
+ export type UpsertContextErrorCode = 'CONTENT_IN_FLIGHT' | 'CONTENT_TOO_LARGE' | 'DUPLICATE_CONTENT' | 'EMBEDDED_CHILDREN_NOT_RECONCILED' | 'EMBEDDING_FAILED' | 'ENCRYPTED_DOCUMENT' | 'EXTRACTION_TIMED_OUT' | 'IMAGE_OVER_PROVIDER_LIMIT' | 'NO_EMBEDDABLE_CONTENT' | 'PROVIDER_ACCESS_DENIED' | 'SOURCE_OVER_PROVIDER_LIMIT' | 'SOURCE_UNREACHABLE' | 'UNREADABLE_DOCUMENT' | 'UNREADABLE_WORKBOOK' | 'UNSUPPORTED_FILE_TYPE';
1169
1191
  /**
1170
1192
  * The existing context a `DUPLICATE_CONTENT` rejection points at — where the byte-identical original
1171
1193
  * already lives.
@@ -1474,6 +1496,11 @@ export type AiSessionContext = {
1474
1496
  * takes precedence over it.
1475
1497
  */
1476
1498
  timeoutMs?: number;
1499
+ /**
1500
+ * The root request's `metricAnnotations`. Nested AI operations (e.g. AI-query stages spawned by a tool
1501
+ * call) report their model usage under them, so it adds up with the agent's own.
1502
+ */
1503
+ metricAnnotations?: Record<string, string>;
1477
1504
  };
1478
1505
  /**
1479
1506
  * API request to delete an AI agent
@@ -38,15 +38,15 @@ export type AiFileProviderType = (typeof AI_FILE_PROVIDER_TYPES)[number];
38
38
  */
39
39
  export declare function isFileCapableProviderType(type: AiProviderType): type is AiFileProviderType;
40
40
  /**
41
- * The AI providers whose chat provider implements the code interpreter. Declared like
42
- * {@link AI_FILE_PROVIDER_TYPES}, so a provider that gains the interpreter is added here and nowhere else.
41
+ * Providers with a vendor-hosted code interpreter; unused by Squid.
42
+ * @deprecated The code interpreter runs in Squid's sandbox and works with any model that supports tool calling.
43
43
  */
44
44
  export declare const AI_CODE_INTERPRETER_PROVIDER_TYPES: readonly ["openai", "anthropic", "gemini"];
45
45
  /**
46
46
  * Public OpenAI chat model names (active models only).
47
47
  * @category AI
48
48
  */
49
- export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol"];
49
+ export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra"];
50
50
  /**
51
51
  * Public Gemini chat model names (active models only).
52
52
  * @category AI
@@ -66,7 +66,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5", "cl
66
66
  * The supported AI model names.
67
67
  * @category AI
68
68
  */
69
- export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "claude-fable-5", "claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-argon", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
69
+ export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra", "claude-fable-5", "claude-fable-5-1", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-argon", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
70
70
  /** Checks if the given model name is a global AI chat model name. */
71
71
  export declare function isVendorAiChatModelName(modelName: unknown): modelName is VendorAiChatModelName;
72
72
  /**
@@ -357,7 +357,7 @@ export interface AiKnowledgeBaseChatOptions {
357
357
  includeReference?: boolean;
358
358
  /** Include metadata in the context */
359
359
  includeMetadata?: boolean;
360
- /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
360
+ /** Which provider's reranker to use for reranking the context. Defaults to the deployment's default reranker. */
361
361
  rerankProvider?: AiRerankProvider;
362
362
  /**
363
363
  * Minimum reranker relevance score a chunk must reach to stay once at least 10 chunks are already kept.
@@ -704,6 +704,12 @@ export declare const BULK_INGESTION_MAX_MULTIPART_FILE_BYTES: number;
704
704
  * @category AI
705
705
  */
706
706
  export declare const MAX_UPLOAD_FILE_BYTES: number;
707
+ /**
708
+ * Largest OneNote section (`.one`) a knowledge base ingests, on either lane. A section carries its attachments,
709
+ * each indexed as a context of its own, so it may exceed {@link MAX_UPLOAD_FILE_BYTES}.
710
+ * @category AI
711
+ */
712
+ export declare const MAX_ONENOTE_SECTION_BYTES: number;
707
713
  /**
708
714
  * @category AI
709
715
  */
@@ -739,7 +745,7 @@ export interface AiKnowledgeBaseSearchOptions {
739
745
  prompt: string;
740
746
  /** The maximum number of results to return */
741
747
  limit?: number;
742
- /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
748
+ /** Which provider's reranker to use for reranking the context. Defaults to the deployment's default reranker. */
743
749
  rerankProvider?: AiRerankProvider;
744
750
  /**
745
751
  * Minimum reranker relevance score a chunk must reach to stay once at least 10 chunks are already kept.
@@ -2094,7 +2100,8 @@ export interface BulkIngestionJobStatusCounts {
2094
2100
  /**
2095
2101
  * Machine-readable class of a bulk-ingestion file failure, for outcomes to treat differently from real
2096
2102
  * failures. Terminal — reported with `retryable: false` — are `'CONTENT_TOO_LARGE'` (past the per-context
2097
- * ceiling), `'ENCRYPTED_DOCUMENT'`, `'IMAGE_OVER_PROVIDER_LIMIT'` (the OCR provider refuses an image in the
2103
+ * ceiling), `'ENCRYPTED_DOCUMENT'`, `'EXTRACTION_ABANDONED'` (each worker that took the file up died before
2104
+ * finishing it), `'IMAGE_OVER_PROVIDER_LIMIT'` (the OCR provider refuses an image in the
2098
2105
  * document as too large, even with the pages that draw it redrawn smaller), `'NO_EMBEDDABLE_CONTENT'`,
2099
2106
  * `'SOURCE_OVER_PROVIDER_LIMIT'` (the bytes exceed what the extraction provider accepts),
2100
2107
  * `'UNREADABLE_DOCUMENT'` (a PDF or Office file whose bytes cannot be opened as one), `'UNREADABLE_WORKBOOK'`
@@ -2108,7 +2115,7 @@ export interface BulkIngestionJobStatusCounts {
2108
2115
  * alone exceeds the ceiling fails this way in every job.
2109
2116
  * @category AI
2110
2117
  */
2111
- export type BulkIngestionFileErrorCode = 'CONTENT_TOO_LARGE' | 'DUPLICATE_CONTENT' | 'ENCRYPTED_DOCUMENT' | 'EXTRACTION_TIMED_OUT' | 'IMAGE_OVER_PROVIDER_LIMIT' | 'JOB_FULL' | 'NO_EMBEDDABLE_CONTENT' | 'PROVIDER_ACCESS_DENIED' | 'SOURCE_OVER_PROVIDER_LIMIT' | 'SOURCE_UNREACHABLE' | 'UNREADABLE_DOCUMENT' | 'UNREADABLE_WORKBOOK' | 'UNSUPPORTED_FILE_TYPE';
2118
+ export type BulkIngestionFileErrorCode = 'CONTENT_TOO_LARGE' | 'DUPLICATE_CONTENT' | 'ENCRYPTED_DOCUMENT' | 'EXTRACTION_ABANDONED' | 'EXTRACTION_TIMED_OUT' | 'IMAGE_OVER_PROVIDER_LIMIT' | 'JOB_FULL' | 'NO_EMBEDDABLE_CONTENT' | 'PROVIDER_ACCESS_DENIED' | 'SOURCE_OVER_PROVIDER_LIMIT' | 'SOURCE_UNREACHABLE' | 'UNREADABLE_DOCUMENT' | 'UNREADABLE_WORKBOOK' | 'UNSUPPORTED_FILE_TYPE';
2112
2119
  /**
2113
2120
  * Per-file/per-context status within a bulk-ingestion job, so a caller can see which file finished,
2114
2121
  * which is still processing, and why a file failed.
@@ -1,10 +1,10 @@
1
1
  import { IntegrationId } from './communication.public-types';
2
2
  /** List of all integration types supported by Squid. */
3
- export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "bitbucket", "built_in_azure_blob", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "azure-entra-external-id", "azure-entra-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "generic_site_ingester", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "twilio", "elevenlabs", "openai_voice", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "bedrock_embedding", "sharepoint", "vertex"];
3
+ export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "bitbucket", "built_in_azure_blob", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "azure-entra-external-id", "azure-entra-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "generic_site_ingester", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "salesforce_db", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "twilio", "elevenlabs", "openai_voice", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "bedrock_embedding", "sharepoint", "vertex"];
4
4
  /**
5
5
  * @category Database
6
6
  */
7
- export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "dynamodb", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "snowflake", "elasticsearch", "legend"];
7
+ export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "dynamodb", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "snowflake", "elasticsearch", "legend", "salesforce_db"];
8
8
  /**
9
9
  * @category Auth
10
10
  */
@@ -43,6 +43,11 @@ export interface ResolveJobRequest {
43
43
  /** The error message, present when status is 'failed'. */
44
44
  error?: string;
45
45
  }
46
+ /** Represents a request to cancel a running server-executed job. */
47
+ export interface CancelJobRequest {
48
+ /** The unique identifier of the job to cancel. */
49
+ jobId: JobId;
50
+ }
46
51
  /**
47
52
  * Represents a keep-alive request signalling that the client still owns the listed active jobs.
48
53
  */
@@ -72,8 +77,9 @@ export interface AsyncJob<T = any> {
72
77
  * - 'in_progress': The job is currently being processed.
73
78
  * - 'completed': The job has finished successfully.
74
79
  * - 'failed': The job has failed.
80
+ * - 'cancelled': The job was stopped by a cancel request.
75
81
  */
76
- status: 'in_progress' | 'completed' | 'failed';
82
+ status: 'in_progress' | 'completed' | 'failed' | 'cancelled';
77
83
  /**
78
84
  * The result of the job, if available.
79
85
  * This is of type `T` and is optional.
@@ -89,7 +95,14 @@ export interface AsyncJob<T = any> {
89
95
  * failure kind (e.g. `'AI_PROVIDER_ERROR'`) without parsing {@link error}.
90
96
  */
91
97
  errorType?: string;
98
+ /**
99
+ * Whether the job can be stopped with a cancel request. Providers that do not honor the abort
100
+ * signal keep running until their current call ends, so cancellation is not always immediate.
101
+ */
102
+ cancellable?: boolean;
92
103
  }
104
+ /** The {@link JobError.errorType} of an error thrown for a job stopped by a cancel request. */
105
+ export declare const JOB_CANCELLED_ERROR_TYPE = "JOB_CANCELLED";
93
106
  /**
94
107
  * An `Error` carrying a machine-readable {@link errorType}, thrown by `JobClient.awaitJob` when a
95
108
  * failed job's {@link AsyncJob.errorType} is set. Lets a caller branch on the failure kind (e.g.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/twilio-client",
3
- "version": "1.0.504",
3
+ "version": "1.0.506",
4
4
  "description": "Squid Twilio Client",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/connectors/twilio/twilio-client/src/index.d.ts",
@@ -17,7 +17,7 @@
17
17
  "author": "",
18
18
  "license": "ISC",
19
19
  "dependencies": {
20
- "@squidcloud/client": "^1.0.504"
20
+ "@squidcloud/client": "^1.0.506"
21
21
  },
22
22
  "engines": {
23
23
  "node": ">=20.0.0"