telnyx 7.13.0 → 7.14.0

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

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Agents,
+  type AgentCampaignConfiguration,
+  type AgentConfiguration,
+  type AgentConsentConfiguration,
+  type AgentEmailContact,
+  type AgentInteraction,
+  type AgentPhoneContact,
+  type AgentResponse,
+  type AgentSubmissionStatus,
+  type AgentTestingConfiguration,
+  type AgentUseCase,
+  type AgentWebsiteContact,
+  type CapabilitiesResponse,
+  type CarrierApprovalResponse,
+  type RcsAgent,
+  type RcsAgentResponse,
+  type AgentListResponse,
+  type AgentRetrieveCarrierApprovalsResponse,
+  type AgentListParams,
+  type AgentCreateParams,
+  type AgentUpdateParams,
+  type AgentLaunchParams,
+  type RcsAgentsDefaultFlatPagination,
+} from './agents';
+export {
+  TestDevices,
+  type TestDeviceResponse,
+  type TestDeviceListResponse,
+  type TestDeviceCreateParams,
+  type TestDeviceDeleteParams,
+} from './test-devices';

package/src/resources/rcs/agents/test-devices.ts

@@ -0,0 +1,94 @@
+// 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';
+
+/**
+ * Manage RCS agent registration, testing, verification, and launch.
+ */
+export class TestDevices extends APIResource {
+  /**
+   * Lists test devices attached to an RCS agent.
+   *
+   * @example
+   * ```ts
+   * const testDeviceResponses =
+   *   await client.rcs.agents.testDevices.list(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  list(id: string, options?: RequestOptions): APIPromise<TestDeviceListResponse> {
+    return this._client.get(path`/rcs/agents/${id}/test_devices`, options);
+  }
+
+  /**
+   * Adds an RCS-capable test number after provider agent creation. Repeating the
+   * request for a number already attached to the agent returns the existing test
+   * device.
+   *
+   * @example
+   * ```ts
+   * const testDeviceResponse =
+   *   await client.rcs.agents.testDevices.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { phone_number: '+13125550123' },
+   *   );
+   * ```
+   */
+  create(id: string, body: TestDeviceCreateParams, options?: RequestOptions): APIPromise<TestDeviceResponse> {
+    return this._client.post(path`/rcs/agents/${id}/test_devices`, { body, ...options });
+  }
+
+  /**
+   * Removes a test device from an RCS agent and its provider registration.
+   *
+   * @example
+   * ```ts
+   * await client.rcs.agents.testDevices.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   * );
+   * ```
+   */
+  delete(testDeviceID: string, params: TestDeviceDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { id } = params;
+    return this._client.delete(path`/rcs/agents/${id}/test_devices/${testDeviceID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface TestDeviceResponse {
+  invite_status: 'PENDING' | 'ACCEPTED' | 'DECLINED';
+
+  phone_number: string;
+
+  test_device_id: string;
+}
+
+export type TestDeviceListResponse = Array<TestDeviceResponse>;
+
+export interface TestDeviceCreateParams {
+  phone_number: string;
+}
+
+export interface TestDeviceDeleteParams {
+  /**
+   * The Telnyx-assigned agent identifier.
+   */
+  id: string;
+}
+
+export declare namespace TestDevices {
+  export {
+    type TestDeviceResponse as TestDeviceResponse,
+    type TestDeviceListResponse as TestDeviceListResponse,
+    type TestDeviceCreateParams as TestDeviceCreateParams,
+    type TestDeviceDeleteParams as TestDeviceDeleteParams,
+  };
+}

package/src/resources/rcs/agents.ts

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

package/src/resources/rcs/brands.ts

@@ -0,0 +1,385 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BrandsAPI from './brands';
+import * as AgentsAPI from './agents/agents';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Manage the legal business entities that operate RCS agents.
+ */
+export class Brands extends APIResource {
+  /**
+   * Lists RCS brands owned by the authenticated organization.
+   *
+   * @example
+   * ```ts
+   * const brandResponses = await client.rcs.brands.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<BrandListResponse> {
+    return this._client.get('/rcs/brands', options);
+  }
+
+  /**
+   * Creates an editable RCS brand draft. Creating the draft does not begin external
+   * review.
+   *
+   * @example
+   * ```ts
+   * const brandResponse = await client.rcs.brands.create({
+   *   addresses: {
+   *     primary: {
+   *       administrative_area: 'IL',
+   *       city: 'Chicago',
+   *       country_code: 'US',
+   *       line_1: '1 Main Street',
+   *       postal_code: '60601',
+   *     },
+   *   },
+   *   contacts: {
+   *     brand: {
+   *       contact_type: 'BRAND',
+   *       email: 'jane@example.com',
+   *       first_name: 'Jane',
+   *       last_name: 'Doe',
+   *       phone_number: '+13125550100',
+   *     },
+   *   },
+   *   display_name: 'Acme',
+   *   identifiers: {
+   *     ein: { identifier_type: 'EIN', value: '12-3456789' },
+   *   },
+   *   legal_entity_type: 'LIMITED_LIABILITY_COMPANY',
+   *   legal_name: 'Acme LLC',
+   *   organization_type: 'PRIVATE_PROFIT',
+   *   website_url: 'https://www.example.com',
+   * });
+   * ```
+   */
+  create(body: BrandCreateParams, options?: RequestOptions): APIPromise<BrandResponse> {
+    return this._client.post('/rcs/brands', { body, ...options });
+  }
+
+  /**
+   * Retrieves an RCS brand and its current lifecycle status.
+   *
+   * @example
+   * ```ts
+   * const brandResponse = await client.rcs.brands.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<BrandResponse> {
+    return this._client.get(path`/rcs/brands/${id}`, options);
+  }
+
+  /**
+   * Updates one or more fields on a brand while its status is `CREATED`. Submitted
+   * brands cannot be changed.
+   *
+   * @example
+   * ```ts
+   * const brandResponse = await client.rcs.brands.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  update(id: string, body: BrandUpdateParams, options?: RequestOptions): APIPromise<BrandResponse> {
+    return this._client.patch(path`/rcs/brands/${id}`, { body, ...options });
+  }
+
+  /**
+   * Starts asynchronous provider provisioning and external review for a brand.
+   * Repeating this request for an in-progress brand returns its current state
+   * without creating new work.
+   *
+   * @example
+   * ```ts
+   * const brandResponse = await client.rcs.brands.submit(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  submit(id: string, options?: RequestOptions): APIPromise<BrandResponse> {
+    return this._client.post(path`/rcs/brands/${id}/submit`, options);
+  }
+}
+
+export interface BrandContact {
+  contact_type: 'BRAND' | 'PRIMARY' | 'OFFICER' | 'AGENT' | 'RESPONSIBLE_PARTY' | 'BILLING' | 'UNKNOWN';
+
+  email: string;
+
+  first_name: string;
+
+  last_name: string;
+
+  phone_number: string;
+
+  title?: string | null;
+}
+
+export type BrandLegalEntityType =
+  | 'LIMITED_LIABILITY_COMPANY'
+  | 'SOLE_PROPRIETORSHIP'
+  | 'PARTNERSHIP'
+  | 'CORPORATION'
+  | 'S_CORPORATION';
+
+export type BrandOrganizationType =
+  | 'PRIVATE_PROFIT'
+  | 'PUBLIC_PROFIT'
+  | 'NON_PROFIT'
+  | 'GOVERNMENT'
+  | 'UNKNOWN';
+
+export interface BrandResponse {
+  addresses: { [key: string]: BrandResponse.Addresses };
+
+  brand_id: string;
+
+  capabilities: AgentsAPI.CapabilitiesResponse;
+
+  contacts: { [key: string]: BrandContact };
+
+  display_name: string;
+
+  identifiers: { [key: string]: EinBrandIdentifier | StockSymbolBrandIdentifier };
+
+  legal_entity_type: string;
+
+  legal_name: string;
+
+  organization_type: string;
+
+  profile_id: string | null;
+
+  status:
+    | 'CREATED'
+    | 'CONFIGURED'
+    | 'SUBMITTED'
+    | 'REVIEWING'
+    | 'VETTING'
+    | 'VERIFIED'
+    | 'REJECTED'
+    | 'FAILED';
+
+  website_url: string;
+}
+
+export namespace BrandResponse {
+  export interface Addresses {
+    administrative_area: string;
+
+    city: string;
+
+    /**
+     * The two-letter ISO 3166-1 country code.
+     */
+    country_code: string;
+
+    line_1: string;
+
+    postal_code: string;
+
+    line_2?: string | null;
+  }
+}
+
+export interface EinBrandIdentifier {
+  identifier_type: 'EIN';
+
+  /**
+   * Nine digits, optionally formatted as NN-NNNNNNN.
+   */
+  value: string;
+}
+
+export interface StockSymbolBrandIdentifier {
+  identifier_type: 'STOCK_SYMBOL';
+
+  /**
+   * A stock symbol using EXCHANGE:SYMBOL.
+   */
+  value: string;
+}
+
+export type BrandListResponse = Array<BrandResponse>;
+
+export interface BrandCreateParams {
+  addresses: { [key: string]: BrandCreateParams.Addresses };
+
+  /**
+   * Named business contacts. Use the `brand` key for the required BRAND contact.
+   */
+  contacts: BrandCreateParams.Contacts;
+
+  display_name: string;
+
+  /**
+   * Named business identifiers. Use the `ein` key for the required EIN and
+   * `stock_symbol` for a public-profit brand's stock symbol.
+   */
+  identifiers: BrandCreateParams.Identifiers;
+
+  legal_entity_type: BrandLegalEntityType;
+
+  legal_name: string;
+
+  organization_type: BrandOrganizationType;
+
+  website_url: string;
+
+  /**
+   * A Messaging Profile owned by the authenticated organization. Agents inherit this
+   * value when they do not provide their own profile.
+   */
+  profile_id?: string | null;
+}
+
+export namespace BrandCreateParams {
+  export interface Addresses {
+    administrative_area: string;
+
+    city: string;
+
+    /**
+     * The two-letter ISO 3166-1 country code.
+     */
+    country_code: string;
+
+    line_1: string;
+
+    postal_code: string;
+
+    line_2?: string | null;
+  }
+
+  /**
+   * Named business contacts. Use the `brand` key for the required BRAND contact.
+   */
+  export interface Contacts {
+    brand: Contacts.Brand;
+
+    [k: string]: BrandsAPI.BrandContact | Contacts.Brand | undefined;
+  }
+
+  export namespace Contacts {
+    export interface Brand extends Omit<BrandsAPI.BrandContact, 'contact_type'> {
+      contact_type?: 'BRAND';
+    }
+  }
+
+  /**
+   * Named business identifiers. Use the `ein` key for the required EIN and
+   * `stock_symbol` for a public-profit brand's stock symbol.
+   */
+  export interface Identifiers {
+    ein: BrandsAPI.EinBrandIdentifier;
+
+    stock_symbol?: BrandsAPI.StockSymbolBrandIdentifier;
+
+    [k: string]:
+      | BrandsAPI.EinBrandIdentifier
+      | BrandsAPI.StockSymbolBrandIdentifier
+      | BrandsAPI.EinBrandIdentifier
+      | BrandsAPI.StockSymbolBrandIdentifier
+      | undefined;
+  }
+}
+
+export interface BrandUpdateParams {
+  addresses?: { [key: string]: BrandUpdateParams.Addresses };
+
+  /**
+   * Named business contacts. Use the `brand` key for the required BRAND contact.
+   */
+  contacts?: BrandUpdateParams.Contacts;
+
+  display_name?: string;
+
+  /**
+   * Named business identifiers. Use the `ein` key for the required EIN and
+   * `stock_symbol` for a public-profit brand's stock symbol.
+   */
+  identifiers?: BrandUpdateParams.Identifiers;
+
+  legal_entity_type?: BrandLegalEntityType;
+
+  legal_name?: string;
+
+  organization_type?: BrandOrganizationType;
+
+  profile_id?: string;
+
+  website_url?: string;
+}
+
+export namespace BrandUpdateParams {
+  export interface Addresses {
+    administrative_area: string;
+
+    city: string;
+
+    /**
+     * The two-letter ISO 3166-1 country code.
+     */
+    country_code: string;
+
+    line_1: string;
+
+    postal_code: string;
+
+    line_2?: string | null;
+  }
+
+  /**
+   * Named business contacts. Use the `brand` key for the required BRAND contact.
+   */
+  export interface Contacts {
+    brand: Contacts.Brand;
+
+    [k: string]: BrandsAPI.BrandContact | Contacts.Brand | undefined;
+  }
+
+  export namespace Contacts {
+    export interface Brand extends Omit<BrandsAPI.BrandContact, 'contact_type'> {
+      contact_type?: 'BRAND';
+    }
+  }
+
+  /**
+   * Named business identifiers. Use the `ein` key for the required EIN and
+   * `stock_symbol` for a public-profit brand's stock symbol.
+   */
+  export interface Identifiers {
+    ein: BrandsAPI.EinBrandIdentifier;
+
+    stock_symbol?: BrandsAPI.StockSymbolBrandIdentifier;
+
+    [k: string]:
+      | BrandsAPI.EinBrandIdentifier
+      | BrandsAPI.StockSymbolBrandIdentifier
+      | BrandsAPI.EinBrandIdentifier
+      | BrandsAPI.StockSymbolBrandIdentifier
+      | undefined;
+  }
+}
+
+export declare namespace Brands {
+  export {
+    type BrandContact as BrandContact,
+    type BrandLegalEntityType as BrandLegalEntityType,
+    type BrandOrganizationType as BrandOrganizationType,
+    type BrandResponse as BrandResponse,
+    type EinBrandIdentifier as EinBrandIdentifier,
+    type StockSymbolBrandIdentifier as StockSymbolBrandIdentifier,
+    type BrandListResponse as BrandListResponse,
+    type BrandCreateParams as BrandCreateParams,
+    type BrandUpdateParams as BrandUpdateParams,
+  };
+}

package/src/resources/rcs/index.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Agents,
+  type AgentCampaignConfiguration,
+  type AgentConfiguration,
+  type AgentConsentConfiguration,
+  type AgentEmailContact,
+  type AgentInteraction,
+  type AgentPhoneContact,
+  type AgentResponse,
+  type AgentSubmissionStatus,
+  type AgentTestingConfiguration,
+  type AgentUseCase,
+  type AgentWebsiteContact,
+  type CapabilitiesResponse,
+  type CarrierApprovalResponse,
+  type RcsAgent,
+  type RcsAgentResponse,
+  type AgentListResponse,
+  type AgentRetrieveCarrierApprovalsResponse,
+  type AgentListParams,
+  type AgentCreateParams,
+  type AgentUpdateParams,
+  type AgentLaunchParams,
+  type RcsAgentsDefaultFlatPagination,
+} from './agents/index';
+export {
+  Brands,
+  type BrandContact,
+  type BrandLegalEntityType,
+  type BrandOrganizationType,
+  type BrandResponse,
+  type EinBrandIdentifier,
+  type StockSymbolBrandIdentifier,
+  type BrandListResponse,
+  type BrandCreateParams,
+  type BrandUpdateParams,
+} from './brands';
+export { Rcs } from './rcs';

