telnyx 5.169.0 → 5.171.0

data/lib/telnyx/models/conversation_relay_language.rb

@@ -30,10 +30,13 @@ module Telnyx
       #   Engine-specific transcription settings for Conversation Relay. This accepts the
       #   same provider-specific options used by the Call Transcription Start command,
       #   such as `transcription_model`, without requiring the engine discriminator to be
-      #   repeated inside this object.
+      #   repeated inside this object. With Deepgram Flux (`deepgram/flux`),
+      #   `interim_results`, `eot_threshold` and `eager_eot_threshold` control the interim
+      #   prompts and the `eagerEndOfTurn` and `turnResumed` frames sent to your WebSocket
+      #   server.
       #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :transcription_engine_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+      #   @return [Telnyx::Models::Calls::ConversationRelayTranscriptionEngineConfig, nil]
+      optional :transcription_engine_config, -> { Telnyx::Calls::ConversationRelayTranscriptionEngineConfig }
 
       # @!attribute transcription_provider
       #   Conversation Relay transcription provider name. Prefer `transcription_engine`
@@ -58,7 +61,7 @@ module Telnyx
       # @!attribute voice_settings
       #   The settings associated with the voice selected
       #
-      #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
+      #   @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings, nil]
       optional :voice_settings, union: -> { Telnyx::ConversationRelayLanguage::VoiceSettings }
 
       # @!method initialize(language:, speech_model: nil, transcription_engine: nil, transcription_engine_config: nil, transcription_provider: nil, tts_provider: nil, voice: nil, voice_settings: nil)
@@ -73,7 +76,7 @@ module Telnyx
       #
       #   @param transcription_engine [Symbol, Telnyx::Models::ConversationRelayLanguage::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
       #
-      #   @param transcription_engine_config [Hash{Symbol=>Object}] Engine-specific transcription settings for Conversation Relay. This accepts the
+      #   @param transcription_engine_config [Telnyx::Models::Calls::ConversationRelayTranscriptionEngineConfig] Engine-specific transcription settings for Conversation Relay. This accepts the
       #
       #   @param transcription_provider [String] Conversation Relay transcription provider name. Prefer `transcription_engine` wh
       #
@@ -81,7 +84,7 @@ module Telnyx
       #
       #   @param voice [String] Voice identifier for this language.
       #
-      #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+      #   @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings] The settings associated with the voice selected
 
       # Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
       # `Telnyx` are supported for backward compatibility. When provided in a
@@ -131,8 +134,10 @@ module Telnyx
 
         variant :xai, -> { Telnyx::XaiVoiceSettings }
 
+        variant :soniox, -> { Telnyx::Calls::SonioxVoiceSettings }
+
         # @!method self.variants
-        #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
+        #   @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, Telnyx::Models::Calls::SonioxVoiceSettings)]
       end
     end
   end

data/lib/telnyx/models/dir/phone_number_list_params.rb

@@ -25,13 +25,7 @@ module Telnyx
         #   @return [Integer, nil]
         optional :page_size, Integer
 
-        # @!attribute status
-        #   Filter by phone-number status.
-        #
-        #   @return [Symbol, Telnyx::Models::Dir::DirPhoneNumberStatus, nil]
-        optional :status, enum: -> { Telnyx::Dir::DirPhoneNumberStatus }
-
-        # @!method initialize(dir_id:, page_number: nil, page_size: nil, status: nil, request_options: {})
+        # @!method initialize(dir_id:, page_number: nil, page_size: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Dir::PhoneNumberListParams} for more details.
         #
@@ -41,8 +35,6 @@ module Telnyx
         #
         #   @param page_size [Integer] Items per page. Maximum 250; values above are clamped to 250.
         #
-        #   @param status [Symbol, Telnyx::Models::Dir::DirPhoneNumberStatus] Filter by phone-number status.
-        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/telnyx/models/dir/phone_number_remove_params.rb

@@ -14,13 +14,20 @@ module Telnyx
         required :dir_id, String
 
         # @!attribute phone_numbers
+        #   The phone numbers to remove from this brand, in E.164 format, up to 100 per
+        #   request. They must currently be attached to this brand.
         #
         #   @return [Array<String>]
         required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
 
         # @!method initialize(dir_id:, phone_numbers:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::PhoneNumberRemoveParams} for more details.
