telnyx 5.158.0 → 5.159.0

data/rbi/telnyx/models/dir/email_verification_status_wrapped.rbi

@@ -72,6 +72,16 @@ module Telnyx
           end
           attr_accessor :record_type
 
+          # When the outstanding code stops being accepted. Null when no verification is in
+          # progress.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :expires_at
+
+          # How many more codes may be requested for this DIR today. Null when the daily cap
+          # does not apply.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :sends_remaining_today
+
           # Verification state for a DIR's authorizer email.
           sig do
             params(
@@ -79,7 +89,9 @@ module Telnyx
               record_type:
                 Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType::OrSymbol,
               status:
-                Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::OrSymbol
+                Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::OrSymbol,
+              expires_at: T.nilable(Time),
+              sends_remaining_today: T.nilable(Integer)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -89,7 +101,13 @@ module Telnyx
             record_type:,
             # `sent` after a code is emailed; `verified` after a successful confirm;
             # `unverified` when no verification is in progress.
-            status:
+            status:,
+            # When the outstanding code stops being accepted. Null when no verification is in
+            # progress.
+            expires_at: nil,
+            # How many more codes may be requested for this DIR today. Null when the daily cap
+            # does not apply.
+            sends_remaining_today: nil
           )
           end
 
@@ -100,7 +118,9 @@ module Telnyx
                 record_type:
                   Telnyx::Dir::EmailVerificationStatusWrapped::Data::RecordType::TaggedSymbol,
                 status:
-                  Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::TaggedSymbol
+                  Telnyx::Dir::EmailVerificationStatusWrapped::Data::Status::TaggedSymbol,
+                expires_at: T.nilable(Time),
+                sends_remaining_today: T.nilable(Integer)
               }
             )
           end

data/rbi/telnyx/models/dir/reference.rbi

@@ -21,8 +21,10 @@ module Telnyx
         sig { returns(Telnyx::Dir::Reference::RefType::TaggedSymbol) }
         attr_accessor :ref_type
 
-        # Position within the reference type. Business references occupy slots 0 and 1;
-        # the financial reference occupies slot 0.
+        # Position within the reference type, counting from 1. Business references occupy
+        # slots 1 and 2, in the order they were sent in the `business_references` array;
+        # the financial reference occupies slot 1. Use this value together with `ref_type`
+        # to address the reference when updating it.
         sig { returns(Integer) }
         attr_accessor :slot
 
@@ -76,8 +78,10 @@ module Telnyx
           record_type:,
           # Whether this is a business reference or the financial reference.
           ref_type:,
-          # Position within the reference type. Business references occupy slots 0 and 1;
-          # the financial reference occupies slot 0.
+          # Position within the reference type, counting from 1. Business references occupy
+          # slots 1 and 2, in the order they were sent in the `business_references` array;
+          # the financial reference occupies slot 1. Use this value together with `ref_type`
+          # to address the reference when updating it.
           slot:,
           # IANA timezone id for the reference. Calls are only placed within the reference's
           # local 8am-9pm window.

data/rbi/telnyx/models/dir/reference_create_params.rbi

@@ -15,7 +15,13 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :dir_id
 
-        # Exactly two business references.
+        # Exactly two business references. Array order determines each one's slot: the
+        # first entry becomes slot 1 and the second becomes slot 2. Those slots are what
+        # you pass when updating a single reference later. Each should be a senior contact
+        # who can speak to your company's reputation and operations: a C-suite executive
+        # (CEO, CFO, CTO, COO), an owner or founder as reflected in your corporate
+        # records, or a senior manager, director, or executive at an organization you work
+        # with, such as a vendor, partner, or client.
         sig { returns(T::Array[Telnyx::Dir::ReferenceInput]) }
         attr_accessor :business_references
 
