telnyx 7.16.0 → 7.18.0

package/src/resources/custom-storage-credentials.ts

@@ -132,48 +132,10 @@ export interface CustomStorageConfiguration {
   configuration:
     | GcsConfigurationData
     | S3ConfigurationData
-    | CustomStorageConfiguration.S3GenericConfigurationData
+    | S3GenericConfigurationData
     | AzureConfigurationData;
 }
 
-export namespace CustomStorageConfiguration {
-  export interface S3GenericConfigurationData {
-    /**
-     * AWS credentials access key id.
-     */
-    aws_access_key_id: string;
-
-    /**
-     * AWS secret access key.
-     */
-    aws_secret_access_key: string;
-
-    /**
-     * Storage backend type
-     */
-    backend: 's3-generic';
-
-    /**
-     * Name of the bucket to be used to store recording files.
-     */
-    bucket: string;
-
-    /**
-     * URL of an S3-compatible storage endpoint, used to direct uploads and presigned
-     * download URLs to a non-AWS store (for example MinIO, Cloudflare R2, Wasabi,
-     * Backblaze B2, or Supabase). A bare host (https://s3.example.com) or a
-     * path-prefixed URL (https://xyz.supabase.co/storage/v1/s3) is accepted, and must
-     * use the http or https scheme.
-     */
-    endpoint: string;
-
-    /**
-     * Region where the bucket is located.
-     */
-    region: string;
-  }
-}
-
 export interface GcsConfigurationData {
   /**
    * Storage backend type
@@ -219,102 +181,62 @@ export interface S3ConfigurationData {
   region: string;
 }
 
+export interface S3GenericConfigurationData {
+  /**
+   * AWS credentials access key id.
+   */
+  aws_access_key_id: string;
+
+  /**
+   * AWS secret access key.
+   */
+  aws_secret_access_key: string;
+
+  /**
+   * Storage backend type
+   */
+  backend: 's3-generic';
+
+  /**
+   * Name of the bucket to be used to store recording files.
+   */
+  bucket: string;
+
+  /**
+   * URL of an S3-compatible storage endpoint, used to direct uploads and presigned
+   * download URLs to a non-AWS store (for example MinIO, Cloudflare R2, Wasabi,
+   * Backblaze B2, or Supabase). A bare host (https://s3.example.com) or a
+   * path-prefixed URL (https://xyz.supabase.co/storage/v1/s3) is accepted, and must
+   * use the http or https scheme.
+   */
+  endpoint: string;
+
+  /**
+   * Region where the bucket is located.
+   */
+  region: string;
+}
+
 export interface CustomStorageCredentialCreateParams {
   backend: 'gcs' | 's3' | 's3-generic' | 'azure';
 
   configuration:
     | GcsConfigurationData
     | S3ConfigurationData
-    | CustomStorageCredentialCreateParams.S3GenericConfigurationData
+    | S3GenericConfigurationData
     | AzureConfigurationData;
 }
 
-export namespace CustomStorageCredentialCreateParams {
-  export interface S3GenericConfigurationData {
-    /**
-     * AWS credentials access key id.
-     */
-    aws_access_key_id: string;
-
-    /**
-     * AWS secret access key.
-     */
-    aws_secret_access_key: string;
-
-    /**
-     * Storage backend type
-     */
-    backend: 's3-generic';
-
-    /**
-     * Name of the bucket to be used to store recording files.
-     */
-    bucket: string;
-
-    /**
-     * URL of an S3-compatible storage endpoint, used to direct uploads and presigned
-     * download URLs to a non-AWS store (for example MinIO, Cloudflare R2, Wasabi,
-     * Backblaze B2, or Supabase). A bare host (https://s3.example.com) or a
-     * path-prefixed URL (https://xyz.supabase.co/storage/v1/s3) is accepted, and must
-     * use the http or https scheme.
-     */
-    endpoint: string;
-
-    /**
-     * Region where the bucket is located.
-     */
-    region: string;
-  }
-}
-
 export interface CustomStorageCredentialUpdateParams {
   backend: 'gcs' | 's3' | 's3-generic' | 'azure';
 
   configuration:
     | GcsConfigurationData
     | S3ConfigurationData
-    | CustomStorageCredentialUpdateParams.S3GenericConfigurationData
+    | S3GenericConfigurationData
     | AzureConfigurationData;
 }
 
