telnyx 5.171.0 → 5.173.0

data/lib/telnyx/resources/browser_sessions/actions.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class BrowserSessions
+      # Execute browser actions: navigate, observe, click, fill, select, press, scroll,
+      # wait_for, screenshot, batch.
+      class Actions
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::BrowserSessions::ActionCreateParams} for more details.
+        #
+        # Executes a browser action on the session. Returns 200 if completed within
+        # wait_seconds, 202 if still in-flight.
+        #
+        # Action types: navigate, observe, click, fill, select, press, scroll, wait_for,
+        # screenshot, batch.
+        #
+        # @overload create(id, body:, wait_seconds: nil, request_options: {})
+        #
+        # @param id [String] Path param
+        #
+        # @param body [Telnyx::Models::BrowserSessions::NavigateAction, Telnyx::Models::BrowserSessions::ObserveAction, Telnyx::Models::BrowserSessions::ClickAction, Telnyx::Models::BrowserSessions::FillAction, Telnyx::Models::BrowserSessions::SelectAction, Telnyx::Models::BrowserSessions::PressAction, Telnyx::Models::BrowserSessions::ScrollAction, Telnyx::Models::BrowserSessions::ScreenshotAction, Telnyx::Models::BrowserSessions::WaitForAction, Telnyx::Models::BrowserSessions::ActionCreateParams::Body::BatchAction] Body param: Discriminated union on type. Variants are strict: unknown fields are
+        #
+        # @param wait_seconds [Integer] Query param: Maximum seconds the submission request waits for completion, not an
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::BrowserSessions::ActionCreateResponse]
+        #
+        # @see Telnyx::Models::BrowserSessions::ActionCreateParams
+        def create(id, params)
+          parsed, options = Telnyx::BrowserSessions::ActionCreateParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed.except(:body))
+          @client.request(
+            method: :post,
+            path: ["browser_sessions/%1$s/actions", id],
+            query: query,
+            body: parsed[:body],
+            model: Telnyx::Models::BrowserSessions::ActionCreateResponse,
+            options: options
+          )
+        end
+
+        # Returns the stored status and result of an action. Use this to poll actions that
+        # returned 202; HTTP 200 can contain any action status. Stored observations
+        # contain metadata with empty tree and refs, not the full snapshot; submit a fresh
+        # observe action to obtain current refs.
+        #
+        # @overload retrieve(action_id, id:, request_options: {})
+        #
+        # @param action_id [String]
+        # @param id [String]
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::BrowserSessions::ActionRetrieveResponse]
+        #
+        # @see Telnyx::Models::BrowserSessions::ActionRetrieveParams
+        def retrieve(action_id, params)
+          parsed, options = Telnyx::BrowserSessions::ActionRetrieveParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["browser_sessions/%1$s/actions/%2$s", id, action_id],
+            model: Telnyx::Models::BrowserSessions::ActionRetrieveResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/browser_sessions.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class BrowserSessions
+      # Execute browser actions: navigate, observe, click, fill, select, press, scroll,
+      # wait_for, screenshot, batch.
+      # @return [Telnyx::Resources::BrowserSessions::Actions]
+      attr_reader :actions
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::BrowserSessionCreateParams} for more details.
+      #
+      # Creates an isolated browser session with network access restricted to the
+      # domains you allow.
+      #
+      # @overload create(policy:, idempotency_key: nil, limits: nil, metadata: nil, request_options: {})
+      #
+      # @param policy [Telnyx::Models::BrowserSessionCreateParams::Policy]
+      #
+      # @param idempotency_key [String] Scoped to the organization. The same key and identical normalized policy, limits
+      #
+      # @param limits [Telnyx::Models::BrowserSessionCreateParams::Limits]
+      #
+      # @param metadata [Object] Arbitrary key-value metadata.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::BrowserSessionCreateResponse]
+      #
+      # @see Telnyx::Models::BrowserSessionCreateParams
+      def create(params)
+        parsed, options = Telnyx::BrowserSessionCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "browser_sessions",
+          body: parsed,
+          model: Telnyx::Models::BrowserSessionCreateResponse,
+          options: options
+        )
+      end
+
+      # Returns the current status of a browser session.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::BrowserSessionRetrieveResponse]
+      #
+      # @see Telnyx::Models::BrowserSessionRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["browser_sessions/%1$s", id],
+          model: Telnyx::Models::BrowserSessionRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists sessions for the authenticated org. Optional status filter.
+      #
+      # @overload list(status: nil, request_options: {})
+      #
+      # @param status [Symbol, Telnyx::Models::BrowserSessionListParams::Status]
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::BrowserSessionListResponse]
+      #
+      # @see Telnyx::Models::BrowserSessionListParams
+      def list(params = {})
+        parsed, options = Telnyx::BrowserSessionListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "browser_sessions",
+          query: query,
+          model: Telnyx::Models::BrowserSessionListResponse,
+          options: options
+        )
+      end
+
+      # Closes a ready session and releases its resources. An already closed, failed, or
+      # expired session is returned unchanged; a provisioning session returns 409
+      # session_not_ready.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::BrowserSessionDeleteResponse]
+      #
+      # @see Telnyx::Models::BrowserSessionDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["browser_sessions/%1$s", id],
+          model: Telnyx::Models::BrowserSessionDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Returns artifact metadata and a signed download URL. The download URL requires
+      # Bearer auth.
+      #
+      # @overload retrieve_artifact(artifact_id, id:, request_options: {})
+      #
+      # @param artifact_id [String]
+      # @param id [String]
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::BrowserSessionRetrieveArtifactResponse]
+      #
+      # @see Telnyx::Models::BrowserSessionRetrieveArtifactParams
+      def retrieve_artifact(artifact_id, params)
+        parsed, options = Telnyx::BrowserSessionRetrieveArtifactParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["browser_sessions/%1$s/artifacts/%2$s", id, artifact_id],
+          model: Telnyx::Models::BrowserSessionRetrieveArtifactResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @actions = Telnyx::Resources::BrowserSessions::Actions.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/calls/actions.rb

