telnyx 5.158.0 → 5.159.0

data/lib/telnyx/resources/email_unsubscribe_groups/suppressions.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class EmailUnsubscribeGroups
+      # Named groups and group-scoped suppressions.
+      class Suppressions
+        # Creates a suppression with `reason: unsubscribe`, `source: manual`,
+        # `group_id: <this group>`. All other body fields are ignored; only `to` is read.
+        # Idempotent (same dedupe key → `200`, no new event).
+        #
+        # @overload create(id, to:, request_options: {})
+        #
+        # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+        #
+        # @param to [String]
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailBlockResponse]
+        #
+        # @see Telnyx::Models::EmailUnsubscribeGroups::SuppressionCreateParams
+        def create(id, params)
+          parsed, options = Telnyx::EmailUnsubscribeGroups::SuppressionCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["email_unsubscribe_groups/%1$s/suppressions", id],
+            body: parsed,
+            model: Telnyx::EmailBlockResponse,
+            options: options
+          )
+        end
+
+        # Account + group scoped. Offset pagination only (`page[number]` default 1,
+        # `page[size]` default 25, max 100). No `sort`/`filter`/ cursor — ordering fixed
+        # `desc created_at, desc id`. Uses the shared `QueryParser.parse_offset/1` — a
+        # malformed `page` returns `400` (code `10015`), consistent with
+        # `GET /v2/email_blocks`. `meta` includes `total_pages`. Rows reuse the standard
+        # suppression shape (`group_id` set to this group).
+        #
+        # @overload list(id, page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+        #
+        # @param page_number [Integer] Offset page number (≥1, default 1).
+        #
+        # @param page_size [Integer] Page size (1–100, default 25).
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::EmailBlock>]
+        #
+        # @see Telnyx::Models::EmailUnsubscribeGroups::SuppressionListParams
+        def list(id, params = {})
+          parsed, options = Telnyx::EmailUnsubscribeGroups::SuppressionListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["email_unsubscribe_groups/%1$s/suppressions", id],
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::EmailBlock,
+            options: options
+          )
+        end
+
+        # Soft-deletes all active blocks for (account, group, normalized email) — one
+        # `removed` audit event per block (`actor: manual`). The `email` path segment is
+        # normalized (trim + lower-case) before matching. Idempotent on already-removed
+        # rows (returns `404` since they're no longer `active`).
+        #
+        # Two distinct `404` cases: a missing/cross-account **group** returns
+        # `10001 "The requested unsubscribe group was not found"`; a group that exists but
+        # has **no active suppression** for that email returns
+        # `10001 "The requested group suppression was not found"`.
+        #
+        # @overload delete(email, id:, request_options: {})
+        #
+        # @param email [String] Recipient address (normalized: trim + lower-case before matching).
+        #
+        # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Telnyx::Models::EmailUnsubscribeGroups::SuppressionDeleteParams
+        def delete(email, params)
+          parsed, options = Telnyx::EmailUnsubscribeGroups::SuppressionDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["email_unsubscribe_groups/%1$s/suppressions/%2$s", id, email],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/email_unsubscribe_groups.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Named groups and group-scoped suppressions.
+    class EmailUnsubscribeGroups
+      # Named groups and group-scoped suppressions.
+      # @return [Telnyx::Resources::EmailUnsubscribeGroups::Suppressions]
+      attr_reader :suppressions
+
+      # Create an unsubscribe group
+      #
+      # @overload create(name:, description: nil, request_options: {})
+      #
+      # @param name [String]
+      # @param description [String, nil]
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::UnsubscribeGroupResponse]
+      #
+      # @see Telnyx::Models::EmailUnsubscribeGroupCreateParams
+      def create(params)
+        parsed, options = Telnyx::EmailUnsubscribeGroupCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "email_unsubscribe_groups",
+          body: parsed,
+          model: Telnyx::UnsubscribeGroupResponse,
+          options: options
+        )
+      end
+
+      # Retrieve an unsubscribe group
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::UnsubscribeGroupResponse]
+      #
+      # @see Telnyx::Models::EmailUnsubscribeGroupRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["email_unsubscribe_groups/%1$s", id],
+          model: Telnyx::UnsubscribeGroupResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Partial update (only `name` / `description`). `PUT` is not routed.
+      #
+      # @overload update(id, description: nil, name: nil, request_options: {})
+      #
+      # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+      #
+      # @param description [String, nil]
+      #
+      # @param name [String]
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::UnsubscribeGroupResponse]
+      #
+      # @see Telnyx::Models::EmailUnsubscribeGroupUpdateParams
+      def update(id, params = {})
+        parsed, options = Telnyx::EmailUnsubscribeGroupUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["email_unsubscribe_groups/%1$s", id],
+          body: parsed,
+          model: Telnyx::UnsubscribeGroupResponse,
+          options: options
+        )
+      end
+
+      # Offset pagination only (`page[number]` default 1, `page[size]` default 25, max
+      # 100). No `sort`/`filter`/cursor — ordering fixed `desc created_at, desc id`.
+      # Uses the shared `QueryParser.parse_offset/1` — a malformed `page` (e.g. flat
+      # `?page=1` instead of `?page[number]=1`) returns `400` (code `10015`), consistent
+      # with `GET /v2/email_blocks`. `meta` includes `total_pages`.
+      #
+      # @overload list(page_number: nil, page_size: nil, request_options: {})
+      #
+      # @param page_number [Integer] Offset page number (≥1, default 1).
+      #
+      # @param page_size [Integer] Page size (1–100, default 25).
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UnsubscribeGroup>]
+      #
+      # @see Telnyx::Models::EmailUnsubscribeGroupListParams
+      def list(params = {})
+        parsed, options = Telnyx::EmailUnsubscribeGroupListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "email_unsubscribe_groups",
+          query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+          page: Telnyx::Internal::DefaultFlatPagination,
+          model: Telnyx::UnsubscribeGroup,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailUnsubscribeGroupDeleteParams} for more details.
+      #
+      # If the group has 0 active suppressions, hard-deletes the row. With `force=true`,
+      # soft-deletes all active suppressions first (status → `removed`, `group_id`
+      # cleared, `removed` audit event per block) in a single transaction, then
+      # hard-deletes the group. Without `force` and active suppressions present → `409`.
+      # Audit trail is preserved. `force` only accepts the string `"true"` or boolean
+      # `true`; all other values are false.
+      #
+      # @overload delete(id, force: nil, request_options: {})
+      #
+      # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+      #
+      # @param force [Symbol, Boolean, Telnyx::Models::EmailUnsubscribeGroupDeleteParams::Force] Force-delete a group with active suppressions. Only `"true"` (string) or `true`
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Telnyx::Models::EmailUnsubscribeGroupDeleteParams
+      def delete(id, params = {})
+        parsed, options = Telnyx::EmailUnsubscribeGroupDeleteParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :delete,
+          path: ["email_unsubscribe_groups/%1$s", id],
+          query: query,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @suppressions = Telnyx::Resources::EmailUnsubscribeGroups::Suppressions.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/email_validations/batch.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class EmailValidations
+      # Validate email addresses synchronously or in asynchronous batches.
+      class Batch
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::EmailValidations::BatchCreateParams} for more details.
+        #
+        # Creates an asynchronous batch validation job for up to 1,000 email addresses.
+        #
+        # @overload create(emails:, webhook_url: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param emails [Array<String>] Body param
+        #
+        # @param webhook_url [String] Body param: URL for batch completion webhook. Empty string is treated as omitted
+        #
+        # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailValidations::BatchCreateResponse]
+        #
+        # @see Telnyx::Models::EmailValidations::BatchCreateParams
+        def create(params)
+          parsed, options = Telnyx::EmailValidations::BatchCreateParams.dump_request(params)
+          header_params = {idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :post,
+            path: "email_validations/batch",
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: Telnyx::Models::EmailValidations::BatchCreateResponse,
+            options: options
+          )
+        end
+
+        # Retrieves the current status and, once completed, validation results for a batch
+        # job.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] Email validation batch UUID.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailValidations::BatchRetrieveResponse]
+        #
+        # @see Telnyx::Models::EmailValidations::BatchRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["email_validations/batch/%1$s", id],
+            model: Telnyx::Models::EmailValidations::BatchRetrieveResponse,
+            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/email_validations.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Validate email addresses synchronously or in asynchronous batches.
+    class EmailValidations
+      # Validate email addresses synchronously or in asynchronous batches.
+      # @return [Telnyx::Resources::EmailValidations::Batch]
+      attr_reader :batch
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailValidationCreateParams} for more details.
+      #
+      # Validates a single email address and returns deliverability checks.
+      #
+      # @overload create(email:, idempotency_key: nil, request_options: {})
+      #
+      # @param email [String] Body param: Email address to validate. Any non-empty string is accepted; invalid
+      #
+      # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailValidationCreateResponse]
+      #
+      # @see Telnyx::Models::EmailValidationCreateParams
+      def create(params)
+        parsed, options = Telnyx::EmailValidationCreateParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :post,
+          path: "email_validations",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Telnyx::Models::EmailValidationCreateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @batch = Telnyx::Resources::EmailValidations::Batch.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rb

