telnyx 5.158.0 → 5.159.0

data/rbi/telnyx/models/email_domain_verification.rbi

@@ -0,0 +1,195 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailDomainVerification < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailDomainVerification, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(Telnyx::EmailDomainVerification::Dkim::TaggedSymbol) }
+      attr_accessor :dkim
+
+      sig { returns(Telnyx::EmailDomainVerification::Dmarc::TaggedSymbol) }
+      attr_accessor :dmarc
+
+      sig { returns(Telnyx::EmailDomainVerification::Mx::TaggedSymbol) }
+      attr_accessor :mx
+
+      sig { returns(Telnyx::EmailDomainVerification::Ownership::TaggedSymbol) }
+      attr_accessor :ownership
+
+      sig { returns(Telnyx::EmailDomainVerification::Spf::TaggedSymbol) }
+      attr_accessor :spf
+
+      sig do
+        params(
+          dkim: Telnyx::EmailDomainVerification::Dkim::OrSymbol,
+          dmarc: Telnyx::EmailDomainVerification::Dmarc::OrSymbol,
+          mx: Telnyx::EmailDomainVerification::Mx::OrSymbol,
+          ownership: Telnyx::EmailDomainVerification::Ownership::OrSymbol,
+          spf: Telnyx::EmailDomainVerification::Spf::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(dkim:, dmarc:, mx:, ownership:, spf:)
+      end
+
+      sig do
+        override.returns(
+          {
+            dkim: Telnyx::EmailDomainVerification::Dkim::TaggedSymbol,
+            dmarc: Telnyx::EmailDomainVerification::Dmarc::TaggedSymbol,
+            mx: Telnyx::EmailDomainVerification::Mx::TaggedSymbol,
+            ownership: Telnyx::EmailDomainVerification::Ownership::TaggedSymbol,
+            spf: Telnyx::EmailDomainVerification::Spf::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Dkim
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailDomainVerification::Dkim) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(:pending, Telnyx::EmailDomainVerification::Dkim::TaggedSymbol)
+        VERIFIED =
+          T.let(:verified, Telnyx::EmailDomainVerification::Dkim::TaggedSymbol)
+        FAILED =
+          T.let(:failed, Telnyx::EmailDomainVerification::Dkim::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailDomainVerification::Dkim::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Dmarc
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailDomainVerification::Dmarc) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MISSING_OPTIONAL =
+          T.let(
+            :missing_optional,
+            Telnyx::EmailDomainVerification::Dmarc::TaggedSymbol
+          )
+        VERIFIED =
+          T.let(:verified, Telnyx::EmailDomainVerification::Dmarc::TaggedSymbol)
+        FAILED =
+          T.let(:failed, Telnyx::EmailDomainVerification::Dmarc::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailDomainVerification::Dmarc::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Mx
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailDomainVerification::Mx) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NOT_REQUIRED =
+          T.let(
+            :not_required,
+            Telnyx::EmailDomainVerification::Mx::TaggedSymbol
+          )
+        PENDING =
+          T.let(:pending, Telnyx::EmailDomainVerification::Mx::TaggedSymbol)
+        VERIFIED =
+          T.let(:verified, Telnyx::EmailDomainVerification::Mx::TaggedSymbol)
+        FAILED =
+          T.let(:failed, Telnyx::EmailDomainVerification::Mx::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailDomainVerification::Mx::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Ownership
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailDomainVerification::Ownership)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :pending,
+            Telnyx::EmailDomainVerification::Ownership::TaggedSymbol
+          )
+        VERIFIED =
+          T.let(
+            :verified,
+            Telnyx::EmailDomainVerification::Ownership::TaggedSymbol
+          )
+        NOT_REQUIRED =
+          T.let(
+            :not_required,
+            Telnyx::EmailDomainVerification::Ownership::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailDomainVerification::Ownership::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Spf
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailDomainVerification::Spf) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MISSING_OPTIONAL =
+          T.let(
+            :missing_optional,
+            Telnyx::EmailDomainVerification::Spf::TaggedSymbol
+          )
+        VERIFIED =
+          T.let(:verified, Telnyx::EmailDomainVerification::Spf::TaggedSymbol)
+        FAILED =
+          T.let(:failed, Telnyx::EmailDomainVerification::Spf::TaggedSymbol)
+        NOT_REQUIRED =
+          T.let(
+            :not_required,
+            Telnyx::EmailDomainVerification::Spf::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailDomainVerification::Spf::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domain_verify_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailDomainVerifyParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailDomainVerifyParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :domain_id
+
+      sig do
+        params(
+          domain_id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(domain_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { domain_id: String, request_options: Telnyx::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domains/email_webhook.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class EmailWebhook < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::EmailDomains::EmailWebhook, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :domain_id
+
+        # Allowlist of event types delivered to this webhook. At least one event is
+        # required — there is no default-to-all.
+        sig do
+          returns(
+            T::Array[Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol]
+          )
+        end
+        attr_accessor :events
+
+        sig do
+          returns(Telnyx::EmailDomains::EmailWebhook::RecordType::TaggedSymbol)
+        end
+        attr_accessor :record_type
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # HTTPS endpoint to deliver subscribed events to.
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            domain_id: String,
+            events: T::Array[Telnyx::EmailDomains::EmailWebhookEvent::OrSymbol],
+            record_type:
+              Telnyx::EmailDomains::EmailWebhook::RecordType::OrSymbol,
+            updated_at: Time,
+            url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          domain_id:,
+          # Allowlist of event types delivered to this webhook. At least one event is
+          # required — there is no default-to-all.
+          events:,
+          record_type:,
+          updated_at:,
+          # HTTPS endpoint to deliver subscribed events to.
+          url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              domain_id: String,
+              events:
+                T::Array[Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol],
+              record_type:
+                Telnyx::EmailDomains::EmailWebhook::RecordType::TaggedSymbol,
+              updated_at: Time,
+              url: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::EmailDomains::EmailWebhook::RecordType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EMAIL_WEBHOOK =
+            T.let(
+              :email_webhook,
+              Telnyx::EmailDomains::EmailWebhook::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::EmailDomains::EmailWebhook::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domains/email_webhook_event.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+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
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailDomains::EmailWebhookEvent)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL_SCHEDULED =
+          T.let(
+            :"email.scheduled",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_SANDBOX =
+          T.let(
+            :"email.sandbox",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_QUEUED =
+          T.let(
+            :"email.queued",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_SENDING =
+          T.let(
+            :"email.sending",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_SENT =
+          T.let(
+            :"email.sent",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_DELIVERED =
+          T.let(
+            :"email.delivered",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_DEFERRED =
+          T.let(
+            :"email.deferred",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_BOUNCED =
+          T.let(
+            :"email.bounced",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_FAILED =
+          T.let(
+            :"email.failed",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_COMPLAINED =
+          T.let(
+            :"email.complained",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_OPENED =
+          T.let(
+            :"email.opened",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_CLICKED =
+          T.let(
+            :"email.clicked",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_UNSUBSCRIBED =
+          T.let(
+            :"email.unsubscribed",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_RECEIVED =
+          T.let(
+            :"email.received",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_DOMAIN_CREATED =
+          T.let(
+            :"email_domain.created",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_DOMAIN_VERIFIED =
+          T.let(
+            :"email_domain.verified",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_DOMAIN_DEGRADED =
+          T.let(
+            :"email_domain.degraded",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_DOMAIN_SUSPENDED =
+          T.let(
+            :"email_domain.suspended",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+        EMAIL_DOMAIN_DELETED =
+          T.let(
+            :"email_domain.deleted",
+            Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailDomains::EmailWebhookEvent::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domains/email_webhook_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class EmailWebhookResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailDomains::EmailWebhookResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Telnyx::EmailDomains::EmailWebhook) }
+        attr_reader :data
+
+        sig { params(data: Telnyx::EmailDomains::EmailWebhook::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::EmailDomains::EmailWebhook::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data:)
+        end
+
+        sig { override.returns({ data: Telnyx::EmailDomains::EmailWebhook }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domains/offset_pagination_meta.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class OffsetPaginationMeta < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailDomains::OffsetPaginationMeta,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :page_number
+
+        sig { returns(Integer) }
+        attr_accessor :page_size
+
+        sig { returns(Integer) }
+        attr_accessor :total_pages
+
+        sig { returns(Integer) }
+        attr_accessor :total_results
+
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            total_pages: Integer,
+            total_results: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(page_number:, page_size:, total_pages:, total_results:)
+        end
+
+        sig do
+          override.returns(
+            {
+              page_number: Integer,
+              page_size: Integer,
+              total_pages: Integer,
+              total_results: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domains/webhook_create_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class WebhookCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailDomains::WebhookCreateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :domain_id
+
+        # At least one event type is required.
+        sig do
+          returns(T::Array[Telnyx::EmailDomains::EmailWebhookEvent::OrSymbol])
+        end
+        attr_accessor :events
+
+        # HTTPS endpoint to deliver subscribed events to.
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig do
+          params(
+            domain_id: String,
+            events: T::Array[Telnyx::EmailDomains::EmailWebhookEvent::OrSymbol],
+            url: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          domain_id:,
+          # At least one event type is required.
+          events:,
+          # HTTPS endpoint to deliver subscribed events to.
+          url:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              domain_id: String,
+              events:
+                T::Array[Telnyx::EmailDomains::EmailWebhookEvent::OrSymbol],
+              url: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domains/webhook_delete_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailDomains
+      class WebhookDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailDomains::WebhookDeleteParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :domain_id
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            domain_id: String,
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(domain_id:, id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              domain_id: String,
+              id: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end