telnyx 5.158.0 → 5.159.0

data/lib/telnyx/models/email_message_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailMessages#list
+    class EmailMessageListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!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
+
+      # @!method initialize(page_cursor: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailMessageListParams} for more details.
+      #
+      #   @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 request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_message_list_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailMessages#list
+    class EmailMessageListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::EmailInboxes::EmailMessage>]
+      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailMessage] }
+
+      # @!attribute meta
+      #
+      #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+      required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Array<Telnyx::Models::EmailInboxes::EmailMessage>]
+      #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+    end
+  end
+end

data/lib/telnyx/models/email_message_retrieve_events_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailMessages#retrieve_events
+    class EmailMessageRetrieveEventsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute email_id
+      #
+      #   @return [String]
+      required :email_id, String
+
+      # @!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
+
+      # @!method initialize(email_id:, page_cursor: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailMessageRetrieveEventsParams} for more details.
+      #
+      #   @param email_id [String]
+      #
+      #   @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 request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_message_retrieve_events_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailMessages#retrieve_events
+    class EmailMessageRetrieveEventsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::MessageEvent>]
+      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessageEvent] }
+
+      # @!attribute meta
+      #
+      #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+      required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Array<Telnyx::Models::MessageEvent>]
+      #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+    end
+  end
+end

data/lib/telnyx/models/email_message_retrieve_params.rb

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

