telnyx 5.170.0 → 5.171.0

data/lib/telnyx/resources/sip_registration_status.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # UAC connection operations
+    class SipRegistrationStatus
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::SipRegistrationStatusListParams} for more details.
+      #
+      # Returns the live SIP registration status for a Telnyx endpoint: whether it is
+      # currently registered, when the current registration expires, and the last
+      # response Telnyx received from the registrar.
+      #
+      # The endpoint supports three credential types, selected with the
+      # `credential_type` query parameter. Each type is keyed by a different identifier:
+      #
+      # | `credential_type`           | Keyed by        | Use case                                                                   |
+      # | --------------------------- | --------------- | -------------------------------------------------------------------------- |
+      # | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
+      # | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
+      # | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
+      #
+      # The authenticated account is taken from your API key; you can only read the
+      # registration status of connections and credentials your account owns.
+      #
+      # @overload list(credential_type:, connection_id: nil, username: nil, request_options: {})
+      #
+      # @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusListParams::CredentialType] The kind of credential to look up. `uac_external_credential` is keyed by `connec
+      #
+      # @param connection_id [String] Identifier of the UAC connection to look up. Required when `credential_type` is
+      #
+      # @param username [String] SIP username to look up. Required when `credential_type` is `telephony_credentia
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::SipRegistrationStatusListResponse]
+      #
+      # @see Telnyx::Models::SipRegistrationStatusListParams
+      def list(params)
+        parsed, options = Telnyx::SipRegistrationStatusListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "sip_registration_status",
+          query: query,
+          model: Telnyx::Models::SipRegistrationStatusListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/telnyx/resources/spend_limits.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Daily and monthly spend limits per product. A limit applies to the organization
+    # of the authenticated user, or to the user's own account when they belong to no
+    # organization; every user of the organization sees and changes the same limits.
+    #
+    # - **Periods.** `daily` covers the current UTC day and `monthly` the current UTC
+    #   calendar month. The two limits are independent: you can set either, both or
+    #   neither.
+    # - **Blocking.** When spend in a period goes above the limit (strictly greater),
+    #   the product is blocked until the period ends: 00:00 UTC the next day for
+    #   `daily`, 00:00 UTC on the 1st of the next month for `monthly`. A block appears
+    #   within about 2 minutes (daily) or 10 minutes (monthly) of the spend being
+    #   recorded.
+    # - **Changes apply immediately.** Creating, updating or deleting a limit checks
+    #   the period's spend in the same request: raising the limit above the spend, or
+    #   removing it, lifts that period's block, and lowering it below the spend blocks
+    #   the product at once. The `evaluation` object in the response says what
+    #   happened.
+    # - **Supported products.** Today only `inference` supports spend limits. A
+    #   blocked account gets HTTP 403 with the error title
+    #   `Inference spend limit reached` (code `10039`) on new billable chat
+    #   completions, Responses, Anthropic Messages and classification requests;
+    #   requests already running finish normally. Take the list of products from the
+    #   list operation.
+    # - **Limits set by Telnyx.** Telnyx support can also set a limit on your account.
+    #   It is listed with `origin: operator` and you can update or delete it like your
+    #   own.
+    class SpendLimits
+      # Sets a limit for a product and period that has none. Send exactly one of
+      # `amount` and `unlimited: true`. The period's spend is checked at once: if it is
+      # already above the new limit, the product is blocked immediately
+      # (`evaluation.blocked_now`). Returns 409 when a limit already exists for the
+      # product and period; update it instead.
+      #
+      # @overload create(body:, request_options: {})
+      #
+      # @param body [Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitWithAmount, Telnyx::Models::SpendLimitCreateParams::Body::CreateSpendLimitUnlimited] Send exactly one of `amount` and `unlimited: true`.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::SpendLimitResponse]
+      #
+      # @see Telnyx::Models::SpendLimitCreateParams
+      def create(params)
+        parsed, options = Telnyx::SpendLimitCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "spend_limits",
+          body: parsed[:body],
+          model: Telnyx::SpendLimitResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::SpendLimitUpdateParams} for more details.
+      #
+      # Replaces the value of the existing limit for the product and period. Send
+      # exactly one of `amount` and `unlimited: true`. The period's spend is checked at
+      # once: raising the limit above the spend lifts the period's block
+      # (`evaluation.released`), and lowering it below the spend blocks the product
+      # (`evaluation.blocked_now`). Returns 404 when no limit is set; create it instead.
+      #
+      # @overload update(product, body:, period: nil, request_options: {})
+      #
+      # @param product [String] Path param: Product the limit applies to, as returned in `product` by the list o
+      #
+      # @param body [Telnyx::Models::SpendLimitUpdateParams::Body::UpdateSpendLimitWithAmount, Telnyx::Models::SpendLimitUpdateParams::Body::UpdateSpendLimitUnlimited] Body param: Send exactly one of `amount` and `unlimited: true`.
+      #
+      # @param period [Symbol, Telnyx::Models::SpendLimitPeriod] Query param: Limit period. Defaults to `daily`; send it explicitly.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::SpendLimitResponse]
+      #
+      # @see Telnyx::Models::SpendLimitUpdateParams
+      def update(product, params)
+        parsed, options = Telnyx::SpendLimitUpdateParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed.except(:body))
+        @client.request(
+          method: :patch,
+          path: ["spend_limits/%1$s", product],
+          query: query,
+          body: parsed[:body],
+          model: Telnyx::SpendLimitResponse,
+          options: options
+        )
+      end
+
+      # Returns one entry per product and period you can set a limit on, with the limit,
+      # the spend so far in the period and whether the product is blocked. An entry
+      # without a limit is still listed (`limit: null`). When the spend cannot be read,
+      # the entry is returned with `spend_usd: null` and `spend_error` set. The list is
+      # not paginated.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::SpendLimitListResponse]
+      #
+      # @see Telnyx::Models::SpendLimitListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "spend_limits",
+          model: Telnyx::Models::SpendLimitListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Removes the limit for the product and period. For `inference`, which has no
+      # default limit, the product becomes unlimited for the period and the period's
+      # block is lifted (`evaluation.released`). The response carries `limit: null` and
+      # the `effective_limit_usd` that applies after the removal. Returns 404 when no
+      # limit is set.
+      #
+      # @overload delete(product, period: nil, reason: nil, request_options: {})
+      #
+      # @param product [String] Product the limit applies to, as returned in `product` by the list operation.
+      #
+      # @param period [Symbol, Telnyx::Models::SpendLimitPeriod] Limit period. Defaults to `daily`; send it explicitly.
+      #
+      # @param reason [String] Why the limit is removed, kept for audit. At most 500 characters.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::SpendLimitResponse]
+      #
+      # @see Telnyx::Models::SpendLimitDeleteParams
+      def delete(product, params = {})
+        parsed, options = Telnyx::SpendLimitDeleteParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :delete,
+          path: ["spend_limits/%1$s", product],
+          query: query,
+          model: Telnyx::SpendLimitResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/telnyx/resources/texml.rb

