telnyx 7.13.0 → 7.14.0

package/src/resources/email-unsubscribe-groups/suppressions.ts

@@ -20,6 +20,16 @@ export class Suppressions extends APIResource {
    * malformed `page` returns `400` (code `10015`), consistent with
    * `GET /v2/email_blocks`. `meta` includes `total_pages`. Rows reuse the standard
    * suppression shape (`group_id` set to this group).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const emailBlock of client.emailUnsubscribeGroups.suppressions.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     id: string,
@@ -37,6 +47,15 @@ export class Suppressions extends APIResource {
    * Creates a suppression with `reason: unsubscribe`, `source: manual`,
    * `group_id: <this group>`. All other body fields are ignored; only `to` is read.
    * Idempotent (same dedupe key → `200`, no new event).
+   *
+   * @example
+   * ```ts
+   * const emailBlockResponse =
+   *   await client.emailUnsubscribeGroups.suppressions.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { to: 'user@example.com' },
+   *   );
+   * ```
    */
   create(
     id: string,
@@ -56,6 +75,14 @@ export class Suppressions extends APIResource {
    * `10001 "The requested unsubscribe group was not found"`; a group that exists but
    * has **no active suppression** for that email returns
    * `10001 "The requested group suppression was not found"`.
+   *
+   * @example
+   * ```ts
+   * await client.emailUnsubscribeGroups.suppressions.delete(
+   *   'email',
+   *   { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   * );
+   * ```
    */
   delete(email: string, params: SuppressionDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { id } = params;

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

@@ -178,7 +178,8 @@ export class ExternalConnections extends APIResource {
   }
 
   /**
-   * Update a location's static emergency address
+   * Update the static emergency address assigned to a specific location of an
+   * external connection.
    *
    * @example
    * ```ts
@@ -188,7 +189,7 @@ export class ExternalConnections extends APIResource {
    *     {
    *       id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *       static_emergency_address_id:
-   *         '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *         '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    *     },
    *   );
    * ```

package/src/resources/external-connections/phone-numbers.ts

@@ -67,7 +67,10 @@ export class PhoneNumbers extends APIResource {
    * const phoneNumber =
    *   await client.externalConnections.phoneNumbers.update(
    *     '1234567889',
-   *     { id: '1293384261075731499' },
+   *     {
+   *       id: '1293384261075731499',
+   *       location_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
+   *     },
    *   );
    * ```
    */

package/src/resources/faxes/faxes.ts

@@ -17,7 +17,7 @@ export class Faxes extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
-   * View a list of faxes
+   * Retrieve a paginated list of faxes sent or received on your account.
    *
    * @example
    * ```ts
@@ -73,7 +73,7 @@ export class Faxes extends APIResource {
   }
 
   /**
-   * Delete a fax
+   * Delete a fax resource from your account.
    *
    * @example
    * ```ts
@@ -90,7 +90,7 @@ export class Faxes extends APIResource {
   }
 
   /**
-   * View a fax
+   * Retrieve the details of a single fax.
    *
    * @example
    * ```ts

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

@@ -0,0 +1,180 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * FQDN connection operations
+ */
+export class FqdnAuthenticationResource extends APIResource {
+  /**
+   * Retrieves the details of an existing FQDN authentication strategy for a specific
+   * FQDN connection.
+   *
+   * @example
+   * ```ts
+   * const fqdnAuthentications =
+   *   await client.fqdnConnections.fqdnAuthentication.list(
+   *     'fqdn_connection_id',
+   *   );
+   * ```
+   */
+  list(fqdnConnectionID: string, options?: RequestOptions): APIPromise<FqdnAuthenticationListResponse> {
+    return this._client.get(path`/fqdn_connections/${fqdnConnectionID}/fqdn_authentication`, options);
+  }
+
+  /**
+   * Updates the FQDN authentication strategy for a specific FQDN connection.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.fqdnConnections.fqdnAuthentication.patchAll(
+   *     'fqdn_connection_id',
+   *   );
+   * ```
+   */
+  patchAll(
+    fqdnConnectionID: string,
+    body: FqdnAuthenticationPatchAllParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FqdnAuthenticationPatchAllResponse> {
+    return this._client.patch(path`/fqdn_connections/${fqdnConnectionID}/fqdn_authentication`, {
+      body,
+      ...options,
+    });
+  }
+}
+
+export interface FqdnAuthentication {
+  /**
+   * Identifies the resource.
+   */
+  id?: string;
+
+  /**
+   * The ID of the FQDN connection this authentication strategy belongs to.
+   */
+  connection_id?: string;
+
+  /**
+   * The failover webhook URL.
+   */
+  failover_url?: string;
+
+  /**
+   * The outbound authentication type.
+   */
+  fqdn_outbound_authentication?: 'ip-authentication' | 'credential-authentication';
+
+  /**
+   * The IP authentication method.
+   */
+  ip_authentication_method?: 'token' | 'p-charge-info';
+
+  /**
+   * Whether the connection is a Microsoft Teams SBC.
+   */
+  microsoft_teams_sbc?: boolean;
+
+  /**
+   * The password for authentication.
+   */
+  password?: string;
+
+  /**
+   * Identifies the type of the resource.
+   */
+  record_type?: string;
+
+  /**
+   * The TXT record name for Microsoft Teams SBC DNS verification.
+   */
+  txt_name?: string;
+
+  /**
+   * The TTL for the TXT record.
+   */
+  txt_ttl?: number;
+
+  /**
+   * The TXT record value for Microsoft Teams SBC DNS verification.
+   */
+  txt_value?: string;
+
+  /**
+   * The username for authentication.
+   */
+  user_name?: string;
+
+  /**
+   * The webhook URL for authentication events.
+   */
+  webhook_url?: string;
+}
+
+export interface FqdnAuthenticationListResponse {
+  data?: FqdnAuthentication;
+}
+
+export interface FqdnAuthenticationPatchAllResponse {
+  data?: FqdnAuthentication;
+}
+
+export interface FqdnAuthenticationPatchAllParams {
+  /**
+   * The failover webhook URL.
+   */
+  failover_url?: string;
+
+  /**
+   * The outbound authentication type.
+   */
+  fqdn_outbound_authentication?: 'ip-authentication' | 'credential-authentication';
+
+  /**
+   * The IP authentication method.
+   */
+  ip_authentication_method?: 'token' | 'p-charge-info';
+
+  /**
+   * The password for authentication.
+   */
+  password?: string;
+
+  /**
+   * The TXT record name for Microsoft Teams SBC DNS verification.
+   */
+  txt_name?: string;
+
+  /**
+   * The TTL for the TXT record.
+   */
+  txt_ttl?: number;
+
+  /**
+   * The TXT record value for Microsoft Teams SBC DNS verification.
+   */
+  txt_value?: string;
+
+  /**
+   * The username for authentication.
+   */
+  user_name?: string;
+
+  /**
+   * The webhook URL for authentication events.
+   */
+  webhook_url?: string;
+}
+
+export declare namespace FqdnAuthenticationResource {
+  export {
+    type FqdnAuthentication as FqdnAuthentication,
+    type FqdnAuthenticationListResponse as FqdnAuthenticationListResponse,
+    type FqdnAuthenticationPatchAllResponse as FqdnAuthenticationPatchAllResponse,
+    type FqdnAuthenticationPatchAllParams as FqdnAuthenticationPatchAllParams,
+  };
+}