telnyx 5.158.0 → 5.159.0

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Messages#list
+      class MessageListParams < 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_from
+        #   Case-insensitive literal substring of the sender address.
+        #
+        #   @return [String, nil]
+        optional :filter_from, String
+
+        # @!attribute filter_label
+        #   Returns only messages carrying this label. Matching is exact and case-sensitive.
+        #   Reserved `telnyx:` labels can be filtered on even though they cannot be written
+        #   by customers.
+        #
+        #   @return [String, nil]
+        optional :filter_label, String
+
+        # @!attribute filter_read
+        #   Whether the message has a read timestamp.
+        #
+        #   @return [Boolean, nil]
+        optional :filter_read, Telnyx::Internal::Type::Boolean
+
+        # @!attribute filter_received_after
+        #   Inclusive ISO 8601 lower bound for the received timestamp.
+        #
+        #   @return [Time, nil]
+        optional :filter_received_after, Time
+
+        # @!attribute filter_received_before
+        #   Inclusive ISO 8601 upper bound for the received timestamp.
+        #
+        #   @return [Time, nil]
+        optional :filter_received_before, Time
+
+        # @!attribute filter_search
+        #   Full-text query over subject and body, up to 500 characters.
+        #
+        #   @return [String, nil]
+        optional :filter_search, String
+
+        # @!attribute filter_subject
+        #   Case-insensitive literal substring of the subject.
+        #
+        #   @return [String, nil]
+        optional :filter_subject, String
+
+        # @!attribute filter_unread
+        #   Whether the message has no read timestamp. Set to `true` to return only unread
+        #   messages.
+        #
+        #   @return [Boolean, nil]
+        optional :filter_unread, Telnyx::Internal::Type::Boolean
+
+        # @!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_from: nil, filter_label: nil, filter_read: nil, filter_received_after: nil, filter_received_before: nil, filter_search: nil, filter_subject: nil, filter_unread: nil, page_after: nil, page_size: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailInboxes::MessageListParams} for more details.
+        #
+        #   @param inbox_id [String]
+        #
+        #   @param filter_from [String] Case-insensitive literal substring of the sender address.
+        #
+        #   @param filter_label [String] Returns only messages carrying this label. Matching is exact and case-sensitive.
+        #
+        #   @param filter_read [Boolean] Whether the message has a read timestamp.
+        #
+        #   @param filter_received_after [Time] Inclusive ISO 8601 lower bound for the received timestamp.
+        #
+        #   @param filter_received_before [Time] Inclusive ISO 8601 upper bound for the received timestamp.
+        #
+        #   @param filter_search [String] Full-text query over subject and body, up to 500 characters.
+        #
+        #   @param filter_subject [String] Case-insensitive literal substring of the subject.
+        #
+        #   @param filter_unread [Boolean] Whether the message has no read timestamp. Set to `true` to return only unread m
+        #
+        #   @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/message_list_response.rb

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

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Messages#update
+      class MessageUpdateParams < 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 message_id
+        #
+        #   @return [String]
+        required :message_id, String
+
+        # @!attribute read_at
+        #   Set to `true` for server time, an ISO 8601 timestamp for an explicit read time,
+        #   or `null` to mark unread.
+        #
+        #   @return [Boolean, Time, Telnyx::Models::EmailInboxes::MessageUpdateParams::ReadAt, nil]
+        required :read_at, union: -> { Telnyx::EmailInboxes::MessageUpdateParams::ReadAt }
+
+        # @!method initialize(inbox_id:, message_id:, read_at:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailInboxes::MessageUpdateParams} for more details.
+        #
+        #   @param inbox_id [String]
+        #
+        #   @param message_id [String]
+        #
+        #   @param read_at [Boolean, Time, Telnyx::Models::EmailInboxes::MessageUpdateParams::ReadAt, nil] Set to `true` for server time, an ISO 8601 timestamp for an explicit read time,
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Set to `true` for server time, an ISO 8601 timestamp for an explicit read time,
+        # or `null` to mark unread.
+        module ReadAt
+          extend Telnyx::Internal::Type::Union
+
+          variant const: -> { Telnyx::Models::EmailInboxes::MessageUpdateParams::ReadAt::TRUE }
+
+          variant Time
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Time)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.nilable(T.any(Telnyx::EmailInboxes::MessageUpdateParams::ReadAt::TaggedBoolean, Time)) }
+          end
+
+          # @!group
+
+          TRUE = true
+
+          # @!endgroup
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Messages#update
+      class MessageUpdateResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::InboundMessage]
+        required :data, -> { Telnyx::InboundMessage }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::InboundMessage]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/messages/action_forward_params.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # @see Telnyx::Resources::EmailInboxes::Messages::Actions#forward
+        class ActionForwardParams < 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 message_id
+          #
+          #   @return [String]
+          required :message_id, String
+
+          # @!attribute to
+          #   One recipient or a non-empty recipient array. Each recipient may be an email
+          #   string or an object with `email` and optional `name`.
+          #
+          #   @return [String, Telnyx::Models::EmailInboxes::Messages::ActionForwardParams::To::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>]
+          required :to, union: -> { Telnyx::EmailInboxes::Messages::ActionForwardParams::To }
+
+          # @!attribute bcc
+          #   One recipient or a recipient array. Each recipient may be an email string or an
+          #   object with `email` and optional `name`.
+          #
+          #   @return [String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>, nil]
+          optional :bcc, union: -> { Telnyx::EmailInboxes::Messages::InboxActionRecipientInput }
+
+          # @!attribute cc
+          #   One recipient or a recipient array. Each recipient may be an email string or an
+          #   object with `email` and optional `name`.
+          #
+          #   @return [String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>, nil]
+          optional :cc, union: -> { Telnyx::EmailInboxes::Messages::InboxActionRecipientInput }
+
+          # @!attribute html
+          #   Optional HTML note prepended to the generated forwarded-message block. Blank
+          #   values are treated as omitted.
+          #
+          #   @return [String, nil]
+          optional :html, String
+
+          # @!attribute text
+          #   Optional plain-text note prepended to the generated forwarded-message block.
+          #   Blank values are treated as omitted.
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!method initialize(inbox_id:, message_id:, to:, bcc: nil, cc: nil, html: nil, text: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::EmailInboxes::Messages::ActionForwardParams} for more details.
+          #
+          #   @param inbox_id [String]
+          #
+          #   @param message_id [String]
+          #
+          #   @param to [String, Telnyx::Models::EmailInboxes::Messages::ActionForwardParams::To::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>] One recipient or a non-empty recipient array. Each recipient may be an email str
+          #
+          #   @param bcc [String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>] One recipient or a recipient array. Each recipient may be an email string or an
+          #
+          #   @param cc [String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>] One recipient or a recipient array. Each recipient may be an email string or an
+          #
+          #   @param html [String] Optional HTML note prepended to the generated forwarded-message block. Blank val
+          #
+          #   @param text [String] Optional plain-text note prepended to the generated forwarded-message block. Bla
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+          # One recipient or a non-empty recipient array. Each recipient may be an email
+          # string or an object with `email` and optional `name`.
+          module To
+            extend Telnyx::Internal::Type::Union
+
+            variant String
+
+            variant -> { Telnyx::EmailInboxes::Messages::ActionForwardParams::To::UnionMember1 }
+
+            variant -> { Telnyx::Models::EmailInboxes::Messages::ActionForwardParams::To::InboxActionEmailAddressInputArray }
+
+            class UnionMember1 < 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
+
+            # @!method self.variants
+            #   @return [Array(String, Telnyx::Models::EmailInboxes::Messages::ActionForwardParams::To::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>)]
+
+            # @type [Telnyx::Internal::Type::Converter]
+            InboxActionEmailAddressInputArray =
+              Telnyx::Internal::Type::ArrayOf[union: -> {
+                Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput
+              }]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/messages/action_reply_all_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # @see Telnyx::Resources::EmailInboxes::Messages::Actions#reply_all
+        class ActionReplyAllParams < Telnyx::Models::EmailInboxes::Messages::ReplyEmailInboxMessageRequest
+          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
+end

