telnyx 7.28.0 → 7.29.0

package/src/resources/email/ip-pools/ip-pools.ts

@@ -0,0 +1,247 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as DedicatedIPsAPI from '../dedicated-ips/dedicated-ips';
+import * as IPsAPI from './ips';
+import { IPCreateParams, IPCreateResponse, IPDeleteParams, IPs } from './ips';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Group dedicated IPs into pools for sending.
+ */
+export class IPPools extends APIResource {
+  ips: IPsAPI.IPs = new IPsAPI.IPs(this._client);
+
+  /**
+   * List the account's dedicated-IP pools. Member IPs are not included (`ips` is
+   * empty); retrieve a pool to see its members.
+   *
+   * @example
+   * ```ts
+   * const ipPools = await client.email.ipPools.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<IPPoolListResponse> {
+    return this._client.get('/email/ip_pools', options);
+  }
+
+  /**
+   * Create an account-scoped pool of dedicated IPs. Set `is_default` or `domain_id`
+   * for the pool to carry mail; a pool with neither carries none.
+   *
+   * @example
+   * ```ts
+   * const ipPoolShowResponse =
+   *   await client.email.ipPools.create({
+   *     name: 'primary-pool',
+   *     is_default: true,
+   *   });
+   * ```
+   */
+  create(body: IPPoolCreateParams, options?: RequestOptions): APIPromise<IPPoolShowResponse> {
+    return this._client.post('/email/ip_pools', { body, ...options });
+  }
+
+  /**
+   * Delete the pool. Member IPs are kept but leave the pool, so they carry no mail
+   * until added to another pool. Deleting a pool changes routing for subsequently
+   * resolved messages. It does not reroute messages already assigned to the deleted
+   * pool. Deleting a pool that still has IPs requires `force=true` and `drain=true`.
+   *
+   * @example
+   * ```ts
+   * await client.email.ipPools.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  delete(
+    id: string,
+    params: IPPoolDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { drain, force } = params ?? {};
+    return this._client.delete(path`/email/ip_pools/${id}`, {
+      query: { drain, force },
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieve a single IP pool by its identifier, including its dedicated-IP members
+   * with billing state.
+   *
+   * @example
+   * ```ts
+   * const ipPoolShowResponse =
+   *   await client.email.ipPools.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<IPPoolShowResponse> {
+    return this._client.get(path`/email/ip_pools/${id}`, options);
+  }
+
+  /**
+   * Rename the pool, set or clear the default flag, or change its domain scope.
+   * Routing follows the new settings for subsequent mail.
+   *
+   * @example
+   * ```ts
+   * const ipPoolShowResponse =
+   *   await client.email.ipPools.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { name: 'renamed-pool' },
+   *   );
+   * ```
+   */
+  update(id: string, body: IPPoolUpdateParams, options?: RequestOptions): APIPromise<IPPoolShowResponse> {
+    return this._client.patch(path`/email/ip_pools/${id}`, { body, ...options });
+  }
+}
+
+/**
+ * An account-scoped pool of dedicated IPs. Mail uses a pool only when the pool is
+ * scoped to the sending domain (`domain_id`) or is the account default
+ * (`is_default`).
+ */
+export interface IPPool {
+  id?: string;
+
+  created_at?: string;
+
+  /**
+   * Email domain this pool is scoped to. The pool carries that domain's mail. Null
+   * when the pool is not domain-scoped.
+   */
+  domain_id?: string | null;
+
+  /**
+   * Member IPs with their routing weights. Populated by Retrieve an IP pool; list,
+   * create, and update responses return an empty array.
+   */
+  ips?: Array<IPPool.IP>;
+
+  /**
+   * Whether this is the account's default pool. The default pool carries mail for
+   * sending domains that have no domain-scoped pool. At most one per account.
+   */
+  is_default?: boolean;
+
+  /**
+   * Pool name, unique within the account.
+   */
+  name?: string;
+
+  record_type?: 'ip_pool';
+
+  updated_at?: string;
+}
+
+export namespace IPPool {
+  /**
+   * A dedicated IP as a member of a pool, with its routing weight in this pool.
+   * Weight is a positive integer (default 100).
+   */
+  export interface IP extends DedicatedIPsAPI.DedicatedIP {
+    /**
+     * Relative routing weight of this IP within the pool.
+     */
+    weight?: number;
+  }
+}
+
+export interface IPPoolShowResponse {
+  /**
+   * An account-scoped pool of dedicated IPs. Mail uses a pool only when the pool is
+   * scoped to the sending domain (`domain_id`) or is the account default
+   * (`is_default`).
+   */
+  data: IPPool;
+}
+
+export interface IPPoolListResponse {
+  data: Array<IPPool>;
+}
+
+export interface IPPoolCreateParams {
+  /**
+   * Pool name: 1-64 characters of lowercase letters, digits, `.`, `_`, and `-`,
+   * starting and ending with a letter or digit. Must be unique within the account
+   * and must not start with `dip_`.
+   */
+  name: string;
+
+  /**
+   * Scope the pool to one of the account's email domains; the pool then carries that
+   * domain's mail. Scope at most one pool to each domain.
+   */
+  domain_id?: string;
+
+  /**
+   * Make this the account's default pool, which carries mail for sending domains
+   * without a domain-scoped pool. An account can have one default pool. Defaults to
+   * `false`.
+   */
+  is_default?: boolean;
+}
+
+export interface IPPoolDeleteParams {
+  /**
+   * Set together with `force=true` to delete a pool that still has IPs. Acknowledges
+   * deletion while the pool still has members; this flag does not reroute already
+   * queued messages.
+   */
+  drain?: boolean;
+
+  /**
+   * Set together with `drain=true` to delete a pool that still has IPs. Either flag
+   * alone has no effect.
+   */
+  force?: boolean;
+}
+
+export interface IPPoolUpdateParams {
+  /**
+   * Scope the pool to one of the account's email domains, or `null` to remove the
+   * scope.
+   */
+  domain_id?: string | null;
+
+  /**
+   * Set or clear the account default flag. An account can have one default pool.
+   */
+  is_default?: boolean;
+
+  /**
+   * Pool name: 1-64 characters of lowercase letters, digits, `.`, `_`, and `-`,
+   * starting and ending with a letter or digit. Must be unique within the account
+   * and must not start with `dip_`.
+   */
+  name?: string;
+}
+
+IPPools.IPs = IPs;
+
+export declare namespace IPPools {
+  export {
+    type IPPool as IPPool,
+    type IPPoolShowResponse as IPPoolShowResponse,
+    type IPPoolListResponse as IPPoolListResponse,
+    type IPPoolCreateParams as IPPoolCreateParams,
+    type IPPoolDeleteParams as IPPoolDeleteParams,
+    type IPPoolUpdateParams as IPPoolUpdateParams,
+  };
+
+  export {
+    IPs as IPs,
+    type IPCreateResponse as IPCreateResponse,
+    type IPCreateParams as IPCreateParams,
+    type IPDeleteParams as IPDeleteParams,
+  };
+}

