telnyx 7.24.0 → 7.26.0

package/src/resources/calls/calls.ts

@@ -93,6 +93,7 @@ import {
   CallControlCommandResult,
   CallControlCommandResultWithConversationID,
   ConversationRelayInterruptible,
+  ConversationRelayTranscriptionEngineConfig,
   DeepgramNova2Config,
   DeepgramNova3Config,
   DeveloperMessage,
@@ -138,10 +139,18 @@ export class Calls extends APIResource {
    * include a `call_leg_id` which can be used to correlate the command with
    * subsequent webhooks.
    *
+   * To place the call with an AI assistant from the start, include `assistant.id`
+   * and any per-call overrides in the `assistant` object; Telnyx attempts to warm up
+   * the assistant before placing the call and starts it automatically when the
+   * called party answers.
+   *
    * **Expected Webhooks:**
    *
    * - `call.initiated`
    * - `call.answered` or `call.hangup`
+   * - `call.conversation.created` when the requested assistant conversation is
+   *   created, or `call.conversation.start_failed` when it could not be started
+   *   after the called party answered
    * - `call.hold` and `call.unhold` if the call is held/unheld
    * - `call.machine.detection.ended` if `answering_machine_detection` was requested
    * - `call.machine.greeting.ended` if `answering_machine_detection` was requested
@@ -150,6 +159,9 @@ export class Calls extends APIResource {
    *   `answering_machine_detection=premium` was requested
    * - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium`
    *   was requested and a beep was detected
+   * - `call.machine.premium.call_screening.detected` if
+   *   `answering_machine_detection=premium_ios_call_screening_detection` was
+   *   requested and an Apple Call Screening tone was detected
    * - `call.deepfake_detection.result` if `deepfake_detection` was enabled
    * - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
    *   error occurred
@@ -188,9 +200,11 @@ export class Calls extends APIResource {
 }
 
 /**
- * AI Assistant configuration. All fields except `id` are optional — the
- * assistant's stored configuration will be used as fallback for any omitted
- * fields.
+ * AI Assistant configuration and per-call overrides. All fields except `id` are
+ * optional. Omitted assistant fields use the stored configuration. Supplied
+ * `voice_settings` and `transcription` objects replace their stored objects rather
+ * than merging individual settings; include every setting you want to retain.
+ * `dynamic_variables` are merged, with request values taking precedence.
  */
 export interface CallAssistantRequest {
   /**
@@ -282,6 +296,19 @@ export interface CallAssistantRequest {
     | Shared.CallControlRetrievalTool
   >;
 
+  /**
+   * Per-call speech-to-text configuration for the assistant. If omitted, the stored
+   * assistant transcription configuration is used. If supplied, this object replaces
+   * the stored transcription settings. This is separate from the top-level
+   * `transcription` boolean on answer and dial commands.
+   */
+  transcription?: ActionsAPI.TranscriptionConfig;
+
+  /**
+   * Per-call voice configuration. Set the voice identifier in
+   * `voice_settings.voice`, not in `assistant.voice`. If supplied, this object
+   * replaces the stored voice settings.
+   */
   voice_settings?: AssistantsAPI.VoiceSettings;
 }
 
@@ -498,9 +525,12 @@ export interface ConversationRelayEmbeddedConfig {
    * 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.
    */
-  transcription_engine_config?: { [key: string]: unknown };
+  transcription_engine_config?: ActionsAPI.ConversationRelayTranscriptionEngineConfig;
 
   /**
    * Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
@@ -519,10 +549,10 @@ export interface ConversationRelayEmbeddedConfig {
    *   the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
    *   [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
    *   for compatibility.
-   * - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
-   *   Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
-   *   Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
-   *   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
+   * - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
+   *   `Azure.en-CA-LiamNeural`, `Azure.en-US-BrianMultilingualNeural`,
+   *   `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
+   *   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).
    * - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
    *   `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
    *   ElevenLabs, you must provide your ElevenLabs API key as an integration secret
@@ -637,9 +667,12 @@ export interface ConversationRelayLanguage {
    * 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.
    */
-  transcription_engine_config?: { [key: string]: unknown };
+  transcription_engine_config?: ActionsAPI.ConversationRelayTranscriptionEngineConfig;
 
   /**
    * Conversation Relay transcription provider name. Prefer `transcription_engine`
@@ -921,10 +954,20 @@ export interface CallDialParams {
    * `greeting_end` or `detect_words` is used and a `machine` is detected, you will
    * receive another `call.machine.greeting.ended` webhook when the answering machine
    * greeting ends with a beep or silence. If `detect_beep` is used, you will only
-   * receive `call.machine.greeting.ended` if a beep is detected.
+   * receive `call.machine.greeting.ended` if a beep is detected. If
+   * `answering_machine_detection` is set to `premium_ios_call_screening_detection`,
+   * Premium AMD runs with iOS Call Screening support: after an initial `machine`
+   * result, Telnyx listens for the iOS call-screening prompt to end or for an Apple
+   * Call Screening tone, sends `call.machine.premium.greeting.ended` with
+   * `result=prompt_ended` or `call.machine.premium.call_screening.detected` with
+   * `result=screening` respectively. When the Apple Call Screening tone is detected,
+   * Premium AMD is restarted on the screened call and a
+   * `call.machine.premium.detection.ended` webhook with the post-screening
+   * classification follows.
    */
   answering_machine_detection?:
     | 'premium'
+    | 'premium_ios_call_screening_detection'
     | 'detect'
     | 'detect_beep'
     | 'detect_words'
@@ -935,14 +978,17 @@ export interface CallDialParams {
    * Optional configuration parameters to modify 'answering_machine_detection'
    * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
    * parameters are applicable when `premium` is selected as
-   * answering_machine_detection.
+   * answering_machine_detection. `prompt_end_timeout_millis` is additionally
+   * applicable when `premium_ios_call_screening_detection` is selected.
    */
   answering_machine_detection_config?: CallDialParams.AnsweringMachineDetectionConfig;
 
   /**
-   * AI Assistant configuration. All fields except `id` are optional — the
-   * assistant's stored configuration will be used as fallback for any omitted
-   * fields.
+   * AI Assistant configuration and per-call overrides. All fields except `id` are
+   * optional. Omitted assistant fields use the stored configuration. Supplied
+   * `voice_settings` and `transcription` objects replace their stored objects rather
+   * than merging individual settings; include every setting you want to retain.
+   * `dynamic_variables` are merged, with request values taking precedence.
    */
   assistant?: CallAssistantRequest;
 
@@ -1329,7 +1375,8 @@ export namespace CallDialParams {
    * Optional configuration parameters to modify 'answering_machine_detection'
    * performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
    * parameters are applicable when `premium` is selected as
-   * answering_machine_detection.
+   * answering_machine_detection. `prompt_end_timeout_millis` is additionally
+   * applicable when `premium_ios_call_screening_detection` is selected.
    */
   export interface AnsweringMachineDetectionConfig {
     /**
@@ -1429,6 +1476,14 @@ export namespace CallDialParams {
      */
     maximum_word_length_millis?: number;
 
+    /**
+     * Maximum time Telnyx waits, in milliseconds, for the iOS call-screening prompt to
+     * end after Premium AMD initially detects a `machine`. Used when
+     * `answering_machine_detection` is `premium_ios_call_screening_detection`.
+     * Defaults to 5000 milliseconds.
+     */
+    prompt_end_timeout_millis?: number;
+
     /**
      * Minimum noise threshold for any analysis.
      */
@@ -1603,6 +1658,7 @@ export declare namespace Calls {
     type CallControlCommandResult as CallControlCommandResult,
     type CallControlCommandResultWithConversationID as CallControlCommandResultWithConversationID,
     type ConversationRelayInterruptible as ConversationRelayInterruptible,
+    type ConversationRelayTranscriptionEngineConfig as ConversationRelayTranscriptionEngineConfig,
     type DeepgramNova2Config as DeepgramNova2Config,
     type DeepgramNova3Config as DeepgramNova3Config,
     type DeveloperMessage as DeveloperMessage,

package/src/resources/calls/index.ts

@@ -8,6 +8,7 @@ export {
   type CallControlCommandResult,
   type CallControlCommandResultWithConversationID,
   type ConversationRelayInterruptible,
+  type ConversationRelayTranscriptionEngineConfig,
   type DeepgramNova2Config,
   type DeepgramNova3Config,
   type DeveloperMessage,

package/src/resources/dir/dir.ts

@@ -110,22 +110,23 @@ export class DirResource extends APIResource {
   }
 
   /**
-   * Delete a DIR. Failure modes: `400` if a child phone number is in a non-deletable
-   * status, `409` if the DIR has an unresolved infringement claim, `404` if the DIR
-   * is not yours.
+   * Request deletion of a DIR. This does not remove the DIR on this call: it records
+   * the request, moves the DIR to `delete_requested`, and Telnyx completes the
+   * removal (de-registration and cleanup) shortly after. A verified DIR keeps
+   * serving its branded identity, and keeps billing, until the removal is executed.
+   * Failure modes: `400` if a child phone number is still attached or the DIR is
+   * `in_review` (wait for the review to finish), `409` if the DIR has an unresolved
+   * infringement claim, `404` if the DIR is not yours.
    *
    * @example
    * ```ts
-   * await client.dir.delete(
+   * const dir = await client.dir.delete(
    *   '16635d38-75a6-4481-82e8-69af60e05011',
    * );
    * ```
    */
-  delete(dirID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/dir/${dirID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  delete(dirID: string, options?: RequestOptions): APIPromise<DirDeleteResponse> {
+    return this._client.delete(path`/dir/${dirID}`, options);
   }
 
   /**
@@ -147,11 +148,14 @@ export class DirResource extends APIResource {
    * Edit a DIR. DIRs in `draft`, `rejected`, `unsuccessful`, or `suspended` can be
    * edited freely: PATCH is a pure edit, `status` is never changed, and you re-vet
    * by calling `POST /v2/dir/{dir_id}/submit` explicitly. A `verified` DIR can also
-   * be edited in place: a PATCH that changes any value returns the DIR to `draft`
-   * and branded delivery stops until you re-submit and the DIR is approved again,
-   * while a PATCH that changes nothing (an empty body or values identical to the
-   * current ones) leaves the DIR `verified`, so idempotent retries are safe. DIRs in
-   * any other status (`submitted`, `in_review`, `expired`, `infringement_claimed`,
+   * be edited in place: a PATCH that changes any value returns the DIR to `draft`;
+   * the currently approved identity keeps displaying, and the edited content goes
+   * live only after you re-submit and the DIR is approved again. A PATCH that
+   * changes nothing (an empty body or values identical to the current ones) leaves
+   * the DIR `verified`, so idempotent retries are safe. Changing only
+   * `bpo_authorizations` or `webhook_url` is the exception: the DIR stays
+   * `verified`. Each BPO authorization is reviewed on its own instead. DIRs in any
+   * other status (`submitted`, `in_review`, `expired`, `infringement_claimed`,
    * `permanently_rejected`) cannot be edited.
    *
    * @example
@@ -245,7 +249,7 @@ export class DirResource extends APIResource {
    *
    * Returns `400` from `submitted`/`in_review`/`permanently_rejected`. Returns `400`
    * if the DIR's business and financial references have not been submitted. Returns
-   * `409` if the DIR has an unresolved infringement claim.
+   * `400` if the DIR has an unresolved infringement claim.
    *
    * @example
    * ```ts
@@ -289,10 +293,95 @@ export class DirResource extends APIResource {
       __binaryResponse: true,
     });
   }
+
+  /**
+   * List the BPO (Business Process Outsourcer) accounts a Brand Owner has authorized
+   * on this DIR, together with the review state of each authorization.
+   *
+   * Authorizations are supplied as the `bpo_authorizations` array when creating or
+   * updating a DIR, and each one is reviewed on its own. Only an `approved`
+   * authorization adds that BPO to this DIR's authorized callers in the branded
+   * calling registry; `pending` and `rejected` authorizations do not. Each entry
+   * includes the `loa_document_id` you submitted: because `bpo_authorizations`
+   * replaces the whole list on every DIR update, send each entry you want to keep
+   * back with its `loa_document_id` unchanged, and it keeps its review state. A
+   * rejected entry carries a `rejection_reason`. Returns an empty list when the DIR
+   * has authorized no BPOs.
+   *
+   * @example
+   * ```ts
+   * const response = await client.dir.retrieveBpoAuthorizations(
+   *   '16635d38-75a6-4481-82e8-69af60e05011',
+   * );
+   * ```
+   */
+  retrieveBpoAuthorizations(
+    dirID: string,
+    query: DirRetrieveBpoAuthorizationsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DirRetrieveBpoAuthorizationsResponse> {
+    return this._client.get(path`/dir/${dirID}/bpo_authorizations`, { query, ...options });
+  }
+
+  /**
+   * The Letter of Authorization in which a Brand Owner authorizes an approved BPO
+   * (Business Process Outsourcer) to place branded calls that display this DIR on
+   * the owner's behalf. Both parties are read from the caller's account: the Brand
+   * Owner is the enterprise that owns the DIR, and the BPO is `bpo_enterprise_id`.
+   * No business identity is accepted in the body.
+   *
+   * When `signature` is omitted the PDF is returned unsigned so the Brand Owner can
+   * sign it externally and the BPO can upload it via the Documents API. When
+   * `signature` is present the PDF embeds the supplied image, printed name, and
+   * signed-at date.
+   *
+   * Returns `application/pdf`.
+   *
+   * @example
+   * ```ts
+   * const response = await client.dir.bpoLoa(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     bpo_enterprise_id:
+   *       '4a6192a4-573d-446d-b3ce-aff9117272a6',
+   *   },
+   * );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
+   */
+  bpoLoa(dirID: string, body: DirBpoLoaParams, options?: RequestOptions): APIPromise<Response> {
+    return this._client.post(path`/dir/${dirID}/bpo_loa`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/pdf' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
 }
 
 export type DirsDefaultFlatPagination = DefaultFlatPagination<Dir>;
 
+/**
+ * One authorization to include when creating or updating a DIR: an approved BPO
+ * (Business Process Outsourcer) account plus the signed Letter of Authorization
+ * the Brand Owner granted it.
+ */
+export interface BpoAuthorizationInput {
+  /**
+   * Enterprise id of an approved BPO (Business Process Outsourcer) account on your
+   * organization to authorize for this DIR.
+   */
+  bpo_enterprise_id: string;
+
+  /**
+   * Id of the signed Letter of Authorization document (uploaded via the Telnyx
+   * Documents API) in which the Brand Owner authorizes this BPO.
+   */
+  loa_document_id: string;
+}
+
 export interface Dir {
   id?: string;
 
@@ -310,6 +399,12 @@ export interface Dir {
 
   created_at?: string;
 
+  /**
+   * When deletion was requested. Set once the DIR enters `delete_requested`; `null`
+   * otherwise.
+   */
+  delete_requested_at?: string | null;
+
   display_name?: string;
 
   documents?: Array<Document> | null;
@@ -345,6 +440,10 @@ export interface Dir {
    * - `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?: DirStatus;
 
@@ -353,6 +452,12 @@ export interface Dir {
   updated_at?: string;
 
   verified_at?: string | null;
+
+  /**
+   * `https://` URL that receives webhook notifications for this DIR's
+   * compliance-review outcomes. `null` when not subscribed.
+   */
+  webhook_url?: string | null;
 }
 
 export namespace Dir {
@@ -390,6 +495,10 @@ export interface DirList {
  * - `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.
  */
 export type DirStatus =
   | 'draft'
@@ -401,7 +510,8 @@ export type DirStatus =
   | 'suspended'
   | 'expired'
   | 'infringement_claimed'
-  | 'permanently_rejected';
+  | 'permanently_rejected'
+  | 'delete_requested';
 
 export interface DirWrapped {
   data: Dir;
@@ -434,9 +544,43 @@ export interface Document {
     | 'bank_statement'
     | 'other';
 
+  /**
+   * An optional note describing this document, for example what it proves.
+   */
   description?: string;
 }
 
+export interface SignaturePayload {
+  /**
+   * PNG image, base64-encoded.
+   */
+  image_base64: string;
+
+  /**
+   * Optional. When absent the rendered PDF falls back to the enterprise contact's
+   * legal name.
+   */
+  signer_name?: string | null;
+}
+
+export interface DirDeleteResponse {
+  data: DirDeleteResponse.Data;
+}
+
+export namespace DirDeleteResponse {
+  export interface Data {
+    /**
+     * Id of the DIR whose deletion was requested.
+     */
+    id: string;
+
+    /**
+     * Always `delete_requested`: the DIR has been queued for removal, not yet removed.
+     */
+    status: 'delete_requested';
+  }
+}
+
 export interface DirListDocumentTypesResponse {
   data: Array<DirListDocumentTypesResponse.Data>;
 
@@ -463,6 +607,60 @@ export namespace DirListDocumentTypesResponse {
   }
 }
 
+/**
+ * Paginated list of a DIR's BPO authorizations.
+ */
+export interface DirRetrieveBpoAuthorizationsResponse {
+  data: Array<DirRetrieveBpoAuthorizationsResponse.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: CallReasonsAPI.BrandedCallingPaginationMeta;
+}
+
+export namespace DirRetrieveBpoAuthorizationsResponse {
+  /**
+   * A single authorization of a BPO (Business Process Outsourcer) account on a DIR.
+   */
+  export interface Data {
+    /**
+     * The authorized BPO account's enterprise id.
+     */
+    bpo_enterprise_id: string;
+
+    /**
+     * 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: string;
+
+    /**
+     * Always `bpo_authorization`.
+     */
+    record_type: 'bpo_authorization';
+
+    /**
+     * 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: 'pending' | 'approved' | 'rejected';
+
+    /**
+     * Why the authorization was rejected. `null` unless `status` is `rejected`.
+     */
+    rejection_reason?: string | null;
+  }
+}
+
 export interface DirListParams extends DefaultFlatPaginationParams {
   /**
    * Case-insensitive partial match on call reason.
@@ -523,6 +721,16 @@ export interface DirUpdateParams {
    */
   authorizer_name?: string;
 
+  /**
+   * 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?: Array<BpoAuthorizationInput>;
+
   /**
    * 1–10 reasons your business calls customers. Validate phrasing against
    * `POST /call_reasons/validate`.
@@ -570,6 +778,13 @@ export interface DirUpdateParams {
    * (BPO/reseller). Updating this triggers re-vetting on next submit.
    */
   reselling?: boolean;
+
+  /**
+   * 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?: string | null;
 }
 
 export interface DirListInfringementClaimsParams extends DefaultFlatPaginationParams {}
@@ -586,7 +801,8 @@ export interface DirUpdateInfringementParams {
   certify_ip_ownership: true;
 
   /**
-   * Must be `true`.
+   * Check to certify that the brand no longer infringes anyone else's trademark or
+   * intellectual property.
    */
   certify_no_infringement: true;
 
@@ -602,6 +818,10 @@ export interface DirUpdateInfringementParams {
 
   call_reasons?: Array<string> | null;
 
+  /**
+   * The business name shown to call recipients, 1 to 35 characters, no emoji, not
+   * blank.
+   */
   display_name?: string | null;
 
   /**
@@ -624,8 +844,9 @@ export interface DirNewLoaParams {
   phone_numbers: Array<string>;
 
   /**
-   * 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?: LoaAPI.AgentInput;
 
@@ -634,27 +855,34 @@ export interface DirNewLoaParams {
    * 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.
    */
-  signature?: DirNewLoaParams.Signature;
+  signature?: SignaturePayload;
 }
 
-export namespace DirNewLoaParams {
+export interface DirRetrieveBpoAuthorizationsParams {
   /**
-   * 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.
+   * 1-based page number. Out-of-range values return an empty page with correct meta.
    */
-  export interface Signature {
-    /**
-     * PNG image, base64-encoded.
-     */
-    image_base64: string;
+  'page[number]'?: number;
 
-    /**
-     * Optional. When absent the rendered PDF falls back to the enterprise contact's
-     * legal name.
-     */
-    signer_name?: string | null;
-  }
+  /**
+   * Items per page. Maximum 250; values above are clamped to 250.
+   */
+  'page[size]'?: number;
+}
+
+export interface DirBpoLoaParams {
+  /**
+   * 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: string;
+
+  /**
+   * 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?: SignaturePayload;
 }
 
 DirResource.Comments = Comments;
@@ -665,18 +893,24 @@ DirResource.VerifyEmail = VerifyEmail;
 
 export declare namespace DirResource {
   export {
+    type BpoAuthorizationInput as BpoAuthorizationInput,
     type Dir as Dir,
     type DirList as DirList,
     type DirStatus as DirStatus,
     type DirWrapped as DirWrapped,
     type Document as Document,
+    type SignaturePayload as SignaturePayload,
+    type DirDeleteResponse as DirDeleteResponse,
     type DirListDocumentTypesResponse as DirListDocumentTypesResponse,
+    type DirRetrieveBpoAuthorizationsResponse as DirRetrieveBpoAuthorizationsResponse,
     type DirsDefaultFlatPagination as DirsDefaultFlatPagination,
     type DirListParams as DirListParams,
     type DirUpdateParams as DirUpdateParams,
     type DirListInfringementClaimsParams as DirListInfringementClaimsParams,
     type DirUpdateInfringementParams as DirUpdateInfringementParams,
     type DirNewLoaParams as DirNewLoaParams,
+    type DirRetrieveBpoAuthorizationsParams as DirRetrieveBpoAuthorizationsParams,
+    type DirBpoLoaParams as DirBpoLoaParams,
   };
 
   export {

package/src/resources/dir/index.ts

@@ -11,17 +11,23 @@ export {
 } from './comments';
 export {
   DirResource,
+  type BpoAuthorizationInput,
   type Dir,
   type DirList,
   type DirStatus,
   type DirWrapped,
   type Document,
+  type SignaturePayload,
+  type DirDeleteResponse,
   type DirListDocumentTypesResponse,
+  type DirRetrieveBpoAuthorizationsResponse,
   type DirListParams,
   type DirUpdateParams,
   type DirListInfringementClaimsParams,
   type DirUpdateInfringementParams,
   type DirNewLoaParams,
+  type DirRetrieveBpoAuthorizationsParams,
+  type DirBpoLoaParams,
   type DirsDefaultFlatPagination,
 } from './dir';
 export {