telnyx 5.158.0 → 5.159.0

data/lib/telnyx/models/email_domains/offset_pagination_meta.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class OffsetPaginationMeta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_number
+        #
+        #   @return [Integer]
+        required :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute total_pages
+        #
+        #   @return [Integer]
+        required :total_pages, Integer
+
+        # @!attribute total_results
+        #
+        #   @return [Integer]
+        required :total_results, Integer
+
+        # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
+        #   @param page_number [Integer]
+        #   @param page_size [Integer]
+        #   @param total_pages [Integer]
+        #   @param total_results [Integer]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domains/webhook_create_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      # @see Telnyx::Resources::EmailDomains::Webhooks#create
+      class WebhookCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute domain_id
+        #
+        #   @return [String]
+        required :domain_id, String
+
+        # @!attribute events
+        #   At least one event type is required.
+        #
+        #   @return [Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>]
+        required :events, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::EmailDomains::EmailWebhookEvent] }
+
+        # @!attribute url
+        #   HTTPS endpoint to deliver subscribed events to.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(domain_id:, events:, url:, request_options: {})
+        #   @param domain_id [String]
+        #
+        #   @param events [Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>] At least one event type is required.
+        #
+        #   @param url [String] HTTPS endpoint to deliver subscribed events to.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domains/webhook_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      # @see Telnyx::Resources::EmailDomains::Webhooks#delete
+      class WebhookDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute domain_id
+        #
+        #   @return [String]
+        required :domain_id, String
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(domain_id:, id:, request_options: {})
+        #   @param domain_id [String]
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domains/webhook_list_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      # @see Telnyx::Resources::EmailDomains::Webhooks#list
+      class WebhookListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute domain_id
+        #
+        #   @return [String]
+        required :domain_id, String
+
+        # @!attribute page_number
+        #   Page number to return (offset pagination)
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   Number of records per page
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute sort
+        #   Field to sort by. Prefix with `-` for descending order.
+        #
+        #   @return [Symbol, Telnyx::Models::EmailDomains::WebhookListParams::Sort, nil]
+        optional :sort, enum: -> { Telnyx::EmailDomains::WebhookListParams::Sort }
+
+        # @!method initialize(domain_id:, page_number: nil, page_size: nil, sort: nil, request_options: {})
+        #   @param domain_id [String]
+        #
+        #   @param page_number [Integer] Page number to return (offset pagination)
+        #
+        #   @param page_size [Integer] Number of records per page
+        #
+        #   @param sort [Symbol, Telnyx::Models::EmailDomains::WebhookListParams::Sort] Field to sort by. Prefix with `-` for descending order.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Field to sort by. Prefix with `-` for descending order.
+        module Sort
+          extend Telnyx::Internal::Type::Enum
+
+          CREATED_AT = :created_at
+          CREATED_AT_DESC = :"-created_at"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domains/webhook_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      # @see Telnyx::Resources::EmailDomains::Webhooks#retrieve
+      class WebhookRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute domain_id
+        #
+        #   @return [String]
+        required :domain_id, String
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(domain_id:, id:, request_options: {})
+        #   @param domain_id [String]
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domains/webhook_update_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      # @see Telnyx::Resources::EmailDomains::Webhooks#update
+      class WebhookUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute domain_id
+        #
+        #   @return [String]
+        required :domain_id, String
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute events
+        #
+        #   @return [Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>, nil]
+        optional :events, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::EmailDomains::EmailWebhookEvent] }
+
+        # @!attribute url
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(domain_id:, id:, events: nil, url: nil, request_options: {})
+        #   @param domain_id [String]
+        #   @param id [String]
+        #   @param events [Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>]
+        #   @param url [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_event_list_params.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailEvents#list
+    class EmailEventListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute email_id
+      #   Filter events for a specific email message UUID. Invalid UUID values are
+      #   silently ignored (no filter applied).
+      #
+      #   @return [String, nil]
+      optional :email_id, String
+
+      # @!attribute event_type
+      #   Comma-separated list of event types to include. Also accepts repeated query
+      #   parameters (e.g. event_type=delivered&event_type=bounced). Unknown values return
+      #   no matches.
+      #
+      #   @return [String, Array<String>, nil]
+      optional :event_type, union: -> { Telnyx::EmailEventListParams::EventType }
+
+      # @!attribute from
+      #   Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
+      #
+      #   @return [Time, nil]
+      optional :from, Time
+
+      # @!attribute page_cursor
+      #   Opaque URL-safe Base64 cursor returned by a previous list response.
+      #
+      #   @return [String, nil]
+      optional :page_cursor, String
+
+      # @!attribute page_size
+      #   Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+      #   clamped to the valid range.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute to
+      #   Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
+      #   to `from + 30 days`.
+      #
+      #   @return [Time, nil]
+      optional :to, Time
+
+      # @!method initialize(email_id: nil, event_type: nil, from: nil, page_cursor: nil, page_size: nil, to: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailEventListParams} for more details.
+      #
+      #   @param email_id [String] Filter events for a specific email message UUID. Invalid UUID values are silentl
+      #
+      #   @param event_type [String, Array<String>] Comma-separated list of event types to include. Also accepts repeated query para
+      #
+      #   @param from [Time] Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
+      #
+      #   @param page_cursor [String] Opaque URL-safe Base64 cursor returned by a previous list response.
+      #
+      #   @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+      #
+      #   @param to [Time] Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Comma-separated list of event types to include. Also accepts repeated query
+      # parameters (e.g. event_type=delivered&event_type=bounced). Unknown values return
+      # no matches.
+      module EventType
+        extend Telnyx::Internal::Type::Union
+
+        variant String
+
+        variant -> { Telnyx::Models::EmailEventListParams::EventType::StringArray }
+
+        # @!method self.variants
+        #   @return [Array(String, Array<String>)]
+
+        # @type [Telnyx::Internal::Type::Converter]
+        StringArray = Telnyx::Internal::Type::ArrayOf[String]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_event_list_response.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailEvents#list
+    class EmailEventListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::EmailEventListResponse::Data>]
+      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::EmailEventListResponse::Data] }
+
+      # @!attribute meta
+      #
+      #   @return [Telnyx::Models::EmailEventListResponse::Meta]
+      required :meta, -> { Telnyx::Models::EmailEventListResponse::Meta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Array<Telnyx::Models::EmailEventListResponse::Data>]
+      #   @param meta [Telnyx::Models::EmailEventListResponse::Meta]
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email_id
+        #
+        #   @return [String]
+        required :email_id, String
+
+        # @!attribute occurred_at
+        #
+        #   @return [Time]
+        required :occurred_at, Time
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailEventListResponse::Data::RecordType]
+        required :record_type, enum: -> { Telnyx::Models::EmailEventListResponse::Data::RecordType }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailEventType]
+        required :type, enum: -> { Telnyx::EmailEventType }
+
+        # @!attribute email
+        #   Summary of the associated email message. Present when the email_message preload
+        #   is available.
+        #
+        #   @return [Telnyx::Models::EmailEventListResponse::Data::Email, nil]
+        optional :email, -> { Telnyx::Models::EmailEventListResponse::Data::Email }
+
+        # @!attribute payload
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :payload, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!method initialize(id:, email_id:, occurred_at:, record_type:, type:, email: nil, payload: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailEventListResponse::Data} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param email_id [String]
+        #
+        #   @param occurred_at [Time]
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailEventListResponse::Data::RecordType]
+        #
+        #   @param type [Symbol, Telnyx::Models::EmailEventType]
+        #
+        #   @param email [Telnyx::Models::EmailEventListResponse::Data::Email] Summary of the associated email message. Present when the email_message preload
+        #
+        #   @param payload [Hash{Symbol=>Object}]
+
+        # @see Telnyx::Models::EmailEventListResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_EVENT = :email_event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::EmailEventListResponse::Data#email
+        class Email < Telnyx::Internal::Type::BaseModel
+          # @!attribute cc
+          #
+          #   @return [Array<Telnyx::Models::EmailInboxes::EmailAddress>]
+          required :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailAddress] }
+
+          # @!attribute from
+          #
+          #   @return [Telnyx::Models::EmailInboxes::EmailAddress]
+          required :from, -> { Telnyx::EmailInboxes::EmailAddress }
+
+          # @!attribute subject
+          #
+          #   @return [String]
+          required :subject, String
+
+          # @!attribute to
+          #
+          #   @return [Array<Telnyx::Models::EmailInboxes::EmailAddress>]
+          required :to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailAddress] }
+
+          # @!method initialize(cc:, from:, subject:, to:)
+          #   Summary of the associated email message. Present when the email_message preload
+          #   is available.
+          #
+          #   @param cc [Array<Telnyx::Models::EmailInboxes::EmailAddress>]
+          #   @param from [Telnyx::Models::EmailInboxes::EmailAddress]
+          #   @param subject [String]
+          #   @param to [Array<Telnyx::Models::EmailInboxes::EmailAddress>]
+        end
+      end
+
+      # @see Telnyx::Models::EmailEventListResponse#meta
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_size
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute time_range
+        #
+        #   @return [Telnyx::Models::TimeRange]
+        required :time_range, -> { Telnyx::TimeRange }
+
+        # @!attribute page_cursor
+        #   Cursor for the next page, when more results are available.
+        #
+        #   @return [String, nil]
+        optional :page_cursor, String
+
+        # @!method initialize(page_size:, time_range:, page_cursor: nil)
+        #   @param page_size [Integer]
+        #
+        #   @param time_range [Telnyx::Models::TimeRange]
+        #
+        #   @param page_cursor [String] Cursor for the next page, when more results are available.
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_event_retrieve_stats_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailEvents#retrieve_stats
+    class EmailEventRetrieveStatsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute from
+      #   Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
+      #
+      #   @return [Time, nil]
+      optional :from, Time
+
+      # @!attribute to
+      #   Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
+      #   to `from + 30 days`.
+      #
+      #   @return [Time, nil]
+      optional :to, Time
+
+      # @!method initialize(from: nil, to: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailEventRetrieveStatsParams} for more details.
+      #
+      #   @param from [Time] Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
+      #
+      #   @param to [Time] Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end