@@ -15,8 +15,10 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::TexmlInitiateAICallParams} for more details.
       #
-      # Initiate an outbound AI call with warm-up support. Validates parameters, builds
-      # an internal TeXML with an AI Assistant configuration, encodes instructions into
+      # Initiate an outbound AI call with warm-up support: Telnyx attempts to warm up
+      # the assistant identified by `AIAssistantId` before placing the call and starts
+      # it automatically when the called party answers. Validates parameters, builds an
+      # internal TeXML with an AI Assistant configuration, encodes instructions into
       # client state, and calls the dial API. The Twiml, Texml, and Url parameters are
       # not allowed and will result in a 422 error.
       #
@@ -35,7 +37,7 @@ module Telnyx
       #
       # @param connection_id [String] The ID of the TeXML connection to use for the call.
       #
-      # @param ai_assistant_id [String] The ID of the AI assistant to use for the call.
+      # @param ai_assistant_id [String] The ID of the AI assistant to use for the call. Telnyx attempts to warm up this
       #
       # @param from [String] The phone number of the party initiating the call. Phone numbers are formatted w
       #

data/lib/telnyx/resources/webhooks.rb

@@ -5,7 +5,7 @@ module Telnyx
     class Webhooks
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho]
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationCreatedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallConversationStartFailedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent, Telnyx::Models::NumberReputationNumberFlaggedWebhookEvent, Telnyx::Models::NumberReputationNumberRemovedWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho, Telnyx::Models::WhatsappWabaAddedWebhookEvent]
       def unsafe_unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnsafeUnwrapWebhookEvent, parsed)
