telnyx 7.3.0 → 7.5.0

package/src/resources/dir/dir.ts

@@ -64,53 +64,6 @@ export class DirResource extends APIResource {
   references: ReferencesAPI.References = new ReferencesAPI.References(this._client);
   verifyEmail: VerifyEmailAPI.VerifyEmail = new VerifyEmailAPI.VerifyEmail(this._client);
 
-  /**
-   * Returns a single DIR by id. The enterprise is resolved server-side from the DIR
-   * id. Returns `404` if the DIR does not exist or is not yours.
-   *
-   * @example
-   * ```ts
-   * const dirWrapped = await client.dir.retrieve(
-   *   '16635d38-75a6-4481-82e8-69af60e05011',
-   * );
-   * ```
-   */
-  retrieve(dirID: string, options?: RequestOptions): APIPromise<DirWrapped> {
-    return this._client.get(path`/dir/${dirID}`, options);
-  }
-
-  /**
-   * 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`,
-   * `permanently_rejected`) cannot be edited.
-   *
-   * @example
-   * ```ts
-   * const dirWrapped = await client.dir.update(
-   *   '16635d38-75a6-4481-82e8-69af60e05011',
-   *   {
-   *     call_reasons: [
-   *       'Appointment reminders',
-   *       'Billing inquiries',
-   *       'Lab results',
-   *     ],
-   *     display_name: 'Acme Plumbing & Wellness',
-   *     logo_url:
-   *       'https://acmeplumbing.example.com/logo-v2-256.bmp',
-   *   },
-   * );
-   * ```
-   */
-  update(dirID: string, body: DirUpdateParams, options?: RequestOptions): APIPromise<DirWrapped> {
-    return this._client.patch(path`/dir/${dirID}`, { body, ...options });
-  }
-
   /**
    * Returns every DIR (Display Identity Record) you own, across all of your
    * enterprises, as a single list. Pagination is JSON:API style (`page[number]`,
@@ -136,6 +89,21 @@ export class DirResource extends APIResource {
     return this._client.getAPIList('/dir', DefaultFlatPagination<Dir>, { query, ...options });
   }
 
+  /**
+   * Reference list of `document_type` values accepted by
+   * `DirCreateRequest.documents[].document_type` and the infringement-contest
+   * endpoint. Each entry has a stable `short_name` (used in API calls) and a
+   * customer-facing description.
+   *
+   * @example
+   * ```ts
+   * const response = await client.dir.listDocumentTypes();
+   * ```
+   */
+  listDocumentTypes(options?: RequestOptions): APIPromise<DirListDocumentTypesResponse> {
+    return this._client.get('/dir/document_types', options);
+  }
+
   /**
    * 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
@@ -156,18 +124,50 @@ export class DirResource extends APIResource {
   }
 
   /**
-   * Reference list of `document_type` values accepted by
-   * `DirCreateRequest.documents[].document_type` and the infringement-contest
-   * endpoint. Each entry has a stable `short_name` (used in API calls) and a
-   * customer-facing description.
+   * Returns a single DIR by id. The enterprise is resolved server-side from the DIR
+   * id. Returns `404` if the DIR does not exist or is not yours.
    *
    * @example
    * ```ts
-   * const response = await client.dir.listDocumentTypes();
+   * const dirWrapped = await client.dir.retrieve(
+   *   '16635d38-75a6-4481-82e8-69af60e05011',
+   * );
    * ```
    */
-  listDocumentTypes(options?: RequestOptions): APIPromise<DirListDocumentTypesResponse> {
-    return this._client.get('/dir/document_types', options);
+  retrieve(dirID: string, options?: RequestOptions): APIPromise<DirWrapped> {
+    return this._client.get(path`/dir/${dirID}`, options);
+  }
+
+  /**
+   * 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`,
+   * `permanently_rejected`) cannot be edited.
+   *
+   * @example
+   * ```ts
+   * const dirWrapped = await client.dir.update(
+   *   '16635d38-75a6-4481-82e8-69af60e05011',
+   *   {
+   *     call_reasons: [
+   *       'Appointment reminders',
+   *       'Billing inquiries',
+   *       'Lab results',
+   *     ],
+   *     display_name: 'Acme Plumbing & Wellness',
+   *     logo_url:
+   *       'https://acmeplumbing.example.com/logo-v2-256.bmp',
+   *   },
+   * );
+   * ```
+   */
+  update(dirID: string, body: DirUpdateParams, options?: RequestOptions): APIPromise<DirWrapped> {
+    return this._client.patch(path`/dir/${dirID}`, { body, ...options });
   }
 
   /**
@@ -201,35 +201,34 @@ export class DirResource extends APIResource {
   }
 
   /**
-   * Generate a pre-filled Letter of Authorization (LOA) PDF for a DIR. Enterprise
-   * identity (legal name, DBA, address, contact, website, tax id) and the DIR
-   * display name are read server-side; the caller supplies the telephone numbers to
-   * authorize, an optional Authorized Agent block, and an optional drawn signature.
-   *
-   * When `signature` is omitted the PDF is returned unsigned so the customer can
-   * sign it externally and 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`.
+   * Push a fix for a DIR that is `suspended` with an open infringement claim back
+   * into vetting. `POST /dir/{dir_id}/submit` is blocked while a claim is open, so
+   * this is the customer-callable path to update the DIR's content and re-certify
+   * before Telnyx adjudicates the claim. All four certification booleans must be
+   * `true`. Optional content fields (`display_name`, `logo_url`, `call_reasons`,
+   * `documents`) update the DIR; documents are append-only.
    *
    * @example
    * ```ts
-   * const response = await client.dir.newLoa(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   { phone_numbers: ['+13125550000'] },
+   * const dirWrapped = await client.dir.updateInfringement(
+   *   '16635d38-75a6-4481-82e8-69af60e05011',
+   *   {
+   *     certify_brand_is_accurate: true,
+   *     certify_ip_ownership: true,
+   *     certify_no_infringement: true,
+   *     certify_no_shaft_content: true,
+   *     infringement_resolution_notes:
+   *       'Updated the display name to remove the disputed mark and re-uploaded the authorization.',
+   *   },
    * );
-   *
-   * const content = await response.blob();
-   * console.log(content);
    * ```
    */
-  newLoa(dirID: string, body: DirNewLoaParams, options?: RequestOptions): APIPromise<Response> {
-    return this._client.post(path`/dir/${dirID}/loa`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: 'application/pdf' }, options?.headers]),
-      __binaryResponse: true,
-    });
+  updateInfringement(
+    dirID: string,
+    body: DirUpdateInfringementParams,
+    options?: RequestOptions,
+  ): APIPromise<DirWrapped> {
+    return this._client.put(path`/dir/${dirID}/infringement_update`, { body, ...options });
   }
 
   /**
@@ -254,34 +253,35 @@ export class DirResource extends APIResource {
   }
 
   /**
-   * Push a fix for a DIR that is `suspended` with an open infringement claim back
-   * into vetting. `POST /dir/{dir_id}/submit` is blocked while a claim is open, so
-   * this is the customer-callable path to update the DIR's content and re-certify
-   * before Telnyx adjudicates the claim. All four certification booleans must be
-   * `true`. Optional content fields (`display_name`, `logo_url`, `call_reasons`,
-   * `documents`) update the DIR; documents are append-only.
+   * Generate a pre-filled Letter of Authorization (LOA) PDF for a DIR. Enterprise
+   * identity (legal name, DBA, address, contact, website, tax id) and the DIR
+   * display name are read server-side; the caller supplies the telephone numbers to
+   * authorize, an optional Authorized Agent block, and an optional drawn signature.
+   *
+   * When `signature` is omitted the PDF is returned unsigned so the customer can
+   * sign it externally and 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 dirWrapped = await client.dir.updateInfringement(
-   *   '16635d38-75a6-4481-82e8-69af60e05011',
-   *   {
-   *     certify_brand_is_accurate: true,
-   *     certify_ip_ownership: true,
-   *     certify_no_infringement: true,
-   *     certify_no_shaft_content: true,
-   *     infringement_resolution_notes:
-   *       'Updated the display name to remove the disputed mark and re-uploaded the authorization.',
-   *   },
+   * const response = await client.dir.newLoa(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { phone_numbers: ['+13125550000'] },
    * );
+   *
+   * const content = await response.blob();
+   * console.log(content);
    * ```
    */
