telnyx 5.7.1 → 5.7.2

data/lib/telnyx/models/fax_failed_webhook_event.rb

@@ -3,195 +3,244 @@
 module Telnyx
   module Models
     class FaxFailedWebhookEvent < Telnyx::Internal::Type::BaseModel
-      # @!attribute id
-      #   Identifies the type of resource.
+      # @!attribute data
       #
-      #   @return [String, nil]
-      optional :id, String
+      #   @return [Telnyx::Models::FaxFailedWebhookEvent::Data, nil]
+      optional :data, -> { Telnyx::FaxFailedWebhookEvent::Data }
 
-      # @!attribute event_type
-      #   The type of event being delivered.
+      # @!attribute meta
+      #   Metadata about the webhook delivery.
       #
-      #   @return [Symbol, Telnyx::Models::FaxFailedWebhookEvent::EventType, nil]
-      optional :event_type, enum: -> { Telnyx::FaxFailedWebhookEvent::EventType }
+      #   @return [Telnyx::Models::FaxFailedWebhookEvent::Meta, nil]
+      optional :meta, -> { Telnyx::FaxFailedWebhookEvent::Meta }
 
-      # @!attribute payload
+      # @!method initialize(data: nil, meta: nil)
+      #   @param data [Telnyx::Models::FaxFailedWebhookEvent::Data]
       #
-      #   @return [Telnyx::Models::FaxFailedWebhookEvent::Payload, nil]
-      optional :payload, -> { Telnyx::FaxFailedWebhookEvent::Payload }
+      #   @param meta [Telnyx::Models::FaxFailedWebhookEvent::Meta] Metadata about the webhook delivery.
 
-      # @!attribute record_type
-      #   Identifies the type of the resource.
-      #
-      #   @return [Symbol, Telnyx::Models::FaxFailedWebhookEvent::RecordType, nil]
-      optional :record_type, enum: -> { Telnyx::FaxFailedWebhookEvent::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::FaxFailedWebhookEvent::EventType] The type of event being delivered.
-      #
-      #   @param payload [Telnyx::Models::FaxFailedWebhookEvent::Payload]
-      #
-      #   @param record_type [Symbol, Telnyx::Models::FaxFailedWebhookEvent::RecordType] Identifies the type of the resource.
-
-      # The type of event being delivered.
-      #
-      # @see Telnyx::Models::FaxFailedWebhookEvent#event_type
-      module EventType
-        extend Telnyx::Internal::Type::Enum
-
-        FAX_FAILED = :"fax.failed"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see Telnyx::Models::FaxFailedWebhookEvent#payload
-      class Payload < Telnyx::Internal::Type::BaseModel
-        # @!attribute client_state
-        #   State received from a command.
+      # @see Telnyx::Models::FaxFailedWebhookEvent#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::FaxFailedWebhookEvent::Data::EventType, nil]
+        optional :event_type, enum: -> { Telnyx::FaxFailedWebhookEvent::Data::EventType }
 
-        # @!attribute direction
-        #   The direction of the fax.
+        # @!attribute occurred_at
+        #   ISO 8601 datetime of when the event occurred.
         #
-        #   @return [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Payload::Direction, nil]
-        optional :direction, enum: -> { Telnyx::FaxFailedWebhookEvent::Payload::Direction }
+        #   @return [Time, nil]
+        optional :occurred_at, Time
 
-        # @!attribute failure_reason
-        #   Cause of the sending failure
+        # @!attribute payload
         #
-        #   @return [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Payload::FailureReason, nil]
-        optional :failure_reason, enum: -> { Telnyx::FaxFailedWebhookEvent::Payload::FailureReason }
+        #   @return [Telnyx::Models::FaxFailedWebhookEvent::Data::Payload, nil]
+        optional :payload, -> { Telnyx::FaxFailedWebhookEvent::Data::Payload }
 
-        # @!attribute fax_id
-        #   Identifies the fax.
+        # @!attribute record_type
+        #   Identifies the type of the resource.
         #
-        #   @return [String, nil]
-        optional :fax_id, String
+        #   @return [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Data::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::FaxFailedWebhookEvent::Data::RecordType }
 
-        # @!attribute from
-        #   The phone number, in E.164 format, the fax will be sent from.
+        # @!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 :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 status
-        #   The status of the fax.
+        #   @param event_type [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Data::EventType] The type of event being delivered.
         #
-        #   @return [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Payload::Status, nil]
-        optional :status, enum: -> { Telnyx::FaxFailedWebhookEvent::Payload::Status }
-
-        # @!attribute to
-        #   The phone number, in E.164 format, the fax will be sent to or SIP URI
+        #   @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
         #