package/src/resources/rcs/rcs.ts

@@ -0,0 +1,89 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BrandsAPI from './brands';
+import {
+  BrandContact,
+  BrandCreateParams,
+  BrandLegalEntityType,
+  BrandListResponse,
+  BrandOrganizationType,
+  BrandResponse,
+  BrandUpdateParams,
+  Brands,
+  EinBrandIdentifier,
+  StockSymbolBrandIdentifier,
+} from './brands';
+import * as AgentsAPI from './agents/agents';
+import {
+  AgentCampaignConfiguration,
+  AgentConfiguration,
+  AgentConsentConfiguration,
+  AgentCreateParams,
+  AgentEmailContact,
+  AgentInteraction,
+  AgentLaunchParams,
+  AgentListParams,
+  AgentListResponse,
+  AgentPhoneContact,
+  AgentResponse,
+  AgentRetrieveCarrierApprovalsResponse,
+  AgentSubmissionStatus,
+  AgentTestingConfiguration,
+  AgentUpdateParams,
+  AgentUseCase,
+  AgentWebsiteContact,
+  Agents,
+  CapabilitiesResponse,
+  CarrierApprovalResponse,
+  RcsAgent,
+  RcsAgentResponse,
+} from './agents/agents';
+
+export class Rcs extends APIResource {
+  agents: AgentsAPI.Agents = new AgentsAPI.Agents(this._client);
+  brands: BrandsAPI.Brands = new BrandsAPI.Brands(this._client);
+}
+
+Rcs.Agents = Agents;
+Rcs.Brands = Brands;
+
+export declare namespace Rcs {
+  export {
+    Agents as Agents,
+    type AgentCampaignConfiguration as AgentCampaignConfiguration,
+    type AgentConfiguration as AgentConfiguration,
+    type AgentConsentConfiguration as AgentConsentConfiguration,
+    type AgentEmailContact as AgentEmailContact,
+    type AgentInteraction as AgentInteraction,
+    type AgentPhoneContact as AgentPhoneContact,
+    type AgentResponse as AgentResponse,
+    type AgentSubmissionStatus as AgentSubmissionStatus,
+    type AgentTestingConfiguration as AgentTestingConfiguration,
+    type AgentUseCase as AgentUseCase,
+    type AgentWebsiteContact as AgentWebsiteContact,
+    type CapabilitiesResponse as CapabilitiesResponse,
+    type CarrierApprovalResponse as CarrierApprovalResponse,
+    type RcsAgent as RcsAgent,
+    type RcsAgentResponse as RcsAgentResponse,
+    type AgentListResponse as AgentListResponse,
+    type AgentRetrieveCarrierApprovalsResponse as AgentRetrieveCarrierApprovalsResponse,
+    type AgentListParams as AgentListParams,
+    type AgentCreateParams as AgentCreateParams,
+    type AgentUpdateParams as AgentUpdateParams,
+    type AgentLaunchParams as AgentLaunchParams,
+  };
+
+  export {
+    Brands as Brands,
+    type BrandContact as BrandContact,
+    type BrandLegalEntityType as BrandLegalEntityType,
+    type BrandOrganizationType as BrandOrganizationType,
+    type BrandResponse as BrandResponse,
+    type EinBrandIdentifier as EinBrandIdentifier,
+    type StockSymbolBrandIdentifier as StockSymbolBrandIdentifier,
+    type BrandListResponse as BrandListResponse,
+    type BrandCreateParams as BrandCreateParams,
+    type BrandUpdateParams as BrandUpdateParams,
+  };
+}

