telnyx 5.158.0 → 5.159.0

data/lib/telnyx/models/email_domain_list_params.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailDomains#list
+    class EmailDomainListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute filter_domain
+      #   Partial match on domain name (case-insensitive)
+      #
+      #   @return [String, nil]
+      optional :filter_domain, String
+
+      # @!attribute filter_profile_id
+      #   Filter by profile UUID
+      #
+      #   @return [String, nil]
+      optional :filter_profile_id, String
+
+      # @!attribute filter_status
+      #
+      #   @return [Symbol, Telnyx::Models::EmailDomainStatus, nil]
+      optional :filter_status, enum: -> { Telnyx::EmailDomainStatus }
+
+      # @!attribute filter_type
+      #
+      #   @return [Symbol, Telnyx::Models::EmailDomainType, nil]
+      optional :filter_type, enum: -> { Telnyx::EmailDomainType }
+
+      # @!attribute filter_usable_for_inbound
+      #
+      #   @return [Boolean, nil]
+      optional :filter_usable_for_inbound, Telnyx::Internal::Type::Boolean
+
+      # @!attribute filter_usable_for_sending
+      #
+      #   @return [Boolean, nil]
+      optional :filter_usable_for_sending, Telnyx::Internal::Type::Boolean
+
+      # @!attribute page_after
+      #   Cursor for records after the provided value (cursor pagination)
+      #
+      #   @return [String, nil]
+      optional :page_after, String
+
+      # @!attribute page_before
+      #   Cursor for records before the provided value (cursor pagination)
+      #
+      #   @return [String, nil]
+      optional :page_before, String
+
+      # @!attribute page_number
+      #   Page number to return (offset pagination)
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of records per page
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort
+      #   Field to sort by. Prefix with `-` for descending order.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailDomainListParams::Sort, nil]
+      optional :sort, enum: -> { Telnyx::EmailDomainListParams::Sort }
+
+      # @!method initialize(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}]
+
+      # Field to sort by. Prefix with `-` for descending order.
+      module Sort
+        extend Telnyx::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+        CREATED_AT_DESC = :"-created_at"
+        DOMAIN = :domain
+        MINUS_DOMAIN = :"-domain"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domain_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailDomains#create
+    class EmailDomainResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::EmailDomain]
+      required :data, -> { Telnyx::EmailDomain }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::EmailDomain]
+    end
+  end
+end

data/lib/telnyx/models/email_domain_retrieve_dns_records_params.rb

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

data/lib/telnyx/models/email_domain_retrieve_dns_records_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailDomains#retrieve_dns_records
+    class EmailDomainRetrieveDNSRecordsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::DNSRecord>]
+      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DNSRecord] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<Telnyx::Models::DNSRecord>]
+    end
+  end
+end

data/lib/telnyx/models/email_domain_retrieve_health_params.rb

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

data/lib/telnyx/models/email_domain_retrieve_health_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailDomains#retrieve_health
+    class EmailDomainRetrieveHealthResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::EmailDomainRetrieveHealthResponse::Data]
+      required :data, -> { Telnyx::Models::EmailDomainRetrieveHealthResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::EmailDomainRetrieveHealthResponse::Data]
+
+      # @see Telnyx::Models::EmailDomainRetrieveHealthResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the email domain
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute checked_at
+        #   Timestamp of the last health check
+        #
+        #   @return [Time]
+        required :checked_at, Time
+
+        # @!attribute record_type
+        #   Record type discriminator
+        #
+        #   @return [Symbol, Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::RecordType]
+        required :record_type, enum: -> { Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::RecordType }
+
+        # @!attribute status
+        #   Current domain status
+        #
+        #   @return [Symbol, Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::Status]
+        required :status, enum: -> { Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::Status }
+
+        # @!attribute usable_for_inbound
+        #   Whether the domain is usable for receiving inbound email
+        #
+        #   @return [Boolean]
+        required :usable_for_inbound, Telnyx::Internal::Type::Boolean
+
+        # @!attribute usable_for_sending
+        #   Whether the domain is usable for sending email
+        #
+        #   @return [Boolean]
+        required :usable_for_sending, Telnyx::Internal::Type::Boolean
+
+        # @!attribute verification
+        #
+        #   @return [Telnyx::Models::EmailDomainVerification]
+        required :verification, -> { Telnyx::EmailDomainVerification }
+
+        # @!method initialize(id:, checked_at:, record_type:, status:, usable_for_inbound:, usable_for_sending:, verification:)
+        #   @param id [String] Unique identifier for the email domain
+        #
+        #   @param checked_at [Time] Timestamp of the last health check
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::RecordType] Record type discriminator
+        #
+        #   @param status [Symbol, Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::Status] Current domain status
+        #
+        #   @param usable_for_inbound [Boolean] Whether the domain is usable for receiving inbound email
+        #
+        #   @param usable_for_sending [Boolean] Whether the domain is usable for sending email
+        #
+        #   @param verification [Telnyx::Models::EmailDomainVerification]
+
+        # Record type discriminator
+        #
+        # @see Telnyx::Models::EmailDomainRetrieveHealthResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_DOMAIN_HEALTH = :email_domain_health
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Current domain status
+        #
+        # @see Telnyx::Models::EmailDomainRetrieveHealthResponse::Data#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          PENDING = :pending
+          VERIFYING = :verifying
+          VERIFIED = :verified
+          FAILED = :failed
+          DEGRADED = :degraded
+          SUSPENDED = :suspended
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domain_retrieve_params.rb

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

