telnyx 7.24.0 → 7.25.0

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

@@ -0,0 +1,117 @@
+// 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';
+
+/**
+ * Verify ownership of a DIR's authorizer email. A short code is emailed and confirmed; the email must be verified before references can be submitted.
+ */
+export class VerifyEmail extends APIResource {
+  /**
+   * Email a 6-digit code to the enterprise account's contact email to confirm
+   * ownership of that address.
+   *
+   * A BPO (Business Process Outsourcer) account has no DIR, so it proves ownership
+   * of its own contact email here rather than through a DIR. A BPO account cannot be
+   * approved for use until this contact email is verified.
+   *
+   * The code expires in 15 minutes. Requesting a new code invalidates any previous
+   * one. Resends are rate limited (a short cooldown plus a daily cap). Submit the
+   * code to `POST /enterprises/{enterprise_id}/verify_email/confirm`.
+   *
+   * @example
+   * ```ts
+   * const enterpriseEmailVerificationStatusWrapped =
+   *   await client.enterprises.verifyEmail.create(
+   *     '4a6192a4-573d-446d-b3ce-aff9117272a6',
+   *   );
+   * ```
+   */
+  create(
+    enterpriseID: string,
+    options?: RequestOptions,
+  ): APIPromise<EnterpriseEmailVerificationStatusWrapped> {
+    return this._client.post(path`/enterprises/${enterpriseID}/verify_email`, options);
+  }
+
+  /**
+   * Submit the 6-digit code that was emailed to the enterprise account's contact
+   * email. On success the contact email is marked verified.
+   *
+   * For security, any failure (wrong, expired, already-used, or too many attempts)
+   * returns the same generic message.
+   *
+   * @example
+   * ```ts
+   * const enterpriseEmailVerificationStatusWrapped =
+   *   await client.enterprises.verifyEmail.confirm(
+   *     '4a6192a4-573d-446d-b3ce-aff9117272a6',
+   *     { code: '482915' },
+   *   );
+   * ```
+   */
+  confirm(
+    enterpriseID: string,
+    body: VerifyEmailConfirmParams,
+    options?: RequestOptions,
+  ): APIPromise<EnterpriseEmailVerificationStatusWrapped> {
+    return this._client.post(path`/enterprises/${enterpriseID}/verify_email/confirm`, { body, ...options });
+  }
+}
+
+export interface EnterpriseEmailVerificationStatusWrapped {
+  /**
+   * Verification state for an enterprise account's contact email.
+   */
+  data: EnterpriseEmailVerificationStatusWrapped.Data;
+}
+
+export namespace EnterpriseEmailVerificationStatusWrapped {
+  /**
+   * Verification state for an enterprise account's contact email.
+   */
+  export interface Data {
+    /**
+     * Whether the enterprise account's contact email has been confirmed.
+     */
+    email_verified: boolean;
+
+    /**
+     * Always `email_verification`.
+     */
+    record_type: 'email_verification';
+
+    /**
+     * `sent` after a code is emailed; `verified` after a successful confirm.
+     */
+    status: 'sent' | 'verified';
+
+    /**
+     * When the code just sent stops being accepted. Present on a send response; null
+     * on a confirm response.
+     */
+    expires_at?: string | null;
+
+    /**
+     * How many more codes may be requested for this enterprise account today. Present
+     * on a send response; null on a confirm response.
+     */
+    sends_remaining_today?: number | null;
+  }
+}
+
+export interface VerifyEmailConfirmParams {
+  /**
+   * The 6-digit code sent to the enterprise account's contact email.
+   */
+  code: string;
+}
+
+export declare namespace VerifyEmail {
+  export {
+    type EnterpriseEmailVerificationStatusWrapped as EnterpriseEmailVerificationStatusWrapped,
+    type VerifyEmailConfirmParams as VerifyEmailConfirmParams,
+  };
+}

package/src/resources/index.ts

