telnyx 5.158.0 → 5.159.0

data/rbi/telnyx/models/email_domains/webhook_list_params.rbi

@@ -0,0 +1,119 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class WebhookListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailDomains::WebhookListParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :domain_id
+
+        # Page number to return (offset pagination)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Number of records per page
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        # Field to sort by. Prefix with `-` for descending order.
+        sig do
+          returns(
+            T.nilable(Telnyx::EmailDomains::WebhookListParams::Sort::OrSymbol)
+          )
+        end
+        attr_reader :sort
+
+        sig do
+          params(
+            sort: Telnyx::EmailDomains::WebhookListParams::Sort::OrSymbol
+          ).void
+        end
+        attr_writer :sort
+
+        sig do
+          params(
+            domain_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            sort: Telnyx::EmailDomains::WebhookListParams::Sort::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          domain_id:,
+          # Page number to return (offset pagination)
+          page_number: nil,
+          # Number of records per page
+          page_size: nil,
+          # Field to sort by. Prefix with `-` for descending order.
+          sort: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              domain_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              sort: Telnyx::EmailDomains::WebhookListParams::Sort::OrSymbol,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Field to sort by. Prefix with `-` for descending order.
+        module Sort
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::EmailDomains::WebhookListParams::Sort)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREATED_AT =
+            T.let(
+              :created_at,
+              Telnyx::EmailDomains::WebhookListParams::Sort::TaggedSymbol
+            )
+          CREATED_AT_DESC =
+            T.let(
+              :"-created_at",
+              Telnyx::EmailDomains::WebhookListParams::Sort::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailDomains::WebhookListParams::Sort::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domains/webhook_retrieve_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class WebhookRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailDomains::WebhookRetrieveParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :domain_id
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            domain_id: String,
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(domain_id:, id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              domain_id: String,
+              id: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domains/webhook_update_params.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class WebhookUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailDomains::WebhookUpdateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :domain_id
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Telnyx::EmailDomains::EmailWebhookEvent::OrSymbol]
+            )
+          )
+        end
+        attr_reader :events
+
+        sig do
+          params(
+            events: T::Array[Telnyx::EmailDomains::EmailWebhookEvent::OrSymbol]
+          ).void
+        end
+        attr_writer :events
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        sig do
+          params(
+            domain_id: String,
+            id: String,
+            events: T::Array[Telnyx::EmailDomains::EmailWebhookEvent::OrSymbol],
+            url: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          domain_id:,
+          id:,
+          events: nil,
+          url: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              domain_id: String,
+              id: String,
+              events:
+                T::Array[Telnyx::EmailDomains::EmailWebhookEvent::OrSymbol],
+              url: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_event_list_params.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailEventListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailEventListParams, Telnyx::Internal::AnyHash)
+        end
+
+      # Filter events for a specific email message UUID. Invalid UUID values are
+      # silently ignored (no filter applied).
+      sig { returns(T.nilable(String)) }
+      attr_reader :email_id
+
+      sig { params(email_id: String).void }
+      attr_writer :email_id
+
+      # 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.
+      sig do
+        returns(T.nilable(Telnyx::EmailEventListParams::EventType::Variants))
+      end
+      attr_reader :event_type
+
+      sig do
+        params(
+          event_type: Telnyx::EmailEventListParams::EventType::Variants
+        ).void
+      end
+      attr_writer :event_type
+
+      # Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :from
+
+      sig { params(from: Time).void }
+      attr_writer :from
+
+      # Opaque URL-safe Base64 cursor returned by a previous list response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :page_cursor
+
+      sig { params(page_cursor: String).void }
+      attr_writer :page_cursor
+
+      # Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+      # clamped to the valid range.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
+      # to `from + 30 days`.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :to
+
+      sig { params(to: Time).void }
+      attr_writer :to
+
+      sig do
+        params(
+          email_id: String,
+          event_type: Telnyx::EmailEventListParams::EventType::Variants,
+          from: Time,
+          page_cursor: String,
+          page_size: Integer,
+          to: Time,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter events for a specific email message UUID. Invalid UUID values are
+        # silently ignored (no filter applied).
+        email_id: nil,
+        # 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.
+        event_type: nil,
+        # Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
+        from: nil,
+        # Opaque URL-safe Base64 cursor returned by a previous list response.
+        page_cursor: nil,
+        # Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+        # clamped to the valid range.
+        page_size: nil,
+        # Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
+        # to `from + 30 days`.
+        to: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email_id: String,
+            event_type: Telnyx::EmailEventListParams::EventType::Variants,
+            from: Time,
+            page_cursor: String,
+            page_size: Integer,
+            to: Time,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # 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
+
+        Variants = T.type_alias { T.any(String, T::Array[String]) }
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailEventListParams::EventType::Variants]
+          )
+        end
+        def self.variants
+        end
+
+        StringArray =
+          T.let(
+            Telnyx::Internal::Type::ArrayOf[String],
+            Telnyx::Internal::Type::Converter
+          )
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_event_list_response.rbi