data/lib/telnyx/models/email_domain_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomainStatus
+      extend Telnyx::Internal::Type::Enum
+
+      PENDING = :pending
+      VERIFYING = :verifying
+      VERIFIED = :verified
+      FAILED = :failed
+      DEGRADED = :degraded
+      SUSPENDED = :suspended
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/telnyx/models/email_domain_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomainType
+      extend Telnyx::Internal::Type::Enum
+
+      CUSTOM = :custom
+      SHARED = :shared
+      SHARED_INBOUND = :shared_inbound
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/telnyx/models/email_domain_update_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailDomains#update
+    class EmailDomainUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute dmarc_policy
+      #   DMARC policy for a sending domain. Drives the recommended \_dmarc.<domain> TXT
+      #   record. DMARC is advisory and never blocks sending. When omitted or null, the
+      #   domain uses the advisory default (v=DMARC1; p=none;
+      #   rua=mailto:dmarc@telnyx.com).
+      #
+      #   @return [Telnyx::Models::EmailDmarcPolicy, nil]
+      optional :dmarc_policy, -> { Telnyx::EmailDmarcPolicy }, nil?: true
+
+      # @!attribute inbound_enabled
+      #   Enable or disable inbound routing for this domain
+      #
+      #   @return [Boolean, nil]
+      optional :inbound_enabled, Telnyx::Internal::Type::Boolean
+
+      # @!attribute tracking
+      #
+      #   @return [Telnyx::Models::DomainsTrackingSettings, nil]
+      optional :tracking, -> { Telnyx::DomainsTrackingSettings }
+
+      # @!method initialize(id:, dmarc_policy: nil, inbound_enabled: nil, tracking: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailDomainUpdateParams} for more details.
+      #
+      #   @param id [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 or disable inbound routing for this domain
+      #
+      #   @param tracking [Telnyx::Models::DomainsTrackingSettings]
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_domain_verification.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class EmailDomainVerification < Telnyx::Internal::Type::BaseModel
+      # @!attribute dkim
+      #
+      #   @return [Symbol, Telnyx::Models::EmailDomainVerification::Dkim]
+      required :dkim, enum: -> { Telnyx::EmailDomainVerification::Dkim }
+
+      # @!attribute dmarc
+      #
+      #   @return [Symbol, Telnyx::Models::EmailDomainVerification::Dmarc]
+      required :dmarc, enum: -> { Telnyx::EmailDomainVerification::Dmarc }
+
+      # @!attribute mx
+      #
+      #   @return [Symbol, Telnyx::Models::EmailDomainVerification::Mx]
+      required :mx, enum: -> { Telnyx::EmailDomainVerification::Mx }
+
+      # @!attribute ownership
+      #
+      #   @return [Symbol, Telnyx::Models::EmailDomainVerification::Ownership]
+      required :ownership, enum: -> { Telnyx::EmailDomainVerification::Ownership }
+
+      # @!attribute spf
+      #
+      #   @return [Symbol, Telnyx::Models::EmailDomainVerification::Spf]
+      required :spf, enum: -> { Telnyx::EmailDomainVerification::Spf }
+
+      # @!method initialize(dkim:, dmarc:, mx:, ownership:, spf:)
+      #   @param dkim [Symbol, Telnyx::Models::EmailDomainVerification::Dkim]
+      #   @param dmarc [Symbol, Telnyx::Models::EmailDomainVerification::Dmarc]
+      #   @param mx [Symbol, Telnyx::Models::EmailDomainVerification::Mx]
+      #   @param ownership [Symbol, Telnyx::Models::EmailDomainVerification::Ownership]
+      #   @param spf [Symbol, Telnyx::Models::EmailDomainVerification::Spf]
+
+      # @see Telnyx::Models::EmailDomainVerification#dkim
+      module Dkim
+        extend Telnyx::Internal::Type::Enum
+
+        PENDING = :pending
+        VERIFIED = :verified
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::EmailDomainVerification#dmarc
+      module Dmarc
+        extend Telnyx::Internal::Type::Enum
+
+        MISSING_OPTIONAL = :missing_optional
+        VERIFIED = :verified
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::EmailDomainVerification#mx
+      module Mx
+        extend Telnyx::Internal::Type::Enum
+
+        NOT_REQUIRED = :not_required
+        PENDING = :pending
+        VERIFIED = :verified
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::EmailDomainVerification#ownership
+      module Ownership
+        extend Telnyx::Internal::Type::Enum
+
+        PENDING = :pending
+        VERIFIED = :verified
+        NOT_REQUIRED = :not_required
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::EmailDomainVerification#spf
+      module Spf
+        extend Telnyx::Internal::Type::Enum
+
+        MISSING_OPTIONAL = :missing_optional
+        VERIFIED = :verified
+        FAILED = :failed
+        NOT_REQUIRED = :not_required
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domain_verify_params.rb

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

