telnyx 7.20.0 → 7.22.0

package/src/resources/ai/openai/chat.ts

@@ -75,22 +75,6 @@ export interface ChatCreateCompletionParams {
    */
   frequency_penalty?: number;
 
-  /**
-   * If specified, the output will be exactly one of the choices.
-   */
-  guided_choice?: Array<string>;
-
-  /**
-   * Must be a valid JSON schema. If specified, the output will follow the JSON
-   * schema.
-   */
-  guided_json?: { [key: string]: unknown };
-
-  /**
-   * If specified, the output will follow the regex pattern.
-   */
-  guided_regex?: string;
-
   /**
    * This is used with `use_beam_search` to prefer shorter or longer completions.
    */
@@ -115,6 +99,15 @@ export interface ChatCreateCompletionParams {
    */
   min_p?: number;
 
+  /**
+   * How strictly `region` is applied. `preferred` (the default when `region` is set)
+   * tries that region first and falls back to another when the model cannot be
+   * served there, so a request that would have succeeded still succeeds. `strict`
+   * pins the request: it is served from that region or it fails with a 422, never
+   * redirected to another region. Requires `region`.
+   */
+  mode?: 'preferred' | 'strict';
+
   /**
    * The language model to chat with.
    */
@@ -140,10 +133,24 @@ export interface ChatCreateCompletionParams {
   reasoning_effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max';
 
   /**
-   * Use this is you want to guarantee a JSON output without defining a schema. For
-   * control over the schema, use `guided_json`.
+   * Optional data-residency region the request should be served from, using the same
+   * vocabulary as your account's Data Locality setting. Behavior depends on `mode`.
+   * Supported for Telnyx-hosted models only: a request routed to an external
+   * provider never passes through Telnyx model routing, so a region cannot be
+   * enforced for it. Omit for today's latency-based routing.
+   */
+  region?: 'USA' | 'EU' | 'AUS' | 'UAE';
+
+  /**
+   * Controls the format of the model output. `json_object` guarantees valid JSON
+   * output without defining a schema; `json_schema` constrains the output to the
+   * JSON schema you supply via the `json_schema` property and is the supported way
+   * to get guaranteed structured output on Telnyx-hosted models.
    */
-  response_format?: ChatCreateCompletionParams.ResponseFormat;
+  response_format?:
+    | ChatCreateCompletionParams.ResponseFormatText
+    | ChatCreateCompletionParams.ResponseFormatJsonObject
+    | ChatCreateCompletionParams.ResponseFormatJsonSchemaParam;
 
   /**
    * If specified, the system will make a best effort to sample deterministically,
@@ -227,11 +234,68 @@ export namespace ChatCreateCompletionParams {
   }
 
   /**
-   * Use this is you want to guarantee a JSON output without defining a schema. For
-   * control over the schema, use `guided_json`.
+   * Plain text output.
    */
-  export interface ResponseFormat {
-    type: 'text' | 'json_object';
+  export interface ResponseFormatText {
+    type: 'text';
+  }
+
+  /**
+   * JSON mode: the model output is valid JSON, without a schema.
+   */
+  export interface ResponseFormatJsonObject {
+    type: 'json_object';
+  }
+
+  /**
+   * Structured output: the model output is constrained to the JSON schema supplied
+   * in `json_schema`.
+   */
+  export interface ResponseFormatJsonSchemaParam {
+    /**
+     * The JSON schema configuration, required when `type` is `json_schema`. Matches
+     * the
+     * [OpenAI structured outputs](https://platform.openai.com/docs/guides/structured-outputs)
+     * `json_schema` response format.
+     */
+    json_schema: ResponseFormatJsonSchemaParam.JsonSchema;
+
+    type: 'json_schema';
+  }
+
+  export namespace ResponseFormatJsonSchemaParam {
+    /**
+     * The JSON schema configuration, required when `type` is `json_schema`. Matches
+     * the
+     * [OpenAI structured outputs](https://platform.openai.com/docs/guides/structured-outputs)
+     * `json_schema` response format.
+     */
+    export interface JsonSchema {
+      /**
+       * The name of the response format. Used for clarity only.
+       */
+      name: string;
+
+      /**
+       * A description of what the response format is for, typically used to guide the
+       * model.
+       */
+      description?: string;
+
+      /**
+       * The JSON schema the model output must conform to. A valid
+       * [JSON Schema](https://json-schema.org) object, e.g. a Pydantic
+       * `model_json_schema()` export.
+       */
+      schema?: { [key: string]: unknown };
+
+      /**
+       * Enables strict schema adherence when supported by the model. If the generated
+       * output does not match the provided schema, the request fails instead of
+       * returning non-conformant output.
+       */
+      strict?: boolean;
+    }
   }
 
   export interface Function {

package/src/resources/ai/openai/openai.ts

@@ -121,6 +121,15 @@ export interface OpenAICreateResponseParams {
    */
   instructions?: string;
 
+  /**
+   * How strictly `region` is applied. `preferred` (the default when `region` is set)
+   * tries that region first and falls back to another when the model cannot be
+   * served there, so a request that would have succeeded still succeeds. `strict`
+   * pins the request: it is served from that region or it fails with a 422, never
+   * redirected to another region. Requires `region`.
+   */
+  mode?: 'preferred' | 'strict';
+
   /**
    * Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or
    * another model available from the Telnyx OpenAI-compatible models endpoint.
@@ -129,6 +138,15 @@ export interface OpenAICreateResponseParams {
 
   reasoning?: OpenAICreateResponseParams.Reasoning;
 
+  /**
+   * Optional data-residency region the request should be served from, using the same
+   * vocabulary as your account's Data Locality setting. Behavior depends on `mode`.
+   * Supported for Telnyx-hosted models only: a request routed to an external
+   * provider never passes through Telnyx model routing, so a region cannot be
+   * enforced for it. Omit for today's latency-based routing.
+   */
+  region?: 'USA' | 'EU' | 'AUS' | 'UAE';
+
   /**
    * The service tier to use for this request. Supported values vary by model; use
    * `GET /v2/ai/openai/models` and inspect the model's `service_tiers` field. If

package/src/resources/compute/compute.ts

@@ -0,0 +1,37 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as FuncsAPI from './funcs';
+import {
+  FuncRetrieveLogsParams,
+  FuncRetrieveLogsResponse,
+  FuncRetrieveMetricAggregatesParams,
+  FuncRetrieveMetricAggregatesResponse,
+  FuncRetrieveRevisionsParams,
+  FuncRetrieveRevisionsResponse,
+  FuncRetrieveShipInspectionResponse,
+  Funcs,
+  FunctionsObservabilityPaginationMeta,
+  LogsMeta,
+} from './funcs';
+
+export class Compute extends APIResource {
+  funcs: FuncsAPI.Funcs = new FuncsAPI.Funcs(this._client);
+}
+
+Compute.Funcs = Funcs;
+
+export declare namespace Compute {
+  export {
+    Funcs as Funcs,
+    type FunctionsObservabilityPaginationMeta as FunctionsObservabilityPaginationMeta,
+    type LogsMeta as LogsMeta,
+    type FuncRetrieveLogsResponse as FuncRetrieveLogsResponse,
+    type FuncRetrieveMetricAggregatesResponse as FuncRetrieveMetricAggregatesResponse,
+    type FuncRetrieveRevisionsResponse as FuncRetrieveRevisionsResponse,
+    type FuncRetrieveShipInspectionResponse as FuncRetrieveShipInspectionResponse,
+    type FuncRetrieveLogsParams as FuncRetrieveLogsParams,
+    type FuncRetrieveMetricAggregatesParams as FuncRetrieveMetricAggregatesParams,
+    type FuncRetrieveRevisionsParams as FuncRetrieveRevisionsParams,
+  };
+}

package/src/resources/compute/funcs.ts

@@ -0,0 +1,298 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as FuncsAPI from './funcs';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Funcs extends APIResource {
+  /**
+   * Returns logs oldest first. `type=runtime` (default) returns function
+   * stdout/stderr. `type=invocations` returns one platform-generated record per HTTP
+   * request served.
+   */
+  retrieveLogs(
+    id: string,
+    query: FuncRetrieveLogsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FuncRetrieveLogsResponse> {
+    return this._client.get(path`/compute/funcs/${id}/logs`, { query, ...options });
+  }
+
+  /**
+   * Returns aggregate request, latency, CPU, memory, and resource-limit metrics for
+   * a function over the requested window.
+   */
+  retrieveMetricAggregates(
+    id: string,
+    query: FuncRetrieveMetricAggregatesParams,
+    options?: RequestOptions,
+  ): APIPromise<FuncRetrieveMetricAggregatesResponse> {
+    return this._client.get(path`/compute/funcs/${id}/metric_aggregates`, { query, ...options });
+  }
+
+  /**
+   * Lists a function's ship history newest first, including per-ship failure stage
+   * and reason when recorded.
+   */
+  retrieveRevisions(
+    id: string,
+    query: FuncRetrieveRevisionsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FuncRetrieveRevisionsResponse> {
+    return this._client.get(path`/compute/funcs/${id}/revisions`, { query, ...options });
+  }
+
+  /**
+   * Returns the latest ship outcome. The stage is `none` on success, `pending` while
+   * building, or a failure stage such as `build`, `platform`, `pre_build`, `deploy`,
+   * or `security_review`. This stage-neutral customer-facing path is an alias over
+   * the same inspection resource as `build_log_inspection`.
+   */
+  retrieveShipInspection(
+    id: string,
+    options?: RequestOptions,
+  ): APIPromise<FuncRetrieveShipInspectionResponse> {
+    return this._client.get(path`/compute/funcs/${id}/ship_inspection`, options);
+  }
+}
+
+export interface FunctionsObservabilityPaginationMeta {
+  page_number?: number;
+
+  page_size?: number;
+
+  total_pages?: number;
+
+  total_results?: number;
+}
+
+export interface LogsMeta {
+  has_more?: boolean;
+
+  partial?: boolean;
+}
+
+export type FuncRetrieveLogsResponse =
+  | FuncRetrieveLogsResponse.FuncRuntimeLogsResponse
+  | FuncRetrieveLogsResponse.FuncInvocationLogsResponse;
+
+export namespace FuncRetrieveLogsResponse {
+  export interface FuncRuntimeLogsResponse {
+    data?: Array<FuncRuntimeLogsResponse.Data>;
+
+    meta?: FuncsAPI.LogsMeta;
+  }
+
+  export namespace FuncRuntimeLogsResponse {
+    export interface Data {
+      level?: string;
+
+      message?: string;
+
+      record_type?: 'compute_func_runtime_log';
+
+      timestamp?: string;
+    }
+  }
+
+  export interface FuncInvocationLogsResponse {
+    data?: Array<FuncInvocationLogsResponse.Data>;
+
+    meta?: FuncsAPI.LogsMeta;
+  }
+
+  export namespace FuncInvocationLogsResponse {
+    export interface Data {
+      duration_ms?: number;
+
+      method?: string;
+
+      path?: string;
+
+      record_type?: 'compute_func_invocation_log';
+
+      region?: string;
+
+      request_size_bytes?: number;
+
+      response_size_bytes?: number;
+
+      status_code?: number;
+
+      timestamp?: string;
+    }
+  }
+}
+
+export interface FuncRetrieveMetricAggregatesResponse {
+  data?: Array<FuncRetrieveMetricAggregatesResponse.Data>;
+
+  meta?: FunctionsObservabilityPaginationMeta;
+}
+
+export namespace FuncRetrieveMetricAggregatesResponse {
+  export interface Data {
+    cpu_used_cores_avg?: number | null;
+
+    cpu_used_cores_max?: number | null;
+
+    end_time?: string;
+
+    function_id?: string;
+
+    function_name?: string;
+
+    memory_used_bytes_avg?: number | null;
+
+    memory_used_bytes_max?: number | null;
+
+    product?: string;
+
+    record_type?: string;
+
+    request_client_error_rate?: number | null;
+
+    request_count?: number | null;
+
+    request_error_rate?: number | null;
+
+    request_latency_avg_ms?: number | null;
+
+    request_latency_p50_ms?: number | null;
+
+    request_latency_p95_ms?: number | null;
+
+    request_latency_p99_ms?: number | null;
+
+    request_success_rate?: number | null;
+
+    start_time?: string;
+  }
+}
+
+export interface FuncRetrieveRevisionsResponse {
+  data?: Array<FuncRetrieveRevisionsResponse.Data>;
+
+  meta?: FunctionsObservabilityPaginationMeta;
+}
+
+export namespace FuncRetrieveRevisionsResponse {
+  export interface Data {
+    active?: boolean;
+
+    build_ok_at?: string;
+
+    build_status?: string;
+
+    commit_sha?: string;
+
+    deploy_status?: string;
+
+    failure_reason?: string;
+
+    failure_stage?: string;
+
+    image?: string;
+
+    record_type?: string;
+
+    revision_id?: string;
+
+    shipped_at?: string;
+
+    shipped_by?: string;
+  }
+}
+
+export interface FuncRetrieveShipInspectionResponse {
+  data?: FuncRetrieveShipInspectionResponse.Data;
+}
+
+export namespace FuncRetrieveShipInspectionResponse {
+  export interface Data {
+    created_at?: string;
+
+    reason?: string;
+
+    /**
+     * Stable record type retained by both inspection path aliases.
+     */
+    record_type?: 'build_log_inspection';
+
+    runtime?: string;
+
+    snippet?: string;
+
+    stage?: 'build' | 'platform' | 'pre_build' | 'deploy' | 'security_review' | 'none' | 'pending';
+  }
+}
+
+export interface FuncRetrieveLogsParams {
+  /**
+   * Return records at or before this RFC 3339 timestamp.
+   */
+  end_time?: string;
+
+  /**
+   * Maximum records to return.
+   */
+  limit?: number;
+
+  /**
+   * Return records at or after this RFC 3339 timestamp.
+   */
+  start_time?: string;
+
+  /**
+   * Log stream to return.
+   */
+  type?: 'runtime' | 'invocations';
+}
+
+export interface FuncRetrieveMetricAggregatesParams {
+  /**
+   * Exclusive window end, UTC ISO 8601 with milliseconds
+   */
+  end_time: string;
+
+  /**
+   * Inclusive window start, UTC ISO 8601 with milliseconds
+   */
+  start_time: string;
+
+  /**
+   * Edge site filter
+   */
+  'filter[edge_site]'?: string;
+
+  /**
+   * Kubernetes namespace filter
+   */
+  'filter[namespace]'?: string;
+
+  'page[number]'?: number;
+
+  'page[size]'?: number;
+}
+
+export interface FuncRetrieveRevisionsParams {
+  'page[number]'?: number;
+
+  'page[size]'?: number;
+}
+
+export declare namespace Funcs {
+  export {
+    type FunctionsObservabilityPaginationMeta as FunctionsObservabilityPaginationMeta,
+    type LogsMeta as LogsMeta,
+    type FuncRetrieveLogsResponse as FuncRetrieveLogsResponse,
+    type FuncRetrieveMetricAggregatesResponse as FuncRetrieveMetricAggregatesResponse,
+    type FuncRetrieveRevisionsResponse as FuncRetrieveRevisionsResponse,
+    type FuncRetrieveShipInspectionResponse as FuncRetrieveShipInspectionResponse,
+    type FuncRetrieveLogsParams as FuncRetrieveLogsParams,
+    type FuncRetrieveMetricAggregatesParams as FuncRetrieveMetricAggregatesParams,
+    type FuncRetrieveRevisionsParams as FuncRetrieveRevisionsParams,
+  };
+}

package/src/resources/compute/index.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Compute } from './compute';
+export {
+  Funcs,
+  type FunctionsObservabilityPaginationMeta,
+  type LogsMeta,
+  type FuncRetrieveLogsResponse,
+  type FuncRetrieveMetricAggregatesResponse,
+  type FuncRetrieveRevisionsResponse,
+  type FuncRetrieveShipInspectionResponse,
+  type FuncRetrieveLogsParams,
+  type FuncRetrieveMetricAggregatesParams,
+  type FuncRetrieveRevisionsParams,
+} from './funcs';

package/src/resources/compute.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './compute/index';

package/src/resources/credential-connections/credential-connections.ts

@@ -257,7 +257,10 @@ export interface CredentialConnection {
 
   /**
    * The password to be used as part of the credentials. Must be 8 to 128 characters
-   * long.
+   * long. For primary accounts created on or after September 8, 2026, this password
+   * is returned as `********`. The password is returned in full on create, and on
+   * update only when that update changed the password. Accounts created before
+   * September 8, 2026 are unaffected.
    */
   password?: string;
 

package/src/resources/email-inboxes/drafts.ts

@@ -415,6 +415,14 @@ export interface EmailMessage {
    * send has been processed or cancelled.
    */
   scheduled_at?: string;
+
+  /**
+   * Recipients excluded from delivery by suppression checks, with reasons. On batch
+   * items, present when that item had suppressed recipients; all other recipients of
+   * the item still receive the message. For single sends this information appears at
+   * the top level of the response instead (see EmailMessageResponse.suppressed).
+   */
+  suppressed?: Array<EmailMessagesAPI.SuppressedRecipient>;
 }
 
 export namespace EmailMessage {

package/src/resources/email-messages/email-messages.ts

@@ -109,7 +109,9 @@ export class EmailMessages extends APIResource {
   }
 
   /**
-   * Creates up to 50 email messages in a single request.
+   * Creates up to 1,000 email messages in a single request. Each message is
+   * validated and sent independently; per-message failures do not affect other
+   * messages in the batch. All responses use 207 Multi-Status.
    *
    * @example
    * ```ts
@@ -336,6 +338,7 @@ export namespace EmailMessageBatchResponse {
       | 'not_found'
       | 'forbidden'
       | 'service_unavailable'
+      | 'unprocessable_entity'
       | 'validation_error'
       | 'recipient_suppressed'
       | 'reputation_suspended';
@@ -548,7 +551,9 @@ export interface EmailMessageCreateParams {
 
 export interface EmailMessageBatchParams {
   /**
-   * Body param
+   * Body param: Array of email messages to send. Up to 1,000 messages per batch
+   * request. Each message is validated and sent independently; per-message failures
+   * do not affect other messages in the batch.
    */
   messages: Array<EmailMessageBatchParams.Message>;
 

package/src/resources/fqdn-connections/fqdn-authentication.ts

@@ -80,7 +80,10 @@ export interface FqdnAuthentication {
   microsoft_teams_sbc?: boolean;
 
   /**
-   * The password for authentication.
+   * The password for authentication. For primary accounts created on or after
+   * September 8, 2026, this password is returned as `********`. The password is
+   * returned in full on create, and on update only when that update changed the
+   * password. Accounts created before September 8, 2026 are unaffected.
    */
   password?: string;
 

package/src/resources/fqdn-connections/fqdn-connections.ts

@@ -249,7 +249,10 @@ export interface FqdnConnection {
   outbound?: OutboundFqdn;
 
   /**
-   * The password for the FQDN connection.
+   * The password for the FQDN connection. For primary accounts created on or after
+   * September 8, 2026, this password is returned as `********`. The password is
+   * returned in full on create, and on update only when that update changed the
+   * password. Accounts created before September 8, 2026 are unaffected.
    */
   password?: string;
 

package/src/resources/index.ts

@@ -185,6 +185,7 @@ export {
   type CommentListParams,
   type CommentCreateParams,
 } from './comments';
+export { Compute } from './compute/compute';
 export {
   Conferences,
   type Conference,
@@ -772,7 +773,9 @@ export {
 } from './messaging-profile-metrics';
 export {
   MessagingProfiles,
+  type MessagingMessagingProfile,
   type MessagingProfile,
+  type MessagingProfileFeatures,
   type NumberPoolSettings,
   type URLShortenerSettings,
   type MessagingProfileCreateResponse,
@@ -787,7 +790,7 @@ export {
   type MessagingProfileListShortCodesParams,
   type MessagingProfileListAlphanumericSenderIDsParams,
   type MessagingProfileRetrieveMetricsParams,
-  type MessagingProfilesDefaultFlatPagination,
+  type MessagingMessagingProfilesDefaultFlatPagination,
 } from './messaging-profiles/messaging-profiles';
 export { MessagingTollfree } from './messaging-tollfree/messaging-tollfree';
 export {
@@ -1622,6 +1625,8 @@ export {
   type OutboundMessage,
   type ReplacedLinkClick,
   type Transcription,
+  type WhatsappAccountUpdate,
+  type WhatsappMessageEcho,
   type CallAIGatherEndedWebhookEvent,
   type CallAIGatherMessageHistoryUpdatedWebhookEvent,
   type CallAIGatherPartialResultsWebhookEvent,