telnyx 7.22.0 → 7.23.0

package/src/resources/connections.ts

@@ -42,6 +42,15 @@ export class Connections extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<ConnectionRetrieveResponse> {
     return this._client.get(path`/connections/${id}`, options);
   }
+
+  /**
+   * Returns the number of connections associated with the authenticated user,
+   * grouped by connection type, together with the connection limits that apply to
+   * the user. Forward-only connections are excluded from the counts.
+   */
+  retrieveCount(options?: RequestOptions): APIPromise<ConnectionRetrieveCountResponse> {
+    return this._client.get('/connections/count', options);
+  }
 }
 
 export type ConnectionsDefaultFlatPagination = DefaultFlatPagination<Connection>;
@@ -146,6 +155,129 @@ export interface ConnectionListActiveCallsResponse {
   record_type: 'call';
 }
 
+export interface ConnectionRetrieveCountResponse {
+  data: ConnectionRetrieveCountResponse.Data;
+}
+
+export namespace ConnectionRetrieveCountResponse {
+  export interface Data {
+    /**
+     * Counts of the authenticated user's connections, grouped by connection type.
+     * Forward-only connections are excluded.
+     */
+    counts: Data.Counts;
+
+    /**
+     * Connection limits that apply to the user. Contains a single global_limit when a
+     * global connection limit applies, or per-type limits (standard_limit, texml_limit
+     * and uac_limit) when the user has per-type connection count capabilities.
+     */
+    limits: Data.GlobalConnectionLimit | Data.PerTypeConnectionLimits;
+
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Counts of the authenticated user's connections, grouped by connection type.
+     * Forward-only connections are excluded.
+     */
+    export interface Counts {
+      /**
+       * Number of Call Control applications.
+       */
+      call_control_applications: number;
+
+      /**
+       * Number of credential connections.
+       */
+      credential_connections: number;
+
+      /**
+       * Number of external connections.
+       */
+      external_connections: number;
+
+      /**
+       * Number of Fax applications.
+       */
+      fax_connections: number;
+
+      /**
+       * Number of FQDN connections.
+       */
+      fqdn_connections: number;
+
+      /**
+       * Number of IP connections.
+       */
+      ip_connections: number;
+
+      /**
+       * Number of Microsoft Teams SBC (direct routing) connections.
+       */
+      microsoft_teams_sbc_connections: number;
+
+      /**
+       * Number of mobile voice (IMS) connections.
+       */
+      mobile_voice_connections: number;
+
+      /**
+       * Number of Microsoft Operator Connect connections.
+       */
+      operator_connect_connections: number;
+
+      /**
+       * Number of TeXML applications.
+       */
+      texml_applications: number;
+
+      /**
+       * Number of third-party provider connections.
+       */
+      third_party_provider_connections: number;
+
+      /**
+       * Number of UAC connections.
+       */
+      uac_connections: number;
+
+      /**
+       * Number of Zoom SBC connections.
+       */
+      zoom_sbc_connections: number;
+    }
+
+    export interface GlobalConnectionLimit {
+      /**
+       * Maximum total number of connections allowed, when a global limit applies.
+       */
+      global_limit: number;
+    }
+
+    export interface PerTypeConnectionLimits {
+      /**
+       * Maximum number of standard connections allowed, when per-type limits apply.
+       */
+      standard_limit: number;
+
+      /**
+       * Maximum number of TeXML applications allowed, when per-type limits apply.
+       */
+      texml_limit: number;
+
+      /**
+       * Maximum number of UAC connections allowed, when per-type limits apply.
+       */
+      uac_limit: number;
+    }
+  }
+}
+
 export interface ConnectionListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -219,6 +351,7 @@ export declare namespace Connections {
     type Connection as Connection,
     type ConnectionRetrieveResponse as ConnectionRetrieveResponse,
     type ConnectionListActiveCallsResponse as ConnectionListActiveCallsResponse,
+    type ConnectionRetrieveCountResponse as ConnectionRetrieveCountResponse,
     type ConnectionsDefaultFlatPagination as ConnectionsDefaultFlatPagination,
     type ConnectionListActiveCallsResponsesDefaultFlatPagination as ConnectionListActiveCallsResponsesDefaultFlatPagination,
     type ConnectionListParams as ConnectionListParams,

package/src/resources/detail-records.ts

@@ -684,11 +684,22 @@ export interface DetailRecordListParams extends DefaultFlatPaginationParams {
   /**
    * Filter records on a given record attribute and value. <br/>Example:
    * filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
+   * <br/>The valid filter fields depend on the record_type: filtering by a field
+   * that does not exist for the selected record_type is rejected with a 400 error.
+   * Call-control and sip-trunking records use started_at, finished_at and
+   * answered_at (they have no created_at); messaging records use created_at. To list
+   * the fields available for a record_type, use the /v2/detail_records/options
+   * endpoint.
    */
   filter?: DetailRecordListParams.Filter;
 
   /**
-   * Specifies the sort order for results. <br/>Example: sort=-created_at
+   * Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The
+   * valid sort fields depend on the record_type: sort by a field that does not exist
+   * for the selected record_type is rejected with a 400 error. Call-control and
+   * sip-trunking records use started_at, finished_at and answered_at (they have no
+   * created_at); messaging records use created_at. To list the fields available for
+   * a record_type, use the /v2/detail_records/options endpoint.
    */
   sort?: Array<string>;
 }
@@ -697,6 +708,12 @@ export namespace DetailRecordListParams {
   /**
    * Filter records on a given record attribute and value. <br/>Example:
    * filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
+   * <br/>The valid filter fields depend on the record_type: filtering by a field
+   * that does not exist for the selected record_type is rejected with a 400 error.
+   * Call-control and sip-trunking records use started_at, finished_at and
+   * answered_at (they have no created_at); messaging records use created_at. To list
+   * the fields available for a record_type, use the /v2/detail_records/options
+   * endpoint.
    */
   export interface Filter {
     /**

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

@@ -109,9 +109,11 @@ export class EmailMessages extends APIResource {
   }
 
   /**
-   * Creates up to 1,000 email messages in a single request. Each message is
-   * validated and sent independently; per-message failures do not affect other
-   * messages in the batch. All responses use 207 Multi-Status.
+   * Creates up to 1,000 email messages in a single request. Request-wide admission
+   * checks run first and can reject the whole batch before message creation. After
+   * those checks pass, each message is validated and sent independently; item-level
+   * failures do not affect other messages, and the processed batch returns 207
+   * Multi-Status.
    *
    * @example
    * ```ts

package/src/resources/index.ts

@@ -100,6 +100,18 @@ export {
   type BillingGroupUpdateParams,
   type BillingGroupsDefaultFlatPagination,
 } from './billing-groups';
+export {
+  BotChallenge,
+  type BotChallengeCreateResponse,
+  type BotChallengeCreateParams,
+} from './bot-challenge';
+export { BotSessions, type BotSessionListResponse, type BotSessionListParams } from './bot-sessions';
+export {
+  BotSignup,
+  type SuccessResponse,
+  type BotSignupCreateParams,
+  type BotSignupResendMagicLinkParams,
+} from './bot-signup';
 export {
   BulkSimCardActions,
   type BulkSimCardActionDetailed,
@@ -208,6 +220,7 @@ export {
   type Connection,
   type ConnectionRetrieveResponse,
   type ConnectionListActiveCallsResponse,
+  type ConnectionRetrieveCountResponse,
   type ConnectionListParams,
   type ConnectionListActiveCallsParams,
   type ConnectionsDefaultFlatPagination,
@@ -648,6 +661,11 @@ export {
 } from './ledger-billing-group-reports';
 export { Legacy } from './legacy/legacy';
 export { List, type ListRetrieveAllResponse, type ListRetrieveByZoneResponse } from './list';
+export {
+  MachinePayments,
+  type MachinePaymentAccountCreditResponse,
+  type MachinePaymentAccountCreditParams,
+} from './machine-payments';
 export {
   ManagedAccounts,
   type ManagedAccount,
@@ -859,6 +877,10 @@ export {
   type NetworksDefaultFlatPagination,
   type NetworkListInterfacesResponsesDefaultFlatPagination,
 } from './networks/networks';
+export {
+  NoiseSuppressionEngines,
+  type NoiseSuppressionEngineListResponse,
+} from './noise-suppression-engines';
 export {
   NotificationChannels,
   type NotificationChannel,
@@ -1621,6 +1643,7 @@ export {
   type FaxSendingStarted,
   type InboundMessage,
   type InboundSipHeader,
+  type MessagingInboundMessage,
   type NumberOrderStatusUpdate,
   type OutboundMessage,
   type ReplacedLinkClick,

package/src/resources/machine-payments.ts

@@ -0,0 +1,169 @@
+// 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';
+
+/**
+ * Machine payment (MPP) account-credit operations. Fund your Telnyx account programmatically from a machine or agent using the Machine Payment Protocol, an HTTP-402 flow settled via Stripe or Tempo.
+ */
+export class MachinePayments extends APIResource {
+  /**
+   * Creates an account credit using the Machine Payment Protocol (MPP), an HTTP-402
+   * payment flow for machines and agents.
+   *
+   * The flow has two steps. First, send an authenticated request with the
+   * `amount_usd` to credit; the response is `402 Payment Required` with one or more
+   * payment challenges (for example separate Tempo and Stripe challenges) in the
+   * `WWW-Authenticate` header. Second, retry the request with an
+   * `Authorization: Payment ...` credential constructed from the challenge; on
+   * success the response includes the credited transaction and a `Payment-Receipt`
+   * header.
+   *
+   * The credited account is never chosen by the request body: the initial request
+   * credits the account of the authenticated user, and a paid retry credits the
+   * account bound to the verified payment credential. The amount must be within the
+   * configured bounds (by default between 5.00 and 500.00 USD).
+   *
+   * Successful paid retries are idempotent — when Rails reaches its
+   * duplicate-transaction lookup for an already-recorded payment, it returns the
+   * existing transaction with `created: false` instead of crediting the account
+   * again. This deduplication applies to successful fulfillment: re-sending the same
+   * Stripe credential may instead be rejected by the upstream provider as an
+   * idempotent replay and return `402 Payment Required` rather than the existing
+   * transaction.
+   *
+   * > **Warning: the payment credential is bound to a specific Telnyx account ID.**
+   * > A payment is captured before the bound account is validated. If the credential
+   * > names an account that is missing, suspended, blocked, cancelled, dormant, or
+   * > ineligible for the tier, the payment is captured but **no account is
+   * > credited**. If the credential names a different but eligible account, that
+   * > account is credited — the service does not compare it against the payer's
+   * > account. There is **no automatic refund**: if the captured payment does not
+   * > credit the intended account, contact Telnyx support for remediation.
+   *
+   * @example
+   * ```ts
+   * const response = await client.machinePayments.accountCredit(
+   *   { amount_usd: '10.00' },
+   * );
+   * ```
+   */
+  accountCredit(
+    body: MachinePaymentAccountCreditParams,
+    options?: RequestOptions,
+  ): APIPromise<MachinePaymentAccountCreditResponse> {
+    return this._client.post('/machine-payments/account-credit', { body, ...options });
+  }
+}
+
+export interface MachinePaymentAccountCreditResponse {
+  /**
+   * An account-credit transaction settled through the Machine Payment Protocol.
+   */
+  data?: MachinePaymentAccountCreditResponse.Data;
+}
+
+export namespace MachinePaymentAccountCreditResponse {
+  /**
+   * An account-credit transaction settled through the Machine Payment Protocol.
+   */
+  export interface Data {
+    /**
+     * Unique identifier of the account-credit transaction.
+     */
+    id: string;
+
+    /**
+     * Identifier of the credited Telnyx account. Derived from the authenticated user
+     * on the initial request and from the verified payment credential on a paid retry
+     * — never from the request body.
+     */
+    account_id: string;
+
+    /**
+     * Credited amount as a decimal string with two fractional digits.
+     */
+    amount: string;
+
+    /**
+     * ISO 4217 currency code of the credited amount (currently always USD).
+     */
+    currency: string;
+
+    /**
+     * Payment source identifier distinguishing machine payments from other
+     * account-credit sources.
+     */
+    payment_source: 'machine_payment';
+
+    /**
+     * Record type identifier.
+     */
+    record_type: 'machine_payment_account_credit';
+
+    /**
+     * True when this response created a new account credit, false when an existing
+     * transaction was returned for a duplicate paid retry.
+     */
+    created?: boolean;
+
+    /**
+     * ISO 8601 timestamp when the transaction was created.
+     */
+    created_at?: string;
+
+    /**
+     * Machine Payment Protocol resource identifier the payment credential was bound
+     * to.
+     */
+    mpp_resource?: string | null;
+
+    /**
+     * Stripe PaymentIntent identifier for Stripe settlements. Absent for Tempo
+     * settlements.
+     */
+    payment_intent_id?: string | null;
+
+    /**
+     * Payment method used by the provider: `stripe_spt` for Stripe Shared Payment
+     * Token payments, `tempo_usdc` for Tempo USDC payments.
+     */
+    payment_method?: 'stripe_spt' | 'tempo_usdc' | null;
+
+    /**
+     * Upstream payment provider that settled the payment.
+     */
+    provider?: 'stripe' | 'tempo' | null;
+
+    /**
+     * Provider receipt reference: the Stripe PaymentIntent identifier for Stripe
+     * settlements, or the on-chain transaction hash for Tempo settlements.
+     */
+    receipt_reference?: string | null;
+
+    /**
+     * Status of the transaction. Successful machine payment credits are recorded as
+     * `settled`.
+     */
+    status?: 'new' | 'processing' | 'settled' | 'expired' | 'invalid' | null;
+  }
+}
+
+export interface MachinePaymentAccountCreditParams {
+  /**
+   * Amount to credit in USD, as a decimal string with up to two fractional digits
+   * (by default between 5.00 and 500.00). The request body is required on the
+   * initial challenge request and remains required on a paid retry, where you
+   * re-send the identical body plus the payment credential — the credential, not the
+   * body, selects the payment, and the retried body is not re-validated.
+   */
+  amount_usd: string;
+}
+
+export declare namespace MachinePayments {
+  export {
+    type MachinePaymentAccountCreditResponse as MachinePaymentAccountCreditResponse,
+    type MachinePaymentAccountCreditParams as MachinePaymentAccountCreditParams,
+  };
+}