@@ -58,19 +58,27 @@ module Telnyx
 
             # Retrieve a paginated list of telco data usage reports
             #
-            # @overload list(request_options: {})
+            # @overload list(page: nil, per_page: nil, request_options: {})
+            #
+            # @param page [Integer] Page number to retrieve (1-based).
+            #
+            # @param per_page [Integer] Filter results by per page.
             #
             # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
             #
-            # @return [Telnyx::Models::Legacy::Reporting::UsageReports::NumberLookupListResponse]
+            # @return [Telnyx::Internal::PerPagePagination<Telnyx::Models::Legacy::Reporting::UsageReports::TelcoDataUsageReportResponse>]
             #
             # @see Telnyx::Models::Legacy::Reporting::UsageReports::NumberLookupListParams
             def list(params = {})
+              parsed, options = Telnyx::Legacy::Reporting::UsageReports::NumberLookupListParams.dump_request(params)
+              query = Telnyx::Internal::Util.encode_query_params(parsed)
               @client.request(
                 method: :get,
                 path: "legacy/reporting/usage_reports/number_lookup",
-                model: Telnyx::Models::Legacy::Reporting::UsageReports::NumberLookupListResponse,
-                options: params[:request_options]
+                query: query,
+                page: Telnyx::Internal::PerPagePagination,
+                model: Telnyx::Legacy::Reporting::UsageReports::TelcoDataUsageReportResponse,
+                options: options
               )
             end
 

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