@@ -287,17 +287,23 @@ export {
 } from './dialogflow-connections';
 export {
   DirResource,
+  type BpoAuthorizationInput,
   type Dir,
   type DirList,
   type DirStatus,
   type DirWrapped,
   type Document,
+  type SignaturePayload,
+  type DirDeleteResponse,
   type DirListDocumentTypesResponse,
+  type DirRetrieveBpoAuthorizationsResponse,
   type DirListParams,
   type DirUpdateParams,
   type DirListInfringementClaimsParams,
   type DirUpdateInfringementParams,
   type DirNewLoaParams,
+  type DirRetrieveBpoAuthorizationsParams,
+  type DirBpoLoaParams,
   type DirsDefaultFlatPagination,
 } from './dir/dir';
 export {
@@ -663,6 +669,7 @@ export {
 } from './ledger-billing-group-reports';
 export { Legacy } from './legacy/legacy';
 export { List, type ListRetrieveAllResponse, type ListRetrieveByZoneResponse } from './list';
+export { LlmTokenGateway } from './llm-token-gateway/llm-token-gateway';
 export {
   MachinePayments,
   type MachinePaymentAccountCreditResponse,
@@ -1358,6 +1365,16 @@ export {
   type SpeechToTextListProvidersParams,
   type SpeechToTextRetrieveTranscriptionParams,
 } from './speech-to-text';
+export {
+  SpendLimits,
+  type SpendLimit,
+  type SpendLimitPeriod,
+  type SpendLimitResponse,
+  type SpendLimitListResponse,
+  type SpendLimitCreateParams,
+  type SpendLimitDeleteParams,
+  type SpendLimitUpdateParams,
+} from './spend-limits';
 export { Storage, type StorageListMigrationSourceCoverageResponse } from './storage/storage';
 export {
   SubNumberOrders,
@@ -1660,6 +1677,7 @@ export {
   type ArtifactFailedWebhookEvent,
   type CallAnsweredWebhookEvent,
   type CallBridgedWebhookEvent,
+  type CallConversationCreatedWebhookEvent,
   type CallConversationEndedWebhookEvent,
   type CallConversationInsightsGeneratedWebhookEvent,
   type CallCostWebhookEvent,
@@ -1676,7 +1694,9 @@ export {
   type CallLeftQueueWebhookEvent,
   type CallMachineDetectionEndedWebhookEvent,
   type CallMachineGreetingEndedWebhookEvent,
+  type CallMachinePremiumCallScreeningDetectedWebhookEvent,
   type CallMachinePremiumDetectionEndedWebhookEvent,
+  type CallMachinePremiumDetectionStartedWebhookEvent,
   type CallMachinePremiumGreetingEndedWebhookEvent,
   type CallPaymentCompletedWebhookEvent,
   type CallPaymentProgressWebhookEvent,

package/src/resources/infringement-claims.ts

@@ -175,6 +175,10 @@ export namespace InfringementClaim {
      * - `infringement_claimed` - a trademark/impersonation claim is open against this
      *   DIR.
      * - `permanently_rejected` - terminal; cannot be resubmitted.
+     * - `delete_requested` - you have requested deletion; the DIR still exists and
+     *   Telnyx is completing the removal (de-registration and cleanup). A verified DIR
+     *   keeps serving its branded identity, and keeps billing, until the removal
+     *   finishes.
      */
     status?: DirAPI.DirStatus;
   }

package/src/resources/llm-token-gateway/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { LlmTokenGateway } from './llm-token-gateway';
+export { Usage, type UsageRetrieveSummaryResponse, type UsageRetrieveSummaryParams } from './usage';

package/src/resources/llm-token-gateway/llm-token-gateway.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as UsageAPI from './usage';
+import { Usage, UsageRetrieveSummaryParams, UsageRetrieveSummaryResponse } from './usage';
+
+export class LlmTokenGateway extends APIResource {
+  usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
+}
+
+LlmTokenGateway.Usage = Usage;
+
+export declare namespace LlmTokenGateway {
+  export {
+    Usage as Usage,
+    type UsageRetrieveSummaryResponse as UsageRetrieveSummaryResponse,
+    type UsageRetrieveSummaryParams as UsageRetrieveSummaryParams,
+  };
+}

package/src/resources/llm-token-gateway/usage.ts

@@ -0,0 +1,336 @@
+// 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';
+
+/**
+ * Manage and report AI Gateway traffic.
+ */
+export class Usage extends APIResource {
+  /**
+   * Return complete usage totals, UTC daily and model breakdowns, and guardrail
+   * event counts for one token group owned by the authenticated account. Requires
+   * the llm_token_gateway.usage.read permission; spend and guardrail read
+   * permissions do not grant this combined report. All sections share one database
+   * snapshot and include the latest usage corrections. Dates use an inclusive start
+   * and exclusive end spanning 1 to 31 days. Only token_group_id, start_date and
+   * end_date are accepted; pagination, group_by and other filters are rejected.
+   * Spend is reference/enforcement USD, not invoice truth or BYOK provider charges.
+   * Unknown cost is excluded from spend and reported through unknown_requests and
+   * reserved_spend. Daily rows include zero-activity days. Model rows are ordered by
+   * request count descending, then model name, and are limited to 1,000. Guardrail
+   * counts count events, not distinct requests; recent_events contains at most 20
+   * newest events. A report that exceeds model or query limits returns 503 rather
+   * than a truncated success.
+   */
+  retrieveSummary(
+    query: UsageRetrieveSummaryParams,
+    options?: RequestOptions,
+  ): APIPromise<UsageRetrieveSummaryResponse> {
+    return this._client.get('/llm_token_gateway/usage/summary', { query, ...options });
+  }
+}
+
+export interface UsageRetrieveSummaryResponse {
+  data: UsageRetrieveSummaryResponse.Data;
+
+  meta: UsageRetrieveSummaryResponse.Meta;
+}
+
+export namespace UsageRetrieveSummaryResponse {
+  export interface Data {
+    /**
+     * One row per UTC day, including zero-activity days.
+     */
+    by_day: Array<Data.ByDay>;
+
+    /**
+     * One row per model, ordered by request count descending then model name.
+     */
+    by_model: Array<Data.ByModel>;
+
+    /**
+     * Complete guardrail event counts and bounded recent findings for the same group
+     * and range.
+     */
+    guardrails: Data.Guardrails;
+
+    /**
+     * Metrics for all matching requests.
+     */
+    totals: Data.Totals;
+  }
+
+  export namespace Data {
+    export interface ByDay {
+      /**
+       * Requests served from the gateway cache.
+       */
+      cache_hits: number;
+
+      /**
+       * UTC day.
+       */
+      date: string;
+
+      /**
+       * Requests classified as failed.
+       */
+      failed_requests: number;
+
+      /**
+       * Independently known input tokens across attempts, including corrected usage.
+       */
+      input_tokens: number;
+
+      /**
+       * Independently known output tokens across attempts, including corrected usage.
+       */
+      output_tokens: number;
+
+      /**
+       * Requests classified as partial after streaming began.
+       */
+      partial_requests: number;
+
+      /**
+       * Number of matching requests.
+       */
+      requests: number;
+
+      /**
+       * Unresolved budget reservations in USD.
+       */
+      reserved_spend: number;
+
+      /**
+       * Sum of known reference/enforcement cost in USD.
+       */
+      spend: number;
+
+      /**
+       * Requests classified as succeeded.
+       */
+      succeeded_requests: number;
+
+      /**
+       * Requests whose cost remains unresolved; unknown cost is excluded from spend.
+       */
+      unknown_requests: number;
+    }
+
+    export interface ByModel {
+      /**
+       * Requests served from the gateway cache.
+       */
+      cache_hits: number;
+
+      /**
+       * Requests classified as failed.
+       */
+      failed_requests: number;
+
+      /**
+       * Independently known input tokens across attempts, including corrected usage.
+       */
+      input_tokens: number;
+
+      /**
+       * Model identifier.
+       */
+      model: string;
+
+      /**
+       * Independently known output tokens across attempts, including corrected usage.
+       */
+      output_tokens: number;
+
+      /**
+       * Requests classified as partial after streaming began.
+       */
+      partial_requests: number;
+
+      /**
+       * Number of matching requests.
+       */
+      requests: number;
+
+      /**
+       * Unresolved budget reservations in USD.
+       */
+      reserved_spend: number;
+
+      /**
+       * Sum of known reference/enforcement cost in USD.
+       */
+      spend: number;
+
+      /**
+       * Requests classified as succeeded.
+       */
+      succeeded_requests: number;
+
+      /**
+       * Requests whose cost remains unresolved; unknown cost is excluded from spend.
+       */
+      unknown_requests: number;
+    }
+
+    /**
+     * Complete guardrail event counts and bounded recent findings for the same group
+     * and range.
+     */
+    export interface Guardrails {
+      /**
+       * Total blocked guardrail events, not distinct requests.
+       */
+      blocked_events: number;
+
+      /**
+       * Total flagged guardrail events, not distinct requests.
+       */
+      flagged_events: number;
+
+      /**
+       * Up to 20 newest privacy-safe guardrail events, ordered by creation time
+       * descending and event ID.
+       */
+      recent_events: Array<Guardrails.RecentEvent>;
+    }
+
+    export namespace Guardrails {
+      export interface RecentEvent {
+        id: string;
+
+        created_at: string;
+
+        end_user_id: string | null;
+
+        evaluation_input_tokens: number | null;
+
+        evaluation_output_tokens: number | null;
+
+        findings: Array<RecentEvent.Finding>;
+
+        /**
+         * Model identifier.
+         */
+        model: string;
+
+        outcome: 'evaluated' | 'flagged' | 'blocked' | 'unevaluated';
+
+        record_type: 'guardrail_event';
+
+        request_id: string;
+
+        stage: 'prompt' | 'response';
+
+        token_group_id: string;
+
+        token_key_id: string;
+
+        token_user_id: string | null;
+      }
+
+      export namespace RecentEvent {
+        export interface Finding {
+          action: 'flag' | 'block';
+
+          code: string;
+
+          count: number;
+
+          detector: 'secrets' | 'dlp' | 'safety';
+        }
+      }
+    }
+
+    /**
+     * Metrics for all matching requests.
+     */
+    export interface Totals {
+      /**
+       * Requests served from the gateway cache.
+       */
+      cache_hits: number;
+
+      /**
+       * Requests classified as failed.
+       */
+      failed_requests: number;
+
+      /**
+       * Independently known input tokens across attempts, including corrected usage.
+       */
+      input_tokens: number;
+
+      /**
+       * Independently known output tokens across attempts, including corrected usage.
+       */
+      output_tokens: number;
+
+      /**
+       * Requests classified as partial after streaming began.
+       */
+      partial_requests: number;
+
+      /**
+       * Number of matching requests.
+       */
+      requests: number;
+
+      /**
+       * Unresolved budget reservations in USD.
+       */
+      reserved_spend: number;
+
+      /**
+       * Sum of known reference/enforcement cost in USD.
+       */
+      spend: number;
+
+      /**
+       * Requests classified as succeeded.
+       */
+      succeeded_requests: number;
+
+      /**
+       * Requests whose cost remains unresolved; unknown cost is excluded from spend.
+       */
+      unknown_requests: number;
+    }
+  }
+
+  export interface Meta {
+    end_date: string;
+
+    start_date: string;
+
+    token_group_id: string;
+  }
+}
+
+export interface UsageRetrieveSummaryParams {
+  /**
+   * Exclusive UTC date in YYYY-MM-DD format. Must follow start_date by 1 to 31 days.
+   */
+  end_date: string;
+
+  /**
+   * Inclusive UTC date in YYYY-MM-DD format. Must precede end_date by 1 to 31 days.
+   */
+  start_date: string;
+
+  /**
+   * ID of a token group owned by the authenticated account.
+   */
+  token_group_id: string;
+}
+
+export declare namespace Usage {
+  export {
+    type UsageRetrieveSummaryResponse as UsageRetrieveSummaryResponse,
+    type UsageRetrieveSummaryParams as UsageRetrieveSummaryParams,
+  };
+}

package/src/resources/llm-token-gateway.ts

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

package/src/resources/meeting-sessions/meeting-sessions.ts

@@ -139,12 +139,12 @@ export class MeetingSessions extends APIResource {
   }
 
   /**
-   * Irreversibly requests deletion of provider-hosted aggregate recording media
-   * under the provider contract. The operation retains the Telnyx-local Meeting
-   * session, transcript segments, events, artifacts, and usage records. It is
-   * separate from `DELETE /meeting_sessions/{id}`, which stops or cancels
-   * participation without deleting the persisted session. A missing/foreign session
-   * returns 404; provider deletion failures return 502.
+   * Irreversibly requests deletion of the aggregate recording media for the session.
+   * The operation retains the Telnyx-local Meeting session, transcript segments,
+   * events, artifacts, and usage records. It is separate from
+   * `DELETE /meeting_sessions/{id}`, which stops or cancels participation without
+   * deleting the persisted session. A missing/foreign session returns 404; provider
+   * deletion failures return 502.
    *
    * @example
    * ```ts
@@ -438,7 +438,7 @@ export namespace MeetingSessionDeleteRecordingMediaResponse {
      */
     meeting_session_id: string;
 
-    provider: 'recall';
+    provider: 'telnyx';
 
     scope: 'provider_recording_media';
   }
@@ -467,8 +467,7 @@ export interface MeetingSessionRetrieveRecordingsResponse {
 export namespace MeetingSessionRetrieveRecordingsResponse {
   export interface Data {
     /**
-     * Expiry timestamp when supplied by the provider, or null. The current adapter
-     * returns null.
+     * Expiry timestamp when available, or null. Currently returns null.
      */
     expires_at: string | null;
 

package/src/resources/porting-orders/phone-number-blocks.ts

@@ -130,7 +130,15 @@ export interface PortingPhoneNumberBlock {
   /**
    * Specifies the phone number type for this porting phone number block.
    */
-  phone_number_type?: 'landline' | 'local' | 'mobile' | 'national' | 'shared_cost' | 'toll_free';
+  phone_number_type?:
+    | 'landline'
+    | 'local'
+    | 'mobile'
+    | 'multipurpose'
+    | 'national'
+    | 'other'
+    | 'shared_cost'
+    | 'toll_free';
 
   /**
    * Identifies the type of the resource.

package/src/resources/porting-orders/porting-orders.ts

@@ -417,7 +417,15 @@ export interface PortingOrder {
   /**
    * The type of the phone number
    */
-  phone_number_type?: 'landline' | 'local' | 'mobile' | 'national' | 'shared_cost' | 'toll_free';
+  phone_number_type?:
+    | 'landline'
+    | 'local'
+    | 'mobile'
+    | 'multipurpose'
+    | 'national'
+    | 'other'
+    | 'shared_cost'
+    | 'toll_free';
 
   /**
    * List of phone numbers associated with this porting order

package/src/resources/porting-phone-numbers.ts

@@ -56,7 +56,15 @@ export interface PortingPhoneNumber {
   /**
    * The type of the phone number
    */
-  phone_number_type?: 'landline' | 'local' | 'mobile' | 'national' | 'shared_cost' | 'toll_free';
+  phone_number_type?:
+    | 'landline'
+    | 'local'
+    | 'mobile'
+    | 'multipurpose'
+    | 'national'
+    | 'other'
+    | 'shared_cost'
+    | 'toll_free';
 
   /**
    * Specifies whether Telnyx is able to confirm portability this number in the

package/src/resources/requirements.ts

@@ -97,7 +97,7 @@ export interface DocReqsRequirement {
    * Indicates the phone_number_type this requirement applies to. Leave blank if this
    * requirement applies to all number_types.
    */
-  phone_number_type?: 'local' | 'national' | 'toll_free';
+  phone_number_type?: 'local' | 'mobile' | 'multipurpose' | 'national' | 'shared_cost' | 'toll_free';
 
   /**
    * Identifies the type of the resource.
@@ -173,7 +173,7 @@ export namespace RequirementListParams {
     /**
      * Filters results to those applying to a specific phone_number_type
      */
-    phone_number_type?: 'local' | 'national' | 'toll_free';
+    phone_number_type?: 'local' | 'mobile' | 'multipurpose' | 'national' | 'shared_cost' | 'toll_free';
   }
 }