-  updateInfringement(
-    dirID: string,
-    body: DirUpdateInfringementParams,
-    options?: RequestOptions,
-  ): APIPromise<DirWrapped> {
-    return this._client.put(path`/dir/${dirID}/infringement_update`, { body, ...options });
+  newLoa(dirID: string, body: DirNewLoaParams, options?: RequestOptions): APIPromise<Response> {
+    return this._client.post(path`/dir/${dirID}/loa`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/pdf' }, options?.headers]),
+      __binaryResponse: true,
+    });
   }
 }
 
@@ -457,6 +457,53 @@ export namespace DirListDocumentTypesResponse {
   }
 }
 
+export interface DirListParams extends DefaultFlatPaginationParams {
+  /**
+   * Case-insensitive partial match on call reason.
+   */
+  'filter[call_reason][contains]'?: string;
+
+  /**
+   * Case-insensitive partial match on display name.
+   */
+  'filter[display_name][contains]'?: string;
+
+  /**
+   * Filter by enterprise ID.
+   */
+  'filter[enterprise_id]'?: string;
+
+  /**
+   * Return only DIRs whose `expiring_at` is at or after this ISO-8601 timestamp.
+   * Pairs with the `[lte]` variant to build renewal-window dashboards.
+   */
+  'filter[expiring_at][gte]'?: string;
+
+  /**
+   * Return only DIRs whose `expiring_at` is at or before this ISO-8601 timestamp.
+   */
+  'filter[expiring_at][lte]'?: string;
+
+  /**
+   * Filter by DIR status.
+   */
+  'filter[status]'?: DirStatus;
+
+  /**
+   * Sort field. Allowed values: `created_at`, `updated_at`, `display_name`,
+   * `status`. Prefix with `-` for descending. Default `-created_at`.
+   */
+  sort?:
+    | 'created_at'
+    | '-created_at'
+    | 'updated_at'
+    | '-updated_at'
+    | 'display_name'
+    | '-display_name'
+    | 'status'
+    | '-status';
+}
+
 export interface DirUpdateParams {
   /**
    * Contact email of the authorizer. Telnyx may send verification or infringement
@@ -519,55 +566,50 @@ export interface DirUpdateParams {
   reselling?: boolean;
 }
 
-export interface DirListParams extends DefaultFlatPaginationParams {
+export interface DirListInfringementClaimsParams extends DefaultFlatPaginationParams {}
+
+export interface DirUpdateInfringementParams {
   /**
-   * Case-insensitive partial match on call reason.
+   * Must be `true`.
    */
-  'filter[call_reason][contains]'?: string;
+  certify_brand_is_accurate: true;
 
   /**
-   * Case-insensitive partial match on display name.
+   * Must be `true`.
    */
-  'filter[display_name][contains]'?: string;
+  certify_ip_ownership: true;
 
   /**
-   * Filter by enterprise ID.
+   * Must be `true`.
    */
-  'filter[enterprise_id]'?: string;
+  certify_no_infringement: true;
 
   /**
-   * Return only DIRs whose `expiring_at` is at or after this ISO-8601 timestamp.
-   * Pairs with the `[lte]` variant to build renewal-window dashboards.
+   * Must be `true`.
    */
-  'filter[expiring_at][gte]'?: string;
+  certify_no_shaft_content: true;
 
   /**
-   * Return only DIRs whose `expiring_at` is at or before this ISO-8601 timestamp.
+   * Explanation of how the infringement concern was addressed.
    */
-  'filter[expiring_at][lte]'?: string;
+  infringement_resolution_notes: string;
+
+  call_reasons?: Array<string> | null;
+
+  display_name?: string | null;
 
   /**
-   * Filter by DIR status.
+   * Append-only supporting documents to attach while resolving the claim (e.g.
+   * authorization or licensing proof).
    */
-  'filter[status]'?: DirStatus;
+  documents?: Array<Document> | null;
 
   /**
-   * Sort field. Allowed values: `created_at`, `updated_at`, `display_name`,
-   * `status`. Prefix with `-` for descending. Default `-created_at`.
+   * Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
    */
-  sort?:
-    | 'created_at'
-    | '-created_at'
-    | 'updated_at'
-    | '-updated_at'
-    | 'display_name'
-    | '-display_name'
-    | 'status'
-    | '-status';
+  logo_url?: string | null;
 }
 
