telnyx 5.158.0 → 5.160.0

data/lib/telnyx/resources/email_blocks.rb

@@ -0,0 +1,250 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Recipient suppression records (`/v2/email_blocks`).
+    class EmailBlocks
+      # Async CSV import of competitor suppression lists.
+      # @return [Telnyx::Resources::EmailBlocks::Import]
+      attr_reader :import
+
+      # Creates a suppression with `reason: manual_block` and `source: manual`.
+      # Caller-supplied `reason` / `source` are **ignored**; `scope` is **derived**
+      # server-side from `domain_id` / `from` and is never trusted. Idempotent: if a
+      # matching row already exists (NULL-safe dedupe key: account_id, scope, to,
+      # reason, domain_id, from), returns the existing record with `200` (no new audit
+      # event).
+      #
+      # `bounce_category`, `dsn_code`, `meta`, and `group_id` are **not accepted** on
+      # the public surface. Use the unsubscribe-group suppression endpoint or the
+      # internal create surface for those.
+      #
+      # @overload create(to:, domain_id: nil, expires_at: nil, from: nil, request_options: {})
+      #
+      # @param to [String] Recipient address (normalized: trim + lower-case).
+      #
+      # @param domain_id [String, nil] `null` ⇒ account scope.
+      #
+      # @param expires_at [Time, nil]
+      #
+      # @param from [String, nil] Sender address (normalized). `null` ⇒ account/domain scope.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailBlockResponse]
+      #
+      # @see Telnyx::Models::EmailBlockCreateParams
+      def create(params)
+        parsed, options = Telnyx::EmailBlockCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "email_blocks",
+          body: parsed,
+          model: Telnyx::EmailBlockResponse,
+          options: options
+        )
+      end
+
+      # Returns the account-owned suppression identified by ID. Cross-account lookups
+      # and malformed IDs return `404` without exposing another account’s data.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailBlockResponse]
+      #
+      # @see Telnyx::Models::EmailBlockRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["email_blocks/%1$s", id],
+          model: Telnyx::EmailBlockResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailBlockListParams} for more details.
+      #
+      # Account-scoped list. Two mutually exclusive pagination modes:
+      #
+      # - **Offset**: `page[number]` (default 1) + `page[size]` (default 25, max 100).
+      #   `meta` contains `total_pages`.
+      # - **Cursor**: `page[after]` and/or `page[before]` (opaque `Base.url_encode64` of
+      #   `{"created_at","id"}`). Cannot combine with `page[number]`; `after`+`before`
+      #   together is an error. `meta` contains `next_cursor` / `previous_cursor`
+      #   (omitted when their flag is false).
+      #
+      # Sort defaults to `-created_at` (desc); only `created_at` is sortable. A `--`
+      # prefix is an error. `nil`/empty filter values are silently dropped.
+      #
+      # @overload list(filter_created_after: nil, filter_created_before: nil, filter_domain_id: nil, filter_reason: nil, page_after: nil, page_before: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #
+      # @param filter_created_after [Time] `created_at > value` (ISO 8601).
+      #
+      # @param filter_created_before [Time] `created_at < value` (ISO 8601).
+      #
+      # @param filter_domain_id [String] Exact-match filter on domain_id (UUID).
+      #
+      # @param filter_reason [Symbol, Telnyx::Models::EmailBlockListParams::FilterReason] Exact-match filter on reason.
+      #
+      # @param page_after [String] Opaque cursor (`Base.url_encode64` of `{"created_at","id"}`). Cursor mode; mutua
+      #
+      # @param page_before [String] Opaque cursor (see `page[after]`). Mutually exclusive with `page[after]` and `pa
+      #
+      # @param page_number [Integer] Offset page number (≥1, default 1).
+      #
+      # @param page_size [Integer] Page size (1–100, default 25).
+      #
+      # @param sort [Symbol, Telnyx::Models::EmailBlockListParams::Sort] Sort field. Leading `-` = desc; only `created_at` is sortable. Default `-created
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::EmailBlock>]
+      #
+      # @see Telnyx::Models::EmailBlockListParams
+      def list(params = {})
+        parsed, options = Telnyx::EmailBlockListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "email_blocks",
+          query: query.transform_keys(
+            filter_created_after: "filter[created_after]",
+            filter_created_before: "filter[created_before]",
+            filter_domain_id: "filter[domain_id]",
+            filter_reason: "filter[reason]",
+            page_after: "page[after]",
+            page_before: "page[before]",
+            page_number: "page[number]",
+            page_size: "page[size]"
+          ),
+          page: Telnyx::Internal::DefaultFlatPagination,
+          model: Telnyx::EmailBlock,
+          options: options
+        )
+      end
+
+      # Soft-deletes (status → `removed`; tombstone retained). A `removed` audit event
+      # is appended unless the block was already `removed` (idempotent — returns the
+      # existing row with `200` and no new event). Mutates `updated_at`.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailBlockResponse]
+      #
+      # @see Telnyx::Models::EmailBlockDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["email_blocks/%1$s", id],
+          model: Telnyx::EmailBlockResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Offset pagination only (`page[number]` default 1, `page[size]` default **50**,
+      # max 100). No `sort`, no `filter`, no cursor — ordering is fixed
+      # `desc occurred_at, desc id`. Verifies the block belongs to the account first
+      # (cross-account → 404).
+      #
+      # @overload retrieve_events(id, page_number: nil, page_size: nil, request_options: {})
+      #
+      # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+      #
+      # @param page_number [Integer] Offset page number (≥1, default 1).
+      #
+      # @param page_size [Integer] Page size (default 50, max 100).
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailBlockRetrieveEventsResponse]
+      #
+      # @see Telnyx::Models::EmailBlockRetrieveEventsParams
+      def retrieve_events(id, params = {})
+        parsed, options = Telnyx::EmailBlockRetrieveEventsParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["email_blocks/%1$s/events", id],
+          query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+          model: Telnyx::Models::EmailBlockRetrieveEventsResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailBlockRetrieveExportParams} for more details.
+      #
+      # Streams the account's suppressions as a chunked CSV (server-side cursor; never
+      # materialized). Content-type `text/csv`, header
+      # `Content-Disposition: attachment; filename="email_blocks_export.csv"`.
+      #
+      # Filters (`filter[reason]`, `filter[domain_id]`, `filter[created_after]`,
+      # `filter[created_before]`) are the only params that affect output. `sort` and
+      # `page[*]` are **parsed** (bad values still produce `400`) but **ignored** — rows
+      # stream `ORDER BY created_at ASC, id ASC` with no pagination.
+      #
+      # CSV columns:
+      # `id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id`.
+      # The CSV carries the `group_id` column so group-scoped suppressions' group link
+      # survives the export (empty for account-scope rows).
+      #
+      # @overload retrieve_export(filter_created_after: nil, filter_created_before: nil, filter_domain_id: nil, filter_reason: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #
+      # @param filter_created_after [Time] `created_at > value` (ISO 8601).
+      #
+      # @param filter_created_before [Time] `created_at < value` (ISO 8601).
+      #
+      # @param filter_domain_id [String] Exact-match filter on domain_id (UUID).
+      #
+      # @param filter_reason [Symbol, Telnyx::Models::EmailBlockRetrieveExportParams::FilterReason] Exact-match filter on reason.
+      #
+      # @param page_number [Integer] Offset page number (≥1, default 1).
+      #
+      # @param page_size [Integer] Page size (1–100, default 25).
+      #
+      # @param sort [Symbol, Telnyx::Models::EmailBlockRetrieveExportParams::Sort] Sort field. Leading `-` = desc; only `created_at` is sortable. Default `-created
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see Telnyx::Models::EmailBlockRetrieveExportParams
+      def retrieve_export(params = {})
+        parsed, options = Telnyx::EmailBlockRetrieveExportParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "email_blocks/export",
+          query: query.transform_keys(
+            filter_created_after: "filter[created_after]",
+            filter_created_before: "filter[created_before]",
+            filter_domain_id: "filter[domain_id]",
+            filter_reason: "filter[reason]",
+            page_number: "page[number]",
+            page_size: "page[size]"
+          ),
+          headers: {"accept" => "text/csv"},
+          model: String,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @import = Telnyx::Resources::EmailBlocks::Import.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/email_domains/webhooks.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class EmailDomains
+      # Per-domain webhook endpoints with event subscriptions
+      class Webhooks
+        # Creates a webhook endpoint subscribed to a specific allowlist of event types.
+        # Both `email.*` events (published by email-api) and `email_domain.*` events
+        # (published by this service) flow through the same webhooks.
+        #
+        # @overload create(domain_id, events:, url:, request_options: {})
+        #
+        # @param domain_id [String] Email domain UUID
+        #
+        # @param events [Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>] At least one event type is required.
+        #
+        # @param url [String] HTTPS endpoint to deliver subscribed events to.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailDomains::EmailWebhookResponse]
+        #
+        # @see Telnyx::Models::EmailDomains::WebhookCreateParams
+        def create(domain_id, params)
+          parsed, options = Telnyx::EmailDomains::WebhookCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["email_domains/%1$s/webhooks", domain_id],
+            body: parsed,
+            model: Telnyx::EmailDomains::EmailWebhookResponse,
+            options: options
+          )
+        end
+
+        # Returns the webhook subscription identified by ID within the specified email
+        # domain.
+        #
+        # @overload retrieve(id, domain_id:, request_options: {})
+        #
+        # @param id [String] Email webhook UUID
+        #
+        # @param domain_id [String] Email domain UUID
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailDomains::EmailWebhookResponse]
+        #
+        # @see Telnyx::Models::EmailDomains::WebhookRetrieveParams
+        def retrieve(id, params)
+          parsed, options = Telnyx::EmailDomains::WebhookRetrieveParams.dump_request(params)
+          domain_id =
+            parsed.delete(:domain_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["email_domains/%1$s/webhooks/%2$s", domain_id, id],
+            model: Telnyx::EmailDomains::EmailWebhookResponse,
+            options: options
+          )
+        end
+
+        # Update a webhook's URL and/or event subscription. A webhook is bound to its
+        # domain — `domain_id` is not mutable.
+        #
+        # @overload update(id, domain_id:, events: nil, url: nil, request_options: {})
+        #
+        # @param id [String] Path param: Email webhook UUID
+        #
+        # @param domain_id [String] Path param: Email domain UUID
+        #
+        # @param events [Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>] Body param
+        #
+        # @param url [String] Body param
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailDomains::EmailWebhookResponse]
+        #
+        # @see Telnyx::Models::EmailDomains::WebhookUpdateParams
+        def update(id, params)
+          parsed, options = Telnyx::EmailDomains::WebhookUpdateParams.dump_request(params)
+          domain_id =
+            parsed.delete(:domain_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :patch,
+            path: ["email_domains/%1$s/webhooks/%2$s", domain_id, id],
+            body: parsed,
+            model: Telnyx::EmailDomains::EmailWebhookResponse,
+            options: options
+          )
+        end
+
+        # Returns a paginated list of webhook subscriptions scoped to the email domain.
+        # Results can be sorted by creation time.
+        #
+        # @overload list(domain_id, page_number: nil, page_size: nil, sort: nil, request_options: {})
+        #
+        # @param domain_id [String] Email domain UUID
+        #
+        # @param page_number [Integer] Page number to return (offset pagination)
+        #
+        # @param page_size [Integer] Number of records per page
+        #
+        # @param sort [Symbol, Telnyx::Models::EmailDomains::WebhookListParams::Sort] Field to sort by. Prefix with `-` for descending order.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::EmailDomains::EmailWebhook>]
+        #
+        # @see Telnyx::Models::EmailDomains::WebhookListParams
+        def list(domain_id, params = {})
+          parsed, options = Telnyx::EmailDomains::WebhookListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["email_domains/%1$s/webhooks", domain_id],
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::EmailDomains::EmailWebhook,
+            options: options
+          )
+        end
+
+        # Deletes the webhook subscription identified by ID within the specified email
+        # domain and returns the deleted subscription.
+        #
+        # @overload delete(id, domain_id:, request_options: {})
+        #
+        # @param id [String] Email webhook UUID
+        #
+        # @param domain_id [String] Email domain UUID
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailDomains::EmailWebhookResponse]
+        #
+        # @see Telnyx::Models::EmailDomains::WebhookDeleteParams
+        def delete(id, params)
+          parsed, options = Telnyx::EmailDomains::WebhookDeleteParams.dump_request(params)
+          domain_id =
+            parsed.delete(:domain_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["email_domains/%1$s/webhooks/%2$s", domain_id, id],
+            model: Telnyx::EmailDomains::EmailWebhookResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/email_domains.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class EmailDomains
+      # Per-domain webhook endpoints with event subscriptions
+      # @return [Telnyx::Resources::EmailDomains::Webhooks]
+      attr_reader :webhooks
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailDomainCreateParams} for more details.
+      #
+      # Registers a domain for email sending and optional inbound delivery. The response
+      # includes the domain configuration and current verification state.
+      #
+      # @overload create(domain:, dmarc_policy: nil, inbound_enabled: nil, tracking: nil, request_options: {})
+      #
+      # @param domain [String]
+      #
+      # @param dmarc_policy [Telnyx::Models::EmailDmarcPolicy, nil] DMARC policy for a sending domain. Drives the recommended \_dmarc.<domain> TXT
+      # re
+      #
+      # @param inbound_enabled [Boolean] Enable inbound routing for this domain
+      #
+      # @param tracking [Telnyx::Models::DomainsTrackingSettings]
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailDomainResponse]
+      #
+      # @see Telnyx::Models::EmailDomainCreateParams
+      def create(params)
+        parsed, options = Telnyx::EmailDomainCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "email_domains",
+          body: parsed,
+          model: Telnyx::EmailDomainResponse,
+          options: options
+        )
+      end
+
+      # Shared (`type: shared`) Telnyx-managed domains are included/readable for every
+      # account, in addition to the account's own custom domains.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Email domain UUID
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailDomainResponse]
+      #
+      # @see Telnyx::Models::EmailDomainRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["email_domains/%1$s", id],
+          model: Telnyx::EmailDomainResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::EmailDomainUpdateParams} for more details.
+      #
+      # Updates mutable settings for an existing email domain, including inbound
+      # delivery and tracking configuration. Shared domains are read-only for non-owner
+      # accounts.
+      #
+      # @overload update(id, dmarc_policy: nil, inbound_enabled: nil, tracking: nil, request_options: {})
+      #
+      # @param id [String] Email domain UUID
+      #
+      # @param dmarc_policy [Telnyx::Models::EmailDmarcPolicy, nil] DMARC policy for a sending domain. Drives the recommended \_dmarc.<domain> TXT
+      # re
+      #
+      # @param inbound_enabled [Boolean] Enable or disable inbound routing for this domain
+      #
+      # @param tracking [Telnyx::Models::DomainsTrackingSettings]
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailDomainResponse]
+      #
+      # @see Telnyx::Models::EmailDomainUpdateParams
+      def update(id, params = {})
+        parsed, options = Telnyx::EmailDomainUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["email_domains/%1$s", id],
+          body: parsed,
+          model: Telnyx::EmailDomainResponse,
+          options: options
+        )
+      end
+
+      # Shared (`type: shared`) Telnyx-managed domains are included/readable for every
+      # account, in addition to the account's own custom domains.
+      #
+      # @overload list(filter_domain: nil, filter_profile_id: nil, filter_status: nil, filter_type: nil, filter_usable_for_inbound: nil, filter_usable_for_sending: nil, page_after: nil, page_before: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #
+      # @param filter_domain [String] Partial match on domain name (case-insensitive)
+      #
+      # @param filter_profile_id [String] Filter by profile UUID
+      #
+      # @param filter_status [Symbol, Telnyx::Models::EmailDomainStatus]
+      #
+      # @param filter_type [Symbol, Telnyx::Models::EmailDomainType]
+      #
+      # @param filter_usable_for_inbound [Boolean]
+      #
+      # @param filter_usable_for_sending [Boolean]
+      #
+      # @param page_after [String] Cursor for records after the provided value (cursor pagination)
+      #
+      # @param page_before [String] Cursor for records before the provided value (cursor pagination)
+      #
+      # @param page_number [Integer] Page number to return (offset pagination)
+      #
+      # @param page_size [Integer] Number of records per page
+      #
+      # @param sort [Symbol, Telnyx::Models::EmailDomainListParams::Sort] Field to sort by. Prefix with `-` for descending order.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::EmailDomain>]
+      #
+      # @see Telnyx::Models::EmailDomainListParams
+      def list(params = {})
+        parsed, options = Telnyx::EmailDomainListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "email_domains",
+          query: query.transform_keys(
+            filter_domain: "filter[domain]",
+            filter_profile_id: "filter[profile_id]",
+            filter_status: "filter[status]",
+            filter_type: "filter[type]",
+            filter_usable_for_inbound: "filter[usable_for_inbound]",
+            filter_usable_for_sending: "filter[usable_for_sending]",
+            page_after: "page[after]",
+            page_before: "page[before]",
+            page_number: "page[number]",
+            page_size: "page[size]"
+          ),
+          page: Telnyx::Internal::DefaultFlatPagination,
+          model: Telnyx::EmailDomain,
+          options: options
+        )
+      end
+
+      # Deletes an email domain configuration. Verified domains require `force=true`,
+      # and shared domains are read-only for non-owner accounts.
+      #
+      # @overload delete(id, force: nil, request_options: {})
+      #
+      # @param id [String] Email domain UUID
+      #
+      # @param force [Boolean] Required as true when deleting verified domains
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailDomainResponse]
+      #
+      # @see Telnyx::Models::EmailDomainDeleteParams
+      def delete(id, params = {})
+        parsed, options = Telnyx::EmailDomainDeleteParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :delete,
+          path: ["email_domains/%1$s", id],
+          query: query,
+          model: Telnyx::EmailDomainResponse,
+          options: options
+        )
+      end
+
+      # Returns the DNS records Telnyx generated for domain ownership and DKIM
+      # verification, plus MX records when inbound delivery is enabled.
+      #
+      # @overload retrieve_dns_records(domain_id, request_options: {})
+      #
+      # @param domain_id [String] Email domain UUID
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailDomainRetrieveDNSRecordsResponse]
+      #
+      # @see Telnyx::Models::EmailDomainRetrieveDNSRecordsParams
+      def retrieve_dns_records(domain_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["email_domains/%1$s/dns_records", domain_id],
+          model: Telnyx::Models::EmailDomainRetrieveDNSRecordsResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Returns a summary of domain health including verification status and usability.
+      #
+      # @overload retrieve_health(id, request_options: {})
+      #
+      # @param id [String] Email domain UUID
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailDomainRetrieveHealthResponse]
+      #
+      # @see Telnyx::Models::EmailDomainRetrieveHealthParams
+      def retrieve_health(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["email_domains/%1$s/health", id],
+          model: Telnyx::Models::EmailDomainRetrieveHealthResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Checks the published DNS records against the records required for the email
+      # domain and returns the latest verification results.
+      #
+      # @overload verify(domain_id, request_options: {})
+      #
+      # @param domain_id [String] Email domain UUID
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::EmailDomainResponse]
+      #
+      # @see Telnyx::Models::EmailDomainVerifyParams
+      def verify(domain_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["email_domains/%1$s/verify", domain_id],
+          model: Telnyx::EmailDomainResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @webhooks = Telnyx::Resources::EmailDomains::Webhooks.new(client: client)
+      end
+    end
+  end
+end