+        #
         #   @param dir_id [String]
-        #   @param phone_numbers [Array<String>]
+        #
+        #   @param phone_numbers [Array<String>] The phone numbers to remove from this brand, in E.164 format, up to 100 per requ
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/telnyx/models/dir/reference_update_params.rb

@@ -24,31 +24,33 @@ module Telnyx
         required :slot, Integer
 
         # @!attribute email
-        #   Reference contact email address.
+        #   The reference's email address. We email them scheduling and dial-in instructions
+        #   before we call, so use an address they check.
         #
         #   @return [String, nil]
         optional :email, String
 
         # @!attribute full_name
-        #   Full name of the reference contact.
+        #   The full name of the person we should contact as your reference.
         #
         #   @return [String, nil]
         optional :full_name, String
 
         # @!attribute job_title
-        #   Job title of the reference contact.
+        #   The reference contact's job title, for example CFO or Owner.
         #
         #   @return [String, nil]
         optional :job_title, String, nil?: true
 
         # @!attribute organization
-        #   Organization the reference contact belongs to.
+        #   The name of the organization the reference contact works for.
         #
         #   @return [String, nil]
         optional :organization, String, nil?: true
 
         # @!attribute phone_e164
-        #   Reference phone number in E.164 format.
+        #   The reference's phone number in E.164 format, for example +14155550123. We call
+        #   this number during their local business hours.
         #
         #   @return [String, nil]
         optional :phone_e164, String
@@ -60,31 +62,35 @@ module Telnyx
         optional :relationship_to_registrant, String, nil?: true
 
         # @!attribute timezone
-        #   IANA timezone id for the reference.
+        #   The reference's IANA time zone, for example America/New_York. We only call
+        #   during their local 8am to 9pm hours, which is why we need it.
         #
         #   @return [String, nil]
         optional :timezone, String
 
         # @!method initialize(dir_id:, ref_type:, slot:, email: nil, full_name: nil, job_title: nil, organization: nil, phone_e164: nil, relationship_to_registrant: nil, timezone: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Dir::ReferenceUpdateParams} for more details.
+        #
         #   @param dir_id [String]
         #
         #   @param ref_type [Symbol, Telnyx::Models::Dir::ReferenceUpdateParams::RefType]
         #
         #   @param slot [Integer]
         #
-        #   @param email [String] Reference contact email address.
+        #   @param email [String] The reference's email address. We email them scheduling and dial-in instructions
         #
-        #   @param full_name [String] Full name of the reference contact.
+        #   @param full_name [String] The full name of the person we should contact as your reference.
         #
-        #   @param job_title [String, nil] Job title of the reference contact.
+        #   @param job_title [String, nil] The reference contact's job title, for example CFO or Owner.
         #
-        #   @param organization [String, nil] Organization the reference contact belongs to.
+        #   @param organization [String, nil] The name of the organization the reference contact works for.
         #
-        #   @param phone_e164 [String] Reference phone number in E.164 format.
+        #   @param phone_e164 [String] The reference's phone number in E.164 format, for example +14155550123. We call
         #
         #   @param relationship_to_registrant [String, nil] How the reference contact is related to the registering business.
         #
-        #   @param timezone [String] IANA timezone id for the reference.
+        #   @param timezone [String] The reference's IANA time zone, for example America/New_York. We only call durin
         #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/telnyx/models/dir.rb

@@ -83,10 +83,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.
       #
       #   @return [Symbol, Telnyx::Models::DirStatus, nil]
       optional :status, enum: -> { Telnyx::DirStatus }
 
+      # @!attribute webhook_url
+      #   `https://` URL that receives webhook notifications for this DIR's
+      #   compliance-review outcomes. `null` when not subscribed.
+      #
+      #   @return [String, nil]
+      optional :webhook_url, String, nil?: true
+
       response_only do
         # @!attribute id
         #
@@ -98,6 +109,13 @@ module Telnyx
         #   @return [Time, nil]
         optional :created_at, Time
 
