telnyx 5.7.1 → 5.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e89574319027088675c85fc5ea31eff8e036fe4c39761a0220624b38447b302f
-  data.tar.gz: 7a9593b6c2ad719c6b965689ccde790180dbaedb9b3e32deac580f8e6b7857be
+  metadata.gz: 44673328be367e8f6d1a6aeabecc5b36c8520f2943faf06a88e071dcab166274
+  data.tar.gz: b328bd1fb4691753ed233b4e67ca5ad2113f599ce515087d340765e97c0a57db
 SHA512:
-  metadata.gz: b9a90014ee5137670f3f37d9e3383721237d04288aa950ff48fb0decf8c51af194e3537581d776c121e192471dbfa56122ef26ce6127ea6012b3b3553a41b087
-  data.tar.gz: 94d4a9de15d606b748beb970dc47de48929b514ac26fc8021894587d1a2fc4ea74693f8b87f51713064987f2cef1e087629a4367ca7dfc9f55482667879a5ec8
+  metadata.gz: 97b4a08db4a7f99cf57bdc4b5499ec3010412fccdc6c5778fa1048cac1f5b38e65615a39a1a351358d75c083493c90b545471c7f477ea01f6f694617b1a70151
+  data.tar.gz: ccf0deedf2c5fba7940c1666065e90ddbb9208499b04186449354723b0dc880217a34954f2372e0a878b7b7954aac2f32f487cb3eb0c93aac4915e6a8f211956

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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)

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.1"
+gem "telnyx", "~> 5.7.2"
 ```
 
 <!-- x-release-please-end -->

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