@@ -15,7 +15,7 @@ module Telnyx
         #
         # @param id [String] Identifies the resource.
         #
-        # @param bundle_id [String] The new bundle_id setting for the number. If you are assigning the number to a b
+        # @param bundle_id [String, nil] The new bundle_id setting for the number. If you are assigning the number to a b
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/telnyx/resources/pricing/products.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Pricing
+      # Public pricing operations
+      class Products
+        # Returns pricing entries for a single product. Most products return standard rate
+        # entries with fields like rate, unit, country_iso, direction, and tiers.
+        # Inference products return model-specific fields (model, input_rate, output_rate,
+        # cached_input_rate) with tiered pricing. Some products use rate decks
+        # (pricing_type: rate_deck) where rates are determined dynamically.
+        #
+        # @overload retrieve(slug, page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param slug [String] Product slug from the catalog listing.
+        #
+        # @param page_number [Integer] Page number (1-based).
+        #
+        # @param page_size [Integer] Number of items per page (max 100).
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Pricing::ProductRetrieveResponse]
+        #
+        # @see Telnyx::Models::Pricing::ProductRetrieveParams
+        def retrieve(slug, params = {})
+          parsed, options = Telnyx::Pricing::ProductRetrieveParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["pricing/products/%1$s", slug],
+            query: query,
+            model: Telnyx::Models::Pricing::ProductRetrieveResponse,
+            options: options
+          )
+        end
+
+        # Returns the full product catalog with pagination. Each entry contains a slug,
+        # display name, and description. Use the slug to fetch per-product pricing via GET
+        # /pricing/products/{slug}.
+        #
+        # @overload list(page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param page_number [Integer] Page number (1-based).
+        #
+        # @param page_size [Integer] Number of items per page (max 100).
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPaginationForInexplicitNumberOrders<Telnyx::Models::Pricing::ProductListResponse>]
+        #
+        # @see Telnyx::Models::Pricing::ProductListParams
+        def list(params = {})
+          parsed, options = Telnyx::Pricing::ProductListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "pricing/products",
+            query: query,
+            page: Telnyx::Internal::DefaultFlatPaginationForInexplicitNumberOrders,
+            model: Telnyx::Models::Pricing::ProductListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/pricing.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Pricing
+      # Public pricing operations
+      # @return [Telnyx::Resources::Pricing::Products]
+      attr_reader :products
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @products = Telnyx::Resources::Pricing::Products.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/short_codes.rb

