telnyx 5.170.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_template.rbi

@@ -2,186 +2,20 @@
 
 module Telnyx
   module Models
-    class EmailTemplate < Telnyx::Internal::Type::BaseModel
+    class EmailTemplate < Telnyx::Models::EmailTemplateCommon
       OrHash =
         T.type_alias { T.any(Telnyx::EmailTemplate, Telnyx::Internal::AnyHash) }
 
-      sig { returns(String) }
-      attr_accessor :id
-
-      # Whether HTML autoescaping is enabled for this template. When `true`, only
-      # rendered `html_body` expression output is HTML-escaped at the output boundary;
-      # `subject` and `text_body` are never autoescaped.
-      sig { returns(T::Boolean) }
-      attr_accessor :autoescape
-
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      sig { returns(T.nilable(String)) }
-      attr_accessor :html_body
-
-      sig { returns(String) }
-      attr_accessor :name
-
-      sig { returns(Telnyx::EmailTemplate::RecordType::TaggedSymbol) }
-      attr_accessor :record_type
-
-      # Whether strict variable validation is enabled for this template. When `true`,
-      # sends and renders that are missing a variable marked `required: true` in
-      # `variable_schema` fail with 422 naming the variable.
-      sig { returns(T::Boolean) }
-      attr_accessor :strict_variables
-
       sig { returns(T.nilable(String)) }
       attr_accessor :subject
 
-      sig { returns(T.nilable(String)) }
-      attr_accessor :text_body
-
-      sig { returns(Time) }
-      attr_accessor :updated_at
-
-      # Structured variable requirements, or `null` when the template uses only the
-      # legacy `variables` array.
-      sig do
-        returns(
-          T.nilable(T::Hash[Symbol, Telnyx::EmailTemplate::VariableSchema])
-        )
-      end
-      attr_accessor :variable_schema
-
-      # Legacy unstructured variable names. This path remains supported unchanged.
-      sig { returns(T::Array[String]) }
-      attr_accessor :variables
-
-      sig do
-        params(
-          id: String,
-          autoescape: T::Boolean,
-          created_at: Time,
-          html_body: T.nilable(String),
-          name: String,
-          record_type: Telnyx::EmailTemplate::RecordType::OrSymbol,
-          strict_variables: T::Boolean,
-          subject: T.nilable(String),
-          text_body: T.nilable(String),
-          updated_at: Time,
-          variable_schema:
-            T.nilable(
-              T::Hash[Symbol, Telnyx::EmailTemplate::VariableSchema::OrHash]
-            ),
-          variables: T::Array[String]
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        id:,
-        # Whether HTML autoescaping is enabled for this template. When `true`, only
-        # rendered `html_body` expression output is HTML-escaped at the output boundary;
-        # `subject` and `text_body` are never autoescaped.
-        autoescape:,
-        created_at:,
-        html_body:,
-        name:,
-        record_type:,
-        # Whether strict variable validation is enabled for this template. When `true`,
-        # sends and renders that are missing a variable marked `required: true` in
-        # `variable_schema` fail with 422 naming the variable.
-        strict_variables:,
-        subject:,
-        text_body:,
-        updated_at:,
-        # Structured variable requirements, or `null` when the template uses only the
-        # legacy `variables` array.
-        variable_schema:,
-        # Legacy unstructured variable names. This path remains supported unchanged.
-        variables:
-      )
+      sig { params(subject: T.nilable(String)).returns(T.attached_class) }
+      def self.new(subject:)
       end
 
-      sig do
-        override.returns(
-          {
-            id: String,
-            autoescape: T::Boolean,
-            created_at: Time,
-            html_body: T.nilable(String),
-            name: String,
-            record_type: Telnyx::EmailTemplate::RecordType::TaggedSymbol,
-            strict_variables: T::Boolean,
-            subject: T.nilable(String),
-            text_body: T.nilable(String),
-            updated_at: Time,
-            variable_schema:
-              T.nilable(T::Hash[Symbol, Telnyx::EmailTemplate::VariableSchema]),
-            variables: T::Array[String]
-          }
-        )
-      end
+      sig { override.returns({ subject: T.nilable(String) }) }
       def to_hash
       end
-
-      module RecordType
-        extend Telnyx::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Telnyx::EmailTemplate::RecordType) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        EMAIL_TEMPLATE =
-          T.let(
-            :email_template,
-            Telnyx::EmailTemplate::RecordType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Telnyx::EmailTemplate::RecordType::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      class VariableSchema < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::EmailTemplate::VariableSchema,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Whether the variable must be supplied when strict variable validation is
-        # enabled.
-        sig { returns(T::Boolean) }
-        attr_accessor :required
-
-        # Default value for an optional variable. Rejected when `required` is `true`.
-        sig { returns(T.nilable(String)) }
-        attr_reader :default
-
-        sig { params(default: String).void }
-        attr_writer :default
-
-        sig do
-          params(required: T::Boolean, default: String).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Whether the variable must be supplied when strict variable validation is
-          # enabled.
-          required:,
-          # Default value for an optional variable. Rejected when `required` is `true`.
-          default: nil
-        )
-        end
-
-        sig { override.returns({ required: T::Boolean, default: String }) }
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/telnyx/models/email_template_common.rbi