@@ -0,0 +1,272 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailEventListResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::EmailEventListResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Telnyx::Models::EmailEventListResponse::Data]) }
+      attr_accessor :data
+
+      sig { returns(Telnyx::Models::EmailEventListResponse::Meta) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Telnyx::Models::EmailEventListResponse::Meta::OrHash).void
+      end
+      attr_writer :meta
+
+      sig do
+        params(
+          data: T::Array[Telnyx::Models::EmailEventListResponse::Data::OrHash],
+          meta: Telnyx::Models::EmailEventListResponse::Meta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, meta:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[Telnyx::Models::EmailEventListResponse::Data],
+            meta: Telnyx::Models::EmailEventListResponse::Meta
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::EmailEventListResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :email_id
+
+        sig { returns(Time) }
+        attr_accessor :occurred_at
+
+        sig do
+          returns(
+            Telnyx::Models::EmailEventListResponse::Data::RecordType::TaggedSymbol
+          )
+        end
+        attr_accessor :record_type
+
+        sig { returns(Telnyx::EmailEventType::TaggedSymbol) }
+        attr_accessor :type
+
+        # Summary of the associated email message. Present when the email_message preload
+        # is available.
+        sig do
+          returns(
+            T.nilable(Telnyx::Models::EmailEventListResponse::Data::Email)
+          )
+        end
+        attr_reader :email
+
+        sig do
+          params(
+            email: Telnyx::Models::EmailEventListResponse::Data::Email::OrHash
+          ).void
+        end
+        attr_writer :email
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :payload
+
+        sig { params(payload: T::Hash[Symbol, T.anything]).void }
+        attr_writer :payload
+
+        sig do
+          params(
+            id: String,
+            email_id: String,
+            occurred_at: Time,
+            record_type:
+              Telnyx::Models::EmailEventListResponse::Data::RecordType::OrSymbol,
+            type: Telnyx::EmailEventType::OrSymbol,
+            email: Telnyx::Models::EmailEventListResponse::Data::Email::OrHash,
+            payload: T::Hash[Symbol, T.anything]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          email_id:,
+          occurred_at:,
+          record_type:,
+          type:,
+          # Summary of the associated email message. Present when the email_message preload
+          # is available.
+          email: nil,
+          payload: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              email_id: String,
+              occurred_at: Time,
+              record_type:
+                Telnyx::Models::EmailEventListResponse::Data::RecordType::TaggedSymbol,
+              type: Telnyx::EmailEventType::TaggedSymbol,
+              email: Telnyx::Models::EmailEventListResponse::Data::Email,
+              payload: T::Hash[Symbol, T.anything]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Models::EmailEventListResponse::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EMAIL_EVENT =
+            T.let(
+              :email_event,
+              Telnyx::Models::EmailEventListResponse::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::EmailEventListResponse::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Email < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::EmailEventListResponse::Data::Email,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Array[Telnyx::EmailInboxes::EmailAddress]) }
+          attr_accessor :cc
+
+          sig { returns(Telnyx::EmailInboxes::EmailAddress) }
+          attr_reader :from
+
+          sig { params(from: Telnyx::EmailInboxes::EmailAddress::OrHash).void }
+          attr_writer :from
+
+          sig { returns(String) }
+          attr_accessor :subject
+
+          sig { returns(T::Array[Telnyx::EmailInboxes::EmailAddress]) }
+          attr_accessor :to
+
+          # Summary of the associated email message. Present when the email_message preload
+          # is available.
+          sig do
+            params(
+              cc: T::Array[Telnyx::EmailInboxes::EmailAddress::OrHash],
+              from: Telnyx::EmailInboxes::EmailAddress::OrHash,
+              subject: String,
+              to: T::Array[Telnyx::EmailInboxes::EmailAddress::OrHash]
+            ).returns(T.attached_class)
+          end
+          def self.new(cc:, from:, subject:, to:)
+          end
+
+          sig do
+            override.returns(
+              {
+                cc: T::Array[Telnyx::EmailInboxes::EmailAddress],
+                from: Telnyx::EmailInboxes::EmailAddress,
+                subject: String,
+                to: T::Array[Telnyx::EmailInboxes::EmailAddress]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::EmailEventListResponse::Meta,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :page_size
+
+        sig { returns(Telnyx::TimeRange) }
+        attr_reader :time_range
+
+        sig { params(time_range: Telnyx::TimeRange::OrHash).void }
+        attr_writer :time_range
+
+        # Cursor for the next page, when more results are available.
+        sig { returns(T.nilable(String)) }
+        attr_reader :page_cursor
+
+        sig { params(page_cursor: String).void }
+        attr_writer :page_cursor
+
+        sig do
+          params(
+            page_size: Integer,
+            time_range: Telnyx::TimeRange::OrHash,
+            page_cursor: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          page_size:,
+          time_range:,
+          # Cursor for the next page, when more results are available.
+          page_cursor: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              page_size: Integer,
+              time_range: Telnyx::TimeRange,
+              page_cursor: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_event_retrieve_stats_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailEventRetrieveStatsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::EmailEventRetrieveStatsParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :from
+
+      sig { params(from: Time).void }
+      attr_writer :from
+
+      # Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
+      # to `from + 30 days`.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :to
+
+      sig { params(to: Time).void }
+      attr_writer :to
+
+      sig do
+        params(
+          from: Time,
+          to: Time,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.
+        from: nil,
+        # Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
+        # to `from + 30 days`.
+        to: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { from: Time, to: Time, request_options: Telnyx::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end