data/lib/telnyx/models/email_domains/email_webhook.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      # @see Telnyx::Resources::EmailDomains::Webhooks#list
+      class EmailWebhook < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute domain_id
+        #
+        #   @return [String]
+        required :domain_id, String
+
+        # @!attribute events
+        #   Allowlist of event types delivered to this webhook. At least one event is
+        #   required — there is no default-to-all.
+        #
+        #   @return [Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>]
+        required :events, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::EmailDomains::EmailWebhookEvent] }
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailDomains::EmailWebhook::RecordType]
+        required :record_type, enum: -> { Telnyx::EmailDomains::EmailWebhook::RecordType }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute url
+        #   HTTPS endpoint to deliver subscribed events to.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(id:, created_at:, domain_id:, events:, record_type:, updated_at:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailDomains::EmailWebhook} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param domain_id [String]
+        #
+        #   @param events [Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>] Allowlist of event types delivered to this webhook. At least one event is requir
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailDomains::EmailWebhook::RecordType]
+        #
+        #   @param updated_at [Time]
+        #
+        #   @param url [String] HTTPS endpoint to deliver subscribed events to.
+
+        # @see Telnyx::Models::EmailDomains::EmailWebhook#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_WEBHOOK = :email_webhook
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domains/email_webhook_event.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      # Event types a webhook may subscribe to. The union of email._ events (published
+      # by email-api) and email_domain._ lifecycle events (published by this service).
+      # An event not listed here can never be subscribed to and is silently dropped.
+      module EmailWebhookEvent
+        extend Telnyx::Internal::Type::Enum
+
+        EMAIL_SCHEDULED = :"email.scheduled"
+        EMAIL_SANDBOX = :"email.sandbox"
+        EMAIL_QUEUED = :"email.queued"
+        EMAIL_SENDING = :"email.sending"
+        EMAIL_SENT = :"email.sent"
+        EMAIL_DELIVERED = :"email.delivered"
+        EMAIL_DEFERRED = :"email.deferred"
+        EMAIL_BOUNCED = :"email.bounced"
+        EMAIL_FAILED = :"email.failed"
+        EMAIL_COMPLAINED = :"email.complained"
+        EMAIL_OPENED = :"email.opened"
+        EMAIL_CLICKED = :"email.clicked"
+        EMAIL_UNSUBSCRIBED = :"email.unsubscribed"
+        EMAIL_RECEIVED = :"email.received"
+        EMAIL_DOMAIN_CREATED = :"email_domain.created"
+        EMAIL_DOMAIN_VERIFIED = :"email_domain.verified"
+        EMAIL_DOMAIN_DEGRADED = :"email_domain.degraded"
+        EMAIL_DOMAIN_SUSPENDED = :"email_domain.suspended"
+        EMAIL_DOMAIN_DELETED = :"email_domain.deleted"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_domains/email_webhook_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailDomains
+      # @see Telnyx::Resources::EmailDomains::Webhooks#create
+      class EmailWebhookResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::EmailDomains::EmailWebhook]
+        required :data, -> { Telnyx::EmailDomains::EmailWebhook }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::EmailDomains::EmailWebhook]
+      end
+    end
+  end
+end