@@ -539,7 +539,7 @@ module Telnyx
         # - `call.hangup`
         # - `call.recording.saved`
         #
-        # @overload hangup(call_control_id, client_state: nil, command_id: nil, custom_headers: nil, request_options: {})
+        # @overload hangup(call_control_id, client_state: nil, command_id: nil, custom_headers: nil, reason: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -549,6 +549,8 @@ module Telnyx
         #
         # @param custom_headers [Array<Telnyx::Models::CustomSipHeader>] Custom headers to be added to the SIP BYE message.
         #
+        # @param reason [String] Text for the SIP `Reason` header (RFC 3326) sent when cancelling an unanswered o
+        #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Telnyx::Models::Calls::ActionHangupResponse]

data/lib/telnyx/resources/compute/funcs/export.rb

@@ -4,6 +4,7 @@ module Telnyx
   module Resources
     class Compute
       class Funcs
+        # Manage Edge Compute functions
         class Export
           # Some parameter documentations has been truncated, see
           # {Telnyx::Models::Compute::Funcs::ExportCreateParams} for more details.

data/lib/telnyx/resources/compute/funcs.rb

@@ -3,10 +3,41 @@
 module Telnyx
   module Resources
     class Compute
+      # Manage Edge Compute functions
       class Funcs
+        # Manage Edge Compute functions
         # @return [Telnyx::Resources::Compute::Funcs::Export]
         attr_reader :export
 
+        # List functions for the authenticated organization. Each function includes its
+        # persisted function-scoped bindings. Actor bindings expose actor_type and
+        # env_name, allowing clients to identify every function attached to a Stateful
+        # Actor type.
+        #
+        # @overload list(page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param page_number [Integer] Page number
+        #
+        # @param page_size [Integer] Page size (maximum 250)
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Compute::FuncListResponse>]
+        #
+        # @see Telnyx::Models::Compute::FuncListParams
+        def list(params = {})
+          parsed, options = Telnyx::Compute::FuncListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "compute/funcs",
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::Models::Compute::FuncListResponse,
+            options: options
+          )
+        end
+
         # Returns logs oldest first. `type=runtime` (default) returns function
         # stdout/stderr. `type=invocations` returns one platform-generated record per HTTP
         # request served.

data/lib/telnyx/resources/compute.rb

@@ -2,10 +2,34 @@
 
 module Telnyx
   module Resources
+    # Inspect Stateful Actor types
     class Compute
+      # Manage Edge Compute functions
       # @return [Telnyx::Resources::Compute::Funcs]
       attr_reader :funcs
 
+      # Retrieve one account-scoped Stateful Actor type. owner_function_id identifies
+      # the function that owns and ships the actor class; other functions may reference
+      # the same actor type through actor bindings.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Actor type ID
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::ComputeRetrieveResponse]
+      #
+      # @see Telnyx::Models::ComputeRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["compute/actors/%1$s", id],
+          model: Telnyx::Models::ComputeRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Telnyx::Client]

data/lib/telnyx/resources/credential_connections.rb

@@ -14,7 +14,7 @@ module Telnyx
       # Creates a new credential-based SIP connection. Credential connections
       # authenticate with a username and password rather than by IP address.
       #
