telnyx 5.158.0 → 5.159.0

data/lib/telnyx/resources/email_messages/recipients.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class EmailMessages
+      # Send and manage email messages. Legacy `/v2/emails` routes are aliases for these
+      # endpoints.
+      class Recipients
+        # Returns the current delivery state of a single recipient, including status,
+        # billable flag, SMTP detail, and lifecycle timestamps. BCC recipient addresses
+        # are redacted (returned as null).
+        #
+        # @overload retrieve(recipient_id, email_id:, request_options: {})
+        #
+        # @param recipient_id [String] Recipient UUID.
+        #
+        # @param email_id [String] Email message UUID.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailMessages::RecipientRetrieveResponse]
+        #
+        # @see Telnyx::Models::EmailMessages::RecipientRetrieveParams
+        def retrieve(recipient_id, params)
+          parsed, options = Telnyx::EmailMessages::RecipientRetrieveParams.dump_request(params)
+          email_id =
+            parsed.delete(:email_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["email_messages/%1$s/recipients/%2$s", email_id, recipient_id],
+            model: Telnyx::Models::EmailMessages::RecipientRetrieveResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::EmailMessages::RecipientListParams} for more details.
+        #
+        # Lists per-recipient delivery states for a single message with cursor pagination.
+        # Each recipient has an independent status, billable flag, and lifecycle
+        # timestamps. BCC recipient addresses are redacted (returned as null) to protect
+        # BCC privacy. Default page size is 25, maximum is 100.
+        #
+        # @overload list(email_id, kind: nil, page_cursor: nil, page_size: nil, status: nil, request_options: {})
+        #
+        # @param email_id [String] Email message UUID.
+        #
+        # @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}, nil]
+        #
+        # @return [Telnyx::Models::EmailMessages::RecipientListResponse]
+        #
+        # @see Telnyx::Models::EmailMessages::RecipientListParams
+        def list(email_id, params = {})
+          parsed, options = Telnyx::EmailMessages::RecipientListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["email_messages/%1$s/recipients", email_id],
+            query: query,
+            model: Telnyx::Models::EmailMessages::RecipientListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/email_messages.rb

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Send and manage email messages. Legacy `/v2/emails` routes are aliases for these
+    # endpoints.
+    class EmailMessages
+      # Send and manage email messages. Legacy `/v2/emails` routes are aliases for these
+      # endpoints.
+      # @return [Telnyx::Resources::EmailMessages::Recipients]
+      attr_reader :recipients
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailMessageCreateParams} for more details.
+      #
+      # Queues, schedules, or sandbox-sends an email message. The legacy `/v2/emails`
+      # POST route is a backward-compatible alias for this operation.
+      #
+      # `subject` is required unless `template_id` is supplied. When using
+      # `template_id`, do not also provide `subject`, `html_body`, or `text_body`; the
+      # template is rendered with `template_variables`.
+      #
+      # Note: template lookup failures (not found, wrong account) return 400, not 404.
+      #
+      # @overload create(from:, to:, attachments: nil, bcc: nil, cc: nil, forward_of_message_id: nil, from_name: nil, group_id: nil, headers: nil, html_body: nil, ignore_suppression: nil, in_reply_to_message_id: nil, inline_css: nil, metadata: nil, reply_to: nil, reply_to_all: nil, sandbox_mode: nil, scheduled_at: nil, send_at: nil, subject: nil, tags: nil, template_id: nil, template_variables: nil, text_body: nil, tracking_settings: nil, idempotency_key: nil, request_options: {})
+      #
+      # @param from [String, Telnyx::Models::EmailInboxes::EmailAddress] Body param
+      #
+      # @param to [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
+      #
+      # @param attachments [Array<Telnyx::Models::AttachmentRequest>] Body param
+      #
+      # @param bcc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
+      #
+      # @param cc [Array<String, Telnyx::Models::EmailInboxes::EmailAddress>] Body param
+      #
+      # @param forward_of_message_id [String, nil] Body param: Telnyx message UUID of the message this send forwards. Forwarded
+      #
+      # @param from_name [String] Body param: Optional display name for string `from`; overrides `from.name` when
+      #
+      # @param group_id [String, nil] Body param: Optional unsubscribe-group UUID used for group-scoped suppression ch
+      #
+      # @param headers [Hash{Symbol=>String}] Body param: Custom email headers. Write-only; not returned in responses.
+      #
+      # @param html_body [String] Body param: HTML email body. Returned only by `GET /email_messages/{id}`; omitte
+      #
+      # @param ignore_suppression [Boolean] Body param: When true, allows delivery to recipients whose suppressions explicit
+      #
+      # @param in_reply_to_message_id [String, nil] Body param: Telnyx message UUID of the message this send replies to. When provid
+      #
+      # @param inline_css [Boolean] Body param
+      #
+      # @param metadata [Hash{Symbol=>Object}] Body param: Custom metadata. Write-only; not returned in responses.
+      #
+      # @param reply_to [String, Telnyx::Models::EmailInboxes::EmailAddress] Body param: Reply-to address. If provided as an object with a name, only the ema
+      #
+      # @param reply_to_all [Boolean, nil] Body param: Indicates a reply-all intent. In Phase 1 (wire-only) this does not
+      #
+      # @param sandbox_mode [Boolean] Body param
+      #
+      # @param scheduled_at [Time, nil] Body param: Future ISO 8601 time to schedule sending. Invalid or past timestamps
+      #
+      # @param send_at [Time] Body param: Deprecated alias for `scheduled_at`.
+      #
+      # @param subject [String] Body param: Required unless `template_id` is supplied. When using a template, th
+      #
+      # @param tags [Array<String>] Body param: Tags for categorization and reporting. Stored on the message and pro
+      #
+      # @param template_id [String] Body param
+      #
+      # @param template_variables [Hash{Symbol=>Object}] Body param: Variables for Liquid template rendering. Non-object values may cause
+      #
+      # @param text_body [String] Body param: Plain text email body. Returned only by `GET /email_messages/{id}`;
+      #
+      # @param tracking_settings [Telnyx::Models::TrackingSettings] Body param: Per-send open and click tracking overrides. Omitted properties inher
+      #
+      # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailInboxes::EmailMessageResponse]
+      #
+      # @see Telnyx::Models::EmailMessageCreateParams
+      def create(params)
+        parsed, options = Telnyx::EmailMessageCreateParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :post,
+          path: "email_messages",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Telnyx::EmailInboxes::EmailMessageResponse,
+          options: options
+        )
+      end
+
+      # The legacy `/v2/emails/{id}` GET route is a backward-compatible alias for this
+      # operation.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Email message UUID.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailMessageRetrieveResponse]
+      #
+      # @see Telnyx::Models::EmailMessageRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["email_messages/%1$s", id],
+          model: Telnyx::Models::EmailMessageRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailMessageListParams} for more details.
+      #
+      # Lists messages sorted newest first by `created_at desc, id desc`. No filters
+      # other than cursor pagination are implemented. The legacy `/v2/emails` GET route
+      # is a backward-compatible alias for this operation.
+      #
+      # @overload list(page_cursor: nil, page_size: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [Telnyx::Models::EmailMessageListResponse]
+      #
+      # @see Telnyx::Models::EmailMessageListParams
+      def list(params = {})
+        parsed, options = Telnyx::EmailMessageListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "email_messages",
+          query: query,
+          model: Telnyx::Models::EmailMessageListResponse,
+          options: options
+        )
+      end
+
+      # Permanently deletes an account-scoped email message, its events, its durable
+      # recipients, and unshared attachment objects. Returns 404 when the message does
+      # not exist in the authenticated account. The legacy `/v2/emails/{id}` DELETE
+      # route is a backward-compatible alias.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Email message UUID.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Telnyx::Models::EmailMessageDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["email_messages/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailMessageBatchParams} for more details.
+      #
+      # Creates up to 50 email messages in a single request.
+      #
+      # @overload batch(messages:, sandbox_mode: nil, idempotency_key: nil, request_options: {})
+      #
+      # @param messages [Array<Telnyx::Models::EmailMessageBatchParams::Message>] Body param
+      #
+      # @param sandbox_mode [Boolean] Body param: Applies sandbox mode to all messages in the batch. Overrides any per
+      #
+      # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailMessageBatchResponse]
+      #
+      # @see Telnyx::Models::EmailMessageBatchParams
+      def batch(params)
+        parsed, options = Telnyx::EmailMessageBatchParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :post,
+          path: "email_messages/batch",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Telnyx::Models::EmailMessageBatchResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailMessageDeleteAllParams} for more details.
+      #
+      # Permanently deletes every email in the authenticated account sent from or to the
+      # supplied address, including retained events whose parent message has expired.
+      # Events and durable recipients are deleted immediately with each message. The
+      # operation never searches or reports matches in another account. The legacy
+      # `/v2/emails` DELETE route is a backward-compatible alias.
+      #
+      # @overload delete_all(address:, request_options: {})
+      #
+      # @param address [String] Sender or recipient address to delete. Matching is trimmed and case-insensitive.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Telnyx::Models::EmailMessageDeleteAllParams
+      def delete_all(params)
+        parsed, options = Telnyx::EmailMessageDeleteAllParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :delete,
+          path: "email_messages",
+          query: query,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Cancels a scheduled email and returns it with status `cancelled`. The legacy
+      # `/v2/emails/{id}/schedule` DELETE route is an alias.
+      #
+      # @overload delete_schedule(email_id, request_options: {})
+      #
+      # @param email_id [String] Email message UUID.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailInboxes::EmailMessageResponse]
+      #
+      # @see Telnyx::Models::EmailMessageDeleteScheduleParams
+      def delete_schedule(email_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["email_messages/%1$s/schedule", email_id],
+          model: Telnyx::EmailInboxes::EmailMessageResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailMessageRetrieveEventsParams} for more details.
+      #
+      # Lists events for a single message sorted oldest first by
+      # `occurred_at asc, id asc`. The legacy `/v2/emails/{id}/events` GET route is a
+      # backward-compatible alias.
+      #
+      # @overload retrieve_events(email_id, page_cursor: nil, page_size: nil, request_options: {})
+      #
+      # @param email_id [String] Email message UUID.
+      #
+      # @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}, nil]
+      #
+      # @return [Telnyx::Models::EmailMessageRetrieveEventsResponse]
+      #
+      # @see Telnyx::Models::EmailMessageRetrieveEventsParams
+      def retrieve_events(email_id, params = {})
+        parsed, options = Telnyx::EmailMessageRetrieveEventsParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["email_messages/%1$s/events", email_id],
+          query: query,
+          model: Telnyx::Models::EmailMessageRetrieveEventsResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @recipients = Telnyx::Resources::EmailMessages::Recipients.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/email_templates.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Create, list, retrieve, update, delete, and render Liquid email templates.
+    class EmailTemplates
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailTemplateCreateParams} for more details.
+      #
+      # Creates a Liquid email template. Variables are auto-extracted when omitted.
+      #
+      # @overload create(name:, html_body: nil, subject: nil, text_body: nil, variables: nil, idempotency_key: nil, request_options: {})
+      #
+      # @param name [String] Body param: Letters, numbers, spaces, hyphens, and underscores only.
+      #
+      # @param html_body [String, nil] Body param: Liquid template HTML body.
+      #
+      # @param subject [String, nil] Body param: Liquid template subject.
+      #
+      # @param text_body [String, nil] Body param: Liquid template text body.
+      #
+      # @param variables [Array<String>] Body param: Template variables. Auto-extracted from subject/body fields when abs
+      #
+      # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailTemplateResponse]
+      #
+      # @see Telnyx::Models::EmailTemplateCreateParams
+      def create(params)
+        parsed, options = Telnyx::EmailTemplateCreateParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
+        @client.request(
+          method: :post,
+          path: "email_templates",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Telnyx::EmailTemplateResponse,
+          options: options
+        )
+      end
+
+      # Get an email template
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Email template UUID.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailTemplateResponse]
+      #
+      # @see Telnyx::Models::EmailTemplateRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["email_templates/%1$s", id],
+          model: Telnyx::EmailTemplateResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Updates one or more template fields.
+      #
+      # @overload update(id, html_body: nil, name: nil, subject: nil, text_body: nil, variables: nil, request_options: {})
+      #
+      # @param id [String] Email template UUID.
+      #
+      # @param html_body [String, nil] Liquid template HTML body.
+      #
+      # @param name [String]
+      #
+      # @param subject [String, nil] Liquid template subject.
+      #
+      # @param text_body [String, nil] Liquid template text body.
+      #
+      # @param variables [Array<String>]
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailTemplateResponse]
+      #
+      # @see Telnyx::Models::EmailTemplateUpdateParams
+      def update(id, params = {})
+        parsed, options = Telnyx::EmailTemplateUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["email_templates/%1$s", id],
+          body: parsed,
+          model: Telnyx::EmailTemplateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailTemplateListParams} for more details.
+      #
+      # Lists templates sorted newest first by `created_at desc, id desc`.
+      #
+      # @overload list(page_cursor: nil, page_size: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [Telnyx::Models::EmailTemplateListResponse]
+      #
+      # @see Telnyx::Models::EmailTemplateListParams
+      def list(params = {})
+        parsed, options = Telnyx::EmailTemplateListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "email_templates",
+          query: query,
+          model: Telnyx::Models::EmailTemplateListResponse,
+          options: options
+        )
+      end
+
+      # Delete an email template
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Email template UUID.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Telnyx::Models::EmailTemplateDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["email_templates/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailTemplateRenderParams} for more details.
+      #
+      # Renders a template using the provided Liquid variables. Missing
+      # `template_variables` defaults to `{}`.
+      #
+      # @overload render(id, template_variables: nil, request_options: {})
+      #
+      # @param id [String] Email template UUID.
+      #
+      # @param template_variables [Hash{Symbol=>Object}] Variables for Liquid template rendering. Non-object values are silently treated
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailTemplateRenderResponse]
+      #
+      # @see Telnyx::Models::EmailTemplateRenderParams
+      def render(id, params = {})
+        parsed, options = Telnyx::EmailTemplateRenderParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["email_templates/%1$s/render", id],
+          body: parsed,
+          model: Telnyx::Models::EmailTemplateRenderResponse,
+          options: options
+        )
+      end
+
+      # Replaces template fields. Behaves identically to PATCH; provided for
+      # compatibility with Phoenix resource routes.
+      #
+      # @overload replace(id, html_body: nil, name: nil, subject: nil, text_body: nil, variables: nil, request_options: {})
+      #
+      # @param id [String] Email template UUID.
+      #
+      # @param html_body [String, nil] Liquid template HTML body.
+      #
+      # @param name [String]
+      #
+      # @param subject [String, nil] Liquid template subject.
+      #
+      # @param text_body [String, nil] Liquid template text body.
+      #
+      # @param variables [Array<String>]
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailTemplateResponse]
+      #
+      # @see Telnyx::Models::EmailTemplateReplaceParams
+      def replace(id, params = {})
+        parsed, options = Telnyx::EmailTemplateReplaceParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["email_templates/%1$s", id],
+          body: parsed,
+          model: Telnyx::EmailTemplateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/telnyx/resources/email_threads.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Account-wide conversation threads across every inbox, for agents operating many
+    # inboxes at once.
+    class EmailThreads
+      # Returns a thread and a bounded page of its inbound and outbound messages,
+      # interleaved in chronological order. The `inbox_id` returned by the list endpoint
+      # is required because a thread ID can occur in multiple inboxes. Only messages
+      # matching that `(inbox_id, thread_id)` pair are returned. Threads outside the
+      # account return an opaque 404.
+      #
+      # @overload retrieve(thread_id, inbox_id:, page_after: nil, page_size: nil, request_options: {})
+      #
+      # @param thread_id [String] Email thread UUID.
+      #
+      # @param inbox_id [String] Inbox UUID that, together with `thread_id`, identifies the thread.
+      #
+      # @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}, nil]
+      #
+      # @return [Telnyx::Models::EmailThreadRetrieveResponse]
+      #
+      # @see Telnyx::Models::EmailThreadRetrieveParams
+      def retrieve(thread_id, params)
+        parsed, options = Telnyx::EmailThreadRetrieveParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["email_threads/%1$s", thread_id],
+          query: query.transform_keys(page_after: "page[after]", page_size: "page[size]"),
+          model: Telnyx::Models::EmailThreadRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailThreadListParams} for more details.
+      #
+      # Lists thread summaries for the whole account, newest first, using stable cursor
+      # pagination. An agent operating many inboxes gets every conversation in one call
+      # instead of one call per inbox. Each thread carries its own `inbox_id` so a reply
+      # can be routed back to the right inbox. Use `filter[inbox_id]` (repeatable) to
+      # narrow the result to specific inboxes. Because a thread ID can be delivered to
+      # multiple inboxes, each result is identified by its `(inbox_id, id)` pair.
+      #
+      # @overload list(filter_inbox_id: nil, filter_label: nil, page_after: nil, page_size: nil, request_options: {})
+      #
+      # @param filter_inbox_id [Array<String>] Restrict results to one or more inboxes. Repeat the parameter
+      #
+      # @param filter_label [String] Returns only threads carrying this label. Matching is exact and case-sensitive.
+      #
+      # @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}, nil]
+      #
+      # @return [Telnyx::Models::EmailInboxes::InboundThreadListResponse]
+      #
+      # @see Telnyx::Models::EmailThreadListParams
+      def list(params = {})
+        parsed, options = Telnyx::EmailThreadListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "email_threads",
+          query: query.transform_keys(
+            filter_inbox_id: "filter[inbox_id]",
+            filter_label: "filter[label]",
+            page_after: "page[after]",
+            page_size: "page[size]"
+          ),
+          model: Telnyx::EmailInboxes::InboundThreadListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end