telnyx 7.26.0 → 7.28.0

package/src/resources/compute/compute.ts

@@ -3,6 +3,9 @@
 import { APIResource } from '../../core/resource';
 import * as FuncsAPI from './funcs/funcs';
 import {
+  FuncListParams,
+  FuncListResponse,
+  FuncListResponsesDefaultFlatPagination,
   FuncRetrieveLogsParams,
   FuncRetrieveLogsResponse,
   FuncRetrieveMetricAggregatesParams,
@@ -14,24 +17,126 @@ import {
   FunctionsObservabilityPaginationMeta,
   LogsMeta,
 } from './funcs/funcs';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
+/**
+ * Inspect Stateful Actor types
+ */
 export class Compute extends APIResource {
   funcs: FuncsAPI.Funcs = new FuncsAPI.Funcs(this._client);
+
+  /**
+   * Retrieve one account-scoped Stateful Actor type. owner_function_id identifies
+   * the function that owns and ships the actor class; other functions may reference
+   * the same actor type through actor bindings.
+   *
+   * @example
+   * ```ts
+   * const compute = await client.compute.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<ComputeRetrieveResponse> {
+    return this._client.get(path`/compute/actors/${id}`, options);
+  }
+}
+
+export interface ComputeRetrieveResponse {
+  data?: ComputeRetrieveResponse.Data;
+}
+
+export namespace ComputeRetrieveResponse {
+  export interface Data {
+    id?: string;
+
+    created_at?: string;
+
+    /**
+     * ID of the function that owns and ships this actor type. Empty when the type is
+     * unowned.
+     */
+    owner_function_id?: string;
+
+    /**
+     * Last deployment fan-out report, not a live probe. Omitted on actor types without
+     * a placement-aware deployment.
+     */
+    placement?: Data.Placement;
+
+    record_type?: string;
+
+    status?: string;
+
+    type?: string;
+
+    updated_at?: string;
+  }
+
+  export namespace Data {
+    /**
+     * Last deployment fan-out report, not a live probe. Omitted on actor types without
+     * a placement-aware deployment.
+     */
+    export interface Placement {
+      cluster_results?: Array<Placement.ClusterResult>;
+
+      /**
+       * Public regions with successful deployment
+       */
+      clusters?: Array<string>;
+
+      excluded_clusters?: Array<string>;
+
+      /**
+       * Optional ISO-8601 millisecond timestamp
+       */
+      observed_at?: string;
+
+      partial?: boolean;
+
+      policy?: 'everywhere' | 'single_site';
+
+      unchecked_clusters?: Array<string>;
+    }
+
+    export namespace Placement {
+      export interface ClusterResult {
+        /**
+         * Public region, or unknown when no mapping exists
+         */
+        cluster_id?: string;
+
+        error?: string;
+
+        error_code?: string;
+
+        status?: string;
+
+        success?: boolean;
+      }
+    }
+  }
 }
 
 Compute.Funcs = Funcs;
 
 export declare namespace Compute {
+  export { type ComputeRetrieveResponse as ComputeRetrieveResponse };
+
   export {
     Funcs as Funcs,
     type FunctionsObservabilityPaginationMeta as FunctionsObservabilityPaginationMeta,
     type LogsMeta as LogsMeta,
+    type FuncListResponse as FuncListResponse,
     type FuncRetrieveLogsResponse as FuncRetrieveLogsResponse,
     type FuncRetrieveMetricAggregatesResponse as FuncRetrieveMetricAggregatesResponse,
     type FuncRetrieveRevisionsResponse as FuncRetrieveRevisionsResponse,
     type FuncRetrieveShipInspectionResponse as FuncRetrieveShipInspectionResponse,
+    type FuncListResponsesDefaultFlatPagination as FuncListResponsesDefaultFlatPagination,
     type FuncRetrieveLogsParams as FuncRetrieveLogsParams,
     type FuncRetrieveMetricAggregatesParams as FuncRetrieveMetricAggregatesParams,
     type FuncRetrieveRevisionsParams as FuncRetrieveRevisionsParams,
+    type FuncListParams as FuncListParams,
   };
 }

