telnyx 7.21.0 → 7.22.0

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

@@ -163,6 +163,26 @@ export class PhoneNumbers extends APIResource {
   ): APIPromise<PhoneNumberGetResponse> {
     return this._client.get('/whatsapp/phone_numbers', { query, ...options });
   }
+
+  /**
+   * Returns one WhatsApp phone number linked to the authenticated Telnyx account.
+   * For a coexistence number in the `syncing` state, the response includes
+   * `sync_progress`.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.whatsapp.phoneNumbers.retrievePhoneNumber(
+   *     'phone_number',
+   *   );
+   * ```
+   */
+  retrievePhoneNumber(
+    phoneNumber: string,
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberRetrievePhoneNumberResponse> {
+    return this._client.get(path`/whatsapp/phone_numbers/${phoneNumber}`, options);
+  }
 }
 
 export type PhoneNumberListResponsesDefaultFlatPagination = DefaultFlatPagination<PhoneNumberListResponse>;
@@ -170,12 +190,34 @@ export type PhoneNumberListResponsesDefaultFlatPagination = DefaultFlatPaginatio
 export interface PhoneNumberListResponse {
   calling_enabled?: boolean;
 
+  /**
+   * Current lifecycle state for a coexistence number. This is null for a standard
+   * Cloud API number.
+   */
+  coexistence_state?:
+    | 'pending_onboarding'
+    | 'sync_pending'
+    | 'syncing'
+    | 'sync_complete'
+    | 'active'
+    | 'history_declined'
+    | 'sync_deadline_expired'
+    | 'offboarded'
+    | 'disconnected'
+    | null;
+
   created_at?: string;
 
   display_name?: string;
 
   enabled?: boolean;
 
+  /**
+   * Indicates whether the number is connected to both the WhatsApp Business app and
+   * Cloud API through WhatsApp Coexistence.
+   */
+  is_on_biz_app?: boolean;
+
   /**
    * Phone number in E164 format
    */
@@ -195,6 +237,18 @@ export interface PhoneNumberListResponse {
 
   status?: string;
 
+  /**
+   * Deadline for initiating the current coexistence synchronization cycle. This is
+   * null when no deadline applies.
+   */
+  sync_deadline?: string | null;
+
+  /**
+   * Synchronization progress. This object is returned only while a coexistence
+   * number is synchronizing.
+   */
+  sync_progress?: PhoneNumberListResponse.SyncProgress | null;
+
   /**
    * User ID
    */
@@ -206,6 +260,24 @@ export interface PhoneNumberListResponse {
   waba_id?: string;
 }
 
+export namespace PhoneNumberListResponse {
+  /**
+   * Synchronization progress. This object is returned only while a coexistence
+   * number is synchronizing.
+   */
+  export interface SyncProgress {
+    contacts_status?: string;
+
+    history_chunk_order?: number | null;
+
+    history_phase?: number | null;
+
+    history_progress?: number | null;
+
+    history_status?: string;
+  }
+}
+
 export interface PhoneNumberGetResponse {
   data?: Array<PhoneNumberGetResponse.Data>;
 
@@ -216,12 +288,34 @@ export namespace PhoneNumberGetResponse {
   export interface Data {
     calling_enabled?: boolean;
 
+    /**
+     * Current lifecycle state for a coexistence number. This is null for a standard
+     * Cloud API number.
+     */
+    coexistence_state?:
+      | 'pending_onboarding'
+      | 'sync_pending'
+      | 'syncing'
+      | 'sync_complete'
+      | 'active'
+      | 'history_declined'
+      | 'sync_deadline_expired'
+      | 'offboarded'
+      | 'disconnected'
+      | null;
+
     created_at?: string;
 
     display_name?: string;
 
     enabled?: boolean;
 
+    /**
+     * Indicates whether the number is connected to both the WhatsApp Business app and
+     * Cloud API through WhatsApp Coexistence.
+     */
+    is_on_biz_app?: boolean;
+
     /**
      * Phone number in E164 format
      */
@@ -241,6 +335,18 @@ export namespace PhoneNumberGetResponse {
 
     status?: string;
 
+    /**
+     * Deadline for initiating the current coexistence synchronization cycle. This is
+     * null when no deadline applies.
+     */
+    sync_deadline?: string | null;
+
+    /**
+     * Synchronization progress. This object is returned only while a coexistence
+     * number is synchronizing.
+     */
+    sync_progress?: Data.SyncProgress | null;
+
     /**
      * User ID
      */
@@ -251,6 +357,24 @@ export namespace PhoneNumberGetResponse {
      */
     waba_id?: string;
   }
+
+  export namespace Data {
+    /**
+     * Synchronization progress. This object is returned only while a coexistence
+     * number is synchronizing.
+     */
+    export interface SyncProgress {
+      contacts_status?: string;
+
+      history_chunk_order?: number | null;
+
+      history_phase?: number | null;
+
+      history_progress?: number | null;
+
+      history_status?: string;
+    }
+  }
 }
 
 export interface PhoneNumberRetrieveConversationWindowResponse {
@@ -281,6 +405,103 @@ export namespace PhoneNumberRetrieveConversationWindowResponse {
   }
 }
 
+export interface PhoneNumberRetrievePhoneNumberResponse {
+  data: PhoneNumberRetrievePhoneNumberResponse.Data;
+}
+
+export namespace PhoneNumberRetrievePhoneNumberResponse {
+  export interface Data {
+    calling_enabled?: boolean;
+
+    /**
+     * Current lifecycle state for a coexistence number. This is null for a standard
+     * Cloud API number.
+     */
+    coexistence_state?:
+      | 'pending_onboarding'
+      | 'sync_pending'
+      | 'syncing'
+      | 'sync_complete'
+      | 'active'
+      | 'history_declined'
+      | 'sync_deadline_expired'
+      | 'offboarded'
+      | 'disconnected'
+      | null;
+
+    created_at?: string;
+
+    display_name?: string;
+
+    enabled?: boolean;
+
+    /**
+     * Indicates whether the number is connected to both the WhatsApp Business app and
+     * Cloud API through WhatsApp Coexistence.
+     */
+    is_on_biz_app?: boolean;
+
+    /**
+     * Phone number in E164 format
+     */
+    phone_number?: string;
+
+    /**
+     * Whatsapp phone number ID
+     */
+    phone_number_id?: string;
+
+    /**
+     * Whatsapp quality rating
+     */
+    quality_rating?: string;
+
+    record_type?: string;
+
+    status?: string;
+
+    /**
+     * Deadline for initiating the current coexistence synchronization cycle. This is
+     * null when no deadline applies.
+     */
+    sync_deadline?: string | null;
+
+    /**
+     * Synchronization progress. This object is returned only while a coexistence
+     * number is synchronizing.
+     */
+    sync_progress?: Data.SyncProgress | null;
+
+    /**
+     * User ID
+     */
+    user_id?: string;
+
+    /**
+     * WABA ID of Whatsapp business account
+     */
+    waba_id?: string;
+  }
+
+  export namespace Data {
+    /**
+     * Synchronization progress. This object is returned only while a coexistence
+     * number is synchronizing.
+     */
+    export interface SyncProgress {
+      contacts_status?: string;
+
+      history_chunk_order?: number | null;
+
+      history_phase?: number | null;
+
+      history_progress?: number | null;
+
+      history_status?: string;
+    }
+  }
+}
+
 export interface PhoneNumberListParams extends DefaultFlatPaginationParams {}
 
 export interface PhoneNumberResendVerificationParams {
@@ -313,6 +534,7 @@ export declare namespace PhoneNumbers {
     type PhoneNumberListResponse as PhoneNumberListResponse,
     type PhoneNumberGetResponse as PhoneNumberGetResponse,
     type PhoneNumberRetrieveConversationWindowResponse as PhoneNumberRetrieveConversationWindowResponse,
+    type PhoneNumberRetrievePhoneNumberResponse as PhoneNumberRetrievePhoneNumberResponse,
     type PhoneNumberListResponsesDefaultFlatPagination as PhoneNumberListResponsesDefaultFlatPagination,
     type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberResendVerificationParams as PhoneNumberResendVerificationParams,

package/src/resources/whatsapp/whatsapp.ts

@@ -39,6 +39,7 @@ import {
   PhoneNumberResendVerificationParams,
   PhoneNumberRetrieveConversationWindowParams,
   PhoneNumberRetrieveConversationWindowResponse,
+  PhoneNumberRetrievePhoneNumberResponse,
   PhoneNumberVerifyParams,
   PhoneNumbers,
 } from './phone-numbers/phone-numbers';
@@ -83,6 +84,7 @@ export declare namespace Whatsapp {
     type PhoneNumberListResponse as PhoneNumberListResponse,
     type PhoneNumberGetResponse as PhoneNumberGetResponse,
     type PhoneNumberRetrieveConversationWindowResponse as PhoneNumberRetrieveConversationWindowResponse,
+    type PhoneNumberRetrievePhoneNumberResponse as PhoneNumberRetrievePhoneNumberResponse,
     type PhoneNumberListResponsesDefaultFlatPagination as PhoneNumberListResponsesDefaultFlatPagination,
     type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberResendVerificationParams as PhoneNumberResendVerificationParams,

package/src/resources/x402/credit-account/credit-account.ts

@@ -0,0 +1,312 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as PaymentsAPI from './payments';
+import {
+  PaymentListParams,
+  PaymentRetrieveResponse,
+  Payments,
+  X402TransactionRecord,
+  X402TransactionRecordsDefaultFlatPagination,
+} from './payments';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * Operations for x402 cryptocurrency payment transactions. Fund your Telnyx account using USDC stablecoin payments via the x402 protocol.
+ */
+export class CreditAccount extends APIResource {
+  payments: PaymentsAPI.Payments = new PaymentsAPI.Payments(this._client);
+
+  /**
+   * Settles an x402 payment using the quote ID and a signed payment authorization.
+   * The payment signature can be provided via the `PAYMENT-SIGNATURE` header or the
+   * `payment_signature` body parameter. Settlement is idempotent — submitting the
+   * same quote ID multiple times returns the existing transaction.
+   *
+   * @example
+   * ```ts
+   * const response = await client.x402.creditAccount.settle({
+   *   id: 'quote_abc123',
+   *   payment_signature: '0xabc123...',
+   * });
+   * ```
+   */
+  settle(
+    params: CreditAccountSettleParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditAccountSettleResponse> {
+    const { header_payment_signature, ...body } = params;
+    return this._client.post('/x402/credit_account', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(header_payment_signature != null ?
+            { 'PAYMENT-SIGNATURE': header_payment_signature }
+          : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Creates a payment quote for the specified USD amount. Returns payment details
+   * including the x402 payment requirements, network, and expiration time. The quote
+   * must be settled before it expires.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.x402.creditAccount.createQuote({
+   *     amount_usd: '50.00',
+   *   });
+   * ```
+   */
+  createQuote(
+    body: CreditAccountCreateQuoteParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditAccountCreateQuoteResponse> {
+    return this._client.post('/x402/credit_account/quote', { body, ...options });
+  }
+}
+
+export interface CreditAccountCreateQuoteResponse {
+  data?: CreditAccountCreateQuoteResponse.Data;
+}
+
+export namespace CreditAccountCreateQuoteResponse {
+  export interface Data {
+    /**
+     * Unique quote identifier. Use this to settle the payment.
+     */
+    id?: string;
+
+    /**
+     * The equivalent amount in the payment cryptocurrency's smallest unit (e.g. USDC
+     * has 6 decimals, so $50.00 = "50000000").
+     */
+    amount_crypto?: string;
+
+    /**
+     * The quoted amount in USD.
+     */
+    amount_usd?: string;
+
+    /**
+     * ISO 8601 timestamp when the quote expires.
+     */
+    expires_at?: string;
+
+    /**
+     * The blockchain network for the payment in CAIP-2 format (e.g. eip155:8453 for
+     * Base).
+     */
+    network?: string;
+
+    /**
+     * x402 protocol v2 payment requirements. Contains all information needed to
+     * construct and sign a payment authorization.
+     */
+    payment_requirements?: Data.PaymentRequirements;
+
+    record_type?: 'quote';
+  }
+
+  export namespace Data {
+    /**
+     * x402 protocol v2 payment requirements. Contains all information needed to
+     * construct and sign a payment authorization.
+     */
+    export interface PaymentRequirements {
+      /**
+       * Accepted payment schemes. Currently only the `exact` EVM scheme is supported.
+       */
+      accepts?: Array<PaymentRequirements.Accept>;
+
+      /**
+       * The resource being paid for. Included in the payment signature.
+       */
+      resource?: PaymentRequirements.Resource;
+
+      /**
+       * x402 protocol version. Currently always 2.
+       */
+      x402Version?: 2;
+    }
+
+    export namespace PaymentRequirements {
+      export interface Accept {
+        /**
+         * Amount in the token's smallest unit.
+         */
+        amount?: string;
+
+        /**
+         * Token contract address (e.g. USDC on Base).
+         */
+        asset?: string;
+
+        /**
+         * Additional scheme-specific parameters including EIP-712 domain info and the
+         * facilitator URL.
+         */
+        extra?: Accept.Extra;
+
+        /**
+         * Maximum time in seconds before the payment authorization expires.
+         */
+        maxTimeoutSeconds?: number;
+
+        /**
+         * Blockchain network identifier in CAIP-2 format (e.g. "eip155:8453" for Base).
+         */
+        network?: string;
+
+        /**
+         * Recipient wallet address.
+         */
+        payTo?: string;
+
+        /**
+         * Payment scheme (e.g. "exact").
+         */
+        scheme?: string;
+      }
+
+      export namespace Accept {
+        /**
+         * Additional scheme-specific parameters including EIP-712 domain info and the
+         * facilitator URL.
+         */
+        export interface Extra {
+          facilitatorUrl?: string;
+
+          /**
+           * EIP-712 domain name (e.g. "USD Coin").
+           */
+          name?: string;
+
+          quoteId?: string;
+
+          /**
+           * EIP-712 domain version.
+           */
+          version?: string;
+        }
+      }
+
+      /**
+       * The resource being paid for. Included in the payment signature.
+       */
+      export interface Resource {
+        /**
+         * Human-readable description of the payment.
+         */
+        description?: string;
+
+        /**
+         * MIME type of the resource.
+         */
+        mimeType?: string;
+
+        /**
+         * Canonical URL of the payment resource.
+         */
+        url?: string;
+      }
+    }
+  }
+}
+
+export interface CreditAccountSettleResponse {
+  data?: CreditAccountSettleResponse.Data;
+}
+
+export namespace CreditAccountSettleResponse {
+  export interface Data {
+    /**
+     * Unique transaction identifier.
+     */
+    id?: string;
+
+    /**
+     * The transaction amount in the specified currency.
+     */
+    amount?: string;
+
+    /**
+     * ISO 8601 timestamp when the transaction was created.
+     */
+    created_at?: string;
+
+    /**
+     * The currency of the transaction amount (e.g. USD).
+     */
+    currency?: string;
+
+    /**
+     * The original quote ID associated with this transaction.
+     */
+    quote_id?: string;
+
+    record_type?: 'x402_transaction';
+
+    /**
+     * The settlement status of the transaction.
+     */
+    status?: 'settled';
+
+    /**
+     * The on-chain transaction hash, if available.
+     */
+    tx_hash?: string | null;
+  }
+}
+
+export interface CreditAccountSettleParams {
+  /**
+   * Body param: The quote ID to settle.
+   */
+  id: string;
+
+  /**
+   * Body param: Base64-encoded signed payment authorization (x402 PaymentPayload).
+   * Can alternatively be provided via the PAYMENT-SIGNATURE header.
+   */
+  payment_signature?: string;
+
+  /**
+   * Header param: Signed payment authorization for the quote. Alternative to
+   * providing `payment_signature` in the request body.
+   */
+  header_payment_signature?: string;
+}
+
+export interface CreditAccountCreateQuoteParams {
+  /**
+   * Amount in USD to fund (minimum 5.00, maximum 10000.00).
+   */
+  amount_usd: string;
+}
+
+CreditAccount.Payments = Payments;
+
+export declare namespace CreditAccount {
+  export {
+    type CreditAccountCreateQuoteResponse as CreditAccountCreateQuoteResponse,
+    type CreditAccountSettleResponse as CreditAccountSettleResponse,
+    type CreditAccountSettleParams as CreditAccountSettleParams,
+    type CreditAccountCreateQuoteParams as CreditAccountCreateQuoteParams,
+  };
+
+  export {
+    Payments as Payments,
+    type X402TransactionRecord as X402TransactionRecord,
+    type PaymentRetrieveResponse as PaymentRetrieveResponse,
+    type X402TransactionRecordsDefaultFlatPagination as X402TransactionRecordsDefaultFlatPagination,
+    type PaymentListParams as PaymentListParams,
+  };
+}

package/src/resources/x402/credit-account/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  CreditAccount,
+  type CreditAccountCreateQuoteResponse,
+  type CreditAccountSettleResponse,
+  type CreditAccountSettleParams,
+  type CreditAccountCreateQuoteParams,
+} from './credit-account';
+export {
+  Payments,
+  type X402TransactionRecord,
+  type PaymentRetrieveResponse,
+  type PaymentListParams,
+  type X402TransactionRecordsDefaultFlatPagination,
+} from './payments';