data/lib/telnyx/models/email_message_retrieve_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailMessages#retrieve
+    class EmailMessageRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::EmailMessageRetrieveResponse::Data]
+      required :data, -> { Telnyx::Models::EmailMessageRetrieveResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::EmailMessageRetrieveResponse::Data]
+
+      # @see Telnyx::Models::EmailMessageRetrieveResponse#data
+      class Data < Telnyx::Models::EmailInboxes::EmailMessage
+        # @!attribute html_body
+        #   HTML body submitted for the message.
+        #
+        #   @return [String, nil]
+        required :html_body, String, nil?: true
+
+        # @!attribute text_body
+        #   Plain-text body submitted for the message.
+        #
+        #   @return [String, nil]
+        required :text_body, String, nil?: true
+
+        # @!method initialize(html_body:, text_body:)
+        #   @param html_body [String, nil] HTML body submitted for the message.
+        #
+        #   @param text_body [String, nil] Plain-text body submitted for the message.
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_messages/email_recipient.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailMessages
+      class EmailRecipient < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Recipient UUID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute address
+        #   Recipient email address. Null for BCC recipients (redacted for privacy).
+        #
+        #   @return [String, nil]
+        required :address, String, nil?: true
+
+        # @!attribute billable
+        #   Whether this recipient's delivery is billable (set on queue acceptance).
+        #
+        #   @return [Boolean]
+        required :billable, Telnyx::Internal::Type::Boolean
+
+        # @!attribute kind
+        #
+        #   @return [Symbol, Telnyx::Models::EmailMessages::EmailRecipient::Kind]
+        required :kind, enum: -> { Telnyx::EmailMessages::EmailRecipient::Kind }
+
+        # @!attribute message_id
+        #   Parent email message UUID.
+        #
+        #   @return [String]
+        required :message_id, String
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailMessages::EmailRecipient::RecordType]
+        required :record_type, enum: -> { Telnyx::EmailMessages::EmailRecipient::RecordType }
+
+        # @!attribute status
+        #   Current per-recipient delivery status.
+        #
+        #   @return [Symbol, Telnyx::Models::EmailMessages::EmailRecipient::Status]
+        required :status, enum: -> { Telnyx::EmailMessages::EmailRecipient::Status }
+
+        # @!attribute delivered_at
+        #
+        #   @return [Time, nil]
+        optional :delivered_at, Time, nil?: true
+
+        # @!attribute failed_at
+        #
+        #   @return [Time, nil]
+        optional :failed_at, Time, nil?: true
+
+        # @!attribute sent_at
+        #
+        #   @return [Time, nil]
+        optional :sent_at, Time, nil?: true
+
+        # @!attribute smtp_code
+        #   SMTP response code when available (e.g. 550 for bounces).
+        #
+        #   @return [Integer, nil]
+        optional :smtp_code, Integer, nil?: true
+
+        # @!attribute smtp_response
+        #   SMTP response message when available.
+        #
+        #   @return [String, nil]
+        optional :smtp_response, String, nil?: true
+
+        # @!method initialize(id:, address:, billable:, kind:, message_id:, record_type:, status:, delivered_at: nil, failed_at: nil, sent_at: nil, smtp_code: nil, smtp_response: nil)
+        #   @param id [String] Recipient UUID.
+        #
+        #   @param address [String, nil] Recipient email address. Null for BCC recipients (redacted for privacy).
+        #
+        #   @param billable [Boolean] Whether this recipient's delivery is billable (set on queue acceptance).
+        #
+        #   @param kind [Symbol, Telnyx::Models::EmailMessages::EmailRecipient::Kind]
+        #
+        #   @param message_id [String] Parent email message UUID.
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailMessages::EmailRecipient::RecordType]
+        #
+        #   @param status [Symbol, Telnyx::Models::EmailMessages::EmailRecipient::Status] Current per-recipient delivery status.
+        #
+        #   @param delivered_at [Time, nil]
+        #
+        #   @param failed_at [Time, nil]
+        #
+        #   @param sent_at [Time, nil]
+        #
+        #   @param smtp_code [Integer, nil] SMTP response code when available (e.g. 550 for bounces).
+        #
+        #   @param smtp_response [String, nil] SMTP response message when available.
+
+        # @see Telnyx::Models::EmailMessages::EmailRecipient#kind
+        module Kind
+          extend Telnyx::Internal::Type::Enum
+
+          TO = :to
+          CC = :cc
+          BCC = :bcc
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::EmailMessages::EmailRecipient#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_RECIPIENT = :email_recipient
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Current per-recipient delivery status.
+        #
+        # @see Telnyx::Models::EmailMessages::EmailRecipient#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          QUEUED = :queued
+          SENDING = :sending
+          SENT = :sent
+          DEFERRED = :deferred
+          DELIVERED = :delivered
+          BOUNCED = :bounced
+          FAILED = :failed
+          GW_REJECT = :gw_reject
+          CANCELLED = :cancelled
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_messages/recipient_list_params.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailMessages
+      # @see Telnyx::Resources::EmailMessages::Recipients#list
+      class RecipientListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute email_id
+        #
+        #   @return [String]
+        required :email_id, String
+
+        # @!attribute kind
+        #   Filter recipients by address kind.
+        #
+        #   @return [Symbol, Telnyx::Models::EmailMessages::RecipientListParams::Kind, nil]
+        optional :kind, enum: -> { Telnyx::EmailMessages::RecipientListParams::Kind }
+
+        # @!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 status
+        #   Filter recipients by status.
+        #
+        #   @return [Symbol, Telnyx::Models::EmailMessages::RecipientListParams::Status, nil]
+        optional :status, enum: -> { Telnyx::EmailMessages::RecipientListParams::Status }
+
+        # @!method initialize(email_id:, kind: nil, page_cursor: nil, page_size: nil, status: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailMessages::RecipientListParams} for more details.
+        #
+        #   @param email_id [String]
+        #
+        #   @param kind [Symbol, Telnyx::Models::EmailMessages::RecipientListParams::Kind] Filter recipients by address kind.
+        #
+        #   @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 status [Symbol, Telnyx::Models::EmailMessages::RecipientListParams::Status] Filter recipients by status.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter recipients by address kind.
+        module Kind
+          extend Telnyx::Internal::Type::Enum
+
+          TO = :to
+          CC = :cc
+          BCC = :bcc
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Filter recipients by status.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          QUEUED = :queued
+          SENDING = :sending
+          SENT = :sent
+          DEFERRED = :deferred
+          DELIVERED = :delivered
+          BOUNCED = :bounced
+          FAILED = :failed
+          GW_REJECT = :gw_reject
+          CANCELLED = :cancelled
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_messages/recipient_list_response.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailMessages
+      # @see Telnyx::Resources::EmailMessages::Recipients#list
+      class RecipientListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::EmailMessages::EmailRecipient>]
+        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailMessages::EmailRecipient] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::EmailMessages::RecipientListResponse::Meta]
+        required :meta, -> { Telnyx::Models::EmailMessages::RecipientListResponse::Meta }
+
+        # @!method initialize(data:, meta:)
+        #   @param data [Array<Telnyx::Models::EmailMessages::EmailRecipient>]
+        #   @param meta [Telnyx::Models::EmailMessages::RecipientListResponse::Meta]
+
+        # @see Telnyx::Models::EmailMessages::RecipientListResponse#meta
+        class Meta < Telnyx::Internal::Type::BaseModel
+          # @!attribute page_size
+          #
+          #   @return [Integer]
+          required :page_size, Integer
+
+          # @!attribute page_cursor
+          #   Cursor for the next page. Absent when there are no more results.
+          #
+          #   @return [String, nil]
+          optional :page_cursor, String, nil?: true
+
+          # @!method initialize(page_size:, page_cursor: nil)
+          #   @param page_size [Integer]
+          #
+          #   @param page_cursor [String, nil] Cursor for the next page. Absent when there are no more results.
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_messages/recipient_retrieve_params.rb

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

