telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/dir_update_infringement_params.rbi

@@ -30,7 +30,8 @@ module Telnyx
       end
       attr_accessor :certify_ip_ownership
 
-      # Must be `true`.
+      # Check to certify that the brand no longer infringes anyone else's trademark or
+      # intellectual property.
       sig do
         returns(
           Telnyx::DirUpdateInfringementParams::CertifyNoInfringement::OrBoolean
@@ -53,6 +54,8 @@ module Telnyx
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :call_reasons
 
+      # The business name shown to call recipients, 1 to 35 characters, no emoji, not
+      # blank.
       sig { returns(T.nilable(String)) }
       attr_accessor :display_name
 
@@ -90,13 +93,16 @@ module Telnyx
         certify_brand_is_accurate:,
         # Must be `true`.
         certify_ip_ownership:,
-        # Must be `true`.
+        # Check to certify that the brand no longer infringes anyone else's trademark or
+        # intellectual property.
         certify_no_infringement:,
         # Must be `true`.
         certify_no_shaft_content:,
         # Explanation of how the infringement concern was addressed.
         infringement_resolution_notes:,
         call_reasons: nil,
+        # The business name shown to call recipients, 1 to 35 characters, no emoji, not
+        # blank.
         display_name: nil,
         # Append-only supporting documents to attach while resolving the claim (e.g.
         # authorization or licensing proof).
@@ -191,7 +197,8 @@ module Telnyx
         end
       end
 
-      # Must be `true`.
+      # Check to certify that the brand no longer infringes anyone else's trademark or
+      # intellectual property.
       module CertifyNoInfringement
         extend Telnyx::Internal::Type::Enum
 

data/rbi/telnyx/models/dir_update_params.rbi

@@ -30,6 +30,22 @@ module Telnyx
       sig { params(authorizer_name: String).void }
       attr_writer :authorizer_name
 
+      # Optional. Replace this DIR's authorized BPO (Business Process Outsourcer)
+      # accounts with these, each with its signed Letter of Authorization. The supplied
+      # list replaces the current one: a BPO left out has its authorization removed, and
+      # a new BPO (or a changed Letter of Authorization) is created `pending` admin
+      # review. Send an empty list to clear all authorizations; omit the field to leave
+      # them unchanged. Editing this list does not re-vet the DIR. Maximum 10.
+      sig { returns(T.nilable(T::Array[Telnyx::BpoAuthorizationInput])) }
+      attr_reader :bpo_authorizations
+
+      sig do
+        params(
+          bpo_authorizations: T::Array[Telnyx::BpoAuthorizationInput::OrHash]
+        ).void
+      end
+      attr_writer :bpo_authorizations
+
       # 1–10 reasons your business calls customers. Validate phrasing against
       # `POST /call_reasons/validate`.
       sig { returns(T.nilable(T::Array[String])) }
@@ -94,11 +110,18 @@ module Telnyx
       sig { params(reselling: T::Boolean).void }
       attr_writer :reselling
 
+      # Optional `https://` URL that receives webhook notifications when this DIR's
+      # compliance review completes. Send `null` to clear. Changing only this field on a
+      # `verified` DIR does not re-vet it. Maximum 2048 characters.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :webhook_url
+
       sig do
         params(
           dir_id: String,
           authorizer_email: String,
           authorizer_name: String,
+          bpo_authorizations: T::Array[Telnyx::BpoAuthorizationInput::OrHash],
           call_reasons: T::Array[String],
           certify_brand_is_accurate: T::Boolean,
           certify_ip_ownership: T::Boolean,
@@ -107,6 +130,7 @@ module Telnyx
           documents: T::Array[Telnyx::Document::OrHash],
           logo_url: String,
           reselling: T::Boolean,
+          webhook_url: T.nilable(String),
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -118,6 +142,13 @@ module Telnyx
         # Name of the person at your enterprise authorizing this DIR. Must be a real
         # individual.
         authorizer_name: nil,
+        # Optional. Replace this DIR's authorized BPO (Business Process Outsourcer)
+        # accounts with these, each with its signed Letter of Authorization. The supplied
+        # list replaces the current one: a BPO left out has its authorization removed, and
+        # a new BPO (or a changed Letter of Authorization) is created `pending` admin
+        # review. Send an empty list to clear all authorizations; omit the field to leave
+        # them unchanged. Editing this list does not re-vet the DIR. Maximum 10.
+        bpo_authorizations: nil,
         # 1–10 reasons your business calls customers. Validate phrasing against
         # `POST /call_reasons/validate`.
         call_reasons: nil,
@@ -142,6 +173,10 @@ module Telnyx
         # Set to true if your organization places calls on behalf of other enterprises
         # (BPO/reseller). Updating this triggers re-vetting on next submit.
         reselling: nil,
+        # Optional `https://` URL that receives webhook notifications when this DIR's
+        # compliance review completes. Send `null` to clear. Changing only this field on a
+        # `verified` DIR does not re-vet it. Maximum 2048 characters.
+        webhook_url: nil,
         request_options: {}
       )
       end
@@ -152,6 +187,7 @@ module Telnyx
             dir_id: String,
             authorizer_email: String,
             authorizer_name: String,
+            bpo_authorizations: T::Array[Telnyx::BpoAuthorizationInput],
             call_reasons: T::Array[String],
             certify_brand_is_accurate: T::Boolean,
             certify_ip_ownership: T::Boolean,
@@ -160,6 +196,7 @@ module Telnyx
             documents: T::Array[Telnyx::Document],
             logo_url: String,
             reselling: T::Boolean,
+            webhook_url: T.nilable(String),
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/doc_reqs_requirement.rbi

@@ -219,11 +219,26 @@ module Telnyx
             :local,
             Telnyx::DocReqsRequirement::PhoneNumberType::TaggedSymbol
           )
