telnyx 5.158.0 → 5.159.0

data/sig/telnyx/models/email_domain_response.rbs

@@ -0,0 +1,13 @@
+module Telnyx
+  module Models
+    type email_domain_response = { data: Telnyx::EmailDomain }
+
+    class EmailDomainResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::EmailDomain
+
+      def initialize: (data: Telnyx::EmailDomain) -> void
+
+      def to_hash: -> { data: Telnyx::EmailDomain }
+    end
+  end
+end

data/sig/telnyx/models/email_domain_retrieve_dns_records_params.rbs

@@ -0,0 +1,23 @@
+module Telnyx
+  module Models
+    type email_domain_retrieve_dns_records_params =
+      { domain_id: String } & Telnyx::Internal::Type::request_parameters
+
+    class EmailDomainRetrieveDNSRecordsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor domain_id: String
+
+      def initialize: (
+        domain_id: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain_id: String,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_domain_retrieve_dns_records_response.rbs

@@ -0,0 +1,14 @@
+module Telnyx
+  module Models
+    type email_domain_retrieve_dns_records_response =
+      { data: ::Array[Telnyx::DNSRecord] }
+
+    class EmailDomainRetrieveDNSRecordsResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: ::Array[Telnyx::DNSRecord]
+
+      def initialize: (data: ::Array[Telnyx::DNSRecord]) -> void
+
+      def to_hash: -> { data: ::Array[Telnyx::DNSRecord] }
+    end
+  end
+end

data/sig/telnyx/models/email_domain_retrieve_health_params.rbs

@@ -0,0 +1,20 @@
+module Telnyx
+  module Models
+    type email_domain_retrieve_health_params =
+      { id: String } & Telnyx::Internal::Type::request_parameters
+
+    class EmailDomainRetrieveHealthParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Telnyx::RequestOptions }
+    end
+  end
+end

data/sig/telnyx/models/email_domain_retrieve_health_response.rbs

@@ -0,0 +1,91 @@
+module Telnyx
+  module Models
+    type email_domain_retrieve_health_response =
+      { data: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data }
+
+    class EmailDomainRetrieveHealthResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data
+
+      def initialize: (
+        data: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data
+      }
+
+      type data =
+        {
+          id: String,
+          checked_at: Time,
+          record_type: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::record_type,
+          status: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::status,
+          usable_for_inbound: bool,
+          usable_for_sending: bool,
+          verification: Telnyx::EmailDomainVerification
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor checked_at: Time
+
+        attr_accessor record_type: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::record_type
+
+        attr_accessor status: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::status
+
+        attr_accessor usable_for_inbound: bool
+
+        attr_accessor usable_for_sending: bool
+
+        attr_accessor verification: Telnyx::EmailDomainVerification
+
+        def initialize: (
+          id: String,
+          checked_at: Time,
+          record_type: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::record_type,
+          status: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::status,
+          usable_for_inbound: bool,
+          usable_for_sending: bool,
+          verification: Telnyx::EmailDomainVerification
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          checked_at: Time,
+          record_type: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::record_type,
+          status: Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::status,
+          usable_for_inbound: bool,
+          usable_for_sending: bool,
+          verification: Telnyx::EmailDomainVerification
+        }
+
+        type record_type = :email_domain_health
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_DOMAIN_HEALTH: :email_domain_health
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::record_type]
+        end
+
+        type status =
+          :pending | :verifying | :verified | :failed | :degraded | :suspended
+
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          PENDING: :pending
+          VERIFYING: :verifying
+          VERIFIED: :verified
+          FAILED: :failed
+          DEGRADED: :degraded
+          SUSPENDED: :suspended
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailDomainRetrieveHealthResponse::Data::status]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domain_retrieve_params.rbs

@@ -0,0 +1,20 @@
+module Telnyx
+  module Models
+    type email_domain_retrieve_params =
+      { id: String } & Telnyx::Internal::Type::request_parameters
+
+    class EmailDomainRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Telnyx::RequestOptions }
+    end
+  end
+end

data/sig/telnyx/models/email_domain_status.rbs

@@ -0,0 +1,19 @@
+module Telnyx
+  module Models
+    type email_domain_status =
+      :pending | :verifying | :verified | :failed | :degraded | :suspended
+
+    module EmailDomainStatus
+      extend Telnyx::Internal::Type::Enum
+
+      PENDING: :pending
+      VERIFYING: :verifying
+      VERIFIED: :verified
+      FAILED: :failed
+      DEGRADED: :degraded
+      SUSPENDED: :suspended
+
+      def self?.values: -> ::Array[Telnyx::Models::email_domain_status]
+    end
+  end
+end

data/sig/telnyx/models/email_domain_type.rbs