package/src/resources/email/ip-pools/ips.ts

@@ -0,0 +1,112 @@
+// 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 { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Group dedicated IPs into pools for sending.
+ */
+export class IPs extends APIResource {
+  /**
+   * Add a dedicated IP to the pool with an optional routing weight. An IP can belong
+   * to one pool; to move an IP that is already in a pool, use
+   * `PATCH /email/dedicated_ips/{id}` with `pool_id`.
+   *
+   * @example
+   * ```ts
+   * const ip = await client.email.ipPools.ips.create(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     dedicated_ip_id: '6a7f9a30-1234-4b5c-8d9e-0f1a2b3c4d5e',
+   *     weight: 100,
+   *   },
+   * );
+   * ```
+   */
+  create(id: string, body: IPCreateParams, options?: RequestOptions): APIPromise<IPCreateResponse> {
+    return this._client.post(path`/email/ip_pools/${id}/ips`, { body, ...options });
+  }
+
+  /**
+   * Remove the dedicated IP from the pool. The IP is kept but carries no mail until
+   * added to a pool again. Removing the last IP requires `force=true` and
+   * `drain=true`.
+   *
+   * @example
+   * ```ts
+   * await client.email.ipPools.ips.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   * );
+   * ```
+   */
+  delete(ipID: string, params: IPDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { id, drain, force } = params;
+    return this._client.delete(path`/email/ip_pools/${id}/ips/${ipID}`, {
+      query: { drain, force },
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface IPCreateResponse {
+  data: IPCreateResponse.Data;
+}
+
+export namespace IPCreateResponse {
+  export interface Data {
+    created_at?: string;
+
+    dedicated_ip_id?: string;
+
+    pool_id?: string;
+
+    weight?: number;
+  }
+}
+
+export interface IPCreateParams {
+  /**
+   * The dedicated IP to add. It must belong to the account, must not be released,
+   * and must not already be in a pool.
+   */
+  dedicated_ip_id: string;
+
+  /**
+   * Relative routing weight for this IP in the pool. Positive integer; defaults
+   * to 100.
+   */
+  weight?: number;
+}
+
+export interface IPDeleteParams {
+  /**
+   * Path param: The IP pool identifier (UUID).
+   */
+  id: string;
+
+  /**
+   * Query param: Set together with `force=true` to remove the last IP in the pool.
+   * Acknowledges that mail routed to the emptied pool is held until the pool has a
+   * sendable IP again.
+   */
+  drain?: boolean;
+
+  /**
+   * Query param: Set together with `drain=true` to remove the last IP in the pool.
+   * Either flag alone has no effect.
+   */
+  force?: boolean;
+}
+
+export declare namespace IPs {
+  export {
+    type IPCreateResponse as IPCreateResponse,
+    type IPCreateParams as IPCreateParams,
+    type IPDeleteParams as IPDeleteParams,
+  };
+}

package/src/resources/email/ip-pools.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './ip-pools/index';

package/src/resources/email.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './email/index';

package/src/resources/fax-applications.ts

@@ -190,8 +190,8 @@ export namespace FaxApplication {
      * in the same way a phone number is used, from a SIP endpoint. Example: the
      * subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
      * the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-     * alphanumeric value. Please note TLS encrypted calls are not allowed for
-     * subdomain calls.
+     * alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+     * TLS transport.
      */
     sip_subdomain?: string;
 
@@ -349,8 +349,8 @@ export namespace FaxApplicationCreateParams {
      * in the same way a phone number is used, from a SIP endpoint. Example: the
      * subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
      * the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-     * alphanumeric value. Please note TLS encrypted calls are not allowed for
-     * subdomain calls.
+     * alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+     * TLS transport.
      */
     sip_subdomain?: string;
 
@@ -440,8 +440,8 @@ export namespace FaxApplicationUpdateParams {
      * in the same way a phone number is used, from a SIP endpoint. Example: the
      * subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
      * the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-     * alphanumeric value. Please note TLS encrypted calls are not allowed for
-     * subdomain calls.
+     * alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+     * TLS transport.
      */
     sip_subdomain?: string;
 

package/src/resources/fqdn-connections/fqdn-connections.ts

@@ -436,8 +436,8 @@ export interface InboundFqdn {
    * in the same way a phone number is used, from a SIP endpoint. Example: the
    * subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
    * the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-   * alphanumeric value. Please note TLS encrypted calls are not allowed for
-   * subdomain calls.
+   * alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+   * TLS transport.
    */
   sip_subdomain?: string | null;
 

package/src/resources/index.ts

@@ -57,6 +57,7 @@ export {
   type AlphanumericSenderIDCreateParams,
   type AlphanumericSenderIDsDefaultFlatPagination,
 } from './alphanumeric-sender-ids';
+export { ArtifactDownloads, type ArtifactDownloadRetrieveParams } from './artifact-downloads';
 export {
   AuditEvents,
   type AuditEventListResponse,
@@ -112,6 +113,18 @@ export {
   type BotSignupCreateParams,
   type BotSignupResendMagicLinkParams,
 } from './bot-signup';
+export {
+  BrowserSessions,
+  type Session,
+  type BrowserSessionCreateResponse,
+  type BrowserSessionRetrieveResponse,
+  type BrowserSessionListResponse,
+  type BrowserSessionDeleteResponse,
+  type BrowserSessionRetrieveArtifactResponse,
+  type BrowserSessionRetrieveArtifactParams,
+  type BrowserSessionListParams,
+  type BrowserSessionCreateParams,
+} from './browser-sessions/browser-sessions';
 export {
   BulkSimCardActions,
   type BulkSimCardActionDetailed,
@@ -354,6 +367,7 @@ export {
   type DynamicEmergencyEndpointCreateParams,
   type DynamicEmergencyEndpointsDefaultFlatPagination,
 } from './dynamic-emergency-endpoints';
+export { Email } from './email/email';
 export {
   EmailBlocks,
   type EmailBlock,
@@ -809,6 +823,7 @@ export {
   type MessagingMessagingProfile,
   type MessagingProfile,
   type MessagingProfileFeatures,
+  type Mm7Metadata,
   type NumberPoolSettings,
   type URLShortenerSettings,
   type MessagingProfileCreateResponse,
@@ -875,6 +890,16 @@ export {
   type NetworkCoverageListParams,
   type NetworkCoverageListResponsesDefaultFlatPagination,
 } from './network-coverage';
+export {
+  NetworkRoutes,
+  type NetappsCursorPaginationMeta,
+  type NetworkRoute,
+  type NetworkRouteCreateResponse,
+  type NetworkRouteRetrieveResponse,
+  type NetworkRouteListResponse,
+  type NetworkRouteListParams,
+  type NetworkRouteCreateParams,
+} from './network-routes';
 export {
   Networks,
   type InterfaceStatus,
@@ -1057,6 +1082,16 @@ export {
   type OutboundVoiceProfileUpdateParams,
   type OutboundVoiceProfilesDefaultFlatPagination,
 } from './outbound-voice-profiles';
+export {
+  PayConnectors,
+  type GenericPayConnectorConfig,
+  type PayConnector,
+  type PayConnectorResponse,
+  type PayConnectorListParams,
+  type PayConnectorCreateParams,
+  type PayConnectorUpdateParams,
+  type PayConnectorsEmailBracketCursorPagination,
+} from './pay-connectors';
 export {
   Payment,
   type PaymentCreateStoredPaymentTransactionResponse,
@@ -1380,6 +1415,7 @@ export {
 export {
   SpendLimits,
   type SpendLimit,
+  type SpendLimitBlock,
   type SpendLimitPeriod,
   type SpendLimitResponse,
   type SpendLimitListResponse,
@@ -1489,6 +1525,16 @@ export {
   type TrafficPolicyProfileListServicesResponsesDefaultFlatPagination,
 } from './traffic-policy-profiles';
 export { TtsIntegrations } from './tts-integrations/tts-integrations';
+export {
+  Tunnels,
+  type Tunnel,
+  type TunnelWithToken,
+  type TunnelCreateResponse,
+  type TunnelRetrieveResponse,
+  type TunnelListResponse,
+  type TunnelListParams,
+  type TunnelCreateParams,
+} from './tunnels/tunnels';
 export {
   UacConnections,
   type UacConnection,

package/src/resources/ip-connections.ts

@@ -186,8 +186,8 @@ export interface InboundIP {
    * in the same way a phone number is used, from a SIP endpoint. Example: the
    * subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
    * the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-   * alphanumeric value. Please note TLS encrypted calls are not allowed for
-   * subdomain calls.
+   * alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+   * TLS transport.
    */
   sip_subdomain?: string;
 
@@ -739,8 +739,8 @@ export namespace IPConnectionCreateParams {
      * in the same way a phone number is used, from a SIP endpoint. Example: the
      * subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
      * the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-     * alphanumeric value. Please note TLS encrypted calls are not allowed for
-     * subdomain calls.
+     * alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+     * TLS transport.
      */
     sip_subdomain?: string;
 

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

@@ -19,6 +19,7 @@ export {
   type MessagingMessagingProfile,
   type MessagingProfile,
   type MessagingProfileFeatures,
+  type Mm7Metadata,
   type NumberPoolSettings,
   type URLShortenerSettings,
   type MessagingProfileCreateResponse,

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

@@ -285,6 +285,11 @@ export interface MessagingMessagingProfile {
    */
   health_webhook_url?: string | null;
 
+  /**
+   * MM7 settings for inbound messages
+   */
+  mm7_metadata?: Mm7Metadata | null;
+
   /**
    * enables SMS fallback for MMS messages.
    */
@@ -567,6 +572,21 @@ export interface MessagingProfileFeatures {
   [k: string]: unknown;
 }
 
+/**
+ * MM7 settings for inbound messages
+ */
+export interface Mm7Metadata {
+  /**
+   * Failover webhook URL to receive inbound MM7 traffic
+   */
+  mm7_failover_webhook_url?: string;
+
+  /**
+   * Webhook URL to receive inbound MM7 traffic
+   */
+  mm7_webhook_url?: string;
+}
+
 /**
  * Number Pool allows you to send messages from a pool of numbers of different
  * types, assigning weights to each type. The pool consists of all the long code
@@ -756,6 +776,11 @@ export interface MessagingProfileCreateParams {
    */
   health_webhook_url?: string | null;
 
+  /**
+   * MM7 settings for inbound messages
+   */
+  mm7_metadata?: Mm7Metadata | null;
+
   /**
    * enables SMS fallback for MMS messages.
    */
@@ -856,6 +881,11 @@ export interface MessagingProfileUpdateParams {
    */
   features?: MessagingProfileFeatures | null;
 
+  /**
+   * MM7 settings for inbound messages
+   */
+  mm7_metadata?: Mm7Metadata | null;
+
   /**
    * enables SMS fallback for MMS messages.
    */
@@ -971,6 +1001,7 @@ export declare namespace MessagingProfiles {
     type MessagingMessagingProfile as MessagingMessagingProfile,
     type MessagingProfile as MessagingProfile,
     type MessagingProfileFeatures as MessagingProfileFeatures,
+    type Mm7Metadata as Mm7Metadata,
     type NumberPoolSettings as NumberPoolSettings,
     type URLShortenerSettings as URLShortenerSettings,
     type MessagingProfileCreateResponse as MessagingProfileCreateResponse,