telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/dir.rbi

@@ -80,12 +80,21 @@ module Telnyx
       # - `infringement_claimed` - a trademark/impersonation claim is open against this
       #   DIR.
       # - `permanently_rejected` - terminal; cannot be resubmitted.
+      # - `delete_requested` - you have requested deletion; the DIR still exists and
+      #   Telnyx is completing the removal (de-registration and cleanup). A verified DIR
+      #   keeps serving its branded identity, and keeps billing, until the removal
+      #   finishes.
       sig { returns(T.nilable(Telnyx::DirStatus::TaggedSymbol)) }
       attr_reader :status
 
       sig { params(status: Telnyx::DirStatus::OrSymbol).void }
       attr_writer :status
 
+      # `https://` URL that receives webhook notifications for this DIR's
+      # compliance-review outcomes. `null` when not subscribed.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :webhook_url
+
       sig { returns(T.nilable(String)) }
       attr_reader :id
 
@@ -98,6 +107,11 @@ module Telnyx
       sig { params(created_at: Time).void }
       attr_writer :created_at
 
+      # When deletion was requested. Set once the DIR enters `delete_requested`; `null`
+      # otherwise.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :delete_requested_at
+
       sig { returns(T.nilable(Time)) }
       attr_accessor :expiring_at
 
@@ -126,6 +140,7 @@ module Telnyx
           certify_ip_ownership: T::Boolean,
           certify_no_shaft_content: T::Boolean,
           created_at: Time,
+          delete_requested_at: T.nilable(Time),
           display_name: String,
           documents: T.nilable(T::Array[Telnyx::Document::OrHash]),
           enterprise_id: String,
@@ -138,7 +153,8 @@ module Telnyx
           status: Telnyx::DirStatus::OrSymbol,
           submitted_at: T.nilable(Time),
           updated_at: Time,
-          verified_at: T.nilable(Time)
+          verified_at: T.nilable(Time),
+          webhook_url: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -150,6 +166,9 @@ module Telnyx
         certify_ip_ownership: nil,
         certify_no_shaft_content: nil,
         created_at: nil,
+        # When deletion was requested. Set once the DIR enters `delete_requested`; `null`
+        # otherwise.
+        delete_requested_at: nil,
         display_name: nil,
         documents: nil,
         enterprise_id: nil,
@@ -174,10 +193,17 @@ module Telnyx
         # - `infringement_claimed` - a trademark/impersonation claim is open against this
         #   DIR.
         # - `permanently_rejected` - terminal; cannot be resubmitted.
+        # - `delete_requested` - you have requested deletion; the DIR still exists and
+        #   Telnyx is completing the removal (de-registration and cleanup). A verified DIR
+        #   keeps serving its branded identity, and keeps billing, until the removal
+        #   finishes.
         status: nil,
         submitted_at: nil,
         updated_at: nil,
-        verified_at: nil
+        verified_at: nil,
+        # `https://` URL that receives webhook notifications for this DIR's
+        # compliance-review outcomes. `null` when not subscribed.
+        webhook_url: nil
       )
       end
 
@@ -192,6 +218,7 @@ module Telnyx
             certify_ip_ownership: T::Boolean,
             certify_no_shaft_content: T::Boolean,
             created_at: Time,
+            delete_requested_at: T.nilable(Time),
             display_name: String,
             documents: T.nilable(T::Array[Telnyx::Document]),
             enterprise_id: String,
@@ -204,7 +231,8 @@ module Telnyx
             status: Telnyx::DirStatus::TaggedSymbol,
             submitted_at: T.nilable(Time),
             updated_at: Time,
-            verified_at: T.nilable(Time)
+            verified_at: T.nilable(Time),
+            webhook_url: T.nilable(String)
           }
         )
       end