data/lib/telnyx/models/email_messages/recipient_retrieve_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailMessages
+      # @see Telnyx::Resources::EmailMessages::Recipients#retrieve
+      class RecipientRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::EmailMessages::EmailRecipient]
+        required :data, -> { Telnyx::EmailMessages::EmailRecipient }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::EmailMessages::EmailRecipient]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_template.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class EmailTemplate < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute html_body
+      #
+      #   @return [String, nil]
+      required :html_body, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute record_type
+      #
+      #   @return [Symbol, Telnyx::Models::EmailTemplate::RecordType]
+      required :record_type, enum: -> { Telnyx::EmailTemplate::RecordType }
+
+      # @!attribute subject
+      #
+      #   @return [String, nil]
+      required :subject, String, nil?: true
+
+      # @!attribute text_body
+      #
+      #   @return [String, nil]
+      required :text_body, String, nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute variables
+      #
+      #   @return [Array<String>]
+      required :variables, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(id:, created_at:, html_body:, name:, record_type:, subject:, text_body:, updated_at:, variables:)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param html_body [String, nil]
+      #   @param name [String]
+      #   @param record_type [Symbol, Telnyx::Models::EmailTemplate::RecordType]
+      #   @param subject [String, nil]
+      #   @param text_body [String, nil]
+      #   @param updated_at [Time]
+      #   @param variables [Array<String>]
+
+      # @see Telnyx::Models::EmailTemplate#record_type
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        EMAIL_TEMPLATE = :email_template
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_template_create_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailTemplates#create
+    class EmailTemplateCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   Letters, numbers, spaces, hyphens, and underscores only.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute html_body
+      #   Liquid template HTML body.
+      #
+      #   @return [String, nil]
+      optional :html_body, String, nil?: true
+
+      # @!attribute subject
+      #   Liquid template subject.
+      #
+      #   @return [String, nil]
+      optional :subject, String, nil?: true
+
+      # @!attribute text_body
+      #   Liquid template text body.
+      #
+      #   @return [String, nil]
+      optional :text_body, String, nil?: true
+
+      # @!attribute variables
+      #   Template variables. Auto-extracted from subject/body fields when absent.
+      #
+      #   @return [Array<String>, nil]
+      optional :variables, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(name:, html_body: nil, subject: nil, text_body: nil, variables: nil, idempotency_key: nil, request_options: {})
+      #   @param name [String] Letters, numbers, spaces, hyphens, and underscores only.
+      #
+      #   @param html_body [String, nil] Liquid template HTML body.
+      #
+      #   @param subject [String, nil] Liquid template subject.
+      #
+      #   @param text_body [String, nil] Liquid template text body.
+      #
+      #   @param variables [Array<String>] Template variables. Auto-extracted from subject/body fields when absent.
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_template_delete_params.rb

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