-export namespace CustomStorageCredentialUpdateParams {
-  export interface S3GenericConfigurationData {
-    /**
-     * AWS credentials access key id.
-     */
-    aws_access_key_id: string;
-
-    /**
-     * AWS secret access key.
-     */
-    aws_secret_access_key: string;
-
-    /**
-     * Storage backend type
-     */
-    backend: 's3-generic';
-
-    /**
-     * Name of the bucket to be used to store recording files.
-     */
-    bucket: string;
-
-    /**
-     * URL of an S3-compatible storage endpoint, used to direct uploads and presigned
-     * download URLs to a non-AWS store (for example MinIO, Cloudflare R2, Wasabi,
-     * Backblaze B2, or Supabase). A bare host (https://s3.example.com) or a
-     * path-prefixed URL (https://xyz.supabase.co/storage/v1/s3) is accepted, and must
-     * use the http or https scheme.
-     */
-    endpoint: string;
-
-    /**
-     * Region where the bucket is located.
-     */
-    region: string;
-  }
-}
-
 export declare namespace CustomStorageCredentials {
   export {
     type AzureConfigurationData as AzureConfigurationData,
@@ -322,6 +244,7 @@ export declare namespace CustomStorageCredentials {
     type CustomStorageConfiguration as CustomStorageConfiguration,
     type GcsConfigurationData as GcsConfigurationData,
     type S3ConfigurationData as S3ConfigurationData,
+    type S3GenericConfigurationData as S3GenericConfigurationData,
     type CustomStorageCredentialCreateParams as CustomStorageCredentialCreateParams,
     type CustomStorageCredentialUpdateParams as CustomStorageCredentialUpdateParams,
   };

package/src/resources/customer-service-records.ts

@@ -11,7 +11,8 @@ import { path } from '../internal/utils/path';
  */
 export class CustomerServiceRecords extends APIResource {
   /**
-   * List customer service records.
+   * Returns a paginated list of your customer service record (CSR) requests, with
+   * support for filtering and sorting.
    *
    * @example
    * ```ts
@@ -69,7 +70,8 @@ export class CustomerServiceRecords extends APIResource {
   }
 
   /**
-   * Get a specific customer service record.
+   * Returns the details of a single customer service record (CSR) request, including
+   * its status and any retrieved record data.
    *
    * @example
    * ```ts

package/src/resources/dialogflow-connections.ts

@@ -11,7 +11,7 @@ import { path } from '../internal/utils/path';
  */
 export class DialogflowConnections extends APIResource {
   /**
-   * Deletes a stored Dialogflow Connection.
+   * Deletes the stored Dialogflow connection for the specified connection.
    *
    * @example
    * ```ts
@@ -76,7 +76,8 @@ export class DialogflowConnections extends APIResource {
   }
 
   /**
-   * Updates a stored Dialogflow Connection.
+   * Updates the stored Dialogflow connection for the specified connection and
+   * returns the updated configuration.
    *
    * @example
    * ```ts

package/src/resources/dir/dir.ts

@@ -47,7 +47,12 @@ import {
   References,
 } from './references';
 import * as VerifyEmailAPI from './verify-email';
-import { EmailVerificationStatusWrapped, VerifyEmail, VerifyEmailConfirmParams } from './verify-email';
+import {
+  EmailVerificationStatus,
+  EmailVerificationStatusWrapped,
+  VerifyEmail,
+  VerifyEmailConfirmParams,
+} from './verify-email';
 import * as LoaAPI from '../enterprises/reputation/loa';
 import { APIPromise } from '../../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
@@ -718,6 +723,7 @@ export declare namespace DirResource {
 
   export {
     VerifyEmail as VerifyEmail,
+    type EmailVerificationStatus as EmailVerificationStatus,
     type EmailVerificationStatusWrapped as EmailVerificationStatusWrapped,
     type VerifyEmailConfirmParams as VerifyEmailConfirmParams,
   };

package/src/resources/dir/index.ts

@@ -55,6 +55,7 @@ export {
 } from './references';
 export {
   VerifyEmail,
+  type EmailVerificationStatus,
   type EmailVerificationStatusWrapped,
   type VerifyEmailConfirmParams,
 } from './verify-email';

package/src/resources/dir/verify-email.ts

@@ -69,46 +69,44 @@ export class VerifyEmail extends APIResource {
   }
 }
 
-export interface EmailVerificationStatusWrapped {
+/**
+ * Verification state for a DIR's authorizer email.
+ */
+export interface EmailVerificationStatus {
   /**
-   * Verification state for a DIR's authorizer email.
+   * Whether the DIR's authorizer email has been confirmed.
    */
-  data: EmailVerificationStatusWrapped.Data;
-}
+  email_verified: boolean;
 
-export namespace EmailVerificationStatusWrapped {
   /**
-   * Verification state for a DIR's authorizer email.
+   * Always `email_verification`.
    */
-  export interface Data {
-    /**
-     * Whether the DIR's authorizer email has been confirmed.
-     */
-    email_verified: boolean;
+  record_type: 'email_verification';
 
-    /**
-     * Always `email_verification`.
-     */
-    record_type: 'email_verification';
+  /**
+   * `sent` after a code is emailed; `verified` after a successful confirm;
+   * `unverified` when no verification is in progress.
+   */
+  status: 'sent' | 'verified' | 'unverified';
 
-    /**
-     * `sent` after a code is emailed; `verified` after a successful confirm;
-     * `unverified` when no verification is in progress.
-     */
-    status: 'sent' | 'verified' | 'unverified';
+  /**
+   * When the outstanding code stops being accepted. Null when no verification is in
+   * progress.
+   */
+  expires_at?: string | null;
 
-    /**
-     * When the outstanding code stops being accepted. Null when no verification is in
-     * progress.
-     */
-    expires_at?: string | null;
+  /**
+   * How many more codes may be requested for this DIR today. Null when the daily cap
+   * does not apply.
+   */
+  sends_remaining_today?: number | null;
+}
 
-    /**
-     * How many more codes may be requested for this DIR today. Null when the daily cap
-     * does not apply.
-     */
-    sends_remaining_today?: number | null;
-  }
+export interface EmailVerificationStatusWrapped {
+  /**
+   * Verification state for a DIR's authorizer email.
+   */
+  data: EmailVerificationStatus;
 }
 
 export interface VerifyEmailConfirmParams {
@@ -120,6 +118,7 @@ export interface VerifyEmailConfirmParams {
 
 export declare namespace VerifyEmail {
   export {
+    type EmailVerificationStatus as EmailVerificationStatus,
     type EmailVerificationStatusWrapped as EmailVerificationStatusWrapped,
     type VerifyEmailConfirmParams as VerifyEmailConfirmParams,
   };

package/src/resources/documents.ts

@@ -84,7 +84,8 @@ export class Documents extends APIResource {
   }
 
   /**
-   * Retrieve a document.
+   * Returns the details of a single document on your account, including its
+   * metadata.
    *
    * @example
    * ```ts
@@ -98,7 +99,7 @@ export class Documents extends APIResource {
   }
 
   /**
-   * Update a document.
+   * Updates the specified document's attributes and returns the updated document.
    *
    * @example
    * ```ts
@@ -116,7 +117,7 @@ export class Documents extends APIResource {
   }
 
   /**
-   * Download a document.
+   * Downloads the raw file content of the specified document as originally uploaded.
    *
    * @example
    * ```ts
@@ -179,11 +180,6 @@ export interface DocServiceDocument extends DocServiceRecord {
    */
   filename?: string;
 
-  /**
-   * Identifies the type of the resource.
-   */
-  record_type?: string;
-
   /**
    * The document's SHA256 hash provided for optional verification purposes.
    */

package/src/resources/dynamic-emergency-addresses.ts

@@ -33,7 +33,8 @@ export class DynamicEmergencyAddresses extends APIResource {
   }
 
   /**
-   * Creates a dynamic emergency address.
+   * Creates a dynamic emergency address, the validated physical location used when
+   * provisioning dynamic emergency endpoints.
    *
    * @example
    * ```ts

package/src/resources/dynamic-emergency-endpoints.ts

@@ -33,7 +33,8 @@ export class DynamicEmergencyEndpoints extends APIResource {
   }
 
   /**
-   * Creates a dynamic emergency endpoints.
+   * Creates a dynamic emergency endpoint, associating a callback number and location
+   * with a device for emergency calling.
    *
    * @example
    * ```ts

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

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as ImportAPI from './import';
-import { EmailBlockImportResponse, Import, ImportCreateParams } from './import';
+import * as ImportsAPI from './imports';
+import { EmailBlockImport, EmailBlockImportResponse, ImportCreateParams, Imports } from './imports';
 import { APIPromise } from '../../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
@@ -13,7 +13,7 @@ import { path } from '../../internal/utils/path';
  * Recipient suppression records (`/v2/email_blocks`).
  */
 export class EmailBlocks extends APIResource {
-  import: ImportAPI.Import = new ImportAPI.Import(this._client);
+  imports: ImportsAPI.Imports = new ImportsAPI.Imports(this._client);
 
   /**
    * Account-scoped list. Two mutually exclusive pagination modes:
@@ -138,22 +138,32 @@ export class EmailBlocks extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.emailBlocks.retrieveEvents(
+   * // Automatically fetches more pages as needed.
+   * for await (const emailBlockRetrieveEventsResponse of client.emailBlocks.retrieveEvents(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   retrieveEvents(
     id: string,
     query: EmailBlockRetrieveEventsParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<EmailBlockRetrieveEventsResponse> {
-    return this._client.get(path`/email_blocks/${id}/events`, { query, ...options });
+  ): PagePromise<EmailBlockRetrieveEventsResponsesDefaultFlatPagination, EmailBlockRetrieveEventsResponse> {
+    return this._client.getAPIList(
+      path`/email_blocks/${id}/events`,
+      DefaultFlatPagination<EmailBlockRetrieveEventsResponse>,
+      { query, ...options },
+    );
   }
 }
 
 export type EmailBlocksDefaultFlatPagination = DefaultFlatPagination<EmailBlock>;
 
+export type EmailBlockRetrieveEventsResponsesDefaultFlatPagination =
+  DefaultFlatPagination<EmailBlockRetrieveEventsResponse>;
+
 /**
  * Suppression record. Schema fields hidden by the view: `account_id`,
  * `bounce_category`, `dsn_code`, `meta`.
@@ -223,44 +233,36 @@ export interface OffsetMeta {
 }
 
 export interface EmailBlockRetrieveEventsResponse {
-  data: Array<EmailBlockRetrieveEventsResponse.Data>;
-
-  meta: OffsetMeta;
-}
-
-export namespace EmailBlockRetrieveEventsResponse {
-  export interface Data {
-    id: string;
+  id: string;
 
-    /**
-     * Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
-     */
-    actor: string;
+  /**
+   * Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
+   */
+  actor: string;
 
-    event_type: 'created' | 'removed' | 'expired' | 'override_used';
+  event_type: 'created' | 'removed' | 'expired' | 'override_used';
 
-    occurred_at: string;
+  occurred_at: string;
 
-    /**
-     * Free-text snapshot of the block's reason at event time.
-     */
-    reason: string;
+  /**
+   * Free-text snapshot of the block's reason at event time.
+   */
+  reason: string;
 
-    /**
-     * View-only.
-     */
-    record_type: 'email_block_event';
+  /**
+   * View-only.
+   */
+  record_type: 'email_block_event';
 
-    /**
-     * Free-text snapshot of the block's source at event time.
-     */
-    source: string;
+  /**
+   * Free-text snapshot of the block's source at event time.
+   */
+  source: string;
 
-    /**
-     * `null` when the schema field is nil (the context usually sets it to `{}`).
-     */
-    meta?: { [key: string]: unknown } | null;
-  }
+  /**
+   * `null` when the schema field is nil (the context usually sets it to `{}`).
+   */
+  meta?: { [key: string]: unknown } | null;
 }
 
 /**
@@ -366,19 +368,9 @@ export interface EmailBlockRetrieveExportParams {
   sort?: 'created_at' | '-created_at';
 }
 
-export interface EmailBlockRetrieveEventsParams {
-  /**
-   * Offset page number (≥1, default 1).
-   */
-  'page[number]'?: number;
-
-  /**
-   * Page size (default 50, max 100).
-   */
-  'page[size]'?: number;
-}
+export interface EmailBlockRetrieveEventsParams extends DefaultFlatPaginationParams {}
 
-EmailBlocks.Import = Import;
+EmailBlocks.Imports = Imports;
 
 export declare namespace EmailBlocks {
   export {
@@ -388,6 +380,7 @@ export declare namespace EmailBlocks {
     type EmailBlockRetrieveEventsResponse as EmailBlockRetrieveEventsResponse,
     type EmailBlockRetrieveExportResponse as EmailBlockRetrieveExportResponse,
     type EmailBlocksDefaultFlatPagination as EmailBlocksDefaultFlatPagination,
+    type EmailBlockRetrieveEventsResponsesDefaultFlatPagination as EmailBlockRetrieveEventsResponsesDefaultFlatPagination,
     type EmailBlockListParams as EmailBlockListParams,
     type EmailBlockCreateParams as EmailBlockCreateParams,
     type EmailBlockRetrieveExportParams as EmailBlockRetrieveExportParams,
@@ -395,7 +388,8 @@ export declare namespace EmailBlocks {
   };
 
   export {
-    Import as Import,
+    Imports as Imports,
+    type EmailBlockImport as EmailBlockImport,
     type EmailBlockImportResponse as EmailBlockImportResponse,
     type ImportCreateParams as ImportCreateParams,
   };