telnyx 7.26.0 → 7.28.0

package/src/resources/tailscale-subnet-routers.ts

@@ -0,0 +1,303 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+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';
+
+/**
+ * Tailscale Subnet Router operations
+ */
+export class TailscaleSubnetRouters extends APIResource {
+  /**
+   * Returns a paginated list of the Tailscale Subnet Routers on the account, with
+   * support for filtering by Network.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const tailscaleSubnetRouter of client.tailscaleSubnetRouters.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: TailscaleSubnetRouterListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TailscaleSubnetRoutersDefaultFlatPagination, TailscaleSubnetRouter> {
+    return this._client.getAPIList(
+      '/tailscale_subnet_routers',
+      DefaultFlatPagination<TailscaleSubnetRouter>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Creates a Tailscale Subnet Router on a Network and enrolls it in the user's
+   * tailnet with the auth key. The response returns the router with `status`
+   * `provisioning`. Poll `GET /tailscale_subnet_routers/{id}` until it is
+   * `provisioned`. Then approve its routes in the tailnet, unless an auto-approver
+   * covers them.
+   *
+   * @example
+   * ```ts
+   * const tailscaleSubnetRouter =
+   *   await client.tailscaleSubnetRouters.create({
+   *     advertised_routes: ['172.27.0.0/24'],
+   *     auth_key: 'tskey-auth-k1AbCdEfGh2IjKlMnOpQrStUv',
+   *     name: 'tailnet-ashburn',
+   *     network_id: '0de011ae-ee53-4df4-ba96-754728eb5aad',
+   *     region_code: 'ashburn-va',
+   *   });
+   * ```
+   */
+  create(
+    body: TailscaleSubnetRouterCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<TailscaleSubnetRouterCreateResponse> {
+    return this._client.post('/tailscale_subnet_routers', { body, ...options });
+  }
+
+  /**
+   * Removes the router from the Network and logs it out of the tailnet. The response
+   * returns the router with `status` `deleting`. The record disappears once removal
+   * completes. A machine entry can remain in the tailnet's admin console until it is
+   * removed there.
+   *
+   * @example
+   * ```ts
+   * const tailscaleSubnetRouter =
+   *   await client.tailscaleSubnetRouters.delete(
+   *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<TailscaleSubnetRouterDeleteResponse> {
+    return this._client.delete(path`/tailscale_subnet_routers/${id}`, options);
+  }
+
+  /**
+   * Returns the details of a single Tailscale Subnet Router by its identifier,
+   * including its enrollment state.
+   *
+   * @example
+   * ```ts
+   * const tailscaleSubnetRouter =
+   *   await client.tailscaleSubnetRouters.retrieve(
+   *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<TailscaleSubnetRouterRetrieveResponse> {
+    return this._client.get(path`/tailscale_subnet_routers/${id}`, options);
+  }
+
+  /**
+   * Renames the router, changes its advertised routes, or retries a failed
+   * enrollment. Any change queues a new provisioning run and returns the router with
+   * `status` `provisioning`. The router keeps its machine identity on the tailnet.
+   * Send an empty object to retry a `failed` router with its stored auth key.
+   * Include a new `auth_key` only while the router has never enrolled. The router's
+   * Network and region cannot change: create a new router instead.
+   *
+   * @example
+   * ```ts
+   * const tailscaleSubnetRouter =
+   *   await client.tailscaleSubnetRouters.update(
+   *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+   *     {
+   *       advertised_routes: ['172.27.0.0/24', '172.27.1.0/24'],
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    body: TailscaleSubnetRouterUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<TailscaleSubnetRouterUpdateResponse> {
+    return this._client.patch(path`/tailscale_subnet_routers/${id}`, { body, ...options });
+  }
+}
+
+export type TailscaleSubnetRoutersDefaultFlatPagination = DefaultFlatPagination<TailscaleSubnetRouter>;
+
+export interface TailscaleSubnetRouter {
+  /**
+   * Identifies the resource.
+   */
+  id?: string;
+
+  /**
+   * IPv4 subnets of the Network that the router advertises to the tailnet. Each
+   * entry is a canonical CIDR that the Network routes. Default, loopback,
+   * link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So
+   * are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
+   */
+  advertised_routes?: Array<string>;
+
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was created.
+   */
+  created_at?: string;
+
+  /**
+   * The router's address on the Network, from `172.27.254.0/24`. Tailnet traffic
+   * enters the Network from this address.
+   */
+  customer_address?: string;
+
+  /**
+   * The router's node id on the tailnet. Set once the router has enrolled.
+   */
+  device_id?: string | null;
+
+  /**
+   * A user specified name for the router.
+   */
+  name?: string;
+
+  /**
+   * The id of the Network the router is attached to.
+   */
+  network_id?: string;
+
+  /**
+   * Identifies the type of the resource.
+   */
+  record_type?: string;
+
+  /**
+   * The code of the region the router is created in. `GET /network_coverage` lists
+   * the regions whose `available_services` include `tailscale_subnet_router`.
+   */
+  region_code?: string;
+
+  /**
+   * `provisioning`: Telnyx is creating the router or applying a change.
+   * `provisioned`: the router is on the tailnet and advertises its routes; the
+   * tailnet still approves them. `failed`: enrollment did not complete, and `PATCH`
+   * retries it. `deleting`: the router is being removed.
+   */
+  status?: 'provisioning' | 'provisioned' | 'failed' | 'deleting';
+
+  /**
+   * The name of the tailnet the router is enrolled in. Set once the router has
+   * enrolled.
+   */
+  tailnet_name?: string | null;
+
+  /**
+   * The router's addresses on the tailnet. Empty until the router has enrolled.
+   */
+  tailscale_ips?: Array<string>;
+
+  /**
+   * ISO 8601 formatted date-time indicating when the resource was updated.
+   */
+  updated_at?: string;
+}
+
+export interface TailscaleSubnetRouterCreateResponse {
+  data?: TailscaleSubnetRouter;
+}
+
+export interface TailscaleSubnetRouterRetrieveResponse {
+  data?: TailscaleSubnetRouter;
+}
+
+export interface TailscaleSubnetRouterUpdateResponse {
+  data?: TailscaleSubnetRouter;
+}
+
+export interface TailscaleSubnetRouterDeleteResponse {
+  data?: TailscaleSubnetRouter;
+}
+
+export interface TailscaleSubnetRouterListParams extends DefaultFlatPaginationParams {
+  /**
+   * Consolidated filter parameter (deepObject style). Originally: filter[network_id]
+   */
+  filter?: TailscaleSubnetRouterListParams.Filter;
+}
+
+export namespace TailscaleSubnetRouterListParams {
+  /**
+   * Consolidated filter parameter (deepObject style). Originally: filter[network_id]
+   */
+  export interface Filter {
+    /**
+     * The id of the Network to filter on.
+     */
+    network_id?: string;
+  }
+}
+
+export interface TailscaleSubnetRouterCreateParams {
+  /**
+   * IPv4 subnets of the Network that the router advertises to the tailnet. Each
+   * entry is a canonical CIDR that the Network routes. Default, loopback,
+   * link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So
+   * are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
+   */
+  advertised_routes: Array<string>;
+
+  /**
+   * A Tailscale auth key that enrolls the router in the user's tailnet: reusable,
+   * pre-approved, tagged, and not ephemeral. Telnyx stores it encrypted until
+   * enrollment succeeds, then discards it. It is never returned.
+   */
+  auth_key: string;
+
+  /**
+   * A user specified name for the router.
+   */
+  name: string;
+
+  /**
+   * The id of the Network to attach the router to.
+   */
+  network_id: string;
+
+  /**
+   * The code of the region to create the router in. `GET /network_coverage` lists
+   * the regions whose `available_services` include `tailscale_subnet_router`.
+   */
+  region_code: string;
+}
+
+export interface TailscaleSubnetRouterUpdateParams {
+  /**
+   * IPv4 subnets of the Network that the router advertises to the tailnet. Each
+   * entry is a canonical CIDR that the Network routes. Default, loopback,
+   * link-local, multicast, and Tailscale (`100.64.0.0/10`) ranges are rejected. So
+   * are ranges that overlap the router's own, `172.27.254.0/24` and `198.18.0.0/20`.
+   */
+  advertised_routes?: Array<string>;
+
+  /**
+   * A replacement Tailscale auth key. Accepted only while the router has never
+   * enrolled, for example after a `failed` enrollment. Never returned.
+   */
+  auth_key?: string;
+
+  /**
+   * A user specified name for the router.
+   */
+  name?: string;
+}
+
+export declare namespace TailscaleSubnetRouters {
+  export {
+    type TailscaleSubnetRouter as TailscaleSubnetRouter,
+    type TailscaleSubnetRouterCreateResponse as TailscaleSubnetRouterCreateResponse,
+    type TailscaleSubnetRouterRetrieveResponse as TailscaleSubnetRouterRetrieveResponse,
+    type TailscaleSubnetRouterUpdateResponse as TailscaleSubnetRouterUpdateResponse,
+    type TailscaleSubnetRouterDeleteResponse as TailscaleSubnetRouterDeleteResponse,
+    type TailscaleSubnetRoutersDefaultFlatPagination as TailscaleSubnetRoutersDefaultFlatPagination,
+    type TailscaleSubnetRouterListParams as TailscaleSubnetRouterListParams,
+    type TailscaleSubnetRouterCreateParams as TailscaleSubnetRouterCreateParams,
+    type TailscaleSubnetRouterUpdateParams as TailscaleSubnetRouterUpdateParams,
+  };
+}

package/src/resources/telephony-credentials.ts

@@ -102,10 +102,21 @@ export class TelephonyCredentials extends APIResource {
    *   await client.telephonyCredentials.createToken('id');
    * ```
    */
-  createToken(id: string, options?: RequestOptions): APIPromise<string> {
+  createToken(
+    id: string,
+    params: TelephonyCredentialCreateTokenParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { 'Idempotency-Key': idempotencyKey } = params ?? {};
     return this._client.post(path`/telephony_credentials/${id}/token`, {
       ...options,
-      headers: buildHeaders([{ Accept: 'text/plain' }, options?.headers]),
+      headers: buildHeaders([
+        {
+          Accept: 'text/plain',
+          ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 }
@@ -263,6 +274,16 @@ export interface TelephonyCredentialUpdateParams {
   tag?: string;
 }
 
+export interface TelephonyCredentialCreateTokenParams {
+  /**
+   * Unique key for safely retrying the same logical request. Generate a UUID v4 for
+   * each operation and reuse it only when retrying that operation with the same
+   * request body. Valid characters: A-Z, a-z, 0-9, -, and \_. Length: 1-255
+   * characters. Do not include sensitive data in the key.
+   */
+  'Idempotency-Key'?: string;
+}
+
 export declare namespace TelephonyCredentials {
   export {
     type TelephonyCredential as TelephonyCredential,
@@ -275,5 +296,6 @@ export declare namespace TelephonyCredentials {
     type TelephonyCredentialListParams as TelephonyCredentialListParams,
     type TelephonyCredentialCreateParams as TelephonyCredentialCreateParams,
     type TelephonyCredentialUpdateParams as TelephonyCredentialUpdateParams,
+    type TelephonyCredentialCreateTokenParams as TelephonyCredentialCreateTokenParams,
   };
 }

package/src/resources/texml/accounts/accounts.ts

@@ -67,7 +67,7 @@ export class Accounts extends APIResource {
    * ```ts
    * const texmlGetCallRecordingsResponseBody =
    *   await client.texml.accounts.retrieveRecordingsJson(
-   *     'account_sid',
+   *     'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
    *   );
    * ```
    */
@@ -86,7 +86,7 @@ export class Accounts extends APIResource {
    * ```ts
    * const response =
    *   await client.texml.accounts.retrieveTranscriptionsJson(
-   *     'account_sid',
+   *     'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
    *   );
    * ```
    */

package/src/resources/texml/accounts/calls/calls.ts

@@ -39,7 +39,7 @@ export class Calls extends APIResource {
    * ```ts
    * const response =
    *   await client.texml.accounts.calls.retrieveCalls(
-   *     'account_sid',
+   *     'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
    *   );
    * ```
    */
@@ -63,12 +63,12 @@ export class Calls extends APIResource {
 
   /**
    * Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request
-   * URL configured for the connection in the Mission Control Portal.
+   * URL configured for the TeXML Application in the Mission Control Portal.
    *
    * @example
    * ```ts
    * const response = await client.texml.accounts.calls.calls(
-   *   'account_sid',
+   *   'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
    *   { body: { Url: 'https://www.example.com/texml.xml' } },
    * );
    * ```
@@ -90,7 +90,7 @@ export class Calls extends APIResource {
    * ```ts
    * const callResource =
    *   await client.texml.accounts.calls.retrieve('call_sid', {
-   *     account_sid: 'account_sid',
+   *     account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
    *   });
    * ```
    */
@@ -107,7 +107,7 @@ export class Calls extends APIResource {
    * ```ts
    * const callResource =
    *   await client.texml.accounts.calls.update('call_sid', {
-   *     account_sid: 'account_sid',
+   *     account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
    *   });
    * ```
    */
@@ -128,7 +128,7 @@ export class Calls extends APIResource {
    * ```ts
    * const response =
    *   await client.texml.accounts.calls.siprecJson('call_sid', {
-   *     account_sid: 'account_sid',
+   *     account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
    *   });
    * ```
    */
@@ -153,7 +153,7 @@ export class Calls extends APIResource {
    * const response =
    *   await client.texml.accounts.calls.streamsJson(
    *     'call_sid',
-   *     { account_sid: 'account_sid' },
+   *     { account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9' },
    *   );
    * ```
    */
@@ -512,7 +512,12 @@ export namespace CallCallsParams {
     Url: string;
 
     /**
-     * The ID of the TeXML Application.
+     * The ID of the TeXML Application that will handle the call, for example
+     * `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+     * compatibility, but the value is the numeric ID of one of your TeXML Applications
+     * (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+     * `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+     * the XML Request URL configured on this application.
      */
     ApplicationSid?: string;
 
@@ -842,7 +847,12 @@ export namespace CallCallsParams {
     Texml: string;
 
     /**
-     * The ID of the TeXML Application.
+     * The ID of the TeXML Application that will handle the call, for example
+     * `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+     * compatibility, but the value is the numeric ID of one of your TeXML Applications
+     * (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+     * `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+     * the XML Request URL configured on this application.
      */
     ApplicationSid?: string;
 
@@ -1166,7 +1176,12 @@ export namespace CallCallsParams {
 
   export interface ApplicationDefault {
     /**
-     * The ID of the TeXML Application.
+     * The ID of the TeXML Application that will handle the call, for example
+     * `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+     * compatibility, but the value is the numeric ID of one of your TeXML Applications
+     * (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+     * `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+     * the XML Request URL configured on this application.
      */
     ApplicationSid?: string;
 
@@ -1493,14 +1508,24 @@ export namespace CallCallsParams {
 
 export interface CallRetrieveParams {
   /**
-   * The id of the account the resource belongs to.
+   * The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;
 }
 
 export interface CallUpdateParams {
   /**
-   * Path param: The id of the account the resource belongs to.
+   * Path param: The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;
 
@@ -1551,7 +1576,12 @@ export interface CallUpdateParams {
 
 export interface CallSiprecJsonParams {
   /**
-   * Path param: The id of the account the resource belongs to.
+   * Path param: The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;
 
@@ -1611,7 +1641,12 @@ export interface CallSiprecJsonParams {
 
 export interface CallStreamsJsonParams {
   /**
-   * Path param: The id of the account the resource belongs to.
+   * Path param: The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;
 

package/src/resources/texml/accounts/calls/recordings-json.ts

@@ -19,7 +19,7 @@ export class RecordingsJson extends APIResource {
    * const texmlGetCallRecordingsResponseBody =
    *   await client.texml.accounts.calls.recordingsJson.retrieveRecordingsJson(
    *     'call_sid',
-   *     { account_sid: 'account_sid' },
+   *     { account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9' },
    *   );
    * ```
    */
@@ -40,7 +40,7 @@ export class RecordingsJson extends APIResource {
    * const texmlCreateCallRecordingResponseBody =
    *   await client.texml.accounts.calls.recordingsJson.recordingsJson(
    *     'call_sid',
-   *     { account_sid: 'account_sid' },
+   *     { account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9' },
    *   );
    * ```
    */
@@ -171,14 +171,24 @@ export type TwimlRecordingChannels = 1 | 2;
 
 export interface RecordingsJsonRetrieveRecordingsJsonParams {
   /**
-   * The id of the account the resource belongs to.
+   * The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;
 }
 
 export interface RecordingsJsonRecordingsJsonParams {
   /**
-   * Path param: The id of the account the resource belongs to.
+   * Path param: The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;
 

package/src/resources/texml/accounts/calls/recordings.ts

@@ -19,7 +19,10 @@ export class Recordings extends APIResource {
    * const texmlCreateCallRecordingResponseBody =
    *   await client.texml.accounts.calls.recordings.recordingSidJson(
    *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-   *     { account_sid: 'account_sid', call_sid: 'call_sid' },
+   *     {
+   *       account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
+   *       call_sid: 'call_sid',
+   *     },
    *   );
    * ```
    */
@@ -42,7 +45,12 @@ export class Recordings extends APIResource {
 
 export interface RecordingRecordingSidJsonParams {
   /**
-   * Path param: The id of the account the resource belongs to.
+   * Path param: The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;
 

package/src/resources/texml/accounts/calls/siprec.ts

@@ -18,7 +18,10 @@ export class Siprec extends APIResource {
    * const response =
    *   await client.texml.accounts.calls.siprec.siprecSidJson(
    *     'siprec_sid',
-   *     { account_sid: 'account_sid', call_sid: 'call_sid' },
+   *     {
+   *       account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
+   *       call_sid: 'call_sid',
+   *     },
    *   );
    * ```
    */
@@ -78,7 +81,12 @@ export interface SiprecSiprecSidJsonResponse {
 
 export interface SiprecSiprecSidJsonParams {
   /**
-   * Path param: The id of the account the resource belongs to.
+   * Path param: The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;
 

package/src/resources/texml/accounts/calls/streams.ts

@@ -18,7 +18,10 @@ export class Streams extends APIResource {
    * const response =
    *   await client.texml.accounts.calls.streams.streamingSidJson(
    *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-   *     { account_sid: 'account_sid', call_sid: 'call_sid' },
+   *     {
+   *       account_sid: 'f5586561-8ff0-4291-a51b-c7dfe4139ff9',
+   *       call_sid: 'call_sid',
+   *     },
    *   );
    * ```
    */
@@ -64,7 +67,12 @@ export interface StreamStreamingSidJsonResponse {
 
 export interface StreamStreamingSidJsonParams {
   /**
-   * Path param: The id of the account the resource belongs to.
+   * Path param: The UUID of the Telnyx account that owns the resource, for example
+   * `f5586561-8ff0-4291-a51b-c7dfe4139ff9`. The `account_sid` path segment is kept
+   * for Twilio API compatibility, but the value is a Telnyx account UUID, not a
+   * Twilio `AC...` SID. It must match the account that owns the API key used to
+   * authenticate the request, otherwise the endpoint returns `404`. The same value
+   * is sent as `AccountSid` in TeXML webhooks.
    */
   account_sid: string;