data/rbi/telnyx/models/dir_bpo_loa_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class DirBpoLoaParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::DirBpoLoaParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :dir_id
+
+      # The approved BPO enterprise the Brand Owner is authorizing. Must be a BPO
+      # account on the caller's organization that has already been approved.
+      sig { returns(String) }
+      attr_accessor :bpo_enterprise_id
+
+      # Optional. When provided the rendered PDF embeds the signature image, printed
+      # name, and signed-at date. When absent the PDF is returned unsigned so the Brand
+      # Owner can sign externally and the BPO can upload it via the Documents API.
+      sig { returns(T.nilable(Telnyx::SignaturePayload)) }
+      attr_reader :signature
+
+      sig { params(signature: Telnyx::SignaturePayload::OrHash).void }
+      attr_writer :signature
+
+      sig do
+        params(
+          dir_id: String,
+          bpo_enterprise_id: String,
+          signature: Telnyx::SignaturePayload::OrHash,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        dir_id:,
+        # The approved BPO enterprise the Brand Owner is authorizing. Must be a BPO
+        # account on the caller's organization that has already been approved.
+        bpo_enterprise_id:,
+        # Optional. When provided the rendered PDF embeds the signature image, printed
+        # name, and signed-at date. When absent the PDF is returned unsigned so the Brand
+        # Owner can sign externally and the BPO can upload it via the Documents API.
+        signature: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            dir_id: String,
+            bpo_enterprise_id: String,
+            signature: Telnyx::SignaturePayload,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir_delete_response.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class DirDeleteResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::Models::DirDeleteResponse, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(Telnyx::Models::DirDeleteResponse::Data) }
+      attr_reader :data
+
+      sig { params(data: Telnyx::Models::DirDeleteResponse::Data::OrHash).void }
+      attr_writer :data
+
+      sig do
+        params(data: Telnyx::Models::DirDeleteResponse::Data::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns({ data: Telnyx::Models::DirDeleteResponse::Data })
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::DirDeleteResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Id of the DIR whose deletion was requested.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Always `delete_requested`: the DIR has been queued for removal, not yet removed.
+        sig do
+          returns(Telnyx::Models::DirDeleteResponse::Data::Status::TaggedSymbol)
+        end
+        attr_accessor :status
+
+        sig do
+          params(
+            id: String,
+            status: Telnyx::Models::DirDeleteResponse::Data::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Id of the DIR whose deletion was requested.
+          id:,
+          # Always `delete_requested`: the DIR has been queued for removal, not yet removed.
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              status:
+                Telnyx::Models::DirDeleteResponse::Data::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Always `delete_requested`: the DIR has been queued for removal, not yet removed.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Models::DirDeleteResponse::Data::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DELETE_REQUESTED =
+            T.let(
+              :delete_requested,
+              Telnyx::Models::DirDeleteResponse::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::DirDeleteResponse::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir_new_loa_params.rbi

@@ -19,8 +19,9 @@ module Telnyx
       sig { returns(T::Array[String]) }
       attr_accessor :phone_numbers
 
-      # Third-party reseller / partner managing the enterprise's phone numbers. Omit
-      # when the enterprise works directly with Telnyx.
+      # Third-party reseller / partner managing the enterprise's phone numbers on its
+      # behalf, such as a call center (BPO) acting for a client. Omit when the
+      # enterprise manages its own numbers.
       sig { returns(T.nilable(Telnyx::Enterprises::Reputation::AgentInput)) }
       attr_reader :agent
 
@@ -32,10 +33,10 @@ module Telnyx
       # Optional. When provided the rendered PDF embeds the signature image, printed
       # name, and signed-at date. When absent the PDF is returned unsigned so the
       # customer can sign externally and upload it via the Documents API.
-      sig { returns(T.nilable(Telnyx::DirNewLoaParams::Signature)) }
+      sig { returns(T.nilable(Telnyx::SignaturePayload)) }
       attr_reader :signature
 
-      sig { params(signature: Telnyx::DirNewLoaParams::Signature::OrHash).void }
+      sig { params(signature: Telnyx::SignaturePayload::OrHash).void }
       attr_writer :signature
 
       sig do
@@ -43,7 +44,7 @@ module Telnyx
           dir_id: String,
           phone_numbers: T::Array[String],
           agent: Telnyx::Enterprises::Reputation::AgentInput::OrHash,
-          signature: Telnyx::DirNewLoaParams::Signature::OrHash,
+          signature: Telnyx::SignaturePayload::OrHash,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -52,8 +53,9 @@ module Telnyx
         # Telephone numbers to authorize on the DIR, in `+E164` format (`+` followed by
         # 10-15 digits). Max 15 per request.
         phone_numbers:,
-        # Third-party reseller / partner managing the enterprise's phone numbers. Omit
-        # when the enterprise works directly with Telnyx.
+        # Third-party reseller / partner managing the enterprise's phone numbers on its
+        # behalf, such as a call center (BPO) acting for a client. Omit when the
+        # enterprise manages its own numbers.
         agent: nil,
         # Optional. When provided the rendered PDF embeds the signature image, printed
         # name, and signed-at date. When absent the PDF is returned unsigned so the
@@ -69,54 +71,13 @@ module Telnyx
             dir_id: String,
             phone_numbers: T::Array[String],
             agent: Telnyx::Enterprises::Reputation::AgentInput,
-            signature: Telnyx::DirNewLoaParams::Signature,
+            signature: Telnyx::SignaturePayload,
             request_options: Telnyx::RequestOptions
           }
         )
       end
       def to_hash
       end
-
-      class Signature < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Telnyx::DirNewLoaParams::Signature, Telnyx::Internal::AnyHash)
-          end
-
-        # PNG image, base64-encoded.
-        sig { returns(String) }
-        attr_accessor :image_base64
-
-        # Optional. When absent the rendered PDF falls back to the enterprise contact's
-        # legal name.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :signer_name
-
-        # Optional. When provided the rendered PDF embeds the signature image, printed
-        # name, and signed-at date. When absent the PDF is returned unsigned so the
-        # customer can sign externally and upload it via the Documents API.
-        sig do
-          params(image_base64: String, signer_name: T.nilable(String)).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # PNG image, base64-encoded.
-          image_base64:,
-          # Optional. When absent the rendered PDF falls back to the enterprise contact's
-          # legal name.
-          signer_name: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            { image_base64: String, signer_name: T.nilable(String) }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/telnyx/models/dir_retrieve_bpo_authorizations_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class DirRetrieveBpoAuthorizationsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::DirRetrieveBpoAuthorizationsParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :dir_id
+
+      # 1-based page number. Out-of-range values return an empty page with correct meta.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Items per page. Maximum 250; values above are clamped to 250.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      sig do
+        params(
+          dir_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        dir_id:,
+        # 1-based page number. Out-of-range values return an empty page with correct meta.
+        page_number: nil,
+        # Items per page. Maximum 250; values above are clamped to 250.
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            dir_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir_retrieve_bpo_authorizations_response.rbi

@@ -0,0 +1,235 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class DirRetrieveBpoAuthorizationsResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::DirRetrieveBpoAuthorizationsResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T::Array[Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data]
+        )
+      end
+      attr_accessor :data
+
+      # JSON:API pagination metadata returned with every paginated list response. Page
+      # numbering is 1-based. `page_size` reports the number of items actually returned
+      # in `data` for this page; the requested size is taken from the `page[size]` query
+      # parameter.
+      sig { returns(Telnyx::BrandedCallingPaginationMeta) }
+      attr_reader :meta
+
+      sig { params(meta: Telnyx::BrandedCallingPaginationMeta::OrHash).void }
+      attr_writer :meta
+
+      # Paginated list of a DIR's BPO authorizations.
+      sig do
+        params(
+          data:
+            T::Array[
+              Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::OrHash
+            ],
+          meta: Telnyx::BrandedCallingPaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # JSON:API pagination metadata returned with every paginated list response. Page
+        # numbering is 1-based. `page_size` reports the number of items actually returned
+        # in `data` for this page; the requested size is taken from the `page[size]` query
+        # parameter.
+        meta:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T::Array[
+                Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data
+              ],
+            meta: Telnyx::BrandedCallingPaginationMeta
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The authorized BPO account's enterprise id.
+        sig { returns(String) }
+        attr_accessor :bpo_enterprise_id
+
+        # Id of the signed Letter of Authorization document submitted for this BPO. Send
+        # it back unchanged in `bpo_authorizations` when updating the DIR to keep this
+        # authorization and its review state.
+        sig { returns(String) }
+        attr_accessor :loa_document_id
+
+        # Review state of this authorization. `pending` when the authorization is first
+        # added, or when you send a different `loa_document_id` for this BPO in
+        # `bpo_authorizations` (uploading a document alone changes nothing). Approving the
+        # DIR approves its pending authorizations; an admin can also approve or reject one
+        # on its own. Only an `approved` authorization adds the BPO to this DIR's
+        # authorized callers in the branded calling registry.
+        sig do
+          returns(
+            Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # Why the authorization was rejected. `null` unless `status` is `rejected`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :rejection_reason
+
+        # Always `bpo_authorization`.
+        sig do
+          returns(
+            Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType::TaggedSymbol
+          )
+        end
+        attr_accessor :record_type
+
+        # A single authorization of a BPO (Business Process Outsourcer) account on a DIR.
+        sig do
+          params(
+            bpo_enterprise_id: String,
+            loa_document_id: String,
+            record_type:
+              Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType::OrSymbol,
+            status:
+              Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status::OrSymbol,
+            rejection_reason: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The authorized BPO account's enterprise id.
+          bpo_enterprise_id:,
+          # Id of the signed Letter of Authorization document submitted for this BPO. Send
+          # it back unchanged in `bpo_authorizations` when updating the DIR to keep this
+          # authorization and its review state.
+          loa_document_id:,
+          # Always `bpo_authorization`.
+          record_type:,
+          # Review state of this authorization. `pending` when the authorization is first
+          # added, or when you send a different `loa_document_id` for this BPO in
+          # `bpo_authorizations` (uploading a document alone changes nothing). Approving the
+          # DIR approves its pending authorizations; an admin can also approve or reject one
+          # on its own. Only an `approved` authorization adds the BPO to this DIR's
+          # authorized callers in the branded calling registry.
+          status:,
+          # Why the authorization was rejected. `null` unless `status` is `rejected`.
+          rejection_reason: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              bpo_enterprise_id: String,
+              loa_document_id: String,
+              record_type:
+                Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType::TaggedSymbol,
+              status:
+                Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status::TaggedSymbol,
+              rejection_reason: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Always `bpo_authorization`.
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BPO_AUTHORIZATION =
+            T.let(
+              :bpo_authorization,
+              Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Review state of this authorization. `pending` when the authorization is first
+        # added, or when you send a different `loa_document_id` for this BPO in
+        # `bpo_authorizations` (uploading a document alone changes nothing). Approving the
+        # DIR approves its pending authorizations; an admin can also approve or reject one
+        # on its own. Only an `approved` authorization adds the BPO to this DIR's
+        # authorized callers in the branded calling registry.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status::TaggedSymbol
+            )
+          APPROVED =
+            T.let(
+              :approved,
+              Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :rejected,
+              Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/dir_status.rbi

@@ -16,6 +16,10 @@ module Telnyx
     # - `infringement_claimed` - a trademark/impersonation claim is open against this
     #   DIR.
     # - `permanently_rejected` - terminal; cannot be resubmitted.
+    # - `delete_requested` - you have requested deletion; the DIR still exists and
+    #   Telnyx is completing the removal (de-registration and cleanup). A verified DIR
+    #   keeps serving its branded identity, and keeps billing, until the removal
+    #   finishes.
     module DirStatus
       extend Telnyx::Internal::Type::Enum
 
@@ -34,6 +38,8 @@ module Telnyx
         T.let(:infringement_claimed, Telnyx::DirStatus::TaggedSymbol)
       PERMANENTLY_REJECTED =
         T.let(:permanently_rejected, Telnyx::DirStatus::TaggedSymbol)
+      DELETE_REQUESTED =
+        T.let(:delete_requested, Telnyx::DirStatus::TaggedSymbol)
 
       sig { override.returns(T::Array[Telnyx::DirStatus::TaggedSymbol]) }
       def self.values