package/src/resources/rcs.ts

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

package/src/resources/regulatory-requirements.ts

@@ -9,7 +9,9 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class RegulatoryRequirements extends APIResource {
   /**
-   * Retrieve regulatory requirements
+   * Returns regulatory requirements for number ordering, porting, or other supported
+   * actions. Results can be filtered by phone number, requirement group, country,
+   * number type, and action.
    */
   retrieve(
     query: RegulatoryRequirementRetrieveParams | null | undefined = {},

package/src/resources/reports/index.ts

@@ -9,6 +9,7 @@ export {
   MdrUsageReports,
   type MdrUsageReport,
   type PaginationMetaReporting,
+  type ReportingPaginationMeta77109e5d17,
   type MdrUsageReportCreateResponse,
   type MdrUsageReportRetrieveResponse,
   type MdrUsageReportDeleteResponse,

package/src/resources/reports/mdr-usage-reports.ts

@@ -182,6 +182,16 @@ export interface PaginationMetaReporting {
   total_results?: number;
 }
 
+export interface ReportingPaginationMeta77109e5d17 {
+  page_number?: number;
+
+  page_size?: number;
+
+  total_pages?: number;
+
+  total_results?: number;
+}
+
 export interface MdrUsageReportCreateResponse {
   data?: MdrUsageReport;
 }
@@ -236,6 +246,7 @@ export declare namespace MdrUsageReports {
   export {
     type MdrUsageReport as MdrUsageReport,
     type PaginationMetaReporting as PaginationMetaReporting,
+    type ReportingPaginationMeta77109e5d17 as ReportingPaginationMeta77109e5d17,
     type MdrUsageReportCreateResponse as MdrUsageReportCreateResponse,
     type MdrUsageReportRetrieveResponse as MdrUsageReportRetrieveResponse,
     type MdrUsageReportDeleteResponse as MdrUsageReportDeleteResponse,