telnyx 5.158.0 → 5.159.0

data/lib/telnyx/models/email_inboxes/mutate_inbox_filters_request.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      class MutateInboxFiltersRequest < Telnyx::Internal::Type::BaseModel
+        # @!attribute entries
+        #
+        #   @return [Array<String>]
+        required :entries, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute type
+        #   The list to change.
+        #
+        #   @return [Symbol, Telnyx::Models::EmailInboxes::MutateInboxFiltersRequest::Type]
+        required :type, enum: -> { Telnyx::EmailInboxes::MutateInboxFiltersRequest::Type }
+
+        # @!method initialize(entries:, type:)
+        #   @param entries [Array<String>]
+        #
+        #   @param type [Symbol, Telnyx::Models::EmailInboxes::MutateInboxFiltersRequest::Type] The list to change.
+
+        # The list to change.
+        #
+        # @see Telnyx::Models::EmailInboxes::MutateInboxFiltersRequest#type
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          ALLOWLIST = :allowlist
+          BLOCKLIST = :blocklist
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/thread_list_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Threads#list
+      class ThreadListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!attribute filter_label
+        #   Returns only threads carrying this label. Thread labels are independent of the
+        #   labels on the thread's messages.
+        #
+        #   @return [String, nil]
+        optional :filter_label, String
+
+        # @!attribute page_after
+        #   Opaque cursor returned by the previous page.
+        #
+        #   @return [String, nil]
+        optional :page_after, String
+
+        # @!attribute page_size
+        #   Number of results to return. Defaults to 25; maximum is 100.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(inbox_id:, filter_label: nil, page_after: nil, page_size: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailInboxes::ThreadListParams} for more details.
+        #
+        #   @param inbox_id [String]
+        #
+        #   @param filter_label [String] Returns only threads carrying this label. Thread labels are independent of the l
+        #
+        #   @param page_after [String] Opaque cursor returned by the previous page.
+        #
+        #   @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/thread_message.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      class ThreadMessage < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute attachments
+        #
+        #   @return [Array<Hash{Symbol=>Object}>]
+        required :attachments,
+                 Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
+
+        # @!attribute bcc
+        #
+        #   @return [Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>]
+        required :bcc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::InboundEmailAddress] }
+
+        # @!attribute cc
+        #
+        #   @return [Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>]
+        required :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::InboundEmailAddress] }
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute direction
+        #
+        #   @return [Symbol, Telnyx::Models::EmailInboxes::ThreadMessage::Direction]
+        required :direction, enum: -> { Telnyx::EmailInboxes::ThreadMessage::Direction }
+
+        # @!attribute from
+        #
+        #   @return [Telnyx::Models::EmailInboxes::InboundEmailAddress]
+        required :from, -> { Telnyx::EmailInboxes::InboundEmailAddress }
+
+        # @!attribute has_quoted_text
+        #   Whether conservative plain-text extraction detected a quoted tail. False does
+        #   not prove that the source contains no quoted content.
+        #
+        #   @return [Boolean]
+        required :has_quoted_text, Telnyx::Internal::Type::Boolean
+
+        # @!attribute headers
+        #
+        #   @return [Hash{Symbol=>Object}]
+        required :headers, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!attribute html_body_url
+        #   URL for an offloaded HTML body. Null means the body is not offloaded to a URL;
+        #   an inline HTML body may still exist but is not returned on list reads. Reply
+        #   extraction uses only the plain-text body during ingest.
+        #
+        #   @return [String, nil]
+        required :html_body_url, String, nil?: true
+
+        # @!attribute in_reply_to
+        #
+        #   @return [String, nil]
+        required :in_reply_to, String, nil?: true
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!attribute inline_files
+        #
+        #   @return [Array<Hash{Symbol=>Object}>]
+        required :inline_files,
+                 Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
+
+        # @!attribute labels
+        #   Mutable message labels used for agent workflow state (for example `spam`,
+        #   `needs_review`, `processed`). Distinct from the immutable send-time `tags` on
+        #   outbound messages: labels are never propagated to Email Detail Records or
+        #   Mission Control reporting. Always empty for outbound messages. Labels on a
+        #   message are independent of the labels on its thread.
+        #
+        #   @return [Array<String>]
+        required :labels, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute message_id
+        #   RFC Message-ID header. Null is possible for legacy outbound messages.
+        #
+        #   @return [String, nil]
+        required :message_id, String, nil?: true
+
+        # @!attribute read_at
+        #   Time the inbound message was marked read. Null means unread.
+        #
+        #   @return [Time, nil]
+        required :read_at, Time, nil?: true
+
+        # @!attribute received_at
+        #   Receipt time for inbound messages; null for outbound messages.
+        #
+        #   @return [Time, nil]
+        required :received_at, Time, nil?: true
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailInboxes::ThreadMessage::RecordType]
+        required :record_type, enum: -> { Telnyx::EmailInboxes::ThreadMessage::RecordType }
+
+        # @!attribute references
+        #   Ordered RFC Message-ID values from the References header.
+        #
+        #   @return [Array<String>]
+        required :references, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute reply_text
+        #   Conservatively extracted new-reply content persisted from the plain-text body
+        #   during ingest. Null means no plain-text extraction input was available or
+        #   extraction was skipped or failed; HTML bodies are not parsed.
+        #
+        #   @return [String, nil]
+        required :reply_text, String, nil?: true
+
+        # @!attribute reply_to
+        #
+        #   @return [Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>]
+        required :reply_to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::InboundEmailAddress] }
+
+        # @!attribute sent_at
+        #   Creation/send-acceptance time for outbound messages; null for inbound messages.
+        #
+        #   @return [Time, nil]
+        required :sent_at, Time, nil?: true
+
+        # @!attribute status
+        #   Received for inbound messages; the current send status for outbound messages.
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!attribute subject
+        #
+        #   @return [String, nil]
+        required :subject, String, nil?: true
+
+        # @!attribute text_body_url
+        #   URL for an offloaded plain-text body. Null means the body is not offloaded to a
+        #   URL; an inline plain-text body may still exist but is not returned on list
+        #   reads. `reply_text` and `has_quoted_text` are persisted during ingest before any
+        #   body offload.
+        #
+        #   @return [String, nil]
+        required :text_body_url, String, nil?: true
+
+        # @!attribute thread_id
+        #
+        #   @return [String]
+        required :thread_id, String
+
+        # @!attribute to
+        #
+        #   @return [Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>]
+        required :to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::InboundEmailAddress] }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!method initialize(id:, attachments:, bcc:, cc:, created_at:, direction:, from:, has_quoted_text:, headers:, html_body_url:, in_reply_to:, inbox_id:, inline_files:, labels:, message_id:, read_at:, received_at:, record_type:, references:, reply_text:, reply_to:, sent_at:, status:, subject:, text_body_url:, thread_id:, to:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailInboxes::ThreadMessage} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param attachments [Array<Hash{Symbol=>Object}>]
+        #
+        #   @param bcc [Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>]
+        #
+        #   @param cc [Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param direction [Symbol, Telnyx::Models::EmailInboxes::ThreadMessage::Direction]
+        #
+        #   @param from [Telnyx::Models::EmailInboxes::InboundEmailAddress]
+        #
+        #   @param has_quoted_text [Boolean] Whether conservative plain-text extraction detected a quoted tail. False does no
+        #
+        #   @param headers [Hash{Symbol=>Object}]
+        #
+        #   @param html_body_url [String, nil] URL for an offloaded HTML body. Null means the body is not offloaded to a URL; a
+        #
+        #   @param in_reply_to [String, nil]
+        #
+        #   @param inbox_id [String]
+        #
+        #   @param inline_files [Array<Hash{Symbol=>Object}>]
+        #
+        #   @param labels [Array<String>] Mutable message labels used for agent workflow state (for example `spam`, `needs
+        #
+        #   @param message_id [String, nil] RFC Message-ID header. Null is possible for legacy outbound messages.
+        #
+        #   @param read_at [Time, nil] Time the inbound message was marked read. Null means unread.
+        #
+        #   @param received_at [Time, nil] Receipt time for inbound messages; null for outbound messages.
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailInboxes::ThreadMessage::RecordType]
+        #
+        #   @param references [Array<String>] Ordered RFC Message-ID values from the References header.
+        #
+        #   @param reply_text [String, nil] Conservatively extracted new-reply content persisted from the plain-text body du
+        #
+        #   @param reply_to [Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>]
+        #
+        #   @param sent_at [Time, nil] Creation/send-acceptance time for outbound messages; null for inbound messages.
+        #
+        #   @param status [String] Received for inbound messages; the current send status for outbound messages.
+        #
+        #   @param subject [String, nil]
+        #
+        #   @param text_body_url [String, nil] URL for an offloaded plain-text body. Null means the body is not offloaded to a
+        #
+        #   @param thread_id [String]
+        #
+        #   @param to [Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>]
+        #
+        #   @param updated_at [Time]
+
+        # @see Telnyx::Models::EmailInboxes::ThreadMessage#direction
+        module Direction
+          extend Telnyx::Internal::Type::Enum
+
+          INBOUND = :inbound
+          OUTBOUND = :outbound
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::EmailInboxes::ThreadMessage#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_MESSAGE = :email_message
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/thread_retrieve_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Threads#retrieve
+      class ThreadRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!attribute thread_id
+        #
+        #   @return [String]
+        required :thread_id, String
+
+        # @!attribute page_after
+        #   Opaque message cursor returned by the previous thread-detail page.
+        #
+        #   @return [String, nil]
+        optional :page_after, String
+
+        # @!attribute page_size
+        #   Number of thread messages to return. Defaults to 25; maximum is 100.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(inbox_id:, thread_id:, page_after: nil, page_size: nil, request_options: {})
+        #   @param inbox_id [String]
+        #
+        #   @param thread_id [String]
+        #
+        #   @param page_after [String] Opaque message cursor returned by the previous thread-detail page.
+        #
+        #   @param page_size [Integer] Number of thread messages to return. Defaults to 25; maximum is 100.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/thread_retrieve_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Threads#retrieve
+      class ThreadRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::EmailInboxes::InboundThreadDetail]
+        required :data, -> { Telnyx::EmailInboxes::InboundThreadDetail }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+        required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
+
+        # @!method initialize(data:, meta:)
+        #   @param data [Telnyx::Models::EmailInboxes::InboundThreadDetail]
+        #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/threads/label_create_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Threads
+        # @see Telnyx::Resources::EmailInboxes::Threads::Labels#create
+        class LabelCreateParams < Telnyx::Models::EmailInboxes::Messages::LabelMutationRequest
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute inbox_id
+          #
+          #   @return [String]
+          required :inbox_id, String
+
+          # @!attribute thread_id
+          #
+          #   @return [String]
+          required :thread_id, String
+
+          # @!method initialize(inbox_id:, thread_id:, request_options: {})
+          #   @param inbox_id [String]
+          #   @param thread_id [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/threads/label_create_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Threads
+        # @see Telnyx::Resources::EmailInboxes::Threads::Labels#create
+        class LabelCreateResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse::Data]
+          required :data, -> { Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse::Data }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse::Data]
+
+          # @see Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse#data
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute labels
+            #
+            #   @return [Array<String>]
+            required :labels, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!attribute record_type
+            #
+            #   @return [Symbol, Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse::Data::RecordType]
+            required :record_type,
+                     enum: -> { Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse::Data::RecordType }
+
+            # @!attribute inbox_id
+            #
+            #   @return [String, nil]
+            optional :inbox_id, String
+
+            # @!method initialize(id:, labels:, record_type:, inbox_id: nil)
+            #   @param id [String]
+            #   @param labels [Array<String>]
+            #   @param record_type [Symbol, Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse::Data::RecordType]
+            #   @param inbox_id [String]
+
+            # @see Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse::Data#record_type
+            module RecordType
+              extend Telnyx::Internal::Type::Enum
+
+              EMAIL_THREAD = :email_thread
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/threads/label_delete_all_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Threads
+        # @see Telnyx::Resources::EmailInboxes::Threads::Labels#delete_all
+        class LabelDeleteAllParams < Telnyx::Models::EmailInboxes::Messages::LabelMutationRequest
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute inbox_id
+          #
+          #   @return [String]
+          required :inbox_id, String
+
+          # @!attribute thread_id
+          #
+          #   @return [String]
+          required :thread_id, String
+
+          # @!method initialize(inbox_id:, thread_id:, request_options: {})
+          #   @param inbox_id [String]
+          #   @param thread_id [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/threads/label_delete_all_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Threads
+        # @see Telnyx::Resources::EmailInboxes::Threads::Labels#delete_all
+        class LabelDeleteAllResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data]
+          required :data, -> { Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data]
+
+          # @see Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse#data
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute labels
+            #
+            #   @return [Array<String>]
+            required :labels, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!attribute record_type
+            #
+            #   @return [Symbol, Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data::RecordType]
+            required :record_type,
+                     enum: -> { Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data::RecordType }
+
+            # @!attribute inbox_id
+            #
+            #   @return [String, nil]
+            optional :inbox_id, String
+
+            # @!method initialize(id:, labels:, record_type:, inbox_id: nil)
+            #   @param id [String]
+            #   @param labels [Array<String>]
+            #   @param record_type [Symbol, Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data::RecordType]
+            #   @param inbox_id [String]
+
+            # @see Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data#record_type
+            module RecordType
+              extend Telnyx::Internal::Type::Enum
+
+              EMAIL_THREAD = :email_thread
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end