-export interface DirListInfringementClaimsParams extends DefaultFlatPaginationParams {}
-
 export interface DirNewLoaParams {
   /**
    * Telephone numbers to authorize on the DIR, in `+E164` format (`+` followed by
@@ -609,47 +651,6 @@ export namespace DirNewLoaParams {
   }
 }
 
-export interface DirUpdateInfringementParams {
-  /**
-   * Must be `true`.
-   */
-  certify_brand_is_accurate: true;
-
-  /**
-   * Must be `true`.
-   */
-  certify_ip_ownership: true;
-
-  /**
-   * Must be `true`.
-   */
-  certify_no_infringement: true;
-
-  /**
-   * Must be `true`.
-   */
-  certify_no_shaft_content: true;
-
-  /**
-   * Explanation of how the infringement concern was addressed.
-   */
-  infringement_resolution_notes: string;
-
-  call_reasons?: Array<string> | null;
-
-  display_name?: string | null;
-
-  /**
-   * Append-only supporting documents.
-   */
-  documents?: Array<Document> | null;
-
-  /**
-   * Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
-   */
-  logo_url?: string | null;
-}
-
 DirResource.Comments = Comments;
 DirResource.PhoneNumberBatches = PhoneNumberBatches;
 DirResource.PhoneNumbers = PhoneNumbers;