-      # @overload create(connection_name:, password:, user_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @overload create(connection_name:, password:, user_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
       # @param connection_name [String] A user-assigned name to help manage the connection.
       #
@@ -28,6 +28,8 @@ module Telnyx
       #
       # @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      # @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       # @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       # @param default_on_hold_comfort_noise_enabled [Boolean] When enabled, Telnyx will generate comfort noise when you place the call on hold
@@ -36,7 +38,7 @@ module Telnyx
       #
       # @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       # @param inbound [Telnyx::Models::CredentialInbound]
       #
@@ -107,7 +109,7 @@ module Telnyx
       #
       # Updates settings of an existing credential connection.
       #
-      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
       # @param id [String] Identifies the resource.
       #
@@ -117,6 +119,8 @@ module Telnyx
       #
       # @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      # @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       # @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       # @param connection_name [String] A user-assigned name to help manage the connection.
@@ -129,7 +133,7 @@ module Telnyx
       #
       # @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       # @param inbound [Telnyx::Models::CredentialInbound]
       #

data/lib/telnyx/resources/dial_metrics.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Call information
+    class DialMetrics
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::DialMetricListParams} for more details.
+      #
+      # Returns dials-per-second (DPS) metrics for your account's outbound dials made
+      # with the Call Control `Dial` command and TeXML, as time buckets with dial
+      # counts, accepted and rejected dials, average and peak DPS, and the DPS limit in
+      # force.
+      #
+      # The result has one record per region per bucket, ordered by `start_time` and
+      # then `region`, newest first unless `sort=start_time`. Regions are never summed:
+      # the DPS limit is enforced per region, so a cross-region total cannot be compared
+      # with it.
+      #
+      # Only buckets that saw dials are returned. Treat a missing bucket as zero dials.
+      #
+      # Only complete 5-second windows are counted, and a window is counted about 15
+      # seconds after it closes. The newest `granularity=second` record is therefore
+      # your live DPS, about 20 seconds old. Request the last minute or two with
+      # `sort=-start_time`; the first record of each `region` is that region's live rate
+      # (`page[limit]=1` would hide every region but one). If no recent record exists,
+      # the live rate is zero.
+      #
+      # Results are cursor paginated. Follow `meta.next`, or pass `meta.cursors.after`
+      # as `page[after]`, until `meta.next` is absent. No total count is returned.
+      #
+      # This endpoint is in development and can change before general availability.
+      #
+      # @overload list(end_time:, granularity:, start_time:, page_after: nil, page_limit: nil, sort: nil, request_options: {})
+      #
+      # @param end_time [Time] Exclusive end of the range, ISO 8601. Must be after `start_time`. Buckets that s
+      #
+      # @param granularity [Symbol, Telnyx::Models::DialMetricListParams::Granularity] Bucket size. `second` returns 5-second buckets (the finest resolution) and is ke
+      #
+      # @param start_time [Time] Inclusive start of the range, ISO 8601 (for example `2026-09-29T12:00:00.000Z`).
+      #
+      # @param page_after [String] Opaque cursor from `meta.cursors.after` of the previous page. Do not parse or co
+      #
+      # @param page_limit [Integer] Maximum number of buckets per page. Values outside the range are clamped to 1-10
+      #
+      # @param sort [Symbol, Telnyx::Models::DialMetricListParams::Sort] Sort order of the buckets by `start_time`. `-start_time` (default) returns the n
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Internal::CloudfsCursorPagination<Telnyx::Models::DialMetricListResponse>]
+      #
+      # @see Telnyx::Models::DialMetricListParams
+      def list(params)
+        parsed, options = Telnyx::DialMetricListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "dial_metrics",
+          query: query.transform_keys(page_after: "page[after]", page_limit: "page[limit]"),
+          page: Telnyx::Internal::CloudfsCursorPagination,
+          model: Telnyx::Models::DialMetricListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/telnyx/resources/dir/references.rb

@@ -6,27 +6,38 @@ module Telnyx
       # Submit and manage the two business references and one financial reference that
       # vouch for a DIR. References are contacted to confirm the business identity
       # during vetting.
+      #
+      # References (two business references and one financial reference) are needed only
+      # if the documents uploaded with the DIR don't already prove the business is
+      # legitimate and financially stable. Any one of these is enough proof: audited or
+      # certified financial statements (uploaded as `other`, with a description), a
+      # commercial credit report (uploaded as `business_credit_report`), or references.
+      # Telnyx reviewers decide during vetting whether your documents are enough.
       class References
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Dir::ReferenceCreateParams} for more details.
         #
         # Submit the two business references and one financial reference for a DIR.
         #