@@ -39,7 +45,13 @@ module Telnyx
         end
         def self.new(
           dir_id:,
-          # Exactly two business references.
+          # Exactly two business references. Array order determines each one's slot: the
+          # first entry becomes slot 1 and the second becomes slot 2. Those slots are what
+          # you pass when updating a single reference later. Each should be a senior contact
+          # who can speak to your company's reputation and operations: a C-suite executive
+          # (CEO, CFO, CTO, COO), an owner or founder as reflected in your corporate
+          # records, or a senior manager, director, or executive at an organization you work
+          # with, such as a vendor, partner, or client.
           business_references:,
           # One reference supplied at submit. The reference type is implied by the field
           # that carries it (business_references vs financial_reference).

data/rbi/telnyx/models/dns_record.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class DNSRecord < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::DNSRecord, Telnyx::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :host
+
+      sig { returns(Telnyx::DNSRecord::Purpose::TaggedSymbol) }
+      attr_accessor :purpose
+
+      sig { returns(Telnyx::DNSRecord::RecordType::TaggedSymbol) }
+      attr_accessor :record_type
+
+      sig { returns(T::Boolean) }
+      attr_accessor :required
+
+      sig { returns(Telnyx::DNSRecord::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(String) }
+      attr_accessor :value
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :actual_value
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :priority
+
+      sig do
+        params(
+          id: String,
+          host: String,
+          purpose: Telnyx::DNSRecord::Purpose::OrSymbol,
+          record_type: Telnyx::DNSRecord::RecordType::OrSymbol,
+          required: T::Boolean,
+          status: Telnyx::DNSRecord::Status::OrSymbol,
+          value: String,
+          actual_value: T.nilable(String),
+          priority: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        host:,
+        purpose:,
+        record_type:,
+        required:,
+        status:,
+        value:,
+        actual_value: nil,
+        priority: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            host: String,
+            purpose: Telnyx::DNSRecord::Purpose::TaggedSymbol,
+            record_type: Telnyx::DNSRecord::RecordType::TaggedSymbol,
+            required: T::Boolean,
+            status: Telnyx::DNSRecord::Status::TaggedSymbol,
+            value: String,
+            actual_value: T.nilable(String),
+            priority: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Purpose
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::DNSRecord::Purpose) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OWNERSHIP = T.let(:ownership, Telnyx::DNSRecord::Purpose::TaggedSymbol)
+        SPF = T.let(:spf, Telnyx::DNSRecord::Purpose::TaggedSymbol)
+        DKIM = T.let(:dkim, Telnyx::DNSRecord::Purpose::TaggedSymbol)
+        DMARC = T.let(:dmarc, Telnyx::DNSRecord::Purpose::TaggedSymbol)
+        MX = T.let(:mx, Telnyx::DNSRecord::Purpose::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Telnyx::DNSRecord::Purpose::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::DNSRecord::RecordType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TXT = T.let(:TXT, Telnyx::DNSRecord::RecordType::TaggedSymbol)
+        MX = T.let(:MX, Telnyx::DNSRecord::RecordType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::DNSRecord::RecordType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Telnyx::DNSRecord::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING = T.let(:pending, Telnyx::DNSRecord::Status::TaggedSymbol)
+        VERIFIED = T.let(:verified, Telnyx::DNSRecord::Status::TaggedSymbol)
+        FAILED = T.let(:failed, Telnyx::DNSRecord::Status::TaggedSymbol)
+        NOT_REQUIRED =
+          T.let(:not_required, Telnyx::DNSRecord::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Telnyx::DNSRecord::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/domains_tracking_settings.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class DomainsTrackingSettings < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::DomainsTrackingSettings, Telnyx::Internal::AnyHash)
+        end
+
+      # Rewrite HTML links through a tracking redirect to record click events.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :click_tracking
+
+      sig { params(click_tracking: T::Boolean).void }
+      attr_writer :click_tracking
+
+      # Inject a tracking pixel into HTML messages to record open events.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :open_tracking
+
+      sig { params(open_tracking: T::Boolean).void }
+      attr_writer :open_tracking
+
+      # Add RFC 8058 List-Unsubscribe headers with a signed one-click unsubscribe URL.
+      # Enabled by default; Gmail/Yahoo bulk-sender rules require one-click unsubscribe
+      # support.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :unsubscribe_tracking
+
+      sig { params(unsubscribe_tracking: T::Boolean).void }
+      attr_writer :unsubscribe_tracking
+
+      sig do
+        params(
+          click_tracking: T::Boolean,
+          open_tracking: T::Boolean,
+          unsubscribe_tracking: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Rewrite HTML links through a tracking redirect to record click events.
+        click_tracking: nil,
+        # Inject a tracking pixel into HTML messages to record open events.
+        open_tracking: nil,
+        # Add RFC 8058 List-Unsubscribe headers with a signed one-click unsubscribe URL.
+        # Enabled by default; Gmail/Yahoo bulk-sender rules require one-click unsubscribe
+        # support.
+        unsubscribe_tracking: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            click_tracking: T::Boolean,
+            open_tracking: T::Boolean,
+            unsubscribe_tracking: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_address_input.rbi

@@ -0,0 +1,16 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailAddressInput
+      extend Telnyx::Internal::Type::Union
+
+      Variants =
+        T.type_alias { T.any(String, Telnyx::EmailInboxes::EmailAddress) }
+
+      sig { override.returns(T::Array[Telnyx::EmailAddressInput::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_block.rbi

@@ -0,0 +1,218 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailBlock < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::EmailBlock, Telnyx::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Telnyx::EmailBlock::Reason::TaggedSymbol) }
+      attr_accessor :reason
+
+      # View-only discriminator.
+      sig { returns(Telnyx::EmailBlock::RecordType::TaggedSymbol) }
+      attr_accessor :record_type
+
+      # Derived server-side from `domain_id`/`from`; never trusted from the caller.
+      sig { returns(Telnyx::EmailBlock::Scope::TaggedSymbol) }
+      attr_accessor :scope
+
+      sig { returns(Telnyx::EmailBlock::Source::TaggedSymbol) }
+      attr_accessor :source
+
+      sig { returns(Telnyx::EmailBlock::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # Normalized recipient. (schema: to_address)
+      sig { returns(String) }
+      attr_accessor :to
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # `null` ⇒ account scope. Stored on the row; exposed here.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :domain_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      # `null` ⇒ not address-scope. (schema: from_address)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :from
+
+      # `null` ⇒ global; set ⇒ group-scoped opt-out.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :group_id
+
+      # Suppression record. Schema fields hidden by the view: `account_id`,
+      # `bounce_category`, `dsn_code`, `meta`.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          reason: Telnyx::EmailBlock::Reason::OrSymbol,
+          record_type: Telnyx::EmailBlock::RecordType::OrSymbol,
+          scope: Telnyx::EmailBlock::Scope::OrSymbol,
+          source: Telnyx::EmailBlock::Source::OrSymbol,
+          status: Telnyx::EmailBlock::Status::OrSymbol,
+          to: String,
+          updated_at: Time,
+          domain_id: T.nilable(String),
+          expires_at: T.nilable(Time),
+          from: T.nilable(String),
+          group_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        reason:,
+        # View-only discriminator.
+        record_type:,
+        # Derived server-side from `domain_id`/`from`; never trusted from the caller.
+        scope:,
+        source:,
+        status:,
+        # Normalized recipient. (schema: to_address)
+        to:,
+        updated_at:,
+        # `null` ⇒ account scope. Stored on the row; exposed here.
+        domain_id: nil,
+        expires_at: nil,
+        # `null` ⇒ not address-scope. (schema: from_address)
+        from: nil,
+        # `null` ⇒ global; set ⇒ group-scoped opt-out.
+        group_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            reason: Telnyx::EmailBlock::Reason::TaggedSymbol,
+            record_type: Telnyx::EmailBlock::RecordType::TaggedSymbol,
+            scope: Telnyx::EmailBlock::Scope::TaggedSymbol,
+            source: Telnyx::EmailBlock::Source::TaggedSymbol,
+            status: Telnyx::EmailBlock::Status::TaggedSymbol,
+            to: String,
+            updated_at: Time,
+            domain_id: T.nilable(String),
+            expires_at: T.nilable(Time),
+            from: T.nilable(String),
+            group_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Reason
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailBlock::Reason) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HARD_BOUNCE =
+          T.let(:hard_bounce, Telnyx::EmailBlock::Reason::TaggedSymbol)
+        SPAM_COMPLAINT =
+          T.let(:spam_complaint, Telnyx::EmailBlock::Reason::TaggedSymbol)
+        UNSUBSCRIBE =
+          T.let(:unsubscribe, Telnyx::EmailBlock::Reason::TaggedSymbol)
+        INVALID = T.let(:invalid, Telnyx::EmailBlock::Reason::TaggedSymbol)
+        MANUAL_BLOCK =
+          T.let(:manual_block, Telnyx::EmailBlock::Reason::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Telnyx::EmailBlock::Reason::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      # View-only discriminator.
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailBlock::RecordType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL_BLOCK =
+          T.let(:email_block, Telnyx::EmailBlock::RecordType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailBlock::RecordType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Derived server-side from `domain_id`/`from`; never trusted from the caller.
+      module Scope
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Telnyx::EmailBlock::Scope) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACCOUNT = T.let(:account, Telnyx::EmailBlock::Scope::TaggedSymbol)
+        DOMAIN = T.let(:domain, Telnyx::EmailBlock::Scope::TaggedSymbol)
+        ADDRESS = T.let(:address, Telnyx::EmailBlock::Scope::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Telnyx::EmailBlock::Scope::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      module Source
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailBlock::Source) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FEEDBACK = T.let(:feedback, Telnyx::EmailBlock::Source::TaggedSymbol)
+        MANUAL = T.let(:manual, Telnyx::EmailBlock::Source::TaggedSymbol)
+        IMPORT = T.let(:import, Telnyx::EmailBlock::Source::TaggedSymbol)
+        SYSTEM = T.let(:system, Telnyx::EmailBlock::Source::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Telnyx::EmailBlock::Source::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailBlock::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE = T.let(:active, Telnyx::EmailBlock::Status::TaggedSymbol)
+        EXPIRED = T.let(:expired, Telnyx::EmailBlock::Status::TaggedSymbol)
+        REMOVED = T.let(:removed, Telnyx::EmailBlock::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Telnyx::EmailBlock::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_block_create_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailBlockCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailBlockCreateParams, Telnyx::Internal::AnyHash)
+        end
+
+      # Recipient address (normalized: trim + lower-case).
+      sig { returns(String) }
+      attr_accessor :to
+
+      # `null` ⇒ account scope.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :domain_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_at
+
+      # Sender address (normalized). `null` ⇒ account/domain scope.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :from
+
+      sig do
+        params(
+          to: String,
+          domain_id: T.nilable(String),
+          expires_at: T.nilable(Time),
+          from: T.nilable(String),
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Recipient address (normalized: trim + lower-case).
+        to:,
+        # `null` ⇒ account scope.
+        domain_id: nil,
+        expires_at: nil,
+        # Sender address (normalized). `null` ⇒ account/domain scope.
+        from: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            to: String,
+            domain_id: T.nilable(String),
+            expires_at: T.nilable(Time),
+            from: T.nilable(String),
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_block_delete_params.rbi

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