@@ -0,0 +1,15 @@
+module Telnyx
+  module Models
+    type email_domain_type = :custom | :shared | :shared_inbound
+
+    module EmailDomainType
+      extend Telnyx::Internal::Type::Enum
+
+      CUSTOM: :custom
+      SHARED: :shared
+      SHARED_INBOUND: :shared_inbound
+
+      def self?.values: -> ::Array[Telnyx::Models::email_domain_type]
+    end
+  end
+end

data/sig/telnyx/models/email_domain_update_params.rbs

@@ -0,0 +1,47 @@
+module Telnyx
+  module Models
+    type email_domain_update_params =
+      {
+        id: String,
+        dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        inbound_enabled: bool,
+        tracking: Telnyx::DomainsTrackingSettings
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailDomainUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_accessor dmarc_policy: Telnyx::EmailDmarcPolicy?
+
+      attr_reader inbound_enabled: bool?
+
+      def inbound_enabled=: (bool) -> bool
+
+      attr_reader tracking: Telnyx::DomainsTrackingSettings?
+
+      def tracking=: (
+        Telnyx::DomainsTrackingSettings
+      ) -> Telnyx::DomainsTrackingSettings
+
+      def initialize: (
+        id: String,
+        ?dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        ?inbound_enabled: bool,
+        ?tracking: Telnyx::DomainsTrackingSettings,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        inbound_enabled: bool,
+        tracking: Telnyx::DomainsTrackingSettings,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_domain_verification.rbs

@@ -0,0 +1,102 @@
+module Telnyx
+  module Models
+    type email_domain_verification =
+      {
+        dkim: Telnyx::Models::EmailDomainVerification::dkim,
+        dmarc: Telnyx::Models::EmailDomainVerification::dmarc,
+        mx: Telnyx::Models::EmailDomainVerification::mx,
+        ownership: Telnyx::Models::EmailDomainVerification::ownership,
+        spf: Telnyx::Models::EmailDomainVerification::spf
+      }
+
+    class EmailDomainVerification < Telnyx::Internal::Type::BaseModel
+      attr_accessor dkim: Telnyx::Models::EmailDomainVerification::dkim
+
+      attr_accessor dmarc: Telnyx::Models::EmailDomainVerification::dmarc
+
+      attr_accessor mx: Telnyx::Models::EmailDomainVerification::mx
+
+      attr_accessor ownership: Telnyx::Models::EmailDomainVerification::ownership
+
+      attr_accessor spf: Telnyx::Models::EmailDomainVerification::spf
+
+      def initialize: (
+        dkim: Telnyx::Models::EmailDomainVerification::dkim,
+        dmarc: Telnyx::Models::EmailDomainVerification::dmarc,
+        mx: Telnyx::Models::EmailDomainVerification::mx,
+        ownership: Telnyx::Models::EmailDomainVerification::ownership,
+        spf: Telnyx::Models::EmailDomainVerification::spf
+      ) -> void
+
+      def to_hash: -> {
+        dkim: Telnyx::Models::EmailDomainVerification::dkim,
+        dmarc: Telnyx::Models::EmailDomainVerification::dmarc,
+        mx: Telnyx::Models::EmailDomainVerification::mx,
+        ownership: Telnyx::Models::EmailDomainVerification::ownership,
+        spf: Telnyx::Models::EmailDomainVerification::spf
+      }
+
+      type dkim = :pending | :verified | :failed
+
+      module Dkim
+        extend Telnyx::Internal::Type::Enum
+
+        PENDING: :pending
+        VERIFIED: :verified
+        FAILED: :failed
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDomainVerification::dkim]
+      end
+
+      type dmarc = :missing_optional | :verified | :failed
+
+      module Dmarc
+        extend Telnyx::Internal::Type::Enum
+
+        MISSING_OPTIONAL: :missing_optional
+        VERIFIED: :verified
+        FAILED: :failed
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDomainVerification::dmarc]
+      end
+
+      type mx = :not_required | :pending | :verified | :failed
+
+      module Mx
+        extend Telnyx::Internal::Type::Enum
+
+        NOT_REQUIRED: :not_required
+        PENDING: :pending
+        VERIFIED: :verified
+        FAILED: :failed
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDomainVerification::mx]
+      end
+
+      type ownership = :pending | :verified | :not_required
+
+      module Ownership
+        extend Telnyx::Internal::Type::Enum
+
+        PENDING: :pending
+        VERIFIED: :verified
+        NOT_REQUIRED: :not_required
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDomainVerification::ownership]
+      end
+
+      type spf = :missing_optional | :verified | :failed | :not_required
+
+      module Spf
+        extend Telnyx::Internal::Type::Enum
+
+        MISSING_OPTIONAL: :missing_optional
+        VERIFIED: :verified
+        FAILED: :failed
+        NOT_REQUIRED: :not_required
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDomainVerification::spf]
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domain_verify_params.rbs

