telnyx 7.1.0 → 7.3.0

package/src/resources/calls/actions.ts

@@ -1114,6 +1114,13 @@ export interface DeepgramNova2Config {
 
   transcription_model: 'deepgram/nova-2';
 
+  /**
+   * Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
+   * toward. For weighted biasing, use `keywords_boosting` instead. Nova-2-only; use
+   * `keyterms` on Nova-3.
+   */
+  hints?: Array<string>;
+
   /**
    * Whether to send also interim results. If set to false, only final results will
    * be sent.
@@ -1176,6 +1183,15 @@ export interface DeepgramNova2Config {
     | 'vi'
     | 'auto_detect';
 
+  /**
+   * Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+   * normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+   * underlying default of `false` — omit the field to get a smart-formatted
+   * transcript, or set it to `false` to receive the raw lowercase transcript without
+   * punctuation.
+   */
+  smart_format?: boolean;
+
   /**
    * Number of milliseconds of silence to consider an utterance ended. Ranges from 0
    * to 5000 ms.
@@ -1194,6 +1210,12 @@ export interface DeepgramNova3Config {
    */
   interim_results?: boolean;
 
+  /**
+   * Nova-3 keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+   * recognition toward. Nova-3-only; use `hints` on Nova-2.
+   */
+  keyterms?: Array<string>;
+
   /**
    * Keywords and their respective intensifiers (boosting values) to improve
    * transcription accuracy for specific words or phrases. The intensifier should be
@@ -1222,6 +1244,15 @@ export interface DeepgramNova3Config {
     | 'pt-PT'
     | 'auto_detect';
 
+  /**
+   * Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+   * normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+   * underlying default of `false` — omit the field to get a smart-formatted
+   * transcript, or set it to `false` to receive the raw lowercase transcript without
+   * punctuation.
+   */
+  smart_format?: boolean;
+
   /**
    * Number of milliseconds of silence to consider an utterance ended. Ranges from 0
    * to 5000 ms.

package/src/resources/dir/dir.ts

@@ -36,6 +36,18 @@ import {
   PhoneNumbers,
   RejectionReason,
 } from './phone-numbers';
+import * as ReferencesAPI from './references';
+import {
+  Reference,
+  ReferenceCreateParams,
+  ReferenceInput,
+  ReferenceList,
+  ReferenceUpdateParams,
+  ReferenceUpdateResponse,
+  References,
+} from './references';
+import * as VerifyEmailAPI from './verify-email';
+import { EmailVerificationStatusWrapped, VerifyEmail, VerifyEmailConfirmParams } from './verify-email';
 import * as LoaAPI from '../enterprises/reputation/loa';
 import { APIPromise } from '../../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
@@ -49,6 +61,8 @@ export class DirResource extends APIResource {
     this._client,
   );
   phoneNumbers: PhoneNumbersAPI.PhoneNumbers = new PhoneNumbersAPI.PhoneNumbers(this._client);
+  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
@@ -639,6 +653,8 @@ export interface DirUpdateInfringementParams {
 DirResource.Comments = Comments;
 DirResource.PhoneNumberBatches = PhoneNumberBatches;
 DirResource.PhoneNumbers = PhoneNumbers;
+DirResource.References = References;
+DirResource.VerifyEmail = VerifyEmail;
 
 export declare namespace DirResource {
   export {
@@ -687,6 +703,22 @@ export declare namespace DirResource {
     type PhoneNumberAddParams as PhoneNumberAddParams,
     type PhoneNumberRemoveParams as PhoneNumberRemoveParams,
   };
+
+  export {
+    References as References,
+    type Reference as Reference,
+    type ReferenceInput as ReferenceInput,
+    type ReferenceList as ReferenceList,
+    type ReferenceUpdateResponse as ReferenceUpdateResponse,
+    type ReferenceCreateParams as ReferenceCreateParams,
+    type ReferenceUpdateParams as ReferenceUpdateParams,
+  };
+
+  export {
+    VerifyEmail as VerifyEmail,
+    type EmailVerificationStatusWrapped as EmailVerificationStatusWrapped,
+    type VerifyEmailConfirmParams as VerifyEmailConfirmParams,
+  };
 }
 
 export { type InfringementClaimsDefaultFlatPagination };

package/src/resources/dir/index.ts

@@ -44,3 +44,17 @@ export {
   type PhoneNumberRemoveParams,
   type DirPhoneNumbersDefaultFlatPagination,
 } from './phone-numbers';
+export {
+  References,
+  type Reference,
+  type ReferenceInput,
+  type ReferenceList,
+  type ReferenceUpdateResponse,
+  type ReferenceCreateParams,
+  type ReferenceUpdateParams,
+} from './references';
+export {
+  VerifyEmail,
+  type EmailVerificationStatusWrapped,
+  type VerifyEmailConfirmParams,
+} from './verify-email';

package/src/resources/dir/references.ts

@@ -0,0 +1,285 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * 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.
+ */
+export class References extends APIResource {
+  /**
+   * 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.
+   *
+   * The request body carries exactly two business references plus one financial
+   * reference. On success the references are stored and the response echoes them in
+   * the same shape as the GET. Submitting again converges on the already-stored
+   * references rather than erroring.
+   *
+   * @example
+   * ```ts
+   * const referenceList = await client.dir.references.create(
+   *   '16635d38-75a6-4481-82e8-69af60e05011',
+   *   {
+   *     business_references: [
+   *       {
+   *         email: 'dana.reyes@example.com',
+   *         full_name: 'Dana Reyes',
+   *         phone_e164: '+14155550123',
+   *         timezone: 'America/New_York',
+   *       },
+   *       {
+   *         email: 'dana.reyes@example.com',
+   *         full_name: 'Dana Reyes',
+   *         phone_e164: '+14155550123',
+   *         timezone: 'America/New_York',
+   *       },
+   *     ],
+   *     financial_reference: {
+   *       email: 'dana.reyes@example.com',
+   *       full_name: 'Dana Reyes',
+   *       phone_e164: '+14155550123',
+   *       timezone: 'America/New_York',
+   *     },
+   *   },
+   * );
+   * ```
+   */
+  create(dirID: string, body: ReferenceCreateParams, options?: RequestOptions): APIPromise<ReferenceList> {
+    return this._client.post(path`/dir/${dirID}/references`, { body, ...options });
+  }
+
+  /**
+   * Partially update one reference, addressed by the DIR id plus the reference's
+   * type (business or financial) and slot.
+   *
+   * Cosmetic fields (full name, job title, organization, relationship, email) are
+   * always editable. The phone number and timezone may only be changed while a
+   * scheduled call has not yet been dialed; if a call is in progress or all attempts
+   * are complete, those fields are locked. Changing the timezone reschedules any
+   * pending call into the new local calling window.
+   *
+   * @example
+   * ```ts
+   * const reference = await client.dir.references.update(0, {
+   *   dir_id: '16635d38-75a6-4481-82e8-69af60e05011',
+   *   ref_type: 'business',
+   * });
+   * ```
+   */
+  update(
+    slot: number,
+    params: ReferenceUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ReferenceUpdateResponse> {
+    const { dir_id, ref_type, ...body } = params;
+    return this._client.patch(path`/dir/${dir_id}/references/${ref_type}/${slot}`, { body, ...options });
+  }
+
+  /**
+   * List the business and financial references submitted for a DIR.
+   *
+   * Returns the two business references (slots 0 and 1) followed by the single
+   * financial reference. Each entry carries only the customer-supplied details
+   * (name, title, organization, relationship, phone, email, timezone). Returns an
+   * empty list when no references were submitted.
+   *
+   * @example
+   * ```ts
+   * const referenceList = await client.dir.references.list(
+   *   '16635d38-75a6-4481-82e8-69af60e05011',
+   * );
+   * ```
+   */
+  list(dirID: string, options?: RequestOptions): APIPromise<ReferenceList> {
+    return this._client.get(path`/dir/${dirID}/references`, options);
+  }
+}
+
+/**
+ * A reference (business or financial) on a DIR, in the customer-facing shape. No
+ * internal identifiers are exposed.
+ */
+export interface Reference {
+  /**
+   * Full name of the reference contact.
+   */
+  full_name: string;
+
+  /**
+   * Reference phone number in E.164 format.
+   */
+  phone_e164: string;
+
+  /**
+   * Always `dir_reference`.
+   */
+  record_type: 'dir_reference';
+
+  /**
+   * Whether this is a business reference or the financial reference.
+   */
+  ref_type: 'business' | 'financial';
+
+  /**
+   * Position within the reference type. Business references occupy slots 0 and 1;
+   * the financial reference occupies slot 0.
+   */
+  slot: number;
+
+  /**
+   * IANA timezone id for the reference. Calls are only placed within the reference's
+   * local 8am-9pm window.
+   */
+  timezone: string;
+
+  /**
+   * Reference contact email address.
+   */
+  email?: string | null;
+
+  /**
+   * Job title of the reference contact.
+   */
+  job_title?: string | null;
+
+  /**
+   * Organization the reference contact belongs to.
+   */
+  organization?: string | null;
+
+  /**
+   * How the reference contact is related to the registering business.
+   */
+  relationship_to_registrant?: string | null;
+}
+
+/**
+ * One reference supplied at submit. The reference type is implied by the field
+ * that carries it (business_references vs financial_reference).
+ */
+export interface ReferenceInput {
+  /**
+   * Reference contact email address. Required: the reference is emailed scheduling
+   * and dial-in notices.
+   */
+  email: string;
+
+  /**
+   * Full name of the reference contact.
+   */
+  full_name: string;
+
+  /**
+   * Reference phone number in E.164 format, e.g. +14155550123.
+   */
+  phone_e164: string;
+
+  /**
+   * IANA timezone id for the reference (e.g. America/New_York). Required: calls are
+   * only placed within the reference's local 8am-9pm window.
+   */
+  timezone: string;
+
+  /**
+   * Job title of the reference contact.
+   */
+  job_title?: string | null;
+
+  /**
+   * Organization the reference contact belongs to.
+   */
+  organization?: string | null;
+
+  /**
+   * How the reference contact is related to the registering business.
+   */
+  relationship_to_registrant?: string | null;
+}
+
+export interface ReferenceList {
+  data: Array<Reference>;
+}
+
+export interface ReferenceUpdateResponse {
+  /**
+   * A reference (business or financial) on a DIR, in the customer-facing shape. No
+   * internal identifiers are exposed.
+   */
+  data: Reference;
+}
+
+export interface ReferenceCreateParams {
+  /**
+   * Exactly two business references.
+   */
+  business_references: Array<ReferenceInput>;
+
+  /**
+   * One reference supplied at submit. The reference type is implied by the field
+   * that carries it (business_references vs financial_reference).
+   */
+  financial_reference: ReferenceInput;
+}
+
+export interface ReferenceUpdateParams {
+  /**
+   * Path param: The DIR id. Lowercase UUID.
+   */
+  dir_id: string;
+
+  /**
+   * Path param: Reference type to address.
+   */
+  ref_type: 'business' | 'financial';
+
+  /**
+   * Body param: Reference contact email address.
+   */
+  email?: string;
+
+  /**
+   * Body param: Full name of the reference contact.
+   */
+  full_name?: string;
+
+  /**
+   * Body param: Job title of the reference contact.
+   */
+  job_title?: string | null;
+
+  /**
+   * Body param: Organization the reference contact belongs to.
+   */
+  organization?: string | null;
+
+  /**
+   * Body param: Reference phone number in E.164 format.
+   */
+  phone_e164?: string;
+
+  /**
+   * Body param: How the reference contact is related to the registering business.
+   */
+  relationship_to_registrant?: string | null;
+
+  /**
+   * Body param: IANA timezone id for the reference.
+   */
+  timezone?: string;
+}
+
+export declare namespace References {
+  export {
+    type Reference as Reference,
+    type ReferenceInput as ReferenceInput,
+    type ReferenceList as ReferenceList,
+    type ReferenceUpdateResponse as ReferenceUpdateResponse,
+    type ReferenceCreateParams as ReferenceCreateParams,
+    type ReferenceUpdateParams as ReferenceUpdateParams,
+  };
+}

package/src/resources/dir/verify-email.ts

@@ -0,0 +1,114 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * 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.
+ */
+export class VerifyEmail extends APIResource {
+  /**
+   * 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`.
+   *
+   * @example
+   * ```ts
+   * const emailVerificationStatusWrapped =
+   *   await client.dir.verifyEmail.create(
+   *     '16635d38-75a6-4481-82e8-69af60e05011',
+   *   );
+   * ```
+   */
+  create(dirID: string, options?: RequestOptions): APIPromise<EmailVerificationStatusWrapped> {
+    return this._client.post(path`/dir/${dirID}/verify_email`, options);
+  }
+
+  /**
+   * Whether the DIR's current authorizer email has been verified.
+   *
+   * @example
+   * ```ts
+   * const emailVerificationStatusWrapped =
+   *   await client.dir.verifyEmail.list(
+   *     '16635d38-75a6-4481-82e8-69af60e05011',
+   *   );
+   * ```
+   */
+  list(dirID: string, options?: RequestOptions): APIPromise<EmailVerificationStatusWrapped> {
+    return this._client.get(path`/dir/${dirID}/verify_email`, options);
+  }
+
+  /**
+   * Submit the 6-digit code that was emailed to the DIR's authorizer email. On
+   * success the authorizer email is marked verified.
+   *
+   * For security, any failure (wrong, expired, already-used, or too many attempts)
+   * returns the same generic message.
+   *
+   * @example
+   * ```ts
+   * const emailVerificationStatusWrapped =
+   *   await client.dir.verifyEmail.confirm(
+   *     '16635d38-75a6-4481-82e8-69af60e05011',
+   *     { code: '482915' },
+   *   );
+   * ```
+   */
+  confirm(
+    dirID: string,
+    body: VerifyEmailConfirmParams,
+    options?: RequestOptions,
+  ): APIPromise<EmailVerificationStatusWrapped> {
+    return this._client.post(path`/dir/${dirID}/verify_email/confirm`, { body, ...options });
+  }
+}
+
+export interface EmailVerificationStatusWrapped {
+  /**
+   * Verification state for a DIR's authorizer email.
+   */
+  data: EmailVerificationStatusWrapped.Data;
+}
+
+export namespace EmailVerificationStatusWrapped {
+  /**
+   * Verification state for a DIR's authorizer email.
+   */
+  export interface Data {
+    /**
+     * Whether the DIR's authorizer email has been confirmed.
+     */
+    email_verified: boolean;
+
+    /**
+     * Always `email_verification`.
+     */
+    record_type: 'email_verification';
+
+    /**
+     * `sent` after a code is emailed; `verified` after a successful confirm;
+     * `unverified` when no verification is in progress.
+     */
+    status: 'sent' | 'verified' | 'unverified';
+  }
+}
+
+export interface VerifyEmailConfirmParams {
+  /**
+   * The 6-digit code sent to the authorizer email.
+   */
+  code: string;
+}
+
+export declare namespace VerifyEmail {
+  export {
+    type EmailVerificationStatusWrapped as EmailVerificationStatusWrapped,
+    type VerifyEmailConfirmParams as VerifyEmailConfirmParams,
+  };
+}

package/src/resources/documents.ts

@@ -96,7 +96,7 @@ export class Documents extends APIResource {
   download(id: string, options?: RequestOptions): APIPromise<Response> {
     return this._client.get(path`/documents/${id}/download`, {
       ...options,
-      headers: buildHeaders([{ Accept: '*' }, options?.headers]),
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
       __binaryResponse: true,
     });
   }

package/src/resources/messaging-10dlc/messaging-10dlc.ts

@@ -129,7 +129,7 @@ export class Messaging10dlc extends APIResource {
 export type Messaging10dlcGetEnumResponse =
   | Array<string>
   | Array<{ [key: string]: unknown }>
-  | { [key: string]: unknown }
+  | { [key: string]: string }
   | { [key: string]: unknown }
   | Messaging10dlcGetEnumResponse.EnumPaginatedResponse;
 

package/src/resources/texml/accounts/calls/calls.ts

@@ -700,7 +700,7 @@ export declare namespace CallCallsParams {
      * The call events for which Telnyx should send a webhook. Multiple events can be
      * defined when separated by a space.
      */
-    StatusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
+    StatusCallbackEvent?: string;
 
     /**
      * HTTP request type used for `StatusCallback`.
@@ -976,7 +976,7 @@ export declare namespace CallCallsParams {
      * The call events for which Telnyx should send a webhook. Multiple events can be
      * defined when separated by a space.
      */
-    StatusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
+    StatusCallbackEvent?: string;
 
     /**
      * HTTP request type used for `StatusCallback`.
@@ -1246,7 +1246,7 @@ export declare namespace CallCallsParams {
      * The call events for which Telnyx should send a webhook. Multiple events can be
      * defined when separated by a space.
      */
-    StatusCallbackEvent?: 'initiated' | 'ringing' | 'answered' | 'completed';
+    StatusCallbackEvent?: string;
 
     /**
      * HTTP request type used for `StatusCallback`.

package/src/resources/whatsapp/index.ts

@@ -10,8 +10,10 @@ export {
 export {
   PhoneNumbers,
   type PhoneNumberListResponse,
+  type PhoneNumberRetrieveConversationWindowResponse,
   type PhoneNumberListParams,
   type PhoneNumberResendVerificationParams,
+  type PhoneNumberRetrieveConversationWindowParams,
   type PhoneNumberVerifyParams,
   type PhoneNumberListResponsesDefaultFlatPagination,
 } from './phone-numbers/index';

package/src/resources/whatsapp/phone-numbers/index.ts

@@ -10,8 +10,10 @@ export {
 export {
   PhoneNumbers,
   type PhoneNumberListResponse,
+  type PhoneNumberRetrieveConversationWindowResponse,
   type PhoneNumberListParams,
   type PhoneNumberResendVerificationParams,
+  type PhoneNumberRetrieveConversationWindowParams,
   type PhoneNumberVerifyParams,
   type PhoneNumberListResponsesDefaultFlatPagination,
 } from './phone-numbers';

package/src/resources/whatsapp/phone-numbers/phone-numbers.ts

@@ -93,6 +93,31 @@ export class PhoneNumbers extends APIResource {
     });
   }
 
+  /**
+   * Returns whether the 24-hour conversation window is currently open for a given
+   * source/destination pair. If window_active is false, only template messages may
+   * be sent.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.whatsapp.phoneNumbers.retrieveConversationWindow(
+   *     'phone_number',
+   *     { destination_number: '+353894650851' },
+   *   );
+   * ```
+   */
+  retrieveConversationWindow(
+    phoneNumber: string,
+    query: PhoneNumberRetrieveConversationWindowParams,
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberRetrieveConversationWindowResponse> {
+    return this._client.get(path`/v2/whatsapp/phone_numbers/${phoneNumber}/conversation_window`, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Submit verification code for a phone number
    *
@@ -153,12 +178,47 @@ export interface PhoneNumberListResponse {
   waba_id?: string;
 }
 
+export interface PhoneNumberRetrieveConversationWindowResponse {
+  data?: PhoneNumberRetrieveConversationWindowResponse.Data;
+}
+
+export namespace PhoneNumberRetrieveConversationWindowResponse {
+  export interface Data {
+    /**
+     * Timestamp of the last inbound message that opened the window
+     */
+    last_user_message_at?: string;
+
+    /**
+     * Whether the 24-hour conversation window is currently open
+     */
+    window_active?: boolean;
+
+    /**
+     * When the window closes. Null if no active window.
+     */
+    window_expires_at?: string;
+
+    /**
+     * Window type. Currently always 24h when present.
+     */
+    window_type?: string;
+  }
+}
+
 export interface PhoneNumberListParams extends DefaultFlatPaginationParams {}
 
 export interface PhoneNumberResendVerificationParams {
   verification_method?: 'sms' | 'voice';
 }
 
+export interface PhoneNumberRetrieveConversationWindowParams {
+  /**
+   * Destination phone number in E.164 format
+   */
+  destination_number: string;
+}
+
 export interface PhoneNumberVerifyParams {
   code: string;
 }
@@ -169,9 +229,11 @@ PhoneNumbers.Profile = Profile;
 export declare namespace PhoneNumbers {
   export {
     type PhoneNumberListResponse as PhoneNumberListResponse,
+    type PhoneNumberRetrieveConversationWindowResponse as PhoneNumberRetrieveConversationWindowResponse,
     type PhoneNumberListResponsesDefaultFlatPagination as PhoneNumberListResponsesDefaultFlatPagination,
     type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberResendVerificationParams as PhoneNumberResendVerificationParams,
+    type PhoneNumberRetrieveConversationWindowParams as PhoneNumberRetrieveConversationWindowParams,
     type PhoneNumberVerifyParams as PhoneNumberVerifyParams,
   };