package/src/resources/compute/funcs/export.ts

@@ -6,6 +6,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage Edge Compute functions
+ */
 export class Export extends APIResource {
   /**
    * Stops exporting a function's logs and removes its destination configuration.

package/src/resources/compute/funcs/funcs.ts

@@ -5,9 +5,17 @@ import * as FuncsAPI from './funcs';
 import * as ExportAPI from './export';
 import { Export, ExportCreateParams, FuncLogExportConfigResponse } from './export';
 import { APIPromise } from '../../../core/api-promise';
+import {
+  DefaultFlatPagination,
+  type DefaultFlatPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * Manage Edge Compute functions
+ */
 export class Funcs extends APIResource {
   export: ExportAPI.Export = new ExportAPI.Export(this._client);
 
@@ -91,8 +99,34 @@ export class Funcs extends APIResource {
   ): APIPromise<FuncRetrieveShipInspectionResponse> {
     return this._client.get(path`/compute/funcs/${id}/ship_inspection`, options);
   }
+
+  /**
+   * List functions for the authenticated organization. Each function includes its
+   * persisted function-scoped bindings. Actor bindings expose actor_type and
+   * env_name, allowing clients to identify every function attached to a Stateful
+   * Actor type.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const funcListResponse of client.compute.funcs.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: FuncListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FuncListResponsesDefaultFlatPagination, FuncListResponse> {
+    return this._client.getAPIList('/compute/funcs', DefaultFlatPagination<FuncListResponse>, {
+      query,
+      ...options,
+    });
+  }
 }
 
+export type FuncListResponsesDefaultFlatPagination = DefaultFlatPagination<FuncListResponse>;
+
 export interface FunctionsObservabilityPaginationMeta {
   page_number?: number;
 
@@ -109,6 +143,66 @@ export interface LogsMeta {
   partial?: boolean;
 }
 
+export interface FuncListResponse {
+  id?: string;
+
+  /**
+   * Always present; empty when the function has no bindings.
+   */
+  bindings?: Array<FuncListResponse.Binding>;
+
+  created_at?: string;
+
+  invoke_url?: string;
+
+  message?: string;
+
+  name?: string;
+
+  record_type?: string;
+
+  status?: string;
+
+  status_detail?: string;
+
+  updated_at?: string;
+}
+
+export namespace FuncListResponse {
+  /**
+   * A function-scoped binding persisted at ship time. For binding_type=actor,
+   * actor_type is the referenced Stateful Actor type and env_name is the binding
+   * name exposed to the function.
+   */
+  export interface Binding {
+    actor_type?: string;
+
+    binding_id?: string;
+
+    binding_type?: string;
+
+    bucket_id?: string;
+
+    created_at?: string;
+
+    env_name?: string;
+
+    func_id?: string;
+
+    kv_id?: string;
+
+    record_type?: string;
+
+    secret_name?: string;
+
+    sqldb_id?: string;
+
+    status?: string;
+
+    updated_at?: string;
+  }
+}
+
 export type FuncRetrieveLogsResponse =
   | FuncRetrieveLogsResponse.FuncRuntimeLogsResponse
   | FuncRetrieveLogsResponse.FuncInvocationLogsResponse;
@@ -318,19 +412,24 @@ export interface FuncRetrieveRevisionsParams {
   'page[size]'?: number;
 }
 
+export interface FuncListParams extends DefaultFlatPaginationParams {}
+
 Funcs.Export = Export;
 
 export declare namespace Funcs {
   export {
     type FunctionsObservabilityPaginationMeta as FunctionsObservabilityPaginationMeta,
     type LogsMeta as LogsMeta,
+    type FuncListResponse as FuncListResponse,
     type FuncRetrieveLogsResponse as FuncRetrieveLogsResponse,
     type FuncRetrieveMetricAggregatesResponse as FuncRetrieveMetricAggregatesResponse,
     type FuncRetrieveRevisionsResponse as FuncRetrieveRevisionsResponse,
     type FuncRetrieveShipInspectionResponse as FuncRetrieveShipInspectionResponse,
+    type FuncListResponsesDefaultFlatPagination as FuncListResponsesDefaultFlatPagination,
     type FuncRetrieveLogsParams as FuncRetrieveLogsParams,
     type FuncRetrieveMetricAggregatesParams as FuncRetrieveMetricAggregatesParams,
     type FuncRetrieveRevisionsParams as FuncRetrieveRevisionsParams,
+    type FuncListParams as FuncListParams,
   };
 
   export {

package/src/resources/compute/funcs/index.ts

@@ -5,6 +5,7 @@ export {
   Funcs,
   type FunctionsObservabilityPaginationMeta,
   type LogsMeta,
+  type FuncListResponse,
   type FuncRetrieveLogsResponse,
   type FuncRetrieveMetricAggregatesResponse,
   type FuncRetrieveRevisionsResponse,
@@ -12,4 +13,6 @@ export {
   type FuncRetrieveLogsParams,
   type FuncRetrieveMetricAggregatesParams,
   type FuncRetrieveRevisionsParams,
+  type FuncListParams,
+  type FuncListResponsesDefaultFlatPagination,
 } from './funcs';

package/src/resources/compute/index.ts

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Compute } from './compute';
+export { Compute, type ComputeRetrieveResponse } from './compute';
 export {
   Funcs,
   type FunctionsObservabilityPaginationMeta,
   type LogsMeta,
+  type FuncListResponse,
   type FuncRetrieveLogsResponse,
   type FuncRetrieveMetricAggregatesResponse,
   type FuncRetrieveRevisionsResponse,
@@ -12,4 +13,6 @@ export {
   type FuncRetrieveLogsParams,
   type FuncRetrieveMetricAggregatesParams,
   type FuncRetrieveRevisionsParams,
+  type FuncListParams,
+  type FuncListResponsesDefaultFlatPagination,
 } from './funcs/index';

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

@@ -170,6 +170,17 @@ export interface CredentialConnection {
    */
   android_push_credential_id?: string | null;
 
+  /**
+   * Stores the connection preference for generating silent RTP toward the opposite
+   * call leg when comfort-noise packets (CN, payload type 13) are received during
+   * hold. Defaults to false and returns the saved value. Only JSON true and false
+   * are accepted; null and non-boolean values are rejected. This preference is
+   * independent of default_on_hold_comfort_noise_enabled and does not modify that
+   * setting. This API provisions the preference; call-processing behavior is
+   * implemented separately.
+   */
+  bridge_generate_comfort_noise_on_cn?: boolean;
+
   /**
    * Specifies if call cost webhooks should be sent for this connection.
    */
@@ -209,8 +220,8 @@ export interface CredentialConnection {
   encode_contact_header_enabled?: boolean;
 
   /**
-   * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-   * TLS.
+   * Enable use of SRTP for encryption. Can only be set when the SIP signaling
+   * transport protocol is TLS.
    */
   encrypted_media?: EncryptedMedia | null;
 
@@ -467,8 +478,8 @@ export interface CredentialOutbound {
 export type DtmfType = 'RFC 2833' | 'Inband' | 'SIP INFO';
 
 /**
- * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
- * TLS.
+ * Enable use of SRTP for encryption. Can only be set when the SIP signaling
+ * transport protocol is TLS.
  */
 export type EncryptedMedia = 'SRTP' | null;
 
@@ -589,6 +600,17 @@ export interface CredentialConnectionCreateParams {
    */
   android_push_credential_id?: string | null;
 
+  /**
+   * Stores the connection preference for generating silent RTP toward the opposite
+   * call leg when comfort-noise packets (CN, payload type 13) are received during
+   * hold. Optional; defaults to false when omitted on creation. Only JSON true and
+   * false are accepted; null and non-boolean values are rejected. This preference is
+   * independent of default_on_hold_comfort_noise_enabled and does not modify that
+   * setting. This API provisions the preference; call-processing behavior is
+   * implemented separately.
+   */
+  bridge_generate_comfort_noise_on_cn?: boolean;
+
   /**
    * Specifies if call cost webhooks should be sent for this connection.
    */
@@ -614,8 +636,8 @@ export interface CredentialConnectionCreateParams {
   encode_contact_header_enabled?: boolean;
 
   /**
-   * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-   * TLS.
+   * Enable use of SRTP for encryption. Can only be set when the SIP signaling
+   * transport protocol is TLS.
    */
   encrypted_media?: EncryptedMedia | null;
 
@@ -719,6 +741,17 @@ export interface CredentialConnectionUpdateParams {
    */
   android_push_credential_id?: string | null;
 
+  /**
+   * Stores the connection preference for generating silent RTP toward the opposite
+   * call leg when comfort-noise packets (CN, payload type 13) are received during
+   * hold. Optional; omitting this field preserves the saved value. Only JSON true
+   * and false are accepted; null and non-boolean values are rejected. This
+   * preference is independent of default_on_hold_comfort_noise_enabled and does not
+   * modify that setting. This API provisions the preference; call-processing
+   * behavior is implemented separately.
+   */
+  bridge_generate_comfort_noise_on_cn?: boolean;
+
   /**
    * Specifies if call cost webhooks should be sent for this connection.
    */
@@ -756,8 +789,8 @@ export interface CredentialConnectionUpdateParams {
   encode_contact_header_enabled?: boolean;
 
   /**
-   * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-   * TLS.
+   * Enable use of SRTP for encryption. Can only be set when the SIP signaling
+   * transport protocol is TLS.
    */
   encrypted_media?: EncryptedMedia | null;
 

package/src/resources/dial-metrics.ts

@@ -0,0 +1,185 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { CloudfsCursorPagination, type CloudfsCursorPaginationParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Call information
+ */
+export class DialMetrics extends APIResource {
+  /**
+   * Returns dials-per-second (DPS) metrics for your account's outbound dials made
+   * with the Call Control `Dial` command and TeXML, as time buckets with dial
+   * counts, accepted and rejected dials, average and peak DPS, and the DPS limit in
+   * force.
+   *
+   * The result has one record per region per bucket, ordered by `start_time` and
+   * then `region`, newest first unless `sort=start_time`. Regions are never summed:
+   * the DPS limit is enforced per region, so a cross-region total cannot be compared
+   * with it.
+   *
+   * Only buckets that saw dials are returned. Treat a missing bucket as zero dials.
+   *
+   * Only complete 5-second windows are counted, and a window is counted about 15
+   * seconds after it closes. The newest `granularity=second` record is therefore
+   * your live DPS, about 20 seconds old. Request the last minute or two with
+   * `sort=-start_time`; the first record of each `region` is that region's live rate
+   * (`page[limit]=1` would hide every region but one). If no recent record exists,
+   * the live rate is zero.
+   *
+   * Results are cursor paginated. Follow `meta.next`, or pass `meta.cursors.after`
+   * as `page[after]`, until `meta.next` is absent. No total count is returned.
+   *
+   * This endpoint is in development and can change before general availability.
+   */
+  list(
+    query: DialMetricListParams,
+    options?: RequestOptions,
+  ): PagePromise<DialMetricListResponsesCloudfsCursorPagination, DialMetricListResponse> {
+    return this._client.getAPIList('/dial_metrics', CloudfsCursorPagination<DialMetricListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type DialMetricListResponsesCloudfsCursorPagination = CloudfsCursorPagination<DialMetricListResponse>;
+
+/**
+ * Dial counts and rates for one region in one time bucket. One record per region
+ * per bucket.
+ */
+export interface DialMetricListResponse {
+  /**
+   * `dials.total` divided by the bucket duration in seconds, rounded to 4 decimal
+   * places. Counts every dial attempt, rejected ones included.
+   */
+  average_dps?: number;
+
+  /**
+   * Dial attempt counts in the bucket.
+   */
+  dials?: DialMetricListResponse.Dials;
+
+  /**
+   * DPS limit in force during the busiest 5-second window, so it compares directly
+   * with `peak_dps`. `null` means unlimited. Enforcement near the limit is
+   * approximate; `dials.rejected.dps_limit` is the authoritative signal that the
+   * limit was reached.
+   */
+  dps_limit?: number | null;
+
+  /**
+   * End of the bucket (exclusive), UTC. Five seconds, one minute or one hour after
+   * `start_time`, depending on `granularity`.
+   */
+  end_time?: string;
+
+  /**
+   * Dials per second, rounded to 4 decimal places, in the busiest 5-second window of
+   * the bucket, summed across all call-processing nodes of the region. Counts every
+   * dial attempt, rejected ones included, so `peak_dps` above `dps_limit` is
+   * expected when dials were rejected. For `granularity=second` it equals
+   * `average_dps`.
+   */
+  peak_dps?: number;
+
+  record_type?: 'dial_metric';
+
+  /**
+   * Region where the dials were handled. Current values are `us`, `eu`, `australia`,
+   * `middle_east`, `canada` and `india`. New values can be added, so clients must
+   * tolerate values not listed here. Buckets of different regions are separate
+   * records.
+   */
+  region?: string;
+
+  /**
+   * Start of the bucket (inclusive), UTC.
+   */
+  start_time?: string;
+}
+
+export namespace DialMetricListResponse {
+  /**
+   * Dial attempt counts in the bucket.
+   */
+  export interface Dials {
+    /**
+     * Dial attempts that were not rejected by a limit.
+     */
+    accepted?: number;
+
+    /**
+     * Dial attempts rejected by a limit.
+     */
+    rejected?: Dials.Rejected;
+
+    /**
+     * All dial attempts, rejected ones included: accepted plus every rejected count.
+     */
+    total?: number;
+  }
+
+  export namespace Dials {
+    /**
+     * Dial attempts rejected by a limit.
+     */
+    export interface Rejected {
+      /**
+       * Rejected by a daily limit.
+       */
+      daily_limit?: number;
+
+      /**
+       * Rejected by the dials-per-second limit.
+       */
+      dps_limit?: number;
+
+      /**
+       * Rejected by an hourly limit.
+       */
+      hourly_limit?: number;
+    }
+  }
+}
+
+export interface DialMetricListParams extends CloudfsCursorPaginationParams {
+  /**
+   * Exclusive end of the range, ISO 8601. Must be after `start_time`. Buckets that
+   * start before this time are returned.
+   */
+  end_time: string;
+
+  /**
+   * Bucket size. `second` returns 5-second buckets (the finest resolution) and is
+   * kept for the last 48 hours. `minute` and `hour` are kept for the last 30 days.
+   */
+  granularity: 'second' | 'minute' | 'hour';
+
+  /**
+   * Inclusive start of the range, ISO 8601 (for example `2026-09-29T12:00:00.000Z`).
+   * Buckets that start at or after this time are returned. A `start_time` older than
+   * the retention window of the chosen `granularity` is moved forward to the start
+   * of that window, and `meta.start_time` returns the start actually used.
+   */
+  start_time: string;
+
+  /**
+   * Sort order of the buckets by `start_time`. `-start_time` (default) returns the
+   * newest first, `start_time` the oldest first. `region` follows the same direction
+   * for buckets with the same `start_time`. To read the live rate, use
+   * `granularity=second` and `sort=-start_time`, then take the first record of each
+   * `region`.
+   */
+  sort?: '-start_time' | 'start_time';
+}
+
+export declare namespace DialMetrics {
+  export {
+    type DialMetricListResponse as DialMetricListResponse,
+    type DialMetricListResponsesCloudfsCursorPagination as DialMetricListResponsesCloudfsCursorPagination,
+    type DialMetricListParams as DialMetricListParams,
+  };
+}

package/src/resources/dir/dir.ts

@@ -248,8 +248,7 @@ export class DirResource extends APIResource {
    * existing registration stays live throughout the new vetting cycle.
    *
    * Returns `400` from `submitted`/`in_review`/`permanently_rejected`. Returns `400`
-   * if the DIR's business and financial references have not been submitted. Returns
-   * `400` if the DIR has an unresolved infringement claim.
+   * if the DIR has an unresolved infringement claim.
    *
    * @example
    * ```ts
@@ -533,6 +532,7 @@ export interface Document {
     | 'letter_of_authorization'
     | 'business_registration'
     | 'articles_of_incorporation'
+    | 'certificate_of_good_standing'
     | 'tax_document'
     | 'ein_letter'
     | 'trademark_registration'
@@ -542,6 +542,8 @@ export interface Document {
     | 'government_id'
     | 'utility_bill'
     | 'bank_statement'
+    | 'business_credit_report'
+    | 'bank_reference_letter'
     | 'other';
 
   /**

package/src/resources/dir/references.ts

@@ -7,6 +7,8 @@ import { path } from '../../internal/utils/path';
 
 /**
  * Submit and manage the two business references and one financial reference that vouch for a DIR. References are contacted to confirm the business identity during vetting.
+ *
+ * References (two business references and one financial reference) are needed only if the documents uploaded with the DIR don't already prove the business is legitimate and financially stable. Any one of these is enough proof: audited or certified financial statements (uploaded as `other`, with a description), a commercial credit report (uploaded as `business_credit_report`), or references. Telnyx reviewers decide during vetting whether your documents are enough.
  */
 export class References extends APIResource {
   /**
@@ -33,21 +35,25 @@ export class References extends APIResource {
   /**
    * Submit the two business references and one financial reference for a DIR.
    *
-   * The DIR's authorizer email must be verified first (see the email-verification
-   * endpoint). Until it is, this returns `409` and no references are stored.
+   * References (two business references and one financial reference) are needed only
+   * if the documents uploaded with the DIR don't already prove the business is
+   * legitimate and financially stable. Any one of these is enough proof: audited or
+   * certified financial statements (uploaded as `other`, with a description), a
+   * commercial credit report (uploaded as `business_credit_report`), or references.
+   * Telnyx reviewers decide during vetting whether your documents are enough.
+   *
+   * References can't be changed while the DIR is `verified`. Update the DIR first,
+   * which returns it to draft.
    *
    * The request body carries exactly two business references plus one financial
    * reference. The first submission stores them and returns `201`. Resubmitting
    * returns `200`: identical values are simply confirmed and nothing is written,
    * while changed values replace those references.
    *
-   * Replacing a reference is allowed only while the DIR itself is still editable,
-   * the same window in which a single reference may be updated; once the DIR has
-   * been submitted for vetting this returns `400`. A replaced reference's pending
-   * verification call is cancelled and its dial-in code stops working, and the
-   * replacement contact is emailed fresh scheduling details. References whose
-   * details did not change keep their existing call, code, and the notice already
-   * sent to them.
+   * A replaced reference's pending verification call is cancelled and its dial-in
+   * code stops working, and the replacement contact is emailed fresh scheduling
+   * details. References whose details did not change keep their existing call, code,
+   * and the notice already sent to them.
    *
    * The response always echoes the stored references in the same shape as the GET.
    *