telnyx 7.21.0 → 7.23.0

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,
@@ -185,6 +197,7 @@ export {
   type CommentListParams,
   type CommentCreateParams,
 } from './comments';
+export { Compute } from './compute/compute';
 export {
   Conferences,
   type Conference,
@@ -207,6 +220,7 @@ export {
   type Connection,
   type ConnectionRetrieveResponse,
   type ConnectionListActiveCallsResponse,
+  type ConnectionRetrieveCountResponse,
   type ConnectionListParams,
   type ConnectionListActiveCallsParams,
   type ConnectionsDefaultFlatPagination,
@@ -647,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,
@@ -774,6 +793,7 @@ export {
   MessagingProfiles,
   type MessagingMessagingProfile,
   type MessagingProfile,
+  type MessagingProfileFeatures,
   type NumberPoolSettings,
   type URLShortenerSettings,
   type MessagingProfileCreateResponse,
@@ -857,6 +877,10 @@ export {
   type NetworksDefaultFlatPagination,
   type NetworkListInterfacesResponsesDefaultFlatPagination,
 } from './networks/networks';
+export {
+  NoiseSuppressionEngines,
+  type NoiseSuppressionEngineListResponse,
+} from './noise-suppression-engines';
 export {
   NotificationChannels,
   type NotificationChannel,
@@ -1619,10 +1643,13 @@ export {
   type FaxSendingStarted,
   type InboundMessage,
   type InboundSipHeader,
+  type MessagingInboundMessage,
   type NumberOrderStatusUpdate,
   type OutboundMessage,
   type ReplacedLinkClick,
   type Transcription,
+  type WhatsappAccountUpdate,
+  type WhatsappMessageEcho,
   type CallAIGatherEndedWebhookEvent,
   type CallAIGatherMessageHistoryUpdatedWebhookEvent,
   type CallAIGatherPartialResultsWebhookEvent,

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,
+  };
+}

package/src/resources/messages/messages.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../core/resource';
 import * as MessagesAPI from './messages';
-import * as Shared from '../shared';
 import * as RcsAPI from './rcs';
 import {
   RcGenerateDeeplinkParams,
@@ -257,6 +256,19 @@ export interface MessagingInboundMessagePayload {
    */
   id?: string;
 
+  /**
+   * Automatic response type triggered by an inbound opt-in, opt-out, or help
+   * keyword. Examples include START, STOP, and HELP.
+   */
+  autoresponse_type?: string;
+
+  /**
+   * Message body for RCS and WhatsApp. RCS messages contain text, user_file,
+   * location, or suggestion_response. For WhatsApp edits and revocations, inspect
+   * type and the corresponding edit or revoke object.
+   */
+  body?: MessagingInboundMessagePayload.Body;
+
   cc?: Array<MessagingInboundMessagePayload.Cc>;
 
   /**
@@ -359,12 +371,17 @@ export interface MessagingInboundMessagePayload {
    */
   text?: string;
 
-  to?: Array<MessagingInboundMessagePayload.To>;
+  /**
+   * Receiving address. SMS, MMS and RCS webhooks use an array of recipients. RCS
+   * recipients are identified by agent_id and agent_name. WhatsApp webhooks use one
+   * E.164 phone number.
+   */
+  to?: Array<MessagingInboundMessagePayload.UnionMember0> | string;
 
   /**
-   * The type of message. This value can be either 'sms' or 'mms'.
+   * The messaging channel used for the message.
    */
-  type?: 'SMS' | 'MMS';
+  type?: 'SMS' | 'MMS' | 'WHATSAPP' | 'RCS';
 
   /**
    * Not used for inbound messages.
@@ -384,6 +401,155 @@ export interface MessagingInboundMessagePayload {
 }
 
 export namespace MessagingInboundMessagePayload {
+  /**
+   * Message body for RCS and WhatsApp. RCS messages contain text, user_file,
+   * location, or suggestion_response. For WhatsApp edits and revocations, inspect
+   * type and the corresponding edit or revoke object.
+   */
+  export interface Body {
+    /**
+     * Telnyx identifier for this webhook message.
+     */
+    id?: string;
+
+    /**
+     * Details for an edited WhatsApp message.
+     */
+    edit?: Body.Edit;
+
+    /**
+     * Meta WhatsApp message identifier for this webhook event.
+     */
+    foreign_id?: string;
+
+    /**
+     * WhatsApp sender in E.164 format.
+     */
+    from?: string;
+
+    /**
+     * Location shared in an RCS message.
+     */
+    location?: Body.Location;
+
+    /**
+     * Details for a revoked WhatsApp message.
+     */
+    revoke?: Body.Revoke;
+
+    /**
+     * Selected RCS suggestion.
+     */
+    suggestion_response?: Body.SuggestionResponse;
+
+    /**
+     * RCS text string or WhatsApp text object.
+     */
+    text?: string | Body.Body;
+
+    /**
+     * Unix timestamp supplied by Meta.
+     */
+    timestamp?: string;
+
+    /**
+     * WhatsApp message body type. Edit and revoke events use `edit` and `revoke`,
+     * respectively.
+     */
+    type?: string;
+
+    /**
+     * RCS file attachment and optional thumbnail.
+     */
+    user_file?: Body.UserFile;
+
+    [k: string]: unknown;
+  }
+
+  export namespace Body {
+    /**
+     * Details for an edited WhatsApp message.
+     */
+    export interface Edit {
+      /**
+       * Replacement WhatsApp message content. Its shape depends on the message type.
+       */
+      message: { [key: string]: unknown };
+
+      /**
+       * Telnyx message ID when a mapping exists, otherwise the original Meta WhatsApp
+       * message ID. Treat this value as opaque.
+       */
+      original_message_id: string;
+    }
+
+    /**
+     * Location shared in an RCS message.
+     */
+    export interface Location {
+      latitude?: number;
+
+      longitude?: number;
+    }
+
+    /**
+     * Details for a revoked WhatsApp message.
+     */
+    export interface Revoke {
+      /**
+       * Telnyx message ID when a mapping exists, otherwise the original Meta WhatsApp
+       * message ID. Treat this value as opaque.
+       */
+      original_message_id: string;
+    }
+
+    /**
+     * Selected RCS suggestion.
+     */
+    export interface SuggestionResponse {
+      postback_data?: string;
+
+      text?: string;
+    }
+
+    export interface Body {
+      body?: string;
+
+      [k: string]: unknown;
+    }
+
+    /**
+     * RCS file attachment and optional thumbnail.
+     */
+    export interface UserFile {
+      payload?: UserFile.Payload;
+
+      thumbnail?: UserFile.Thumbnail;
+    }
+
+    export namespace UserFile {
+      export interface Payload {
+        file_name?: string;
+
+        file_size_bytes?: number;
+
+        file_uri?: string;
+
+        mime_type?: string;
+      }
+
+      export interface Thumbnail {
+        file_name?: string;
+
+        file_size_bytes?: number;
+
+        file_uri?: string;
+
+        mime_type?: string;
+      }
+    }
+  }
+
   export interface Cc {
     /**
      * The carrier of the receiver.
@@ -414,12 +580,12 @@ export namespace MessagingInboundMessagePayload {
     /**
      * The amount deducted from your account.
      */
-    amount?: string;
+    amount?: string | null;
 
     /**
      * The ISO 4217 currency identifier.
      */
-    currency?: string;
+    currency?: string | null;
   }
 
   /**
@@ -466,7 +632,7 @@ export namespace MessagingInboundMessagePayload {
     /**
      * The line-type of the sender.
      */
-    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '' | 'long_code';
 
     /**
      * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
@@ -474,7 +640,7 @@ export namespace MessagingInboundMessagePayload {
      */
     phone_number?: string;
 
-    status?: 'received' | 'delivered';
+    status?: 'received' | 'delivered' | 'webhook_delivered';
   }
 
   export interface Media {
@@ -499,7 +665,17 @@ export namespace MessagingInboundMessagePayload {
     url?: string;
   }
 
-  export interface To {
+  export interface UnionMember0 {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -533,6 +709,11 @@ export interface MessagingOutboundMessagePayload {
    */
   id?: string;
 
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  body?: MessagingOutboundMessagePayload.Body;
+
   cc?: Array<MessagingOutboundMessagePayload.Cc>;
 
   /**
@@ -648,7 +829,7 @@ export interface MessagingOutboundMessagePayload {
   /**
    * The type of message.
    */
-  type?: 'SMS' | 'MMS';
+  type?: 'SMS' | 'MMS' | 'RCS';
 
   /**
    * Message must be out of the queue by this time or else it will be discarded and
@@ -677,6 +858,16 @@ export interface MessagingOutboundMessagePayload {
 }
 
 export namespace MessagingOutboundMessagePayload {
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  export interface Body {
+    /**
+     * RCS text message.
+     */
+    text?: string;
+  }
+
   export interface Cc {
     /**
      * The carrier of the receiver.
@@ -751,6 +942,16 @@ export namespace MessagingOutboundMessagePayload {
   }
 
   export interface From {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -817,7 +1018,8 @@ export namespace MessagingOutboundMessagePayload {
       | 'sending_failed'
       | 'delivery_unconfirmed'
       | 'delivered'
-      | 'delivery_failed';
+      | 'delivery_failed'
+      | 'read';
   }
 }
 
@@ -827,6 +1029,11 @@ export interface OutboundMessagePayload {
    */
   id?: string;
 
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  body?: OutboundMessagePayload.Body;
+
   cc?: Array<OutboundMessagePayload.Cc>;
 
   /**
@@ -856,7 +1063,7 @@ export interface OutboundMessagePayload {
    * These errors may point at addressees when referring to unsuccessful/unconfirmed
    * delivery statuses.
    */
-  errors?: Array<Shared.MessagingError>;
+  errors?: Array<MessagingError0b38e7044b>;
 
   from?: OutboundMessagePayload.From;
 
@@ -942,7 +1149,7 @@ export interface OutboundMessagePayload {
   /**
    * The type of message.
    */
-  type?: 'SMS' | 'MMS';
+  type?: 'SMS' | 'MMS' | 'RCS';
 
   /**
    * Message must be out of the queue by this time or else it will be discarded and
@@ -971,6 +1178,16 @@ export interface OutboundMessagePayload {
 }
 
 export namespace OutboundMessagePayload {
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  export interface Body {
+    /**
+     * RCS text message.
+     */
+    text?: string;
+  }
+
   export interface Cc {
     /**
      * The carrier of the receiver.
@@ -1045,6 +1262,16 @@ export namespace OutboundMessagePayload {
   }
 
   export interface From {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -1111,7 +1338,8 @@ export namespace OutboundMessagePayload {
       | 'sending_failed'
       | 'delivery_unconfirmed'
       | 'delivered'
-      | 'delivery_failed';
+      | 'delivery_failed'
+      | 'read';
   }
 }
 
@@ -1834,7 +2062,7 @@ export interface WhatsappReaction {
 }
 
 export interface MessageRetrieveResponse {
-  data?: MessagingOutboundMessagePayload | MessagingInboundMessagePayload;
+  data?: OutboundMessagePayload | MessagingInboundMessagePayload;
 }
 
 export interface MessageCancelScheduledResponse {
@@ -2133,31 +2361,31 @@ export namespace MessageCancelScheduledResponse {
 }
 
 export interface MessageRetrieveGroupMessagesResponse {
-  data?: Array<MessagingOutboundMessagePayload>;
+  data?: Array<OutboundMessagePayload>;
 }
 
 export interface MessageScheduleResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendGroupMmsResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendLongCodeResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendNumberPoolResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendShortCodeResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendWithAlphanumericSenderResponse {

package/src/resources/messaging-profiles/index.ts

@@ -18,6 +18,7 @@ export {
   MessagingProfiles,
   type MessagingMessagingProfile,
   type MessagingProfile,
+  type MessagingProfileFeatures,
   type NumberPoolSettings,
   type URLShortenerSettings,
   type MessagingProfileCreateResponse,