telnyx 5.158.0 → 5.159.0

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Drafts#send_
+      class EmailMessageResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::EmailInboxes::EmailMessage]
+        required :data, -> { Telnyx::EmailInboxes::EmailMessage }
+
+        # @!attribute suppressed
+        #   Recipients removed by suppression checks when at least one recipient remains and
+        #   the message is accepted.
+        #
+        #   @return [Array<Telnyx::Models::EmailInboxes::EmailMessageResponse::Suppressed>, nil]
+        optional :suppressed,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailMessageResponse::Suppressed] }
+
+        # @!method initialize(data:, suppressed: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailInboxes::EmailMessageResponse} for more details.
+        #
+        #   @param data [Telnyx::Models::EmailInboxes::EmailMessage]
+        #
+        #   @param suppressed [Array<Telnyx::Models::EmailInboxes::EmailMessageResponse::Suppressed>] Recipients removed by suppression checks when at least one recipient remains and
+
+        class Suppressed < Telnyx::Internal::Type::BaseModel
+          # @!attribute override_allowed
+          #   Whether an authorized send may override this suppression.
+          #
+          #   @return [Boolean]
+          required :override_allowed, Telnyx::Internal::Type::Boolean
+
+          # @!attribute reason
+          #   Suppression reason returned by the recipient suppression service.
+          #
+          #   @return [String]
+          required :reason, String
+
+          # @!attribute scope
+          #   Scope at which the suppression applies.
+          #
+          #   @return [String]
+          required :scope, String
+
+          # @!attribute to
+          #   Suppressed recipient email address.
+          #
+          #   @return [String]
+          required :to, String
+
+          # @!method initialize(override_allowed:, reason:, scope:, to:)
+          #   @param override_allowed [Boolean] Whether an authorized send may override this suppression.
+          #
+          #   @param reason [String] Suppression reason returned by the recipient suppression service.
+          #
+          #   @param scope [String] Scope at which the suppression applies.
+          #
+          #   @param to [String] Suppressed recipient email address.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      class EmailPaginationMeta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_size
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute page_cursor
+        #   Cursor for the next page, when more results are available.
+        #
+        #   @return [String, nil]
+        optional :page_cursor, String
+
+        # @!method initialize(page_size:, page_cursor: nil)
+        #   @param page_size [Integer]
+        #
+        #   @param page_cursor [String] Cursor for the next page, when more results are available.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Filters#add
+      class FilterAddParams < Telnyx::Models::EmailInboxes::MutateInboxFiltersRequest
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!method initialize(inbox_id:, request_options: {})
+        #   @param inbox_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Filters#add
+      class FilterAddResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::EmailInboxes::FilterAddResponse::Data]
+        required :data, -> { Telnyx::Models::EmailInboxes::FilterAddResponse::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::EmailInboxes::FilterAddResponse::Data]
+
+        # @see Telnyx::Models::EmailInboxes::FilterAddResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute allowlist
+          #
+          #   @return [Array<String>]
+          required :allowlist, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute blocklist
+          #
+          #   @return [Array<String>]
+          required :blocklist, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute record_type
+          #
+          #   @return [Symbol, Telnyx::Models::EmailInboxes::FilterAddResponse::Data::RecordType]
+          required :record_type, enum: -> { Telnyx::Models::EmailInboxes::FilterAddResponse::Data::RecordType }
+
+          # @!method initialize(allowlist:, blocklist:, record_type:)
+          #   @param allowlist [Array<String>]
+          #   @param blocklist [Array<String>]
+          #   @param record_type [Symbol, Telnyx::Models::EmailInboxes::FilterAddResponse::Data::RecordType]
+
+          # @see Telnyx::Models::EmailInboxes::FilterAddResponse::Data#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_INBOX_FILTERS = :email_inbox_filters
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Filters#delete_all
+      class FilterDeleteAllResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::EmailInboxes::FilterDeleteAllResponse::Data]
+        required :data, -> { Telnyx::Models::EmailInboxes::FilterDeleteAllResponse::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::EmailInboxes::FilterDeleteAllResponse::Data]
+
+        # @see Telnyx::Models::EmailInboxes::FilterDeleteAllResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute allowlist
+          #
+          #   @return [Array<String>]
+          required :allowlist, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute blocklist
+          #
+          #   @return [Array<String>]
+          required :blocklist, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute record_type
+          #
+          #   @return [Symbol, Telnyx::Models::EmailInboxes::FilterDeleteAllResponse::Data::RecordType]
+          required :record_type,
+                   enum: -> { Telnyx::Models::EmailInboxes::FilterDeleteAllResponse::Data::RecordType }
+
+          # @!method initialize(allowlist:, blocklist:, record_type:)
+          #   @param allowlist [Array<String>]
+          #   @param blocklist [Array<String>]
+          #   @param record_type [Symbol, Telnyx::Models::EmailInboxes::FilterDeleteAllResponse::Data::RecordType]
+
+          # @see Telnyx::Models::EmailInboxes::FilterDeleteAllResponse::Data#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_INBOX_FILTERS = :email_inbox_filters
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Filters#list
+      class FilterListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::EmailInboxes::FilterListResponse::Data]
+        required :data, -> { Telnyx::Models::EmailInboxes::FilterListResponse::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::EmailInboxes::FilterListResponse::Data]
+
+        # @see Telnyx::Models::EmailInboxes::FilterListResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute allowlist
+          #
+          #   @return [Array<String>]
+          required :allowlist, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute blocklist
+          #
+          #   @return [Array<String>]
+          required :blocklist, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute record_type
+          #
+          #   @return [Symbol, Telnyx::Models::EmailInboxes::FilterListResponse::Data::RecordType]
+          required :record_type, enum: -> { Telnyx::Models::EmailInboxes::FilterListResponse::Data::RecordType }
+
+          # @!method initialize(allowlist:, blocklist:, record_type:)
+          #   @param allowlist [Array<String>]
+          #   @param blocklist [Array<String>]
+          #   @param record_type [Symbol, Telnyx::Models::EmailInboxes::FilterListResponse::Data::RecordType]
+
+          # @see Telnyx::Models::EmailInboxes::FilterListResponse::Data#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_INBOX_FILTERS = :email_inbox_filters
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Filters#replace
+      class FilterReplaceParams < 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 allowlist
+        #
+        #   @return [Array<String>, nil]
+        optional :allowlist, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute blocklist
+        #
+        #   @return [Array<String>, nil]
+        optional :blocklist, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(inbox_id:, allowlist: nil, blocklist: nil, request_options: {})
+        #   @param inbox_id [String]
+        #   @param allowlist [Array<String>]
+        #   @param blocklist [Array<String>]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Filters#replace
+      class FilterReplaceResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::EmailInboxes::FilterReplaceResponse::Data]
+        required :data, -> { Telnyx::Models::EmailInboxes::FilterReplaceResponse::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::EmailInboxes::FilterReplaceResponse::Data]
+
+        # @see Telnyx::Models::EmailInboxes::FilterReplaceResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute allowlist
+          #
+          #   @return [Array<String>]
+          required :allowlist, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute blocklist
+          #
+          #   @return [Array<String>]
+          required :blocklist, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute record_type
+          #
+          #   @return [Symbol, Telnyx::Models::EmailInboxes::FilterReplaceResponse::Data::RecordType]
+          required :record_type, enum: -> { Telnyx::Models::EmailInboxes::FilterReplaceResponse::Data::RecordType }
+
+          # @!method initialize(allowlist:, blocklist:, record_type:)
+          #   @param allowlist [Array<String>]
+          #   @param blocklist [Array<String>]
+          #   @param record_type [Symbol, Telnyx::Models::EmailInboxes::FilterReplaceResponse::Data::RecordType]
+
+          # @see Telnyx::Models::EmailInboxes::FilterReplaceResponse::Data#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_INBOX_FILTERS = :email_inbox_filters
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      class InboundEmailAddress < Telnyx::Internal::Type::BaseModel
+        # @!attribute email
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(email:, name: nil)
+        #   @param email [String]
+        #   @param name [String]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      class InboundThread < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!attribute labels
+        #   Mutable thread labels used for agent workflow state. Independent of the labels
+        #   on the thread's messages, and distinct from the send-time `tags` on outbound
+        #   messages.
+        #
+        #   @return [Array<String>]
+        required :labels, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute last_message_at
+        #
+        #   @return [Time]
+        required :last_message_at, Time
+
+        # @!attribute last_message_id
+        #
+        #   @return [String]
+        required :last_message_id, String
+
+        # @!attribute message_count
+        #   Total inbound and outbound messages in the thread.
+        #
+        #   @return [Integer]
+        required :message_count, Integer
+
+        # @!attribute preview
+        #
+        #   @return [String, nil]
+        required :preview, String, nil?: true
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailInboxes::InboundThread::RecordType]
+        required :record_type, enum: -> { Telnyx::EmailInboxes::InboundThread::RecordType }
+
+        # @!attribute subject
+        #
+        #   @return [String, nil]
+        required :subject, String, nil?: true
+
+        # @!attribute unread_count
+        #   Unread inbound messages; outbound messages never increment this count.
+        #
+        #   @return [Integer]
+        required :unread_count, Integer
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!method initialize(id:, created_at:, inbox_id:, labels:, last_message_at:, last_message_id:, message_count:, preview:, record_type:, subject:, unread_count:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailInboxes::InboundThread} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param inbox_id [String]
+        #
+        #   @param labels [Array<String>] Mutable thread labels used for agent workflow state. Independent of the labels o
+        #
+        #   @param last_message_at [Time]
+        #
+        #   @param last_message_id [String]
+        #
+        #   @param message_count [Integer] Total inbound and outbound messages in the thread.
+        #
+        #   @param preview [String, nil]
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailInboxes::InboundThread::RecordType]
+        #
+        #   @param subject [String, nil]
+        #
+        #   @param unread_count [Integer] Unread inbound messages; outbound messages never increment this count.
+        #
+        #   @param updated_at [Time]
+
+        # @see Telnyx::Models::EmailInboxes::InboundThread#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_THREAD = :email_thread
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      class InboundThreadDetail < Telnyx::Models::EmailInboxes::InboundThread
+        # @!attribute messages
+        #
+        #   @return [Array<Telnyx::Models::EmailInboxes::ThreadMessage>]
+        required :messages, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::ThreadMessage] }
+
+        # @!method initialize(messages:)
+        #   @param messages [Array<Telnyx::Models::EmailInboxes::ThreadMessage>]
+      end
+    end
+  end
+end

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

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

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

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