@@ -34,7 +34,7 @@ module Telnyx
       #
       # @param messaging_profile_id [String] Unique identifier for a messaging profile.
       #
-      # @param tags [Array<String>]
+      # @param tags [Array<String>] Tags associated with the resource.
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/telnyx/resources/speech_to_text.rb

@@ -56,7 +56,7 @@ module Telnyx
       # `Authorization: Bearer <API_KEY>` header.
       #
       # Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
-      # `Speechmatics`, `Soniox`, `Parakeet`.
+      # `Speechmatics`, `Soniox`, `Parakeet`, `Humain`, `Reson8`.
       #
       # **Connection flow:**
       #

data/lib/telnyx/resources/text_to_speech.rb

@@ -20,13 +20,13 @@ module Telnyx
       # with provider-specific parameters.
       #
       # Supported providers: `aws`, `telnyx`, `azure`, `elevenlabs`, `minimax`, `rime`,
-      # `resemble`, `xai`.
+      # `resemble`, `xai`, `humain`.
       #
       # The Telnyx `Ultra` model supports 44 languages with emotion control, speed
       # adjustment, and volume control. Use the `telnyx` provider-specific parameters to
       # configure these features.
       #
-      # @overload generate_speech(aws: nil, azure: nil, disable_cache: nil, elevenlabs: nil, language: nil, minimax: nil, output_type: nil, provider: nil, resemble: nil, rime: nil, telnyx: nil, text: nil, text_type: nil, voice: nil, voice_settings: nil, xai: nil, request_options: {})
+      # @overload generate_speech(aws: nil, azure: nil, disable_cache: nil, elevenlabs: nil, humain: nil, language: nil, minimax: nil, output_type: nil, provider: nil, resemble: nil, rime: nil, telnyx: nil, text: nil, text_type: nil, voice: nil, voice_settings: nil, xai: nil, request_options: {})
       #
       # @param aws [::Telnyx::Models::TextToSpeechGenerateSpeechParams::Aws] AWS Polly provider-specific parameters.
       #
@@ -36,6 +36,8 @@ module Telnyx
       #
       # @param elevenlabs [::Telnyx::Models::TextToSpeechGenerateSpeechParams::Elevenlabs] ElevenLabs provider-specific parameters.
       #
+      # @param humain [::Telnyx::Models::TextToSpeechGenerateSpeechParams::Humain] Humain provider-specific parameters. Unlike other providers, Humain has no forma
+      #
       # @param language [String] Language code (e.g. `en-US`). Usage varies by provider.
       #
       # @param minimax [::Telnyx::Models::TextToSpeechGenerateSpeechParams::Minimax] Minimax provider-specific parameters.
@@ -114,7 +116,7 @@ module Telnyx
       # synthesize; receive JSON frames containing base64-encoded audio chunks.
       #
       # Supported providers: `aws`, `telnyx`, `azure`, `murfai`, `minimax`, `rime`,
-      # `resemble`, `elevenlabs`, `xai`.
+      # `resemble`, `elevenlabs`, `xai`, `humain`.
       #
       # **Connection flow:**
       #

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::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::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::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, 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::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
       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::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::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::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, 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::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
       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")