telnyx 5.7.0 → 5.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93320204bacb5edf16ad90de4f4954976beb015bfb321757348853bf70cd8b69
-  data.tar.gz: 5646bf54cdb3b90b101934aecbb49ab4828fa2a56d973a562fba8582a6180ffe
+  metadata.gz: 44673328be367e8f6d1a6aeabecc5b36c8520f2943faf06a88e071dcab166274
+  data.tar.gz: b328bd1fb4691753ed233b4e67ca5ad2113f599ce515087d340765e97c0a57db
 SHA512:
-  metadata.gz: 821f012485a42c92be66fd2cef27d216f72d8c0c1440a243ecece12a56003aa377720c9d6e463abf3f913041237f2ff198b7d3e26037091658f9609e5c8b343d
-  data.tar.gz: 3ceda969a1361defb80f8cfbbad710856da184fa49b9ebf5b8ea7f835a934d3c589720df68a4d436b07aa3ddd2428f2bdab82ed213ef6f49d850f8d17baa9a26
+  metadata.gz: 97b4a08db4a7f99cf57bdc4b5499ec3010412fccdc6c5778fa1048cac1f5b38e65615a39a1a351358d75c083493c90b545471c7f477ea01f6f694617b1a70151
+  data.tar.gz: ccf0deedf2c5fba7940c1666065e90ddbb9208499b04186449354723b0dc880217a34954f2372e0a878b7b7954aac2f32f487cb3eb0c93aac4915e6a8f211956

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 5.7.2 (2026-01-30)
+
+Full Changelog: [v5.7.1...v5.7.2](https://github.com/team-telnyx/telnyx-ruby/compare/v5.7.1...v5.7.2)
+
+### Bug Fixes
+
+* use PaginationMeta schema for ListFaxesResponse.meta ([584eea3](https://github.com/team-telnyx/telnyx-ruby/commit/584eea35132ca54d84b21159bd28b30faf9d5655))
+
+## 5.7.1 (2026-01-30)
+
+Full Changelog: [v5.7.0...v5.7.1](https://github.com/team-telnyx/telnyx-ruby/compare/v5.7.0...v5.7.1)
+
+### Bug Fixes
+
+* remove deprecated TeXML API endpoints from OpenAPI spec ([53481a2](https://github.com/team-telnyx/telnyx-ruby/commit/53481a2b89a0dc63ca5877421d13d62855478e9b))
+
 ## 5.7.0 (2026-01-29)
 
 Full Changelog: [v5.6.0...v5.7.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.6.0...v5.7.0)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "telnyx", "~> 5.7.0"
+gem "telnyx", "~> 5.7.2"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/models/ai/audio_transcribe_params.rb

@@ -11,7 +11,8 @@ module Telnyx
         # @!attribute model
         #   ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
         #   English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
-        #   higher latency.
+        #   higher latency. `deepgram/nova-3` supports English variants (en, en-US, en-GB,
+        #   en-AU, en-NZ, en-IN) and only accepts mp3/wav files.
         #
         #   @return [Symbol, Telnyx::Models::AI::AudioTranscribeParams::Model]
         required :model, enum: -> { Telnyx::AI::AudioTranscribeParams::Model }
@@ -19,7 +20,8 @@ module Telnyx
         # @!attribute file
         #   The audio file object to transcribe, in one of these formats: flac, mp3, mp4,
         #   mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot
-        #   be used together with `file_url`
+        #   be used together with `file_url`. Note: `deepgram/nova-3` only supports mp3 and
+        #   wav formats.
         #
         #   @return [Pathname, StringIO, IO, String, Telnyx::FilePart, nil]
         optional :file, Telnyx::Internal::Type::FileInput
@@ -27,11 +29,30 @@ module Telnyx
         # @!attribute file_url
         #   Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a,
         #   ogg, wav, or webm. Support for hosted files is limited to 100MB. Cannot be used
-        #   together with `file`
+        #   together with `file`. Note: `deepgram/nova-3` only supports mp3 and wav formats.
         #
         #   @return [String, nil]
         optional :file_url, String
 
+        # @!attribute language
+        #   The language of the audio to be transcribed. For `deepgram/nova-3`, only English
+        #   variants are supported: `en`, `en-US`, `en-GB`, `en-AU`, `en-NZ`, `en-IN`. For
+        #   `openai/whisper-large-v3-turbo`, supports multiple languages.
+        #   `distil-whisper/distil-large-v2` does not support language parameter.
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute model_config
+        #   Additional model-specific configuration parameters. Only allowed with
+        #   `deepgram/nova-3` model. Can include Deepgram-specific options such as
+        #   `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
+        #   If `language` is provided both as a top-level parameter and in `model_config`,
+        #   the top-level parameter takes precedence.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :model_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
         # @!attribute response_format
         #   The format of the transcript output. Use `verbose_json` to take advantage of
         #   timestamps.
@@ -49,7 +70,7 @@ module Telnyx
                  enum: -> { Telnyx::AI::AudioTranscribeParams::TimestampGranularities },
                  api_name: :"timestamp_granularities[]"
 
-        # @!method initialize(model:, file: nil, file_url: nil, response_format: nil, timestamp_granularities: nil, request_options: {})
+        # @!method initialize(model:, file: nil, file_url: nil, language: nil, model_config: nil, response_format: nil, timestamp_granularities: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::AudioTranscribeParams} for more details.
         #
@@ -59,6 +80,10 @@ module Telnyx
         #
         #   @param file_url [String] Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg
         #
+        #   @param language [String] The language of the audio to be transcribed. For `deepgram/nova-3`, only English
+        #
+        #   @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with `deepgram/
+        #
         #   @param response_format [Symbol, Telnyx::Models::AI::AudioTranscribeParams::ResponseFormat] The format of the transcript output. Use `verbose_json` to take advantage of tim
         #
         #   @param timestamp_granularities [Symbol, Telnyx::Models::AI::AudioTranscribeParams::TimestampGranularities] The timestamp granularities to populate for this transcription. `response_format
@@ -67,12 +92,14 @@ module Telnyx
 
         # ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
         # English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
-        # higher latency.
+        # higher latency. `deepgram/nova-3` supports English variants (en, en-US, en-GB,
+        # en-AU, en-NZ, en-IN) and only accepts mp3/wav files.
         module Model
           extend Telnyx::Internal::Type::Enum
 
           DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
           OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
+          DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/calls/action_start_recording_params.rb

@@ -80,13 +80,15 @@ module Telnyx
         optional :transcription, Telnyx::Internal::Type::Boolean
 
         # @!attribute transcription_engine
-        #   Engine to use for speech recognition. `A` - `Google`
+        #   Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`,
+        #   `deepgram/nova-3` - `Deepgram Nova-3`. Note: `deepgram/nova-3` supports only
+        #   `en` and `en-{Region}` languages.
         #
-        #   @return [String, nil]
-        optional :transcription_engine, String
+        #   @return [Symbol, Telnyx::Models::Calls::ActionStartRecordingParams::TranscriptionEngine, nil]
+        optional :transcription_engine,
+                 enum: -> { Telnyx::Calls::ActionStartRecordingParams::TranscriptionEngine }
 
         # @!attribute transcription_language
-        #   Language to use for speech recognition
         #
         #   @return [Symbol, Telnyx::Models::Calls::ActionStartRecordingParams::TranscriptionLanguage, nil]
         optional :transcription_language,
@@ -149,9 +151,9 @@ module Telnyx
         #
         #   @param transcription [Boolean] Enable post recording transcription. The default value is false.
         #
-        #   @param transcription_engine [String] Engine to use for speech recognition. `A` - `Google`
+        #   @param transcription_engine [Symbol, Telnyx::Models::Calls::ActionStartRecordingParams::TranscriptionEngine] Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`, `deepgram/
         #
-        #   @param transcription_language [Symbol, Telnyx::Models::Calls::ActionStartRecordingParams::TranscriptionLanguage] Language to use for speech recognition
+        #   @param transcription_language [Symbol, Telnyx::Models::Calls::ActionStartRecordingParams::TranscriptionLanguage]
         #
         #   @param transcription_max_speaker_count [Integer] Defines maximum number of speakers in the conversation. Applies to `google` engi
         #
@@ -203,7 +205,20 @@ module Telnyx
           #   @return [Array<Symbol>]
         end
 
-        # Language to use for speech recognition
+        # Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`,
+        # `deepgram/nova-3` - `Deepgram Nova-3`. Note: `deepgram/nova-3` supports only
+        # `en` and `en-{Region}` languages.
+        module TranscriptionEngine
+          extend Telnyx::Internal::Type::Enum
+
+          A = :A
+          B = :B
+          DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         module TranscriptionLanguage
           extend Telnyx::Internal::Type::Enum
 
@@ -352,6 +367,106 @@ module Telnyx
           ZH = :zh
           ZH_TW = :"zh-TW"
           ZU_ZA = :"zu-ZA"
+          EN = :en
+          DE = :de
+          ES = :es
+          RU = :ru
+          KO = :ko
+          FR = :fr
+          JA = :ja
+          PT = :pt
+          TR = :tr
+          PL = :pl
+          CA = :ca
+          NL = :nl
+          AR = :ar
+          SV = :sv
+          IT = :it
+          ID = :id
+          HI = :hi
+          FI = :fi
+          VI = :vi
+          HE = :he
+          UK = :uk
+          EL = :el
+          MS = :ms
+          CS = :cs
+          RO = :ro
+          DA = :da
+          HU = :hu
+          TA = :ta
+          NO = :no
+          TH = :th
+          UR = :ur
+          HR = :hr
+          BG = :bg
+          LT = :lt
+          LA = :la
+          MI = :mi
+          ML = :ml
+          CY = :cy
+          SK = :sk
+          TE = :te
+          FA = :fa
+          LV = :lv
+          BN = :bn
+          SR = :sr
+          AZ = :az
+          SL = :sl
+          KN = :kn
+          ET = :et
+          MK = :mk
+          BR = :br
+          EU = :eu
+          IS = :is
+          HY = :hy
+          NE = :ne
+          MN = :mn
+          BS = :bs
+          KK = :kk
+          SQ = :sq
+          SW = :sw
+          GL = :gl
+          MR = :mr
+          PA = :pa
+          SI = :si
+          KM = :km
+          SN = :sn
+          YO = :yo
+          SO = :so
+          AF = :af
+          OC = :oc
+          KA = :ka
+          BE = :be
+          TG = :tg
+          SD = :sd
+          GU = :gu
+          AM = :am
+          YI = :yi
+          LO = :lo
+          UZ = :uz
+          FO = :fo
+          HT = :ht
+          PS = :ps
+          TK = :tk
+          NN = :nn
+          MT = :mt
+          SA = :sa
+          LB = :lb
+          MY = :my
+          BO = :bo
+          TL = :tl
+          MG = :mg
+          AS = :as
+          TT = :tt
+          HAW = :haw
+          LN = :ln
+          HA = :ha
+          BA = :ba
+          JW = :jw
+          SU = :su
+          AUTO_DETECT = :auto_detect
+          ES_419 = :"es-419"
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/fax_delivered_webhook_event.rb

@@ -3,191 +3,240 @@
 module Telnyx
   module Models
     class FaxDeliveredWebhookEvent < Telnyx::Internal::Type::BaseModel
-      # @!attribute id
-      #   Identifies the type of resource.
+      # @!attribute data
       #
-      #   @return [String, nil]
-      optional :id, String
+      #   @return [Telnyx::Models::FaxDeliveredWebhookEvent::Data, nil]
+      optional :data, -> { Telnyx::FaxDeliveredWebhookEvent::Data }
 
-      # @!attribute event_type
-      #   The type of event being delivered.
+      # @!attribute meta
+      #   Metadata about the webhook delivery.
       #
-      #   @return [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::EventType, nil]
-      optional :event_type, enum: -> { Telnyx::FaxDeliveredWebhookEvent::EventType }
+      #   @return [Telnyx::Models::FaxDeliveredWebhookEvent::Meta, nil]
+      optional :meta, -> { Telnyx::FaxDeliveredWebhookEvent::Meta }
 
-      # @!attribute payload
+      # @!method initialize(data: nil, meta: nil)
+      #   @param data [Telnyx::Models::FaxDeliveredWebhookEvent::Data]
       #
-      #   @return [Telnyx::Models::FaxDeliveredWebhookEvent::Payload, nil]
-      optional :payload, -> { Telnyx::FaxDeliveredWebhookEvent::Payload }
+      #   @param meta [Telnyx::Models::FaxDeliveredWebhookEvent::Meta] Metadata about the webhook delivery.
 
-      # @!attribute record_type
-      #   Identifies the type of the resource.
-      #
-      #   @return [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::RecordType, nil]
-      optional :record_type, enum: -> { Telnyx::FaxDeliveredWebhookEvent::RecordType }
-
-      # @!method initialize(id: nil, event_type: nil, payload: nil, record_type: nil)
-      #   @param id [String] Identifies the type of resource.
-      #
-      #   @param event_type [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::EventType] The type of event being delivered.
-      #
-      #   @param payload [Telnyx::Models::FaxDeliveredWebhookEvent::Payload]
-      #
-      #   @param record_type [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::RecordType] Identifies the type of the resource.
-
-      # The type of event being delivered.
-      #
-      # @see Telnyx::Models::FaxDeliveredWebhookEvent#event_type
-      module EventType
-        extend Telnyx::Internal::Type::Enum
-
-        FAX_DELIVERED = :"fax.delivered"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see Telnyx::Models::FaxDeliveredWebhookEvent#payload
-      class Payload < Telnyx::Internal::Type::BaseModel
-        # @!attribute call_duration_secs
-        #   The duration of the call in seconds.
-        #
-        #   @return [Integer, nil]
-        optional :call_duration_secs, Integer
-
-        # @!attribute client_state
-        #   State received from a command.
+      # @see Telnyx::Models::FaxDeliveredWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifies the type of resource.
         #
         #   @return [String, nil]
-        optional :client_state, String
+        optional :id, String
 
-        # @!attribute connection_id
-        #   The ID of the connection used to send the fax.
+        # @!attribute event_type
+        #   The type of event being delivered.
         #
-        #   @return [String, nil]
-        optional :connection_id, String
+        #   @return [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Data::EventType, nil]
+        optional :event_type, enum: -> { Telnyx::FaxDeliveredWebhookEvent::Data::EventType }
 
-        # @!attribute direction
-        #   The direction of the fax.
+        # @!attribute occurred_at
+        #   ISO 8601 datetime of when the event occurred.
         #
-        #   @return [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Payload::Direction, nil]
-        optional :direction, enum: -> { Telnyx::FaxDeliveredWebhookEvent::Payload::Direction }
+        #   @return [Time, nil]
+        optional :occurred_at, Time
 
-        # @!attribute fax_id
-        #   Identifies the fax.
+        # @!attribute payload
         #
-        #   @return [String, nil]
-        optional :fax_id, String
+        #   @return [Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload, nil]
+        optional :payload, -> { Telnyx::FaxDeliveredWebhookEvent::Data::Payload }
 
-        # @!attribute from
-        #   The phone number, in E.164 format, the fax will be sent from.
+        # @!attribute record_type
+        #   Identifies the type of the resource.
         #
-        #   @return [String, nil]
-        optional :from, String
+        #   @return [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Data::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::FaxDeliveredWebhookEvent::Data::RecordType }
 
-        # @!attribute media_name
-        #   The media_name used for the fax's media. Must point to a file previously
-        #   uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-        #   and media_url/contents can't be submitted together.
+        # @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
+        #   @param id [String] Identifies the type of resource.
         #
-        #   @return [String, nil]
-        optional :media_name, String
-
-        # @!attribute original_media_url
-        #   The original URL to the PDF used for the fax's media. If media_name was
-        #   supplied, this is omitted
+        #   @param event_type [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Data::EventType] The type of event being delivered.
         #
-        #   @return [String, nil]
-        optional :original_media_url, String
-
-        # @!attribute page_count
-        #   Number of transferred pages
-        #
-        #   @return [Integer, nil]
-        optional :page_count, Integer
-
-        # @!attribute status
-        #   The status of the fax.
+        #   @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
         #
-        #   @return [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Payload::Status, nil]
-        optional :status, enum: -> { Telnyx::FaxDeliveredWebhookEvent::Payload::Status }
-
-        # @!attribute to
-        #   The phone number, in E.164 format, the fax will be sent to or SIP URI
+        #   @param payload [Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload]
         #
-        #   @return [String, nil]
-        optional :to, String
+        #   @param record_type [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Data::RecordType] Identifies the type of the resource.
 
-        # @!attribute user_id
-        #   Identifier of the user to whom the fax belongs
+        # The type of event being delivered.
         #
-        #   @return [String, nil]
-        optional :user_id, String
-
-        # @!method initialize(call_duration_secs: nil, client_state: nil, connection_id: nil, direction: nil, fax_id: nil, from: nil, media_name: nil, original_media_url: nil, page_count: nil, status: nil, to: nil, user_id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::FaxDeliveredWebhookEvent::Payload} for more details.
-        #
-        #   @param call_duration_secs [Integer] The duration of the call in seconds.
-        #
-        #   @param client_state [String] State received from a command.
-        #
-        #   @param connection_id [String] The ID of the connection used to send the fax.
-        #
-        #   @param direction [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Payload::Direction] The direction of the fax.
-        #
-        #   @param fax_id [String] Identifies the fax.
-        #
-        #   @param from [String] The phone number, in E.164 format, the fax will be sent from.
-        #
-        #   @param media_name [String] The media_name used for the fax's media. Must point to a file previously uploade
-        #
-        #   @param original_media_url [String] The original URL to the PDF used for the fax's media. If media_name was supplied
-        #
-        #   @param page_count [Integer] Number of transferred pages
-        #
-        #   @param status [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Payload::Status] The status of the fax.
-        #
-        #   @param to [String] The phone number, in E.164 format, the fax will be sent to or SIP URI
-        #
-        #   @param user_id [String] Identifier of the user to whom the fax belongs
-
-        # The direction of the fax.
-        #
-        # @see Telnyx::Models::FaxDeliveredWebhookEvent::Payload#direction
-        module Direction
+        # @see Telnyx::Models::FaxDeliveredWebhookEvent::Data#event_type
+        module EventType
           extend Telnyx::Internal::Type::Enum
 
-          INBOUND = :inbound
-          OUTBOUND = :outbound
+          FAX_DELIVERED = :"fax.delivered"
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
 
-        # The status of the fax.
+        # @see Telnyx::Models::FaxDeliveredWebhookEvent::Data#payload
+        class Payload < Telnyx::Internal::Type::BaseModel
+          # @!attribute call_duration_secs
+          #   The duration of the call in seconds.
+          #
+          #   @return [Integer, nil]
+          optional :call_duration_secs, Integer
+
+          # @!attribute client_state
+          #   State received from a command.
+          #
+          #   @return [String, nil]
+          optional :client_state, String
+
+          # @!attribute connection_id
+          #   The ID of the connection used to send the fax.
+          #
+          #   @return [String, nil]
+          optional :connection_id, String
+
+          # @!attribute direction
+          #   The direction of the fax.
+          #
+          #   @return [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::Direction, nil]
+          optional :direction, enum: -> { Telnyx::FaxDeliveredWebhookEvent::Data::Payload::Direction }
+
+          # @!attribute fax_id
+          #   Identifies the fax.
+          #
+          #   @return [String, nil]
+          optional :fax_id, String
+
+          # @!attribute from
+          #   The phone number, in E.164 format, the fax will be sent from.
+          #
+          #   @return [String, nil]
+          optional :from, String
+
+          # @!attribute media_name
+          #   The media_name used for the fax's media. Must point to a file previously
+          #   uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
+          #   and media_url/contents can't be submitted together.
+          #
+          #   @return [String, nil]
+          optional :media_name, String
+
+          # @!attribute original_media_url
+          #   The original URL to the PDF used for the fax's media. If media_name was
+          #   supplied, this is omitted
+          #
+          #   @return [String, nil]
+          optional :original_media_url, String
+
+          # @!attribute page_count
+          #   Number of transferred pages
+          #
+          #   @return [Integer, nil]
+          optional :page_count, Integer
+
+          # @!attribute status
+          #   The status of the fax.
+          #
+          #   @return [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::Status, nil]
+          optional :status, enum: -> { Telnyx::FaxDeliveredWebhookEvent::Data::Payload::Status }
+
+          # @!attribute to
+          #   The phone number, in E.164 format, the fax will be sent to or SIP URI
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!attribute user_id
+          #   Identifier of the user to whom the fax belongs
+          #
+          #   @return [String, nil]
+          optional :user_id, String
+
+          # @!method initialize(call_duration_secs: nil, client_state: nil, connection_id: nil, direction: nil, fax_id: nil, from: nil, media_name: nil, original_media_url: nil, page_count: nil, status: nil, to: nil, user_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload} for more details.
+          #
+          #   @param call_duration_secs [Integer] The duration of the call in seconds.
+          #
+          #   @param client_state [String] State received from a command.
+          #
+          #   @param connection_id [String] The ID of the connection used to send the fax.
+          #
+          #   @param direction [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::Direction] The direction of the fax.
+          #
+          #   @param fax_id [String] Identifies the fax.
+          #
+          #   @param from [String] The phone number, in E.164 format, the fax will be sent from.
+          #
+          #   @param media_name [String] The media_name used for the fax's media. Must point to a file previously uploade
+          #
+          #   @param original_media_url [String] The original URL to the PDF used for the fax's media. If media_name was supplied
+          #
+          #   @param page_count [Integer] Number of transferred pages
+          #
+          #   @param status [Symbol, Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload::Status] The status of the fax.
+          #
+          #   @param to [String] The phone number, in E.164 format, the fax will be sent to or SIP URI
+          #
+          #   @param user_id [String] Identifier of the user to whom the fax belongs
+
+          # The direction of the fax.
+          #
+          # @see Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload#direction
+          module Direction
+            extend Telnyx::Internal::Type::Enum
+
+            INBOUND = :inbound
+            OUTBOUND = :outbound
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The status of the fax.
+          #
+          # @see Telnyx::Models::FaxDeliveredWebhookEvent::Data::Payload#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            DELIVERED = :delivered
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifies the type of the resource.
         #
-        # @see Telnyx::Models::FaxDeliveredWebhookEvent::Payload#status
-        module Status
+        # @see Telnyx::Models::FaxDeliveredWebhookEvent::Data#record_type
+        module RecordType
           extend Telnyx::Internal::Type::Enum
 
-          DELIVERED = :delivered
+          EVENT = :event
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
       end
 
-      # Identifies the type of the resource.
-      #
-      # @see Telnyx::Models::FaxDeliveredWebhookEvent#record_type
-      module RecordType
-        extend Telnyx::Internal::Type::Enum
+      # @see Telnyx::Models::FaxDeliveredWebhookEvent#meta
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute attempt
+        #   The delivery attempt number.
+        #
+        #   @return [Integer, nil]
+        optional :attempt, Integer
 
-        EVENT = :event
+        # @!attribute delivered_to
+        #   The URL the webhook was delivered to.
+        #
+        #   @return [String, nil]
+        optional :delivered_to, String
 
-        # @!method self.values
-        #   @return [Array<Symbol>]
+        # @!method initialize(attempt: nil, delivered_to: nil)
+        #   Metadata about the webhook delivery.
+        #
+        #   @param attempt [Integer] The delivery attempt number.
+        #
+        #   @param delivered_to [String] The URL the webhook was delivered to.
       end
     end
   end