+        MOBILE =
+          T.let(
+            :mobile,
+            Telnyx::DocReqsRequirement::PhoneNumberType::TaggedSymbol
+          )
+        MULTIPURPOSE =
+          T.let(
+            :multipurpose,
+            Telnyx::DocReqsRequirement::PhoneNumberType::TaggedSymbol
+          )
         NATIONAL =
           T.let(
             :national,
             Telnyx::DocReqsRequirement::PhoneNumberType::TaggedSymbol
           )
+        SHARED_COST =
+          T.let(
+            :shared_cost,
+            Telnyx::DocReqsRequirement::PhoneNumberType::TaggedSymbol
+          )
         TOLL_FREE =
           T.let(
             :toll_free,

data/rbi/telnyx/models/document.rbi

@@ -17,6 +17,7 @@ module Telnyx
       sig { returns(Telnyx::Document::DocumentType::OrSymbol) }
       attr_accessor :document_type
 
+      # An optional note describing this document, for example what it proves.
       sig { returns(T.nilable(String)) }
       attr_reader :description
 
@@ -38,6 +39,7 @@ module Telnyx
         # contains; `other` triggers manual vetting and may slow approval. The matching
         # short_name reference list is at `GET /v2/dir/document_types`.
         document_type:,
+        # An optional note describing this document, for example what it proves.
         description: nil
       )
       end

data/rbi/telnyx/models/email_block.rbi

@@ -40,6 +40,10 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :domain_id
 
+      # Optional expiration time. An active row stops matching send-time suppression
+      # checks as soon as `expires_at <= now()`. A maintenance worker later transitions
+      # the row to `status: expired` and appends an `expired` audit event (normally
+      # within 15 minutes).
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
@@ -85,6 +89,10 @@ module Telnyx
         updated_at:,
         # `null` ⇒ account scope. Stored on the row; exposed here.
         domain_id: nil,
+        # Optional expiration time. An active row stops matching send-time suppression
+        # checks as soon as `expires_at <= now()`. A maintenance worker later transitions
+        # the row to `status: expired` and appends an `expired` audit event (normally
+        # within 15 minutes).
         expires_at: nil,
         # `null` ⇒ not address-scope. (schema: from_address)
         from: nil,

data/rbi/telnyx/models/email_blocks/email_block_import.rbi

@@ -54,7 +54,9 @@ module Telnyx
         sig { params(created_count: Integer).void }
         attr_writer :created_count
 
-        # Only when `status == completed`.
+        # Rows that passed CSV parsing but failed suppression creation. This is the
+        # creation-failure subset of `skipped_count`; parser-rejected rows equal
+        # `skipped_count - error_count`. Only when `status == completed`.
         sig { returns(T.nilable(Integer)) }
         attr_reader :error_count
 
@@ -148,7 +150,9 @@ module Telnyx
           completed_at: nil,
           # Only when `status == completed`.
           created_count: nil,
-          # Only when `status == completed`.
+          # Rows that passed CSV parsing but failed suppression creation. This is the
+          # creation-failure subset of `skipped_count`; parser-rejected rows equal
+          # `skipped_count - error_count`. Only when `status == completed`.
           error_count: nil,
           # `{row_number: reason}`; only rendered when non-empty.
           errors: nil,

data/rbi/telnyx/models/email_domain_rotate_dkim_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailDomainRotateDkimParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailDomainRotateDkimParams, 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