telnyx 7.13.0 → 7.14.0

package/src/resources/messages/rcs.ts

@@ -30,7 +30,8 @@ export class Rcs extends APIResource {
   }
 
   /**
-   * Send an RCS message
+   * Queues an outbound RCS message through the selected RCS agent. Check recipient
+   * capabilities before sending features that require RCS support.
    *
    * @example
    * ```ts

package/src/resources/messaging/rcs/agents.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as RcsAgentsAPI from '../../rcs-agents';
-import { RcsAgentsDefaultFlatPagination } from '../../rcs-agents';
+import * as RcsAgentsAPI from '../../rcs/agents/agents';
+import { RcsAgentsDefaultFlatPagination } from '../../rcs/agents/agents';
 import { APIPromise } from '../../../core/api-promise';
 import {
   DefaultFlatPagination,
@@ -17,7 +17,7 @@ import { path } from '../../../internal/utils/path';
  */
 export class Agents extends APIResource {
   /**
-   * List all RCS agents
+   * Returns RCS agents available to the authenticated account.
    *
    * @example
    * ```ts
@@ -38,7 +38,7 @@ export class Agents extends APIResource {
   }
 
   /**
-   * Retrieve an RCS agent
+   * Returns the configuration and current state of the specified RCS agent.
    *
    * @example
    * ```ts
@@ -51,7 +51,7 @@ export class Agents extends APIResource {
   }
 
   /**
-   * Modify an RCS agent
+   * Updates the supplied configuration fields on the specified RCS agent.
    *
    * @example
    * ```ts

package/src/resources/messaging/rcs/rcs.ts

@@ -14,7 +14,7 @@ export class Rcs extends APIResource {
   agents: AgentsAPI.Agents = new AgentsAPI.Agents(this._client);
 
   /**
-   * Check RCS capabilities (batch)
+   * Returns RCS capability information for multiple recipients in one request.
    *
    * @example
    * ```ts
@@ -33,7 +33,8 @@ export class Rcs extends APIResource {
   }
 
   /**
-   * Check RCS capabilities
+   * Returns the RCS features supported by the specified recipient for the selected
+   * agent.
    *
    * @example
    * ```ts

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

@@ -141,7 +141,9 @@ export class Brand extends APIResource {
   }
 
   /**
-   * Resend brand 2FA email
+   * Requests a new two-factor authentication email for the specified 10DLC brand.
+   * Complete verification through the link delivered to the brand contact before
+   * continuing registration.
    *
    * @example
    * ```ts

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

@@ -36,7 +36,7 @@ export class ExternalVettingResource extends APIResource {
    * const externalVetting =
    *   await client.messaging10dlc.brand.externalVetting.order(
    *     'brandId',
-   *     { evpId: 'evpId', vettingClass: 'vettingClass' },
+   *     { evpId: 'Evpid', vettingClass: 'Vettingclass' },
    *   );
    * ```
    */
@@ -59,7 +59,11 @@ export class ExternalVettingResource extends APIResource {
    * const externalVetting =
    *   await client.messaging10dlc.brand.externalVetting.imports(
    *     'brandId',
-   *     { evpId: 'evpId', vettingId: 'vettingId' },
+   *     {
+   *       evpId: 'Evpid',
+   *       vettingId: 'Vettingid',
+   *       vettingToken: 'Vettingtoken',
+   *     },
    *   );
    * ```
    */

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

@@ -92,7 +92,22 @@ export class Campaign extends APIResource {
    * @example
    * ```ts
    * const telnyxCampaignCsp =
-   *   await client.messaging10dlc.campaign.update('campaignId');
+   *   await client.messaging10dlc.campaign.update(
+   *     'campaignId',
+   *     {
+   *       autoRenewal: true,
+   *       helpMessage: 'Helpmessage',
+   *       messageFlow: 'Messageflow',
+   *       resellerId: 'RESELLER',
+   *       sample1: 'Sample1',
+   *       sample2: 'Sample2',
+   *       sample3: 'Sample3',
+   *       sample4: 'Sample4',
+   *       sample5: 'Sample5',
+   *       webhookFailoverURL: 'WebhookURL',
+   *       webhookURL: 'WebhookURL',
+   *     },
+   *   );
    * ```
    */
   update(
@@ -163,7 +178,8 @@ export class Campaign extends APIResource {
   }
 
   /**
-   * Get Sharing Status
+   * Returns whether the campaign is configured for partner sharing and the current
+   * sharing state.
    *
    * @example
    * ```ts

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

@@ -10,7 +10,9 @@ import { path } from '../../../internal/utils/path';
  */
 export class Osr extends APIResource {
   /**
-   * Get OSR campaign attributes
+   * Returns the optional shared-responsibility attributes recorded for the campaign.
+   * Use these values to inspect the campaign configuration submitted to the
+   * registry.
    *
    * @example
    * ```ts

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

@@ -9,7 +9,8 @@ import { RequestOptions } from '../../../internal/request-options';
  */
 export class Usecase extends APIResource {
   /**
-   * Get Campaign Cost
+   * Returns the upfront and monthly cost associated with the selected 10DLC campaign
+   * use case.
    *
    * @example
    * ```ts

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

@@ -95,7 +95,8 @@ export class Messaging10dlc extends APIResource {
     new PhoneNumberAssignmentByProfileAPI.PhoneNumberAssignmentByProfile(this._client);
 
   /**
-   * Get Enum
+   * Returns the accepted values for the selected 10DLC enumeration endpoint. Use
+   * these values when constructing brand and campaign requests.
    *
    * @example
    * ```ts

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

@@ -38,7 +38,7 @@ export class PartnerCampaigns extends APIResource {
   }
 
   /**
-   * Get Sharing Status
+   * Returns the partner-sharing state for the specified campaign.
    *
    * @example
    * ```ts

package/src/resources/messaging-10dlc/phone-number-campaigns.ts

@@ -11,7 +11,8 @@ import { path } from '../../internal/utils/path';
  */
 export class PhoneNumberCampaigns extends APIResource {
   /**
-   * List phone number campaigns
+   * Returns phone-number-to-campaign assignments for the authenticated account.
+   * Apply the documented filters and pagination parameters to narrow the result set.
    *
    * @example
    * ```ts
@@ -33,7 +34,8 @@ export class PhoneNumberCampaigns extends APIResource {
   }
 
   /**
-   * Create New Phone Number Campaign
+   * Assigns a phone number to a 10DLC campaign. The assignment controls which
+   * registered campaign is used for traffic from that number.
    *
    * @example
    * ```ts
@@ -80,7 +82,7 @@ export class PhoneNumberCampaigns extends APIResource {
   }
 
   /**
-   * Create New Phone Number Campaign
+   * Replaces the 10DLC campaign assignment for the specified phone number.
    *
    * @example
    * ```ts

package/src/resources/messaging-hosted-number-orders/actions.ts

@@ -13,7 +13,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Actions extends APIResource {
   /**
-   * Upload hosted number document
+   * Uploads a supporting document to the specified hosted-messaging order.
    *
    * @example
    * ```ts

package/src/resources/messaging-hosted-number-orders/messaging-hosted-number-orders.ts

@@ -17,7 +17,8 @@ export class MessagingHostedNumberOrders extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
-   * List messaging hosted number orders
+   * Returns hosted-messaging orders for the authenticated account. Apply the
+   * documented filters and pagination parameters to narrow the result set.
    *
    * @example
    * ```ts
@@ -39,7 +40,8 @@ export class MessagingHostedNumberOrders extends APIResource {
   }
 
   /**
-   * Create a messaging hosted number order
+   * Creates an order to enable Telnyx messaging on phone numbers whose voice service
+   * remains with another carrier.
    *
    * @example
    * ```ts
@@ -55,7 +57,8 @@ export class MessagingHostedNumberOrders extends APIResource {
   }
 
   /**
-   * Check hosted messaging eligibility
+   * Checks whether the supplied phone numbers are eligible for hosted messaging
+   * before an order is created.
    *
    * @example
    * ```ts
@@ -89,7 +92,8 @@ export class MessagingHostedNumberOrders extends APIResource {
   }
 
   /**
-   * Retrieve a messaging hosted number order
+   * Returns the current state, phone numbers, and required actions for the specified
+   * hosted-messaging order.
    *
    * @example
    * ```ts
@@ -112,7 +116,7 @@ export class MessagingHostedNumberOrders extends APIResource {
    *     'id',
    *     {
    *       verification_codes: [
-   *         { code: 'code', phone_number: 'phone_number' },
+   *         { phone_number: 'string', code: 'string' },
    *       ],
    *     },
    *   );

package/src/resources/messaging-hosted-numbers.ts

@@ -10,7 +10,7 @@ import { path } from '../internal/utils/path';
 
 export class MessagingHostedNumbers extends APIResource {
   /**
-   * Delete a messaging hosted number
+   * Removes the specified hosted number from Telnyx messaging management.
    *
    * @example
    * ```ts

package/src/resources/messaging-numbers-bulk-updates.ts

@@ -10,7 +10,8 @@ import { path } from '../internal/utils/path';
  */
 export class MessagingNumbersBulkUpdates extends APIResource {
   /**
-   * Bulk update phone number profiles
+   * Starts a bulk update of messaging-profile assignments for the supplied phone
+   * numbers. The response identifies the order used to monitor processing.
    *
    * @example
    * ```ts
@@ -34,7 +35,8 @@ export class MessagingNumbersBulkUpdates extends APIResource {
   }
 
   /**
-   * Retrieve bulk update status
+   * Returns processing status and results for a bulk messaging-settings update
+   * order.
    *
    * @example
    * ```ts

package/src/resources/messaging-profile-metrics.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as Shared from './shared';
+import * as AlphanumericSenderIDsAPI from './alphanumeric-sender-ids';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
@@ -26,7 +26,7 @@ export type MessagingMetricsTimeFrame = '1h' | '3h' | '24h' | '3d' | '7d' | '30d
 export interface MessagingProfileMetricListResponse {
   data?: Array<{ [key: string]: unknown }>;
 
-  meta?: Shared.MessagingPaginationMeta;
+  meta?: AlphanumericSenderIDsAPI.MessagingPaginationMeta0b38e7044b;
 }
 
 export interface MessagingProfileMetricListParams {

package/src/resources/messaging-profiles/autoresp-configs.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as Shared from '../shared';
+import * as AlphanumericSenderIDsAPI from '../alphanumeric-sender-ids';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -11,7 +11,7 @@ import { path } from '../../internal/utils/path';
  */
 export class AutorespConfigs extends APIResource {
   /**
-   * List Auto-Response Settings
+   * Returns the auto-response rules configured for the specified messaging profile.
    *
    * @example
    * ```ts
@@ -30,7 +30,8 @@ export class AutorespConfigs extends APIResource {
   }
 
   /**
-   * Create auto-response setting
+   * Creates an auto-response rule on the specified messaging profile. Matching
+   * inbound messages trigger the configured response.
    *
    * @example
    * ```ts
@@ -54,7 +55,7 @@ export class AutorespConfigs extends APIResource {
   }
 
   /**
-   * Delete Auto-Response Setting
+   * Deletes the specified auto-response rule from the messaging profile.
    *
    * @example
    * ```ts
@@ -78,7 +79,8 @@ export class AutorespConfigs extends APIResource {
   }
 
   /**
-   * Get Auto-Response Setting
+   * Returns the matching criteria and response content for the specified
+   * auto-response rule.
    *
    * @example
    * ```ts
@@ -102,7 +104,7 @@ export class AutorespConfigs extends APIResource {
   }
 
   /**
-   * Update Auto-Response Setting
+   * Replaces the configuration of the specified auto-response rule.
    *
    * @example
    * ```ts
@@ -167,7 +169,7 @@ export interface AutoRespConfigResponse {
 export interface AutorespConfigListResponse {
   data: Array<AutoRespConfig>;
 
-  meta: Shared.MessagingPaginationMeta;
+  meta: AlphanumericSenderIDsAPI.MessagingPaginationMeta0b38e7044b;
 }
 
 export type AutorespConfigDeleteResponse = string;

package/src/resources/messaging-profiles/messaging-profiles.ts

@@ -35,7 +35,8 @@ export class MessagingProfiles extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
-   * List messaging profiles
+   * Returns messaging profiles owned by the authenticated account. Apply the
+   * documented filters and pagination parameters to narrow the result set.
    *
    * @example
    * ```ts
@@ -56,7 +57,8 @@ export class MessagingProfiles extends APIResource {
   }
 
   /**
-   * Create a messaging profile
+   * Creates a messaging profile that controls outbound sender selection, webhook
+   * delivery, and inbound message handling for associated numbers and short codes.
    *
    * @example
    * ```ts
@@ -75,7 +77,8 @@ export class MessagingProfiles extends APIResource {
   }
 
   /**
-   * Delete a messaging profile
+   * Deletes the specified messaging profile and returns the profile's final
+   * configuration.
    *
    * @example
    * ```ts
@@ -90,7 +93,8 @@ export class MessagingProfiles extends APIResource {
   }
 
   /**
-   * Retrieve a messaging profile
+   * Returns the complete configuration of the specified messaging profile, including
+   * webhook and sender-selection settings.
    *
    * @example
    * ```ts
@@ -108,7 +112,8 @@ export class MessagingProfiles extends APIResource {
   }
 
   /**
-   * Update a messaging profile
+   * Updates the supplied settings on the specified messaging profile. Settings
+   * omitted from the request remain unchanged.
    *
    * @example
    * ```ts
@@ -127,7 +132,8 @@ export class MessagingProfiles extends APIResource {
   }
 
   /**
-   * List phone numbers associated with a messaging profile
+   * Returns the phone numbers currently associated with the specified messaging
+   * profile.
    *
    * @example
    * ```ts
@@ -155,7 +161,8 @@ export class MessagingProfiles extends APIResource {
   }
 
   /**
-   * List short codes associated with a messaging profile
+   * Returns the short codes currently associated with the specified messaging
+   * profile.
    *
    * @example
    * ```ts

package/src/resources/messaging-tollfree/verification/index.ts

@@ -2,6 +2,9 @@
 
 export {
   Requests,
+  type MessagingTollFreeVerificationEntityType,
+  type MessagingTollFreeVerificationTfVerificationRequest,
+  type MessagingTollFreeVerificationVerificationRequestEgress,
   type TfPhoneNumber,
   type TfVerificationRequest,
   type TfVerificationStatus,
@@ -11,6 +14,7 @@ export {
   type VerificationRequestEgress,
   type VerificationRequestStatus,
   type Volume,
+  type RequestRetrieveResponse,
   type RequestRetrieveStatusHistoryResponse,
   type RequestListParams,
   type RequestCreateParams,