@@ -665,11 +666,11 @@ export declare namespace DirResource {
     type Document as Document,
     type DirListDocumentTypesResponse as DirListDocumentTypesResponse,
     type DirsDefaultFlatPagination as DirsDefaultFlatPagination,
-    type DirUpdateParams as DirUpdateParams,
     type DirListParams as DirListParams,
+    type DirUpdateParams as DirUpdateParams,
     type DirListInfringementClaimsParams as DirListInfringementClaimsParams,
-    type DirNewLoaParams as DirNewLoaParams,
     type DirUpdateInfringementParams as DirUpdateInfringementParams,
+    type DirNewLoaParams as DirNewLoaParams,
   };
 
   export {
@@ -678,8 +679,8 @@ export declare namespace DirResource {
     type DirComment as DirComment,
     type CommentCreateResponse as CommentCreateResponse,
     type DirCommentsDefaultFlatPagination as DirCommentsDefaultFlatPagination,
-    type CommentCreateParams as CommentCreateParams,
     type CommentListParams as CommentListParams,
+    type CommentCreateParams as CommentCreateParams,
   };
 
   export {
@@ -688,8 +689,8 @@ export declare namespace DirResource {
     type PhoneNumberBatch as PhoneNumberBatch,
     type PhoneNumberBatchRetrieveResponse as PhoneNumberBatchRetrieveResponse,
     type PhoneNumberBatchesDefaultFlatPagination as PhoneNumberBatchesDefaultFlatPagination,
-    type PhoneNumberBatchRetrieveParams as PhoneNumberBatchRetrieveParams,
     type PhoneNumberBatchListParams as PhoneNumberBatchListParams,
+    type PhoneNumberBatchRetrieveParams as PhoneNumberBatchRetrieveParams,
   };
 
   export {
@@ -699,9 +700,9 @@ export declare namespace DirResource {
     type PhoneNumberAddResponse as PhoneNumberAddResponse,
     type PhoneNumberRemoveResponse as PhoneNumberRemoveResponse,
     type DirPhoneNumbersDefaultFlatPagination as DirPhoneNumbersDefaultFlatPagination,
+    type PhoneNumberRemoveParams as PhoneNumberRemoveParams,
     type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberAddParams as PhoneNumberAddParams,
-    type PhoneNumberRemoveParams as PhoneNumberRemoveParams,
   };
 
   export {

package/src/resources/dir/index.ts

@@ -5,8 +5,8 @@ export {
   type CommentType,
   type DirComment,
   type CommentCreateResponse,
-  type CommentCreateParams,
   type CommentListParams,
+  type CommentCreateParams,
   type DirCommentsDefaultFlatPagination,
 } from './comments';
 export {
@@ -17,11 +17,11 @@ export {
   type DirWrapped,
   type Document,
   type DirListDocumentTypesResponse,
-  type DirUpdateParams,
   type DirListParams,
+  type DirUpdateParams,
   type DirListInfringementClaimsParams,
-  type DirNewLoaParams,
   type DirUpdateInfringementParams,
+  type DirNewLoaParams,
   type DirsDefaultFlatPagination,
 } from './dir';
 export {
@@ -29,8 +29,8 @@ export {
   type DirPhoneNumberStatus,
   type PhoneNumberBatch,
   type PhoneNumberBatchRetrieveResponse,
-  type PhoneNumberBatchRetrieveParams,
   type PhoneNumberBatchListParams,
+  type PhoneNumberBatchRetrieveParams,
   type PhoneNumberBatchesDefaultFlatPagination,
 } from './phone-number-batches';
 export {
@@ -39,9 +39,9 @@ export {
   type RejectionReason,
   type PhoneNumberAddResponse,
   type PhoneNumberRemoveResponse,
+  type PhoneNumberRemoveParams,
   type PhoneNumberListParams,
   type PhoneNumberAddParams,
-  type PhoneNumberRemoveParams,
   type DirPhoneNumbersDefaultFlatPagination,
 } from './phone-numbers';
 export {

package/src/resources/dir/phone-number-batches.ts

@@ -12,28 +12,6 @@ import { path } from '../../internal/utils/path';
  * Phone numbers are submitted to Telnyx for vetting in batches. Batches group all numbers added in a single request under the same Letter of Authorization.
  */
 export class PhoneNumberBatches extends APIResource {
-  /**
-   * Get a single phone-number batch by id. The enterprise is resolved server-side
-   * from the DIR id.
-   *
-   * @example
-   * ```ts
-   * const phoneNumberBatch =
-   *   await client.dir.phoneNumberBatches.retrieve(
-   *     '0a4b1f5e-2f12-4c0c-9a98-9b3a7d8b8e62',
-   *     { dir_id: '16635d38-75a6-4481-82e8-69af60e05011' },
-   *   );
-   * ```
-   */
-  retrieve(
-    batchID: string,
-    params: PhoneNumberBatchRetrieveParams,
-    options?: RequestOptions,
-  ): APIPromise<PhoneNumberBatchRetrieveResponse> {
-    const { dir_id } = params;
-    return this._client.get(path`/dir/${dir_id}/phone_number_batches/${batchID}`, options);
-  }
-
   /**
    * List the phone-number batches submitted under a DIR. The enterprise is resolved
    * server-side from the DIR id.
@@ -59,6 +37,28 @@ export class PhoneNumberBatches extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * Get a single phone-number batch by id. The enterprise is resolved server-side
+   * from the DIR id.
+   *
+   * @example
+   * ```ts
+   * const phoneNumberBatch =
+   *   await client.dir.phoneNumberBatches.retrieve(
+   *     '0a4b1f5e-2f12-4c0c-9a98-9b3a7d8b8e62',
+   *     { dir_id: '16635d38-75a6-4481-82e8-69af60e05011' },
+   *   );
+   * ```
+   */
+  retrieve(
+    batchID: string,
+    params: PhoneNumberBatchRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberBatchRetrieveResponse> {
+    const { dir_id } = params;
+    return this._client.get(path`/dir/${dir_id}/phone_number_batches/${batchID}`, options);
+  }
 }
 
 export type PhoneNumberBatchesDefaultFlatPagination = DefaultFlatPagination<PhoneNumberBatch>;
@@ -144,18 +144,18 @@ export interface PhoneNumberBatchRetrieveResponse {
   data: PhoneNumberBatch;
 }
 
-export interface PhoneNumberBatchRetrieveParams {
+export interface PhoneNumberBatchListParams extends DefaultFlatPaginationParams {
   /**
-   * The DIR id. Lowercase UUID.
+   * Restrict to batches whose aggregate status equals this value.
    */
-  dir_id: string;
+  'filter[status]'?: DirPhoneNumberStatus;
 }
 
-export interface PhoneNumberBatchListParams extends DefaultFlatPaginationParams {
+export interface PhoneNumberBatchRetrieveParams {
   /**
-   * Restrict to batches whose aggregate status equals this value.
+   * The DIR id. Lowercase UUID.
    */
-  'filter[status]'?: DirPhoneNumberStatus;
+  dir_id: string;
 }
 
 export declare namespace PhoneNumberBatches {
@@ -164,7 +164,7 @@ export declare namespace PhoneNumberBatches {
     type PhoneNumberBatch as PhoneNumberBatch,
     type PhoneNumberBatchRetrieveResponse as PhoneNumberBatchRetrieveResponse,
     type PhoneNumberBatchesDefaultFlatPagination as PhoneNumberBatchesDefaultFlatPagination,
-    type PhoneNumberBatchRetrieveParams as PhoneNumberBatchRetrieveParams,
     type PhoneNumberBatchListParams as PhoneNumberBatchListParams,
+    type PhoneNumberBatchRetrieveParams as PhoneNumberBatchRetrieveParams,
   };
 }