-        #   @return [String, nil]
-        optional :to, String
-
-        # @!attribute user_id
-        #   Identifier of the user to whom the fax belongs
+        #   @param payload [Telnyx::Models::FaxFailedWebhookEvent::Data::Payload]
         #
-        #   @return [String, nil]
-        optional :user_id, String
+        #   @param record_type [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Data::RecordType] Identifies the type of the resource.
 
-        # @!method initialize(client_state: nil, connection_id: nil, direction: nil, failure_reason: nil, fax_id: nil, from: nil, media_name: nil, original_media_url: nil, status: nil, to: nil, user_id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::FaxFailedWebhookEvent::Payload} for more details.
+        # The type of event being delivered.
         #
-        #   @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::FaxFailedWebhookEvent::Payload::Direction] The direction of the fax.
-        #
-        #   @param failure_reason [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Payload::FailureReason] Cause of the sending failure
-        #
-        #   @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 status [Symbol, Telnyx::Models::FaxFailedWebhookEvent::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::FaxFailedWebhookEvent::Payload#direction
-        module Direction
+        # @see Telnyx::Models::FaxFailedWebhookEvent::Data#event_type
+        module EventType
           extend Telnyx::Internal::Type::Enum
 
-          INBOUND = :inbound
-          OUTBOUND = :outbound
+          FAX_FAILED = :"fax.failed"
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
 
-        # Cause of the sending failure
-        #
-        # @see Telnyx::Models::FaxFailedWebhookEvent::Payload#failure_reason
-        module FailureReason
-          extend Telnyx::Internal::Type::Enum
-
-          REJECTED = :rejected
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
+        # @see Telnyx::Models::FaxFailedWebhookEvent::Data#payload
+        class Payload < Telnyx::Internal::Type::BaseModel
+          # @!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::FaxFailedWebhookEvent::Data::Payload::Direction, nil]
+          optional :direction, enum: -> { Telnyx::FaxFailedWebhookEvent::Data::Payload::Direction }
+
+          # @!attribute failure_reason
+          #   Cause of the sending failure
+          #
+          #   @return [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Data::Payload::FailureReason, nil]
+          optional :failure_reason, enum: -> { Telnyx::FaxFailedWebhookEvent::Data::Payload::FailureReason }
+
+          # @!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 status
+          #   The status of the fax.
+          #
+          #   @return [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Data::Payload::Status, nil]
+          optional :status, enum: -> { Telnyx::FaxFailedWebhookEvent::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(client_state: nil, connection_id: nil, direction: nil, failure_reason: nil, fax_id: nil, from: nil, media_name: nil, original_media_url: nil, status: nil, to: nil, user_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::FaxFailedWebhookEvent::Data::Payload} for more details.
+          #
+          #   @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::FaxFailedWebhookEvent::Data::Payload::Direction] The direction of the fax.
+          #
+          #   @param failure_reason [Symbol, Telnyx::Models::FaxFailedWebhookEvent::Data::Payload::FailureReason] Cause of the sending failure
+          #
+          #   @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 status [Symbol, Telnyx::Models::FaxFailedWebhookEvent::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::FaxFailedWebhookEvent::Data::Payload#direction
+          module Direction
+            extend Telnyx::Internal::Type::Enum
+
+            INBOUND = :inbound
+            OUTBOUND = :outbound
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Cause of the sending failure
+          #
+          # @see Telnyx::Models::FaxFailedWebhookEvent::Data::Payload#failure_reason
+          module FailureReason
+            extend Telnyx::Internal::Type::Enum
+
+            REJECTED = :rejected
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The status of the fax.
+          #
+          # @see Telnyx::Models::FaxFailedWebhookEvent::Data::Payload#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            FAILED = :failed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
 
-        # The status of the fax.
+        # Identifies the type of the resource.
         #
-        # @see Telnyx::Models::FaxFailedWebhookEvent::Payload#status
-        module Status
+        # @see Telnyx::Models::FaxFailedWebhookEvent::Data#record_type
+        module RecordType
           extend Telnyx::Internal::Type::Enum
 
-          FAILED = :failed
+          EVENT = :event
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
       end
 
-      # Identifies the type of the resource.
-      #
-      # @see Telnyx::Models::FaxFailedWebhookEvent#record_type
-      module RecordType
-        extend Telnyx::Internal::Type::Enum
+      # @see Telnyx::Models::FaxFailedWebhookEvent#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