telnyx 6.83.0 → 7.1.0

package/src/resources/ip-connections.ts

@@ -289,7 +289,7 @@ export interface IPConnection {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: CredentialConnectionsAPI.ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored
@@ -517,7 +517,7 @@ export interface IPConnectionCreateParams {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: CredentialConnectionsAPI.ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored
@@ -738,7 +738,7 @@ export interface IPConnectionUpdateParams {
    * applied to outgoing audio. When set to 'both', it's applied in both directions.
    * When set to 'disabled', noise suppression is turned off.
    */
-  noise_suppression?: 'inbound' | 'outbound' | 'both' | 'disabled';
+  noise_suppression?: CredentialConnectionsAPI.ConnectionNoiseSuppression;
 
   /**
    * Configuration options for noise suppression. These settings are stored

package/src/resources/legacy/reporting/usage-reports/usage-reports.ts

@@ -69,8 +69,14 @@ export interface UsageReportRetrieveSpeechToTextResponse {
 }
 
 export interface UsageReportRetrieveSpeechToTextParams {
+  /**
+   * End of the date range filter (inclusive, ISO 8601).
+   */
   end_date?: string;
 
+  /**
+   * Start of the date range filter (inclusive, ISO 8601).
+   */
   start_date?: string;
 }
 

package/src/resources/messages/index.ts

@@ -2,7 +2,6 @@
 
 export {
   Messages,
-  type MessagingError,
   type OutboundMessagePayload,
   type RcsAgentMessage,
   type RcsCardContent,

package/src/resources/messages/messages.ts

@@ -221,32 +221,6 @@ export class Messages extends APIResource {
   }
 }
 
-export interface MessagingError {
-  code: string;
-
-  title: string;
-
-  detail?: string;
-
-  meta?: { [key: string]: unknown };
-
-  source?: MessagingError.Source;
-}
-
-export namespace MessagingError {
-  export interface Source {
-    /**
-     * Indicates which query parameter caused the error.
-     */
-    parameter?: string;
-
-    /**
-     * JSON pointer (RFC6901) to the offending entity.
-     */
-    pointer?: string;
-  }
-}
-
 export interface OutboundMessagePayload {
   /**
    * Identifies the type of resource.
@@ -282,7 +256,7 @@ export interface OutboundMessagePayload {
    * These errors may point at addressees when referring to unsuccessful/unconfirmed
    * delivery statuses.
    */
-  errors?: Array<MessagingError>;
+  errors?: Array<Shared.MessagingError>;
 
   from?: OutboundMessagePayload.From;
 
@@ -1298,7 +1272,7 @@ export interface MessageCancelScheduledResponse {
    * These errors may point at addressees when referring to unsuccessful/unconfirmed
    * delivery statuses.
    */
-  errors?: Array<MessagingError>;
+  errors?: Array<Shared.MessagingError>;
 
   from?: MessageCancelScheduledResponse.From;
 
@@ -2137,7 +2111,6 @@ Messages.Rcs = Rcs;
 
 export declare namespace Messages {
   export {
-    type MessagingError as MessagingError,
     type OutboundMessagePayload as OutboundMessagePayload,
     type RcsAgentMessage as RcsAgentMessage,
     type RcsCardContent as RcsCardContent,

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

@@ -5,10 +5,9 @@ import * as ExternalVettingAPI from './external-vetting';
 import {
   ExternalVetting,
   ExternalVettingImportsParams,
-  ExternalVettingImportsResponse,
   ExternalVettingListResponse,
   ExternalVettingOrderParams,
-  ExternalVettingOrderResponse,
+  ExternalVettingResource,
 } from './external-vetting';
 import { APIPromise } from '../../../core/api-promise';
 import { PagePromise, PerPagePaginationV2, type PerPagePaginationV2Params } from '../../../core/pagination';
@@ -20,7 +19,8 @@ import { path } from '../../../internal/utils/path';
  * Brand operations
  */
 export class Brand extends APIResource {
-  externalVetting: ExternalVettingAPI.ExternalVetting = new ExternalVettingAPI.ExternalVetting(this._client);
+  externalVetting: ExternalVettingAPI.ExternalVettingResource =
+    new ExternalVettingAPI.ExternalVettingResource(this._client);
 
   /**
    * This endpoint is used to create a new brand. A brand is an entity created by The
@@ -156,7 +156,7 @@ export class Brand extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const brandSMSOtpStatus =
    *   await client.messaging10dlc.brand.getSMSOtpByReference(
    *     'OTP4B2001',
    *   );
@@ -166,7 +166,7 @@ export class Brand extends APIResource {
     referenceID: string,
     query: BrandGetSMSOtpByReferenceParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<BrandGetSMSOtpByReferenceResponse> {
+  ): APIPromise<BrandSMSOtpStatus> {
     return this._client.get(path`/10dlc/brand/smsOtp/${referenceID}`, { query, ...options });
   }
 
@@ -201,16 +201,13 @@ export class Brand extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const brandSMSOtpStatus =
    *   await client.messaging10dlc.brand.retrieveSMSOtpStatus(
    *     '4b20019b-043a-78f8-0657-b3be3f4b4002',
    *   );
    * ```
    */
-  retrieveSMSOtpStatus(
-    brandID: string,
-    options?: RequestOptions,
-  ): APIPromise<BrandRetrieveSMSOtpStatusResponse> {
+  retrieveSMSOtpStatus(brandID: string, options?: RequestOptions): APIPromise<BrandSMSOtpStatus> {
     return this._client.get(path`/10dlc/brand/${brandID}/smsOtp`, options);
   }
 
@@ -326,6 +323,52 @@ export interface BrandOptionalAttributes {
   taxExemptStatus?: string;
 }
 
+/**
+ * Status information for an SMS OTP sent during Sole Proprietor brand verification
+ */
+export interface BrandSMSOtpStatus {
+  /**
+   * The Brand ID associated with this OTP request
+   */
+  brandId: string;
+
+  /**
+   * The current delivery status of the OTP SMS message. Common values include:
+   * `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
+   */
+  deliveryStatus: string;
+
+  /**
+   * The mobile phone number where the OTP was sent, in E.164 format
+   */
+  mobilePhone: string;
+
+  /**
+   * The reference ID for this OTP request, used for status queries
+   */
+  referenceId: string;
+
+  /**
+   * The timestamp when the OTP request was initiated
+   */
+  requestDate: string;
+
+  /**
+   * The timestamp when the delivery status was last updated
+   */
+  deliveryStatusDate?: string;
+
+  /**
+   * Additional details about the delivery status
+   */
+  deliveryStatusDetails?: string;
+
+  /**
+   * The timestamp when the OTP was successfully verified (if applicable)
+   */
+  verifyDate?: string;
+}
+
 /**
  * Entity type behind the brand. This is the form of business establishment.
  */
@@ -697,98 +740,6 @@ export namespace BrandGetFeedbackResponse {
   }
 }
 
-/**
- * Status information for an SMS OTP sent during Sole Proprietor brand verification
- */
-export interface BrandGetSMSOtpByReferenceResponse {
-  /**
-   * The Brand ID associated with this OTP request
-   */
-  brandId: string;
-
-  /**
-   * The current delivery status of the OTP SMS message. Common values include:
-   * `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
-   */
-  deliveryStatus: string;
-
-  /**
-   * The mobile phone number where the OTP was sent, in E.164 format
-   */
-  mobilePhone: string;
-
-  /**
-   * The reference ID for this OTP request, used for status queries
-   */
-  referenceId: string;
-
-  /**
-   * The timestamp when the OTP request was initiated
-   */
-  requestDate: string;
-
-  /**
-   * The timestamp when the delivery status was last updated
-   */
-  deliveryStatusDate?: string;
-
-  /**
-   * Additional details about the delivery status
-   */
-  deliveryStatusDetails?: string;
-
-  /**
-   * The timestamp when the OTP was successfully verified (if applicable)
-   */
-  verifyDate?: string;
-}
-
-/**
- * Status information for an SMS OTP sent during Sole Proprietor brand verification
- */
-export interface BrandRetrieveSMSOtpStatusResponse {
-  /**
-   * The Brand ID associated with this OTP request
-   */
-  brandId: string;
-
-  /**
-   * The current delivery status of the OTP SMS message. Common values include:
-   * `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
-   */
-  deliveryStatus: string;
-
-  /**
-   * The mobile phone number where the OTP was sent, in E.164 format
-   */
-  mobilePhone: string;
-
-  /**
-   * The reference ID for this OTP request, used for status queries
-   */
-  referenceId: string;
-
-  /**
-   * The timestamp when the OTP request was initiated
-   */
-  requestDate: string;
-
-  /**
-   * The timestamp when the delivery status was last updated
-   */
-  deliveryStatusDate?: string;
-
-  /**
-   * Additional details about the delivery status
-   */
-  deliveryStatusDetails?: string;
-
-  /**
-   * The timestamp when the OTP was successfully verified (if applicable)
-   */
-  verifyDate?: string;
-}
-
 /**
  * Response after successfully triggering a Brand SMS OTP
  */
@@ -1061,10 +1012,19 @@ export interface BrandListParams extends PerPagePaginationV2Params {
    */
   brandId?: string;
 
+  /**
+   * Filter results by country.
+   */
   country?: string;
 
+  /**
+   * Filter results by display name.
+   */
   displayName?: string;
 
+  /**
+   * Filter results by entity type.
+   */
   entityType?: string;
 
   /**
@@ -1087,6 +1047,9 @@ export interface BrandListParams extends PerPagePaginationV2Params {
     | 'tcrBrandId'
     | '-tcrBrandId';
 
+  /**
+   * Filter results by state.
+   */
   state?: string;
 
   /**
@@ -1122,13 +1085,14 @@ export interface BrandVerifySMSOtpParams {
   otpPin: string;
 }
 
-Brand.ExternalVetting = ExternalVetting;
+Brand.ExternalVettingResource = ExternalVettingResource;
 
 export declare namespace Brand {
   export {
     type AltBusinessIDType as AltBusinessIDType,
     type BrandIdentityStatus as BrandIdentityStatus,
     type BrandOptionalAttributes as BrandOptionalAttributes,
+    type BrandSMSOtpStatus as BrandSMSOtpStatus,
     type EntityType as EntityType,
     type StockExchange as StockExchange,
     type TelnyxBrand as TelnyxBrand,
@@ -1136,8 +1100,6 @@ export declare namespace Brand {
     type BrandRetrieveResponse as BrandRetrieveResponse,
     type BrandListResponse as BrandListResponse,
     type BrandGetFeedbackResponse as BrandGetFeedbackResponse,
-    type BrandGetSMSOtpByReferenceResponse as BrandGetSMSOtpByReferenceResponse,
-    type BrandRetrieveSMSOtpStatusResponse as BrandRetrieveSMSOtpStatusResponse,
     type BrandTriggerSMSOtpResponse as BrandTriggerSMSOtpResponse,
     type BrandListResponsesPerPagePaginationV2 as BrandListResponsesPerPagePaginationV2,
     type BrandCreateParams as BrandCreateParams,
@@ -1149,10 +1111,9 @@ export declare namespace Brand {
   };
 
   export {
-    ExternalVetting as ExternalVetting,
+    ExternalVettingResource as ExternalVettingResource,
+    type ExternalVetting as ExternalVetting,
     type ExternalVettingListResponse as ExternalVettingListResponse,
-    type ExternalVettingImportsResponse as ExternalVettingImportsResponse,
-    type ExternalVettingOrderResponse as ExternalVettingOrderResponse,
     type ExternalVettingImportsParams as ExternalVettingImportsParams,
     type ExternalVettingOrderParams as ExternalVettingOrderParams,
   };

package/src/resources/messaging-10dlc/brand/external-vetting.ts

@@ -8,7 +8,7 @@ import { path } from '../../../internal/utils/path';
 /**
  * Brand operations
  */
-export class ExternalVetting extends APIResource {
+export class ExternalVettingResource extends APIResource {
   /**
    * Get list of valid external vetting record for a given brand
    *
@@ -32,7 +32,7 @@ export class ExternalVetting extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const externalVetting =
    *   await client.messaging10dlc.brand.externalVetting.imports(
    *     'brandId',
    *     { evpId: 'evpId', vettingId: 'vettingId' },
@@ -43,7 +43,7 @@ export class ExternalVetting extends APIResource {
     brandID: string,
     body: ExternalVettingImportsParams,
     options?: RequestOptions,
-  ): APIPromise<ExternalVettingImportsResponse> {
+  ): APIPromise<ExternalVetting> {
     return this._client.put(path`/10dlc/brand/${brandID}/externalVetting`, { body, ...options });
   }
 
@@ -56,7 +56,7 @@ export class ExternalVetting extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const externalVetting =
    *   await client.messaging10dlc.brand.externalVetting.order(
    *     'brandId',
    *     { evpId: 'evpId', vettingClass: 'vettingClass' },
@@ -67,57 +67,12 @@ export class ExternalVetting extends APIResource {
     brandID: string,
     body: ExternalVettingOrderParams,
     options?: RequestOptions,
-  ): APIPromise<ExternalVettingOrderResponse> {
+  ): APIPromise<ExternalVetting> {
     return this._client.post(path`/10dlc/brand/${brandID}/externalVetting`, { body, ...options });
   }
 }
 
-export type ExternalVettingListResponse = Array<ExternalVettingListResponse.ExternalVettingListResponseItem>;
-
-export namespace ExternalVettingListResponse {
-  export interface ExternalVettingListResponseItem {
-    /**
-     * Vetting submission date. This is the date when the vetting request is generated
-     * in ISO 8601 format.
-     */
-    createDate?: string;
-
-    /**
-     * External vetting provider ID for the brand.
-     */
-    evpId?: string;
-
-    /**
-     * Vetting effective date. This is the date when vetting was completed, or the
-     * starting effective date in ISO 8601 format. If this date is missing, then the
-     * vetting was not complete or not valid.
-     */
-    vettedDate?: string;
-
-    /**
-     * Identifies the vetting classification.
-     */
-    vettingClass?: string;
-
-    /**
-     * Unique ID that identifies a vetting transaction performed by a vetting provider.
-     * This ID is provided by the vetting provider at time of vetting.
-     */
-    vettingId?: string;
-
-    /**
-     * Vetting score ranging from 0-100.
-     */
-    vettingScore?: number;
-
-    /**
-     * Required by some providers for vetting record confirmation.
-     */
-    vettingToken?: string;
-  }
-}
-
-export interface ExternalVettingImportsResponse {
+export interface ExternalVetting {
   /**
    * Vetting submission date. This is the date when the vetting request is generated
    * in ISO 8601 format.
@@ -158,46 +113,7 @@ export interface ExternalVettingImportsResponse {
   vettingToken?: string;
 }
 
-export interface ExternalVettingOrderResponse {
-  /**
-   * Vetting submission date. This is the date when the vetting request is generated
-   * in ISO 8601 format.
-   */
-  createDate?: string;
-
-  /**
-   * External vetting provider ID for the brand.
-   */
-  evpId?: string;
-
-  /**
-   * Vetting effective date. This is the date when vetting was completed, or the
-   * starting effective date in ISO 8601 format. If this date is missing, then the
-   * vetting was not complete or not valid.
-   */
-  vettedDate?: string;
-
-  /**
-   * Identifies the vetting classification.
-   */
-  vettingClass?: string;
-
-  /**
-   * Unique ID that identifies a vetting transaction performed by a vetting provider.
-   * This ID is provided by the vetting provider at time of vetting.
-   */
-  vettingId?: string;
-
-  /**
-   * Vetting score ranging from 0-100.
-   */
-  vettingScore?: number;
-
-  /**
-   * Required by some providers for vetting record confirmation.
-   */
-  vettingToken?: string;
-}
+export type ExternalVettingListResponse = Array<ExternalVetting>;
 
 export interface ExternalVettingImportsParams {
   /**
@@ -229,11 +145,10 @@ export interface ExternalVettingOrderParams {
   vettingClass: string;
 }
 
-export declare namespace ExternalVetting {
+export declare namespace ExternalVettingResource {
   export {
+    type ExternalVetting as ExternalVetting,
     type ExternalVettingListResponse as ExternalVettingListResponse,
-    type ExternalVettingImportsResponse as ExternalVettingImportsResponse,
-    type ExternalVettingOrderResponse as ExternalVettingOrderResponse,
     type ExternalVettingImportsParams as ExternalVettingImportsParams,
     type ExternalVettingOrderParams as ExternalVettingOrderParams,
   };

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

@@ -5,6 +5,7 @@ export {
   type AltBusinessIDType,
   type BrandIdentityStatus,
   type BrandOptionalAttributes,
+  type BrandSMSOtpStatus,
   type EntityType,
   type StockExchange,
   type TelnyxBrand,
@@ -12,8 +13,6 @@ export {
   type BrandRetrieveResponse,
   type BrandListResponse,
   type BrandGetFeedbackResponse,
-  type BrandGetSMSOtpByReferenceResponse,
-  type BrandRetrieveSMSOtpStatusResponse,
   type BrandTriggerSMSOtpResponse,
   type BrandCreateParams,
   type BrandUpdateParams,
@@ -24,10 +23,9 @@ export {
   type BrandListResponsesPerPagePaginationV2,
 } from './brand';
 export {
-  ExternalVetting,
+  ExternalVettingResource,
+  type ExternalVetting,
   type ExternalVettingListResponse,
-  type ExternalVettingImportsResponse,
-  type ExternalVettingOrderResponse,
   type ExternalVettingImportsParams,
   type ExternalVettingOrderParams,
 } from './external-vetting';

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

@@ -861,6 +861,9 @@ export interface CampaignUpdateParams {
 }
 
 export interface CampaignListParams extends PerPagePaginationV2Params {
+  /**
+   * Filter results by brand id.
+   */
   brandId: string;
 
   /**

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

@@ -35,6 +35,9 @@ export interface UsecaseGetCostResponse {
 }
 
 export interface UsecaseGetCostParams {
+  /**
+   * Filter results by usecase.
+   */
   usecase: string;
 }
 

package/src/resources/messaging-10dlc/campaign-builder/brand.ts

@@ -71,6 +71,9 @@ export interface BrandQualifyByUsecaseResponse {
 }
 
 export interface BrandQualifyByUsecaseParams {
+  /**
+   * Unique identifier of the brand.
+   */
   brandId: string;
 }
 

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

@@ -5,6 +5,7 @@ export {
   type AltBusinessIDType,
   type BrandIdentityStatus,
   type BrandOptionalAttributes,
+  type BrandSMSOtpStatus,
   type EntityType,
   type StockExchange,
   type TelnyxBrand,
@@ -12,8 +13,6 @@ export {
   type BrandRetrieveResponse,
   type BrandListResponse,
   type BrandGetFeedbackResponse,
-  type BrandGetSMSOtpByReferenceResponse,
-  type BrandRetrieveSMSOtpStatusResponse,
   type BrandTriggerSMSOtpResponse,
   type BrandCreateParams,
   type BrandUpdateParams,

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

@@ -43,14 +43,13 @@ import {
   BrandCreateParams,
   BrandGetFeedbackResponse,
   BrandGetSMSOtpByReferenceParams,
-  BrandGetSMSOtpByReferenceResponse,
   BrandIdentityStatus,
   BrandListParams,
   BrandListResponse,
   BrandListResponsesPerPagePaginationV2,
   BrandOptionalAttributes,
   BrandRetrieveResponse,
-  BrandRetrieveSMSOtpStatusResponse,
+  BrandSMSOtpStatus,
   BrandTriggerSMSOtpParams,
   BrandTriggerSMSOtpResponse,
   BrandUpdateParams,
@@ -159,6 +158,7 @@ export declare namespace Messaging10dlc {
     type AltBusinessIDType as AltBusinessIDType,
     type BrandIdentityStatus as BrandIdentityStatus,
     type BrandOptionalAttributes as BrandOptionalAttributes,
+    type BrandSMSOtpStatus as BrandSMSOtpStatus,
     type EntityType as EntityType,
     type StockExchange as StockExchange,
     type TelnyxBrand as TelnyxBrand,
@@ -166,8 +166,6 @@ export declare namespace Messaging10dlc {
     type BrandRetrieveResponse as BrandRetrieveResponse,
     type BrandListResponse as BrandListResponse,
     type BrandGetFeedbackResponse as BrandGetFeedbackResponse,
-    type BrandGetSMSOtpByReferenceResponse as BrandGetSMSOtpByReferenceResponse,
-    type BrandRetrieveSMSOtpStatusResponse as BrandRetrieveSMSOtpStatusResponse,
     type BrandTriggerSMSOtpResponse as BrandTriggerSMSOtpResponse,
     type BrandListResponsesPerPagePaginationV2 as BrandListResponsesPerPagePaginationV2,
     type BrandCreateParams as BrandCreateParams,

package/src/resources/messaging-10dlc/phone-number-assignment-by-profile.ts

@@ -188,14 +188,26 @@ export interface PhoneNumberAssignmentByProfileAssignParams {
 }
 
 export interface PhoneNumberAssignmentByProfileListPhoneNumberStatusParams {
+  /**
+   * Page number to retrieve (1-based).
+   */
   page?: number;
 
+  /**
+   * Number of records to return per page.
+   */
   recordsPerPage?: number;
 }
 
 export interface PhoneNumberAssignmentByProfileRetrievePhoneNumberStatusParams {
+  /**
+   * Page number to retrieve (1-based).
+   */
   page?: number;
 
+  /**
+   * Number of records to return per page.
+   */
   recordsPerPage?: number;
 }