+        # @!attribute delete_requested_at
+        #   When deletion was requested. Set once the DIR enters `delete_requested`; `null`
+        #   otherwise.
+        #
+        #   @return [Time, nil]
+        optional :delete_requested_at, Time, nil?: true
+
         # @!attribute expiring_at
         #
         #   @return [Time, nil]
@@ -124,7 +142,7 @@ module Telnyx
         optional :verified_at, Time, nil?: true
       end
 
-      # @!method initialize(id: nil, authorizer_email: nil, authorizer_name: nil, call_reasons: nil, certify_brand_is_accurate: nil, certify_ip_ownership: nil, certify_no_shaft_content: nil, created_at: nil, display_name: nil, documents: nil, enterprise_id: nil, expiring_at: nil, logo_url: nil, rejected_at: nil, rejection_reasons: nil, reselling: nil, status: nil, submitted_at: nil, updated_at: nil, verified_at: nil)
+      # @!method initialize(id: nil, authorizer_email: nil, authorizer_name: nil, call_reasons: nil, certify_brand_is_accurate: nil, certify_ip_ownership: nil, certify_no_shaft_content: nil, created_at: nil, delete_requested_at: nil, display_name: nil, documents: nil, enterprise_id: nil, expiring_at: nil, logo_url: nil, rejected_at: nil, rejection_reasons: nil, reselling: nil, status: nil, submitted_at: nil, updated_at: nil, verified_at: nil, webhook_url: nil)
       #   Some parameter documentations has been truncated, see {Telnyx::Models::DirAPI}
       #   for more details.
       #
@@ -144,6 +162,8 @@ module Telnyx
       #
       #   @param created_at [Time]
       #
+      #   @param delete_requested_at [Time, nil] When deletion was requested. Set once the DIR enters `delete_requested`; `null`
+      #
       #   @param display_name [String]
       #
       #   @param documents [Array<Telnyx::Models::Document>, nil]
@@ -167,6 +187,8 @@ module Telnyx
       #   @param updated_at [Time]
       #
       #   @param verified_at [Time, nil]
+      #
+      #   @param webhook_url [String, nil] `https://` URL that receives webhook notifications for this DIR's compliance-rev
 
       class CallReason < Telnyx::Internal::Type::BaseModel
         # @!attribute reason

data/lib/telnyx/models/dir_bpo_loa_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Dir#bpo_loa
+    class DirBpoLoaParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute dir_id
+      #
+      #   @return [String]
+      required :dir_id, String
+
+      # @!attribute bpo_enterprise_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.
+      #
+      #   @return [String]
+      required :bpo_enterprise_id, String
+
+      # @!attribute signature
+      #   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.
+      #
+      #   @return [Telnyx::Models::SignaturePayload, nil]
+      optional :signature, -> { Telnyx::SignaturePayload }
+
+      # @!method initialize(dir_id:, bpo_enterprise_id:, signature: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DirBpoLoaParams} for more details.
+      #
+      #   @param dir_id [String]
+      #
+      #   @param bpo_enterprise_id [String] The approved BPO enterprise the Brand Owner is authorizing. Must be a BPO accoun
+      #
+      #   @param signature [Telnyx::Models::SignaturePayload] Optional. When provided the rendered PDF embeds the signature image, printed nam
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/dir_delete_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Dir#delete
+    class DirDeleteResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::DirDeleteResponse::Data]
+      required :data, -> { Telnyx::Models::DirDeleteResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::DirDeleteResponse::Data]
+
+      # @see Telnyx::Models::DirDeleteResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Id of the DIR whose deletion was requested.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   Always `delete_requested`: the DIR has been queued for removal, not yet removed.
+        #
+        #   @return [Symbol, Telnyx::Models::DirDeleteResponse::Data::Status]
+        required :status, enum: -> { Telnyx::Models::DirDeleteResponse::Data::Status }
+
+        # @!method initialize(id:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::DirDeleteResponse::Data} for more details.
+        #
+        #   @param id [String] Id of the DIR whose deletion was requested.
+        #
+        #   @param status [Symbol, Telnyx::Models::DirDeleteResponse::Data::Status] Always `delete_requested`: the DIR has been queued for removal, not yet removed.
+
+        # Always `delete_requested`: the DIR has been queued for removal, not yet removed.
+        #
+        # @see Telnyx::Models::DirDeleteResponse::Data#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          DELETE_REQUESTED = :delete_requested
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir_new_loa_params.rb