data/lib/telnyx/models/email_inboxes/messages/action_reply_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # @see Telnyx::Resources::EmailInboxes::Messages::Actions#reply
+        class ActionReplyParams < Telnyx::Models::EmailInboxes::Messages::ReplyEmailInboxMessageRequest
+          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
+end

data/lib/telnyx/models/email_inboxes/messages/inbox_action_email_address_input.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # Email address accepted by inbox message actions, as a string or an object with
+        # `email` and optional `name`.
+        module InboxActionEmailAddressInput
+          extend Telnyx::Internal::Type::Union
+
+          variant String
+
+          variant -> { Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1 }
+
+          class UnionMember1 < 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
+
+          # @!method self.variants
+          #   @return [Array(String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1)]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/messages/inbox_action_recipient_input.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # One recipient or a recipient array. Each recipient may be an email string or an
+        # object with `email` and optional `name`.
+        module InboxActionRecipientInput
+          extend Telnyx::Internal::Type::Union
+
+          variant String
+
+          variant -> { Telnyx::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1 }
+
+          variant -> { Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::InboxActionEmailAddressInputArray }
+
+          class UnionMember1 < 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
+
+          # @!method self.variants
+          #   @return [Array(String, Telnyx::Models::EmailInboxes::Messages::InboxActionRecipientInput::UnionMember1, Array<String, Telnyx::Models::EmailInboxes::Messages::InboxActionEmailAddressInput::UnionMember1>)]
+
+          # @type [Telnyx::Internal::Type::Converter]
+          InboxActionEmailAddressInputArray =
+            Telnyx::Internal::Type::ArrayOf[union: -> {
+              Telnyx::EmailInboxes::Messages::InboxActionEmailAddressInput
+            }]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # @see Telnyx::Resources::EmailInboxes::Messages::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 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
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # @see Telnyx::Resources::EmailInboxes::Messages::Labels#create
+        class LabelCreateResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::InboundMessage]
+          required :data, -> { Telnyx::InboundMessage }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::InboundMessage]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # @see Telnyx::Resources::EmailInboxes::Messages::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 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
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        # @see Telnyx::Resources::EmailInboxes::Messages::Labels#delete_all
+        class LabelDeleteAllResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::InboundMessage]
+          required :data, -> { Telnyx::InboundMessage }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::InboundMessage]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/messages/label_mutation_request.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        class LabelMutationRequest < Telnyx::Internal::Type::BaseModel
+          # @!attribute labels
+          #   One or more labels. Each label is a freeform, case-sensitive string of at most
+          #   255 characters; a message or thread may carry at most 50 labels. The `telnyx:`
+          #   prefix is a reserved system namespace and is rejected on customer writes.
+          #
+          #   @return [Array<String>]
+          required :labels, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(labels:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::EmailInboxes::Messages::LabelMutationRequest} for more details.
+          #
+          #   Labels to add or remove. Both operations are idempotent set operations, so a
+          #   retried request converges instead of failing.
+          #
+          #   @param labels [Array<String>] One or more labels. Each label is a freeform, case-sensitive string of at most 2
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/messages/reply_email_inbox_message_request.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Messages
+        class ReplyEmailInboxMessageRequest < Telnyx::Internal::Type::BaseModel
+          # @!attribute html
+          #   HTML reply body.
+          #
+          #   @return [String, nil]
+          optional :html, String
+
+          # @!attribute text
+          #   Plain-text reply body.
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!method initialize(html: nil, text: nil)
+          #   At least one of `text` or `html` must contain a non-whitespace body. Recipients
+          #   are derived from the source message; caller-supplied `to`, `cc`, or `bcc` values
+          #   are ignored.
+          #
+          #   @param html [String] HTML reply body.
+          #
+          #   @param text [String] Plain-text reply body.
+        end
+      end
+    end
+  end
+end