@@ -0,0 +1,238 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailTemplateCommon < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailTemplateCommon, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Whether HTML autoescaping is enabled for this template. When `true`, only
+      # rendered `html_body` expression output is HTML-escaped at the output boundary;
+      # `subject` and `text_body` are never autoescaped.
+      sig { returns(T::Boolean) }
+      attr_accessor :autoescape
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :html_body
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(Telnyx::EmailTemplateCommon::RecordType::TaggedSymbol) }
+      attr_accessor :record_type
+
+      # Whether strict variable validation is enabled for this template. When `true`,
+      # sends and renders that are missing a variable marked `required: true` in
+      # `variable_schema` fail with 422 naming the variable.
+      sig { returns(T::Boolean) }
+      attr_accessor :strict_variables
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :text_body
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Structured variable requirements, or `null` when the template uses only the
+      # legacy `variables` array.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[Symbol, Telnyx::EmailTemplateCommon::VariableSchema]
+          )
+        )
+      end
+      attr_accessor :variable_schema
+
+      # Persisted variable names. In `explicit` mode this array preserves the exact
+      # provided order, duplicates, and string contents; in `automatic` mode it is
+      # derived from the stored subject and bodies.
+      sig { returns(T::Array[String]) }
+      attr_accessor :variables
+
+      # `automatic` when variable names are derived from template content; `explicit`
+      # when `variables` is the exact manually managed array.
+      sig { returns(Telnyx::EmailTemplateCommon::VariablesMode::TaggedSymbol) }
+      attr_accessor :variables_mode
+
+      sig do
+        params(
+          id: String,
+          autoescape: T::Boolean,
+          created_at: Time,
+          html_body: T.nilable(String),
+          name: String,
+          record_type: Telnyx::EmailTemplateCommon::RecordType::OrSymbol,
+          strict_variables: T::Boolean,
+          text_body: T.nilable(String),
+          updated_at: Time,
+          variable_schema:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Telnyx::EmailTemplateCommon::VariableSchema::OrHash
+              ]
+            ),
+          variables: T::Array[String],
+          variables_mode: Telnyx::EmailTemplateCommon::VariablesMode::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Whether HTML autoescaping is enabled for this template. When `true`, only
+        # rendered `html_body` expression output is HTML-escaped at the output boundary;
+        # `subject` and `text_body` are never autoescaped.
+        autoescape:,
+        created_at:,
+        html_body:,
+        name:,
+        record_type:,
+        # Whether strict variable validation is enabled for this template. When `true`,
+        # sends and renders that are missing a variable marked `required: true` in
+        # `variable_schema` fail with 422 naming the variable.
+        strict_variables:,
+        text_body:,
+        updated_at:,
+        # Structured variable requirements, or `null` when the template uses only the
+        # legacy `variables` array.
+        variable_schema:,
+        # Persisted variable names. In `explicit` mode this array preserves the exact
+        # provided order, duplicates, and string contents; in `automatic` mode it is
+        # derived from the stored subject and bodies.
+        variables:,
+        # `automatic` when variable names are derived from template content; `explicit`
+        # when `variables` is the exact manually managed array.
+        variables_mode:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            autoescape: T::Boolean,
+            created_at: Time,
+            html_body: T.nilable(String),
+            name: String,
+            record_type: Telnyx::EmailTemplateCommon::RecordType::TaggedSymbol,
+            strict_variables: T::Boolean,
+            text_body: T.nilable(String),
+            updated_at: Time,
+            variable_schema:
+              T.nilable(
+                T::Hash[Symbol, Telnyx::EmailTemplateCommon::VariableSchema]
+              ),
+            variables: T::Array[String],
+            variables_mode:
+              Telnyx::EmailTemplateCommon::VariablesMode::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailTemplateCommon::RecordType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL_TEMPLATE =
+          T.let(
+            :email_template,
+            Telnyx::EmailTemplateCommon::RecordType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailTemplateCommon::RecordType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class VariableSchema < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::EmailTemplateCommon::VariableSchema,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Whether the variable must be supplied when strict variable validation is
+        # enabled.
+        sig { returns(T::Boolean) }
+        attr_accessor :required
+
+        # Default value for an optional variable. Rejected when `required` is `true`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :default
+
+        sig { params(default: String).void }
+        attr_writer :default
+
+        sig do
+          params(required: T::Boolean, default: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Whether the variable must be supplied when strict variable validation is
+          # enabled.
+          required:,
+          # Default value for an optional variable. Rejected when `required` is `true`.
+          default: nil
+        )
+        end
+
+        sig { override.returns({ required: T::Boolean, default: String }) }
+        def to_hash
+        end
+      end
+
+      # `automatic` when variable names are derived from template content; `explicit`
+      # when `variables` is the exact manually managed array.
+      module VariablesMode
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Telnyx::EmailTemplateCommon::VariablesMode)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUTOMATIC =
+          T.let(
+            :automatic,
+            Telnyx::EmailTemplateCommon::VariablesMode::TaggedSymbol
+          )
+        EXPLICIT =
+          T.let(
+            :explicit,
+            Telnyx::EmailTemplateCommon::VariablesMode::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailTemplateCommon::VariablesMode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end