@@ -20,8 +20,9 @@ module Telnyx
       required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]
 
       # @!attribute agent
-      #   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.
       #
       #   @return [Telnyx::Models::Enterprises::Reputation::AgentInput, nil]
       optional :agent, -> { Telnyx::Enterprises::Reputation::AgentInput }
@@ -31,8 +32,8 @@ module Telnyx
       #   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.
       #
-      #   @return [Telnyx::Models::DirNewLoaParams::Signature, nil]
-      optional :signature, -> { Telnyx::DirNewLoaParams::Signature }
+      #   @return [Telnyx::Models::SignaturePayload, nil]
+      optional :signature, -> { Telnyx::SignaturePayload }
 
       # @!method initialize(dir_id:, phone_numbers:, agent: nil, signature: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
@@ -42,38 +43,11 @@ module Telnyx
       #
       #   @param phone_numbers [Array<String>] Telephone numbers to authorize on the DIR, in `+E164` format (`+` followed by 10
       #
-      #   @param agent [Telnyx::Models::Enterprises::Reputation::AgentInput] Third-party reseller / partner managing the enterprise's phone numbers. Omit whe
+      #   @param agent [Telnyx::Models::Enterprises::Reputation::AgentInput] Third-party reseller / partner managing the enterprise's phone numbers on its be
       #
-      #   @param signature [Telnyx::Models::DirNewLoaParams::Signature] Optional. When provided the rendered PDF embeds the signature image, printed nam
+      #   @param signature [Telnyx::Models::SignaturePayload] Optional. When provided the rendered PDF embeds the signature image, printed nam
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-      class Signature < Telnyx::Internal::Type::BaseModel
-        # @!attribute image_base64
-        #   PNG image, base64-encoded.
-        #
-        #   @return [String]
-        required :image_base64, String
-
-        # @!attribute signer_name
-        #   Optional. When absent the rendered PDF falls back to the enterprise contact's
-        #   legal name.
-        #
-        #   @return [String, nil]
-        optional :signer_name, String, nil?: true
-
-        # @!method initialize(image_base64:, signer_name: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::DirNewLoaParams::Signature} for more details.
-        #
-        #   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.
-        #
-        #   @param image_base64 [String] PNG image, base64-encoded.
-        #
-        #   @param signer_name [String, nil] Optional. When absent the rendered PDF falls back to the enterprise contact's le
-      end
     end
   end
 end