@@ -17,7 +17,7 @@ module Telnyx
       #
       # @param key [String, nil] The webhook signing key
       #
-      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho]
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationCreatedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallConversationStartFailedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent, Telnyx::Models::NumberReputationNumberFlaggedWebhookEvent, Telnyx::Models::NumberReputationNumberRemovedWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho, Telnyx::Models::WhatsappWabaAddedWebhookEvent]
       def unwrap(payload, headers:, key: @client.public_key)
         if key.nil?
           raise ArgumentError.new("Cannot verify a webhook without a key on either the client's public_key or passed in as an argument")

data/lib/telnyx/resources/whatsapp/phone_numbers/calling_routing.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Whatsapp
+      class PhoneNumbers
+        # Manage Whatsapp phone numbers
+        class CallingRouting
+          # Retrieve the connection ID currently stored for a WhatsApp Calling BYON (Bring
+          # Your Own Number) phone number: the connection that inbound WhatsApp calls to the
+          # number are delivered to.
+          #
+          # Use it to check the result of
+          # `PATCH /whatsapp/phone_numbers/{id}/calling_routing`. A read made immediately
+          # after an update can still return the previous value.
+          #
+          # Sub-users need read permission on connections.
+          #
+          # @overload list(id, request_options: {})
+          #
+          # @param id [String] The BYON phone number in E.164 format. The leading `+` is optional.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::Whatsapp::PhoneNumbers::CallingRoutingListResponse]
+          #
+          # @see Telnyx::Models::Whatsapp::PhoneNumbers::CallingRoutingListParams
+          def list(id, params = {})
+            @client.request(
+              method: :get,
+              path: ["whatsapp/phone_numbers/%1$s/calling_routing", id],
+              model: Telnyx::Models::Whatsapp::PhoneNumbers::CallingRoutingListResponse,
+              options: params[:request_options]
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::Whatsapp::PhoneNumbers::CallingRoutingPatchAllParams} for more
+          # details.
+          #
+          # Set or clear the connection ID for a WhatsApp Calling BYON (Bring Your Own
+          # Number) phone number: the connection that inbound WhatsApp calls to the number
+          # are delivered to.
+          #
+          # The update is processed asynchronously. A `202` response means the request was
+          # accepted, not that the routing changed. Check the result with
+          # `GET /whatsapp/phone_numbers/{id}/calling_routing`, which can return the
+          # previous value immediately after an update. An update for a number that is not a
+          # WhatsApp Calling number in the account returns 404.
+          #
+          # The connection must belong to the same account and must not be a WhatsApp
+          # connection. Send `connection_id: null` to clear the routing; omitting
+          # `connection_id` is rejected. Numbers active on Telnyx are rejected, because they
+          # route through their own connection assignment.
+          #
+          # Sub-users need update permission on connections, and read permission to check
+          # the result with `GET`.
+          #
+          # @overload patch_all(id, connection_id:, request_options: {})
+          #
+          # @param id [String] The BYON phone number in E.164 format. The leading `+` is optional.
+          #
+          # @param connection_id [String, Integer, nil] ID of the connection to deliver inbound WhatsApp calls to: a positive integer up
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::Whatsapp::PhoneNumbers::CallingRoutingPatchAllResponse]
+          #
+          # @see Telnyx::Models::Whatsapp::PhoneNumbers::CallingRoutingPatchAllParams
+          def patch_all(id, params)
+            parsed, options = Telnyx::Whatsapp::PhoneNumbers::CallingRoutingPatchAllParams.dump_request(params)
+            @client.request(
+              method: :patch,
+              path: ["whatsapp/phone_numbers/%1$s/calling_routing", id],
+              body: parsed,
+              model: Telnyx::Models::Whatsapp::PhoneNumbers::CallingRoutingPatchAllResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/whatsapp/phone_numbers.rb

@@ -17,6 +17,10 @@ module Telnyx
         # @return [Telnyx::Resources::Whatsapp::PhoneNumbers::ConversationalComponents]
         attr_reader :conversational_components
 
+        # Manage Whatsapp phone numbers
+        # @return [Telnyx::Resources::Whatsapp::PhoneNumbers::CallingRouting]
+        attr_reader :calling_routing
+
         # Returns WhatsApp phone numbers linked to the authenticated Telnyx account.
         #
         # @overload list(page_number: nil, page_size: nil, request_options: {})
@@ -190,6 +194,7 @@ module Telnyx
           @profile = Telnyx::Resources::Whatsapp::PhoneNumbers::Profile.new(client: client)
           @conversational_components =
             Telnyx::Resources::Whatsapp::PhoneNumbers::ConversationalComponents.new(client: client)
+          @calling_routing = Telnyx::Resources::Whatsapp::PhoneNumbers::CallingRouting.new(client: client)
         end
       end
     end

data/lib/telnyx/resources/whatsapp/signup.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Whatsapp
+      class Signup
+        # List finished WhatsApp Embedded Signup sessions, with status `SUCCESS` or
+        # `FAILURE`, newest first. Use the `errors` of a failed session to see why
+        # provisioning stopped.
+        #
+        # @overload list(filter_created_at_gte: nil, filter_created_at_lte: nil, filter_customer_id: nil, filter_waba_id: nil, page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param filter_created_at_gte [Time] Return sessions created at or after this time (RFC 3339)
+        #
+        # @param filter_created_at_lte [Time] Return sessions created at or before this time (RFC 3339)
+        #
+        # @param filter_customer_id [String] Filter by the tech provider customer reference
+        #
+        # @param filter_waba_id [String] Filter by Meta WABA ID
+        #
+        # @param page_number [Integer]
+        #
+        # @param page_size [Integer]
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Whatsapp::SignupListResponse>]
+        #
+        # @see Telnyx::Models::Whatsapp::SignupListParams
+        def list(params = {})
+          parsed, options = Telnyx::Whatsapp::SignupListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "whatsapp/signup",
+            query: query.transform_keys(
+              filter_created_at_gte: "filter[created_at][gte]",
+              filter_created_at_lte: "filter[created_at][lte]",
+              filter_customer_id: "filter[customer_id]",
+              filter_waba_id: "filter[waba_id]",
+              page_number: "page[number]",
+              page_size: "page[size]"
+            ),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::Models::Whatsapp::SignupListResponse,
+            options: options
+          )
+        end
+
+        # Retrieve the current state and status of a WhatsApp Embedded Signup session.
+        #
+        # @overload retrieve_status(id, request_options: {})
+        #
+        # @param id [String] Signup session ID
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Whatsapp::SignupRetrieveStatusResponse]
+        #
+        # @see Telnyx::Models::Whatsapp::SignupRetrieveStatusParams
+        def retrieve_status(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["whatsapp/signup/%1$s/status", id],
+            model: Telnyx::Models::Whatsapp::SignupRetrieveStatusResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/whatsapp.rb

@@ -19,6 +19,9 @@ module Telnyx
       # @return [Telnyx::Resources::Whatsapp::UserData]
       attr_reader :user_data
 
+      # @return [Telnyx::Resources::Whatsapp::Signup]
+      attr_reader :signup
+
       # @api private
       #
       # @param client [Telnyx::Client]
@@ -28,6 +31,7 @@ module Telnyx
         @templates = Telnyx::Resources::Whatsapp::Templates.new(client: client)
         @phone_numbers = Telnyx::Resources::Whatsapp::PhoneNumbers.new(client: client)
         @user_data = Telnyx::Resources::Whatsapp::UserData.new(client: client)
+        @signup = Telnyx::Resources::Whatsapp::Signup.new(client: client)
       end
     end
   end

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.170.0"
+  VERSION = "5.171.0"
 end