telnyx 5.158.0 → 5.159.0

data/rbi/telnyx/models/email_message_retrieve_events_response.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailMessageRetrieveEventsResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::EmailMessageRetrieveEventsResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Telnyx::MessageEvent]) }
+      attr_accessor :data
+
+      sig { returns(Telnyx::EmailInboxes::EmailPaginationMeta) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Telnyx::EmailInboxes::EmailPaginationMeta::OrHash).void
+      end
+      attr_writer :meta
+
+      sig do
+        params(
+          data: T::Array[Telnyx::MessageEvent::OrHash],
+          meta: Telnyx::EmailInboxes::EmailPaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, meta:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[Telnyx::MessageEvent],
+            meta: Telnyx::EmailInboxes::EmailPaginationMeta
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_message_retrieve_params.rbi

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

data/rbi/telnyx/models/email_message_retrieve_response.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailMessageRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::EmailMessageRetrieveResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Telnyx::Models::EmailMessageRetrieveResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::Models::EmailMessageRetrieveResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::EmailMessageRetrieveResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::EmailMessageRetrieveResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Models::EmailInboxes::EmailMessage
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::EmailMessageRetrieveResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # HTML body submitted for the message.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :html_body
+
+        # Plain-text body submitted for the message.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :text_body
+
+        sig do
+          params(
+            html_body: T.nilable(String),
+            text_body: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # HTML body submitted for the message.
+          html_body:,
+          # Plain-text body submitted for the message.
+          text_body:
+        )
+        end
+
+        sig do
+          override.returns(
+            { html_body: T.nilable(String), text_body: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_messages/email_recipient.rbi

@@ -0,0 +1,260 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailMessages
+      class EmailRecipient < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailMessages::EmailRecipient,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Recipient UUID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Recipient email address. Null for BCC recipients (redacted for privacy).
+        sig { returns(T.nilable(String)) }
+        attr_accessor :address
+
+        # Whether this recipient's delivery is billable (set on queue acceptance).
+        sig { returns(T::Boolean) }
+        attr_accessor :billable
+
+        sig do
+          returns(Telnyx::EmailMessages::EmailRecipient::Kind::TaggedSymbol)
+        end
+        attr_accessor :kind
+
+        # Parent email message UUID.
+        sig { returns(String) }
+        attr_accessor :message_id
+
+        sig do
+          returns(
+            Telnyx::EmailMessages::EmailRecipient::RecordType::TaggedSymbol
+          )
+        end
+        attr_accessor :record_type
+
+        # Current per-recipient delivery status.
+        sig do
+          returns(Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol)
+        end
+        attr_accessor :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :delivered_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :failed_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :sent_at
+
+        # SMTP response code when available (e.g. 550 for bounces).
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :smtp_code
+
+        # SMTP response message when available.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :smtp_response
+
+        sig do
+          params(
+            id: String,
+            address: T.nilable(String),
+            billable: T::Boolean,
+            kind: Telnyx::EmailMessages::EmailRecipient::Kind::OrSymbol,
+            message_id: String,
+            record_type:
+              Telnyx::EmailMessages::EmailRecipient::RecordType::OrSymbol,
+            status: Telnyx::EmailMessages::EmailRecipient::Status::OrSymbol,
+            delivered_at: T.nilable(Time),
+            failed_at: T.nilable(Time),
+            sent_at: T.nilable(Time),
+            smtp_code: T.nilable(Integer),
+            smtp_response: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Recipient UUID.
+          id:,
+          # Recipient email address. Null for BCC recipients (redacted for privacy).
+          address:,
+          # Whether this recipient's delivery is billable (set on queue acceptance).
+          billable:,
+          kind:,
+          # Parent email message UUID.
+          message_id:,
+          record_type:,
+          # Current per-recipient delivery status.
+          status:,
+          delivered_at: nil,
+          failed_at: nil,
+          sent_at: nil,
+          # SMTP response code when available (e.g. 550 for bounces).
+          smtp_code: nil,
+          # SMTP response message when available.
+          smtp_response: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              address: T.nilable(String),
+              billable: T::Boolean,
+              kind: Telnyx::EmailMessages::EmailRecipient::Kind::TaggedSymbol,
+              message_id: String,
+              record_type:
+                Telnyx::EmailMessages::EmailRecipient::RecordType::TaggedSymbol,
+              status:
+                Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol,
+              delivered_at: T.nilable(Time),
+              failed_at: T.nilable(Time),
+              sent_at: T.nilable(Time),
+              smtp_code: T.nilable(Integer),
+              smtp_response: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Kind
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::EmailMessages::EmailRecipient::Kind)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TO =
+            T.let(
+              :to,
+              Telnyx::EmailMessages::EmailRecipient::Kind::TaggedSymbol
+            )
+          CC =
+            T.let(
+              :cc,
+              Telnyx::EmailMessages::EmailRecipient::Kind::TaggedSymbol
+            )
+          BCC =
+            T.let(
+              :bcc,
+              Telnyx::EmailMessages::EmailRecipient::Kind::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailMessages::EmailRecipient::Kind::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::EmailMessages::EmailRecipient::RecordType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EMAIL_RECIPIENT =
+            T.let(
+              :email_recipient,
+              Telnyx::EmailMessages::EmailRecipient::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailMessages::EmailRecipient::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Current per-recipient delivery status.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::EmailMessages::EmailRecipient::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          QUEUED =
+            T.let(
+              :queued,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          SENDING =
+            T.let(
+              :sending,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          SENT =
+            T.let(
+              :sent,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          DEFERRED =
+            T.let(
+              :deferred,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          DELIVERED =
+            T.let(
+              :delivered,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          BOUNCED =
+            T.let(
+              :bounced,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          GW_REJECT =
+            T.let(
+              :gw_reject,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailMessages::EmailRecipient::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_messages/recipient_list_params.rbi

@@ -0,0 +1,218 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailMessages
+      class RecipientListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailMessages::RecipientListParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :email_id
+
+        # Filter recipients by address kind.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::EmailMessages::RecipientListParams::Kind::OrSymbol
+            )
+          )
+        end
+        attr_reader :kind
+
+        sig do
+          params(
+            kind: Telnyx::EmailMessages::RecipientListParams::Kind::OrSymbol
+          ).void
+        end
+        attr_writer :kind
+
+        # 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
+
+        # Filter recipients by status.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::EmailMessages::RecipientListParams::Status::OrSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status: Telnyx::EmailMessages::RecipientListParams::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig do
+          params(
+            email_id: String,
+            kind: Telnyx::EmailMessages::RecipientListParams::Kind::OrSymbol,
+            page_cursor: String,
+            page_size: Integer,
+            status:
+              Telnyx::EmailMessages::RecipientListParams::Status::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          email_id:,
+          # Filter recipients by address kind.
+          kind: 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,
+          # Filter recipients by status.
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              email_id: String,
+              kind: Telnyx::EmailMessages::RecipientListParams::Kind::OrSymbol,
+              page_cursor: String,
+              page_size: Integer,
+              status:
+                Telnyx::EmailMessages::RecipientListParams::Status::OrSymbol,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter recipients by address kind.
+        module Kind
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::EmailMessages::RecipientListParams::Kind)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TO =
+            T.let(
+              :to,
+              Telnyx::EmailMessages::RecipientListParams::Kind::TaggedSymbol
+            )
+          CC =
+            T.let(
+              :cc,
+              Telnyx::EmailMessages::RecipientListParams::Kind::TaggedSymbol
+            )
+          BCC =
+            T.let(
+              :bcc,
+              Telnyx::EmailMessages::RecipientListParams::Kind::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailMessages::RecipientListParams::Kind::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Filter recipients by status.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::EmailMessages::RecipientListParams::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          QUEUED =
+            T.let(
+              :queued,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          SENDING =
+            T.let(
+              :sending,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          SENT =
+            T.let(
+              :sent,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          DEFERRED =
+            T.let(
+              :deferred,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          DELIVERED =
+            T.let(
+              :delivered,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          BOUNCED =
+            T.let(
+              :bounced,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          GW_REJECT =
+            T.let(
+              :gw_reject,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailMessages::RecipientListParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end