data/lib/telnyx/models/dir_retrieve_bpo_authorizations_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Dir#retrieve_bpo_authorizations
+    class DirRetrieveBpoAuthorizationsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute dir_id
+      #
+      #   @return [String]
+      required :dir_id, String
+
+      # @!attribute page_number
+      #   1-based page number. Out-of-range values return an empty page with correct meta.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Items per page. Maximum 250; values above are clamped to 250.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(dir_id:, page_number: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DirRetrieveBpoAuthorizationsParams} for more details.
+      #
+      #   @param dir_id [String]
+      #
+      #   @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
+      #
+      #   @param page_size [Integer] Items per page. Maximum 250; values above are clamped to 250.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/dir_retrieve_bpo_authorizations_response.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::Dir#retrieve_bpo_authorizations
+    class DirRetrieveBpoAuthorizationsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data>]
+      required :data,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data] }
+
+      # @!attribute meta
+      #   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.
+      #
+      #   @return [Telnyx::Models::BrandedCallingPaginationMeta]
+      required :meta, -> { Telnyx::BrandedCallingPaginationMeta }
+
+      # @!method initialize(data:, meta:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::DirRetrieveBpoAuthorizationsResponse} for more details.
+      #
+      #   Paginated list of a DIR's BPO authorizations.
+      #
+      #   @param data [Array<Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data>]
+      #
+      #   @param meta [Telnyx::Models::BrandedCallingPaginationMeta] JSON:API pagination metadata returned with every paginated list response. Page n
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute bpo_enterprise_id
+        #   The authorized BPO account's enterprise id.
+        #
+        #   @return [String]
+        required :bpo_enterprise_id, String
+
+        # @!attribute loa_document_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.
+        #
+        #   @return [String]
+        required :loa_document_id, String
+
+        # @!attribute status
+        #   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.
+        #
+        #   @return [Symbol, Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status]
+        required :status, enum: -> { Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status }
+
+        # @!attribute rejection_reason
+        #   Why the authorization was rejected. `null` unless `status` is `rejected`.
+        #
+        #   @return [String, nil]
+        optional :rejection_reason, String, nil?: true
+
+        response_only do
+          # @!attribute record_type
+          #   Always `bpo_authorization`.
+          #
+          #   @return [Symbol, Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType]
+          required :record_type, enum: -> { Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType }
+        end
+
+        # @!method initialize(bpo_enterprise_id:, loa_document_id:, record_type:, status:, rejection_reason: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data} for more details.
+        #
+        #   A single authorization of a BPO (Business Process Outsourcer) account on a DIR.
+        #
+        #   @param bpo_enterprise_id [String] The authorized BPO account's enterprise id.
+        #
+        #   @param loa_document_id [String] Id of the signed Letter of Authorization document submitted for this BPO. Send i
+        #
+        #   @param record_type [Symbol, Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::RecordType] Always `bpo_authorization`.
+        #
+        #   @param status [Symbol, Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data::Status] Review state of this authorization. `pending` when the authorization is first ad
+        #
+        #   @param rejection_reason [String, nil] Why the authorization was rejected. `null` unless `status` is `rejected`.
+
+        # Always `bpo_authorization`.
+        #
+        # @see Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          BPO_AUTHORIZATION = :bpo_authorization
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        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.
+        #
+        # @see Telnyx::Models::DirRetrieveBpoAuthorizationsResponse::Data#status
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          PENDING = :pending
+          APPROVED = :approved
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/dir_status.rb

@@ -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
 
@@ -29,6 +33,7 @@ module Telnyx
       EXPIRED = :expired
       INFRINGEMENT_CLAIMED = :infringement_claimed
       PERMANENTLY_REJECTED = :permanently_rejected
+      DELETE_REQUESTED = :delete_requested
 
       # @!method self.values
       #   @return [Array<Symbol>]

data/lib/telnyx/models/dir_update_infringement_params.rb

@@ -26,7 +26,8 @@ module Telnyx
       required :certify_ip_ownership, enum: -> { Telnyx::DirUpdateInfringementParams::CertifyIPOwnership }
 
       # @!attribute certify_no_infringement
-      #   Must be `true`.
+      #   Check to certify that the brand no longer infringes anyone else's trademark or
+      #   intellectual property.
       #
       #   @return [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyNoInfringement]
       required :certify_no_infringement, enum: -> { Telnyx::DirUpdateInfringementParams::CertifyNoInfringement }
@@ -50,6 +51,8 @@ module Telnyx
       optional :call_reasons, Telnyx::Internal::Type::ArrayOf[String], nil?: true
 
       # @!attribute display_name
+      #   The business name shown to call recipients, 1 to 35 characters, no emoji, not
+      #   blank.
       #
       #   @return [String, nil]
       optional :display_name, String, nil?: true
@@ -77,7 +80,7 @@ module Telnyx
       #
       #   @param certify_ip_ownership [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyIPOwnership] Must be `true`.
       #
-      #   @param certify_no_infringement [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyNoInfringement] Must be `true`.
+      #   @param certify_no_infringement [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyNoInfringement] Check to certify that the brand no longer infringes anyone else's trademark or i
       #
       #   @param certify_no_shaft_content [Boolean, Telnyx::Models::DirUpdateInfringementParams::CertifyNoShaftContent] Must be `true`.
       #
@@ -85,7 +88,7 @@ module Telnyx
       #
       #   @param call_reasons [Array<String>, nil]
       #
-      #   @param display_name [String, nil]
+      #   @param display_name [String, nil] The business name shown to call recipients, 1 to 35 characters, no emoji, not bl
       #
       #   @param documents [Array<Telnyx::Models::Document>, nil] Append-only supporting documents to attach while resolving the claim (e.g. autho
       #
@@ -113,7 +116,8 @@ module Telnyx
         #   @return [Array<Boolean>]
       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