@@ -0,0 +1,23 @@
+module Telnyx
+  module Models
+    type email_domain_verify_params =
+      { domain_id: String } & Telnyx::Internal::Type::request_parameters
+
+    class EmailDomainVerifyParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor domain_id: String
+
+      def initialize: (
+        domain_id: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain_id: String,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_domains/email_webhook.rbs

@@ -0,0 +1,62 @@
+module Telnyx
+  module Models
+    module EmailDomains
+      type email_webhook =
+        {
+          id: String,
+          created_at: Time,
+          domain_id: String,
+          events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          record_type: Telnyx::Models::EmailDomains::EmailWebhook::record_type,
+          updated_at: Time,
+          url: String
+        }
+
+      class EmailWebhook < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor domain_id: String
+
+        attr_accessor events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event]
+
+        attr_accessor record_type: Telnyx::Models::EmailDomains::EmailWebhook::record_type
+
+        attr_accessor updated_at: Time
+
+        attr_accessor url: String
+
+        def initialize: (
+          id: String,
+          created_at: Time,
+          domain_id: String,
+          events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          record_type: Telnyx::Models::EmailDomains::EmailWebhook::record_type,
+          updated_at: Time,
+          url: String
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Time,
+          domain_id: String,
+          events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          record_type: Telnyx::Models::EmailDomains::EmailWebhook::record_type,
+          updated_at: Time,
+          url: String
+        }
+
+        type record_type = :email_webhook
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_WEBHOOK: :email_webhook
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailDomains::EmailWebhook::record_type]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domains/email_webhook_event.rbs

@@ -0,0 +1,52 @@
+module Telnyx
+  module Models
+    module EmailDomains
+      type email_webhook_event =
+        :"email.scheduled"
+        | :"email.sandbox"
+        | :"email.queued"
+        | :"email.sending"
+        | :"email.sent"
+        | :"email.delivered"
+        | :"email.deferred"
+        | :"email.bounced"
+        | :"email.failed"
+        | :"email.complained"
+        | :"email.opened"
+        | :"email.clicked"
+        | :"email.unsubscribed"
+        | :"email.received"
+        | :"email_domain.created"
+        | :"email_domain.verified"
+        | :"email_domain.degraded"
+        | :"email_domain.suspended"
+        | :"email_domain.deleted"
+
+      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"
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDomains::email_webhook_event]
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domains/email_webhook_response.rbs

@@ -0,0 +1,15 @@
+module Telnyx
+  module Models
+    module EmailDomains
+      type email_webhook_response = { data: Telnyx::EmailDomains::EmailWebhook }
+
+      class EmailWebhookResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: Telnyx::EmailDomains::EmailWebhook
+
+        def initialize: (data: Telnyx::EmailDomains::EmailWebhook) -> void
+
+        def to_hash: -> { data: Telnyx::EmailDomains::EmailWebhook }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domains/offset_pagination_meta.rbs

@@ -0,0 +1,37 @@
+module Telnyx
+  module Models
+    module EmailDomains
+      type offset_pagination_meta =
+        {
+          page_number: Integer,
+          page_size: Integer,
+          total_pages: Integer,
+          total_results: Integer
+        }
+
+      class OffsetPaginationMeta < Telnyx::Internal::Type::BaseModel
+        attr_accessor page_number: Integer
+
+        attr_accessor page_size: Integer
+
+        attr_accessor total_pages: Integer
+
+        attr_accessor total_results: Integer
+
+        def initialize: (
+          page_number: Integer,
+          page_size: Integer,
+          total_pages: Integer,
+          total_results: Integer
+        ) -> void
+
+        def to_hash: -> {
+          page_number: Integer,
+          page_size: Integer,
+          total_pages: Integer,
+          total_results: Integer
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domains/webhook_create_params.rbs

@@ -0,0 +1,38 @@
+module Telnyx
+  module Models
+    module EmailDomains
+      type webhook_create_params =
+        {
+          domain_id: String,
+          events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          url: String
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class WebhookCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor domain_id: String
+
+        attr_accessor events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event]
+
+        attr_accessor url: String
+
+        def initialize: (
+          domain_id: String,
+          events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          url: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          domain_id: String,
+          events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          url: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domains/webhook_delete_params.rbs

@@ -0,0 +1,30 @@
+module Telnyx
+  module Models
+    module EmailDomains
+      type webhook_delete_params =
+        { domain_id: String, id: String }
+        & Telnyx::Internal::Type::request_parameters
+
+      class WebhookDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor domain_id: String
+
+        attr_accessor id: String
+
+        def initialize: (
+          domain_id: String,
+          id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          domain_id: String,
+          id: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end