-        # The DIR's authorizer email must be verified first (see the email-verification
-        # endpoint). Until it is, this returns `409` and no references are stored.
+        # References (two business references and one financial reference) are needed only
+        # if the documents uploaded with the DIR don't already prove the business is
+        # legitimate and financially stable. Any one of these is enough proof: audited or
+        # certified financial statements (uploaded as `other`, with a description), a
+        # commercial credit report (uploaded as `business_credit_report`), or references.
+        # Telnyx reviewers decide during vetting whether your documents are enough.
+        #
+        # References can't be changed while the DIR is `verified`. Update the DIR first,
+        # which returns it to draft.
         #
         # The request body carries exactly two business references plus one financial
         # reference. The first submission stores them and returns `201`. Resubmitting
         # returns `200`: identical values are simply confirmed and nothing is written,
         # while changed values replace those references.
         #
-        # Replacing a reference is allowed only while the DIR itself is still editable,
-        # the same window in which a single reference may be updated; once the DIR has
-        # been submitted for vetting this returns `400`. A replaced reference's pending
-        # verification call is cancelled and its dial-in code stops working, and the
-        # replacement contact is emailed fresh scheduling details. References whose
-        # details did not change keep their existing call, code, and the notice already
-        # sent to them.
+        # A replaced reference's pending verification call is cancelled and its dial-in
+        # code stops working, and the replacement contact is emailed fresh scheduling
+        # details. References whose details did not change keep their existing call, code,
+        # and the notice already sent to them.
         #
         # The response always echoes the stored references in the same shape as the GET.
         #

data/lib/telnyx/resources/dir/verify_email.rb

@@ -4,14 +4,26 @@ module Telnyx
   module Resources
     class Dir
       # Verify ownership of a DIR's authorizer email. A short code is emailed and
-      # confirmed; the email must be verified before references can be submitted.
+      # confirmed.
       class VerifyEmail
         # Email a 6-digit code to the DIR's authorizer email to confirm ownership of that
-        # address.
-        #
-        # The code expires in 15 minutes. Requesting a new code invalidates any previous
-        # one. Resends are rate limited (a short cooldown plus a daily cap). Submit the
-        # code to `POST /dir/{dir_id}/verify_email/confirm`.
+        # address. The code goes to the authorizer, not to the caller. If the authorizer
+        # is someone else (for example a client's executive), that person has to share the
+        # code with whoever is completing setup.
+        #
+        # How long the code lasts: 15 minutes by default. 8 hours when the DIR has a call
+        # center (BPO) linked through `bpo_authorizations` whose authorization is pending
+        # review or approved (a rejected authorization does not count). Link the call
+        # center before you send the code: a code sent before the link keeps the 15-minute
+        # window, and a code sent after the link lasts 8 hours. The email states the
+        # window, and `expires_at` in the response always shows the exact expiry.
+        #
+        # To resend, call this endpoint again. Each send issues a fresh code and
+        # invalidates the previous one. Sends are limited to one every 60 seconds and 10
+        # per DIR per UTC day. A throttled send returns `429` with `retry_after_secs` and
+        # `sends_remaining_today` in the error `meta`.
+        #
+        # Submit the code to `POST /dir/{dir_id}/verify_email/confirm`.
         #
         # @overload create(dir_id, request_options: {})
         #

data/lib/telnyx/resources/dir.rb

@@ -21,11 +21,18 @@ module Telnyx
       # Submit and manage the two business references and one financial reference that
       # vouch for a DIR. References are contacted to confirm the business identity
       # during vetting.
+      #
+      # References (two business references and one financial reference) are needed only
+      # if the documents uploaded with the DIR don't already prove the business is
+      # legitimate and financially stable. Any one of these is enough proof: audited or
+      # certified financial statements (uploaded as `other`, with a description), a
+      # commercial credit report (uploaded as `business_credit_report`), or references.
+      # Telnyx reviewers decide during vetting whether your documents are enough.
       # @return [Telnyx::Resources::Dir::References]
       attr_reader :references
 
       # Verify ownership of a DIR's authorizer email. A short code is emailed and
-      # confirmed; the email must be verified before references can be submitted.
+      # confirmed.
       # @return [Telnyx::Resources::Dir::VerifyEmail]
       attr_reader :verify_email
 
@@ -382,8 +389,7 @@ module Telnyx
       # existing registration stays live throughout the new vetting cycle.
       #
       # Returns `400` from `submitted`/`in_review`/`permanently_rejected`. Returns `400`
-      # if the DIR's business and financial references have not been submitted. Returns
-      # `400` if the DIR has an unresolved infringement claim.
+      # if the DIR has an unresolved infringement claim.
       #
       # @overload submit(dir_id, request_options: {})
       #