wiil-core-js 0.0.82

package/dist/core/service-configuration/phone-config.schema.d.ts

@@ -0,0 +1,206 @@
+import { z } from "zod";
+import { PhoneStatus, ProviderType } from "../type-definitions";
+/**
+ * @fileoverview Phone configuration schema definitions for telephony management.
+ *
+ * Phone Configurations manage telephony resources including phone numbers from various providers
+ * (SignalWire, Twilio). They track provider information, channel associations, and operational status.
+ * Referenced by Phone Channel configurations for call and SMS deployments.
+ *
+ * @module service-configuration/phone-config
+ */
+/**
+ * Zod schema for Phone Configuration validation.
+ *
+ * Manages a phone number resource from a telephony provider, tracking its configuration, status,
+ * and associations with deployment channels. A single phone number can support both voice calls
+ * and SMS through separate channel associations.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Referenced By**: PhoneChannelConfig (via phoneConfigurationId)
+ * - **Purpose**: Manages telephony resources and provider integration
+ * - **Dual Channel Support**: One phone number can have both voice and SMS channels
+ * - **Providers**: SignalWire, Twilio, and other SIP/VoIP providers
+ *
+ * **Phone Number Lifecycle:**
+ * - **PENDING**: Purchase initiated, awaiting provisioning
+ * - **ACTIVE**: Operational and ready for deployments
+ * - **INACTIVE**: Purchased but not yet activated
+ * - **SUSPENDED**: Temporarily disabled
+ * - **RELEASED**: Disconnected and returned to provider
+ *
+ * @typedef {Object} PhoneConfigurationProperties
+ * @property {string} id - Unique identifier for the phone configuration
+ * @property {string} phoneNumber - Phone number, short code, or alphanumeric sender ID
+ * @property {string} providerPhoneNumberId - Unique identifier from the telephony provider's system for this phone number
+ * @property {string} phoneRequestId - Reference ID for the original phone number request or setup configuration
+ * @property {string | null} friendlyName - Human-readable display name for administrative interfaces
+ * @property {string | null} [regionId] - Region identifier where this number is registered (provider-specific)
+ * @property {number | null} [monthlyPrice] - Monthly recurring cost for maintaining this phone number
+ * @property {string | null} [regionOrCountryName] - Human-readable region or country name
+ * @property {string} [countryCode] - ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'CA')
+ * @property {ProviderType} providerType - Telephony service provider (SIGNALWIRE, TWILIO, etc.) (default: SIGNALWIRE)
+ * @property {boolean} isImported - Whether this number was imported from external system (default: false)
+ * @property {PhoneStatus} status - Current operational status (PENDING, ACTIVE, INACTIVE, SUSPENDED, RELEASED) (default: INACTIVE)
+ * @property {boolean} isPorted - Whether this number was ported from another provider (default: false)
+ * @property {boolean | null} [markedForRelease] - Whether marked for disconnection (default: false)
+ * @property {Record<string, any>} [metadata] - Additional provider-specific metadata
+ * @property {string | null} [voiceChannelId] - ID of the voice/call deployment channel using this number
+ * @property {string | null} [smsChannelId] - ID of the SMS deployment channel using this number
+ * @property {DeploymentChannelInfo | null} [voiceChannel] - Populated voice channel configuration and deployment
+ * @property {DeploymentChannelInfo | null} [smsChannel] - Populated SMS channel configuration and deployment
+ * @property {boolean} isUSSMSPermitted - Whether US SMS messaging is permitted (compliance flag) (default: false)
+ * @property {number} [createdAt] - Unix timestamp (milliseconds) when created
+ * @property {number} [updatedAt] - Unix timestamp (milliseconds) when last updated
+ *
+ * @example
+ * ```typescript
+ * const phoneConfig: PhoneConfiguration = {
+ *   id: '123*',
+ *   phoneNumber: '+12125551234',
+ *   providerPhoneNumberId: 'PN123abc*',
+ *   phoneRequestId: 'REQ456*',
+ *   friendlyName: 'Customer Support Line',
+ *   regionId: 'us-ny',
+ *   monthlyPrice: 1.00,
+ *   regionOrCountryName: 'New York, United States',
+ *   countryCode: 'US',
+ *   providerType: ProviderType.SIGNALWIRE,
+ *   status: PhoneStatus.ACTIVE,
+ *   isImported: false,
+ *   isPorted: false,
+ *   isUSSMSPermitted: true,
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+export declare const PhoneConfigurationSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    phoneNumber: z.ZodString;
+    providerPhoneNumberId: z.ZodString;
+    phoneRequestId: z.ZodString;
+    friendlyName: z.ZodNullable<z.ZodString>;
+    regionId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    monthlyPrice: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    regionOrCountryName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    countryCode: z.ZodOptional<z.ZodString>;
+    providerType: z.ZodDefault<z.ZodEnum<typeof ProviderType>>;
+    isImported: z.ZodDefault<z.ZodBoolean>;
+    status: z.ZodDefault<z.ZodEnum<typeof PhoneStatus>>;
+    isPorted: z.ZodDefault<z.ZodBoolean>;
+    markedForRelease: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodBoolean>>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    voiceChannelId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    smsChannelId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    voiceChannel: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        deploymentType: z.ZodEnum<typeof import("../type-definitions").DeploymentType>;
+        channelName: z.ZodOptional<z.ZodString>;
+        recordingEnabled: z.ZodDefault<z.ZodBoolean>;
+        channelIdentifier: z.ZodString;
+        configuration: z.ZodUnion<readonly [z.ZodObject<{
+            phoneConfigurationId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            communicationType: z.ZodDefault<z.ZodEnum<typeof import("../type-definitions").OttCommunicationType>>;
+            widgetConfiguration: z.ZodOptional<z.ZodObject<{
+                position: z.ZodDefault<z.ZodEnum<{
+                    left: "left";
+                    right: "right";
+                }>>;
+                customTheme: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>, z.ZodObject<{
+            packageName: z.ZodDefault<z.ZodString>;
+            platform: z.ZodDefault<z.ZodEnum<typeof import("../type-definitions").MobilePlatform>>;
+        }, z.core.$strip>]>;
+        deployment: z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            projectId: z.ZodString;
+            deploymentChannelId: z.ZodString;
+            deploymentName: z.ZodOptional<z.ZodString>;
+            agentConfigurationId: z.ZodString;
+            instructionConfigurationId: z.ZodString;
+            provisioningConfigChainId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            provisioningType: z.ZodNullable<z.ZodOptional<z.ZodEnum<typeof import("../type-definitions").DeploymentProvisioningType>>>;
+            deploymentStatus: z.ZodEnum<typeof import("../type-definitions").DeploymentStatus>;
+            isActive: z.ZodDefault<z.ZodBoolean>;
+            project: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+            agent: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+            instruction: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+            createdAt: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    smsChannel: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        deploymentType: z.ZodEnum<typeof import("../type-definitions").DeploymentType>;
+        channelName: z.ZodOptional<z.ZodString>;
+        recordingEnabled: z.ZodDefault<z.ZodBoolean>;
+        channelIdentifier: z.ZodString;
+        configuration: z.ZodUnion<readonly [z.ZodObject<{
+            phoneConfigurationId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            communicationType: z.ZodDefault<z.ZodEnum<typeof import("../type-definitions").OttCommunicationType>>;
+            widgetConfiguration: z.ZodOptional<z.ZodObject<{
+                position: z.ZodDefault<z.ZodEnum<{
+                    left: "left";
+                    right: "right";
+                }>>;
+                customTheme: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>, z.ZodObject<{
+            packageName: z.ZodDefault<z.ZodString>;
+            platform: z.ZodDefault<z.ZodEnum<typeof import("../type-definitions").MobilePlatform>>;
+        }, z.core.$strip>]>;
+        deployment: z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            projectId: z.ZodString;
+            deploymentChannelId: z.ZodString;
+            deploymentName: z.ZodOptional<z.ZodString>;
+            agentConfigurationId: z.ZodString;
+            instructionConfigurationId: z.ZodString;
+            provisioningConfigChainId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            provisioningType: z.ZodNullable<z.ZodOptional<z.ZodEnum<typeof import("../type-definitions").DeploymentProvisioningType>>>;
+            deploymentStatus: z.ZodEnum<typeof import("../type-definitions").DeploymentStatus>;
+            isActive: z.ZodDefault<z.ZodBoolean>;
+            project: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+            agent: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+            instruction: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+            createdAt: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    isUSSMSPermitted: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Type definition for Phone Configuration.
+ *
+ * Represents a complete phone configuration including all metadata,
+ * provider information, and channel associations.
+ */
+export type PhoneConfiguration = z.infer<typeof PhoneConfigurationSchema>;
+/**
+ * Zod schema for updating an existing phone configuration.
+ *
+ * Only allows updating the friendly name and requires the id to identify the configuration.
+ *
+ * @example
+ * ```typescript
+ * const updatePayload: UpdatePhoneConfiguration = {
+ *   id: '123*',
+ *   friendlyName: 'Updated Support Line Name'
+ * };
+ * ```
+ */
+export declare const UpdatePhoneConfigurationSchema: z.ZodObject<{
+    id: z.ZodString;
+    friendlyName: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Type definition for updating an existing phone configuration.
+ *
+ * Represents a partial update payload with required id field.
+ */
+export type UpdatePhoneConfiguration = z.infer<typeof UpdatePhoneConfigurationSchema>;

package/dist/core/service-configuration/phone-config.schema.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdatePhoneConfigurationSchema = exports.PhoneConfigurationSchema = void 0;
+const zod_1 = require("zod");
+const base_schema_1 = require("../base.schema");
+const interaction_channels_schema_1 = require("./interaction-channels.schema");
+const type_definitions_1 = require("../type-definitions");
+/**
+ * @fileoverview Phone configuration schema definitions for telephony management.
+ *
+ * Phone Configurations manage telephony resources including phone numbers from various providers
+ * (SignalWire, Twilio). They track provider information, channel associations, and operational status.
+ * Referenced by Phone Channel configurations for call and SMS deployments.
+ *
+ * @module service-configuration/phone-config
+ */
+/**
+ * Zod schema for Phone Configuration validation.
+ *
+ * Manages a phone number resource from a telephony provider, tracking its configuration, status,
+ * and associations with deployment channels. A single phone number can support both voice calls
+ * and SMS through separate channel associations.
+ *
+ * @remarks
+ * **Architecture Context:**
+ * - **Referenced By**: PhoneChannelConfig (via phoneConfigurationId)
+ * - **Purpose**: Manages telephony resources and provider integration
+ * - **Dual Channel Support**: One phone number can have both voice and SMS channels
+ * - **Providers**: SignalWire, Twilio, and other SIP/VoIP providers
+ *
+ * **Phone Number Lifecycle:**
+ * - **PENDING**: Purchase initiated, awaiting provisioning
+ * - **ACTIVE**: Operational and ready for deployments
+ * - **INACTIVE**: Purchased but not yet activated
+ * - **SUSPENDED**: Temporarily disabled
+ * - **RELEASED**: Disconnected and returned to provider
+ *
+ * @typedef {Object} PhoneConfigurationProperties
+ * @property {string} id - Unique identifier for the phone configuration
+ * @property {string} phoneNumber - Phone number, short code, or alphanumeric sender ID
+ * @property {string} providerPhoneNumberId - Unique identifier from the telephony provider's system for this phone number
+ * @property {string} phoneRequestId - Reference ID for the original phone number request or setup configuration
+ * @property {string | null} friendlyName - Human-readable display name for administrative interfaces
+ * @property {string | null} [regionId] - Region identifier where this number is registered (provider-specific)
+ * @property {number | null} [monthlyPrice] - Monthly recurring cost for maintaining this phone number
+ * @property {string | null} [regionOrCountryName] - Human-readable region or country name
+ * @property {string} [countryCode] - ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'CA')
+ * @property {ProviderType} providerType - Telephony service provider (SIGNALWIRE, TWILIO, etc.) (default: SIGNALWIRE)
+ * @property {boolean} isImported - Whether this number was imported from external system (default: false)
+ * @property {PhoneStatus} status - Current operational status (PENDING, ACTIVE, INACTIVE, SUSPENDED, RELEASED) (default: INACTIVE)
+ * @property {boolean} isPorted - Whether this number was ported from another provider (default: false)
+ * @property {boolean | null} [markedForRelease] - Whether marked for disconnection (default: false)
+ * @property {Record<string, any>} [metadata] - Additional provider-specific metadata
+ * @property {string | null} [voiceChannelId] - ID of the voice/call deployment channel using this number
+ * @property {string | null} [smsChannelId] - ID of the SMS deployment channel using this number
+ * @property {DeploymentChannelInfo | null} [voiceChannel] - Populated voice channel configuration and deployment
+ * @property {DeploymentChannelInfo | null} [smsChannel] - Populated SMS channel configuration and deployment
+ * @property {boolean} isUSSMSPermitted - Whether US SMS messaging is permitted (compliance flag) (default: false)
+ * @property {number} [createdAt] - Unix timestamp (milliseconds) when created
+ * @property {number} [updatedAt] - Unix timestamp (milliseconds) when last updated
+ *
+ * @example
+ * ```typescript
+ * const phoneConfig: PhoneConfiguration = {
+ *   id: '123*',
+ *   phoneNumber: '+12125551234',
+ *   providerPhoneNumberId: 'PN123abc*',
+ *   phoneRequestId: 'REQ456*',
+ *   friendlyName: 'Customer Support Line',
+ *   regionId: 'us-ny',
+ *   monthlyPrice: 1.00,
+ *   regionOrCountryName: 'New York, United States',
+ *   countryCode: 'US',
+ *   providerType: ProviderType.SIGNALWIRE,
+ *   status: PhoneStatus.ACTIVE,
+ *   isImported: false,
+ *   isPorted: false,
+ *   isUSSMSPermitted: true,
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+exports.PhoneConfigurationSchema = base_schema_1.BaseModelSchema.safeExtend({
+    phoneNumber: zod_1.z.string().min(1).describe("Phone number, short code, or alphanumeric sender ID"),
+    providerPhoneNumberId: zod_1.z.string().describe("Unique identifier for this phone number from the telephony provider's system (provider-specific format)"),
+    phoneRequestId: zod_1.z.string().describe("Reference ID for the original phone number request or setup configuration"),
+    friendlyName: zod_1.z.string().nullable().describe("Human-readable display name for this phone number used in administrative interfaces (e.g., 'Customer Support Line', 'Sales Main Number')"),
+    regionId: zod_1.z.string().optional().nullable().describe("Region identifier where this phone number is registered (provider-specific, e.g., 'us-ny' for New York)"),
+    monthlyPrice: zod_1.z.number().optional().nullable().describe("Monthly recurring cost for maintaining this phone number in USD or provider currency"),
+    regionOrCountryName: zod_1.z.string().optional().nullable().describe("Human-readable name of the region or country where this number is registered (e.g., 'New York, United States', 'London, United Kingdom')"),
+    countryCode: zod_1.z.string().optional().describe("ISO 3166-1 alpha-2 country code where the phone number is registered (e.g., 'US', 'GB', 'CA')"),
+    providerType: zod_1.z.enum(type_definitions_1.ProviderType).default(type_definitions_1.ProviderType.SIGNALWIRE).describe("Telephony service provider managing this phone number (SIGNALWIRE, TWILIO, VONAGE, etc.)"),
+    isImported: zod_1.z.boolean().default(false).describe("Flag indicating if this phone number was imported from an external system rather than purchased through the platform"),
+    status: zod_1.z.enum(type_definitions_1.PhoneStatus).default(type_definitions_1.PhoneStatus.INACTIVE).describe("Current operational status (PENDING: provisioning, ACTIVE: operational, INACTIVE: purchased but not activated, SUSPENDED: temporarily disabled, RELEASED: disconnected)"),
+    isPorted: zod_1.z.boolean().default(false).describe("Flag indicating if this phone number was ported from another telephony provider (true) or purchased new (false)"),
+    markedForRelease: zod_1.z.boolean().nullable().optional().default(false).describe("Flag indicating if this phone number is marked for release/disconnection in the next billing cycle"),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().describe("Additional provider-specific metadata, configuration details, or custom attributes for this phone number"),
+    voiceChannelId: zod_1.z.string().optional().nullable().describe("ID of the voice/call deployment channel associated with this phone number (null if not used for voice)"),
+    smsChannelId: zod_1.z.string().optional().nullable().describe("ID of the SMS deployment channel associated with this phone number (null if not used for SMS)"),
+    voiceChannel: interaction_channels_schema_1.DeploymentChannelWithDeploymentSchema.nullable().optional().describe("Populated voice deployment channel configuration including deployment details (null if not loaded or not used for voice)"),
+    smsChannel: interaction_channels_schema_1.DeploymentChannelWithDeploymentSchema.nullable().optional().describe("Populated SMS deployment channel configuration including deployment details (null if not loaded or not used for SMS)"),
+    isUSSMSPermitted: zod_1.z.boolean().default(false).describe("Compliance flag indicating if US SMS messaging is permitted for this phone number (required for A2P 10DLC registration)"),
+});
+/**
+ * Zod schema for updating an existing phone configuration.
+ *
+ * Only allows updating the friendly name and requires the id to identify the configuration.
+ *
+ * @example
+ * ```typescript
+ * const updatePayload: UpdatePhoneConfiguration = {
+ *   id: '123*',
+ *   friendlyName: 'Updated Support Line Name'
+ * };
+ * ```
+ */
+exports.UpdatePhoneConfigurationSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    friendlyName: zod_1.z.string().nullable(),
+});

package/dist/core/service-configuration/phone-number.schema.d.ts

@@ -0,0 +1,236 @@
+import { z } from "zod";
+import { PhoneNumberType, PhonePurchaseStatus } from "../type-definitions/service-config.definitions";
+/**
+ * @fileoverview Phone number configuration and purchase schema definitions.
+ *
+ * Phone number schemas manage the complete lifecycle of phone number acquisition from telephony providers:
+ * discovery of available inventory, purchase transactions, and provisioning into Phone Configurations.
+ * Supports multiple providers (SignalWire, Twilio) with provider-specific extensions.
+ *
+ * @module service-configuration/phone-number
+ */
+/**
+ * Zod schema for base phone number information.
+ *
+ * Common properties shared across all phone number providers.
+ *
+ * @typedef {Object} BasePhoneNumberInfoProperties
+ * @property {string} friendlyName - Human-readable name for the phone number
+ * @property {string} phoneNumber - The phone number in E.164 format
+ * @property {string | null} [lata] - Local Access and Transport Area code
+ * @property {string} [rateCenter] - Rate center for the phone number
+ * @property {string} [region] - Geographic region
+ * @property {string} [postalCode] - Postal/ZIP code for the phone number
+ * @property {string} countryCode - ISO country code
+ * @property {Object} capabilities - Phone number capabilities
+ * @property {boolean} capabilities.voice - Supports voice calls
+ * @property {boolean} capabilities.SMS - Supports SMS messaging
+ * @property {boolean} capabilities.MMS - Supports MMS messaging
+ * @property {boolean} beta - Whether this is a beta number
+ * @property {PhoneNumberType} numberType - Type of phone number (local, toll-free, etc.)
+ *
+ * @example
+ * ```typescript
+ * const phoneInfo: BasePhoneNumberInfo = {
+ *   friendlyName: 'Customer Support Line',
+ *   phoneNumber: '+12125551234',
+ *   countryCode: 'US',
+ *   capabilities: { voice: true, SMS: true, MMS: false },
+ *   beta: false,
+ *   numberType: PhoneNumberType.LOCAL
+ * };
+ * ```
+ */
+export declare const BasePhoneNumberInfoSchema: z.ZodObject<{
+    friendlyName: z.ZodString;
+    phoneNumber: z.ZodString;
+    lata: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    rateCenter: z.ZodOptional<z.ZodString>;
+    region: z.ZodOptional<z.ZodString>;
+    postalCode: z.ZodOptional<z.ZodString>;
+    countryCode: z.ZodString;
+    capabilities: z.ZodObject<{
+        voice: z.ZodBoolean;
+        SMS: z.ZodBoolean;
+        MMS: z.ZodBoolean;
+    }, z.core.$strip>;
+    beta: z.ZodBoolean;
+    numberType: z.ZodEnum<typeof PhoneNumberType>;
+}, z.core.$strip>;
+/**
+ * Type definition for base phone number information.
+ */
+export type BasePhoneNumberInfo = z.infer<typeof BasePhoneNumberInfoSchema>;
+/**
+ * Zod schema for phone provider response.
+ *
+ * Response from phone number provider API calls.
+ *
+ * @example
+ * ```typescript
+ * const response: PhoneProviderResponse = {
+ *   success: true,
+ *   status: 200,
+ *   data: { availableNumbers: [...] }
+ * };
+ * ```
+ */
+export declare const PhoneProviderResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    status: z.ZodOptional<z.ZodNumber>;
+    data: z.ZodUnknown;
+}, z.core.$strip>;
+/**
+ * Type definition for phone provider response.
+ */
+export type PhoneProviderResponse = z.infer<typeof PhoneProviderResponseSchema>;
+/**
+ * Zod schema for phone number purchase transaction.
+ *
+ * Represents a phone number purchase request and its lifecycle through the purchase process.
+ *
+ * @typedef {Object} PhoneNumberPurchaseProperties
+ * @property {string} id - Unique identifier for the purchase transaction
+ * @property {string} friendlyName - Human-readable name for the purchased number
+ * @property {string} phoneNumber - The phone number being purchased
+ * @property {ProviderType} providerType - Provider from which the number is being purchased
+ * @property {string} countryCode - ISO country code for the phone number (e.g., 'US', 'GB', 'CA')
+ * @property {number} amount - Purchase amount (must be positive)
+ * @property {string} currency - Currency code (3 characters, default: "USD")
+ * @property {PhonePurchaseStatus} status - Current status of the purchase (default: PENDING)
+ * @property {PhoneNumberType} numberType - Type of phone number (default: LOCAL)
+ * @property {string | null} [statusDetails] - Additional details about the current status
+ * @property {number | null} [completedAt] - Timestamp when purchase was completed
+ * @property {Record<string, any> | null} [metadata] - Additional metadata for the purchase
+ * @property {number} [createdAt] - Timestamp when created
+ * @property {number} [updatedAt] - Timestamp when last updated
+ *
+ * @example
+ * ```typescript
+ * const purchase: PhoneNumberPurchase = {
+ *   id: '32422DEGER56',
+ *   friendlyName: 'Main Support Line',
+ *   phoneNumber: '+12125551234',
+ *   countryCode: 'US',
+ *   chargedCredits: 1500,
+ *   status: PhonePurchaseStatus.COMPLETED,
+ *   numberType: PhoneNumberType.LOCAL,
+ *   completedAt: Date.now(),
+ *   createdAt: Date.now(),
+ *   updatedAt: Date.now()
+ * };
+ * ```
+ */
+export declare const PhoneNumberPurchaseSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    friendlyName: z.ZodString;
+    phoneNumber: z.ZodString;
+    countryCode: z.ZodString;
+    chargedCredits: z.ZodNumber;
+    status: z.ZodDefault<z.ZodEnum<typeof PhonePurchaseStatus>>;
+    numberType: z.ZodDefault<z.ZodEnum<typeof PhoneNumberType>>;
+    statusDetails: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    completedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+}, z.core.$strip>;
+/**
+ * Type definition for phone number purchase.
+ */
+export type PhoneNumberPurchase = z.infer<typeof PhoneNumberPurchaseSchema>;
+/**
+ * Zod schema for creating a new phone number purchase.
+ *
+ * Omits auto-generated and transaction-specific fields.
+ *
+ * @remarks
+ * Use this schema when initiating a new phone number purchase.
+ *
+ * @example
+ * ```typescript
+ * const newPurchase: CreatePhoneNumberPurchase = {
+ *   friendlyName: 'New Support Line',
+ *   phoneNumber: '+12125551234',
+ *   countryCode: 'US',
+ *   providerType: ProviderType.TWILIO,
+ *   phoneNumberInfo: { ... },
+ *   numberType: PhoneNumberType.LOCAL
+ * };
+ * ```
+ */
+export declare const CreatePhoneNumberPurchaseSchema: z.ZodObject<{
+    phoneNumber: z.ZodString;
+    friendlyName: z.ZodString;
+    countryCode: z.ZodString;
+    numberType: z.ZodDefault<z.ZodEnum<typeof PhoneNumberType>>;
+}, z.core.$strip>;
+/**
+ * Type definition for creating a phone number purchase.
+ */
+export type CreatePhoneNumberPurchase = z.infer<typeof CreatePhoneNumberPurchaseSchema>;
+export declare const BusinessPhoneNumberPurchaseRequestSchema: z.ZodObject<{
+    phoneNumber: z.ZodString;
+    friendlyName: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type BusinessPhoneNumberPurchaseRequest = z.infer<typeof BusinessPhoneNumberPurchaseRequestSchema>;
+/**
+ * Legacy schema export for backwards compatibility.
+ * @deprecated Use CreatePhoneNumberPurchaseSchema instead.
+ */
+export declare const PhoneNumberPurchaseRequestSchema: z.ZodObject<{
+    phoneNumber: z.ZodString;
+    friendlyName: z.ZodString;
+    countryCode: z.ZodString;
+    numberType: z.ZodDefault<z.ZodEnum<typeof PhoneNumberType>>;
+}, z.core.$strip>;
+/**
+ * Legacy type export for backwards compatibility.
+ * @deprecated Use CreatePhoneNumberPurchase instead.
+ */
+export type PhoneNumberPurchaseRequest = CreatePhoneNumberPurchase;
+/**
+ * Zod schema for phone number pricing information.
+ *
+ * Represents pricing details for phone numbers from various providers.
+ *
+ * @typedef {Object} PhoneNumberPricingProperties
+ * @property {PhoneNumberType} number_type - Type of phone number
+ * @property {string} country - Full country name
+ * @property {string} countryCode - ISO country code
+ * @property {Array} phoneNumberPrices - Array of pricing tiers
+ * @property {number} price - Final price for the number
+ * @property {string} priceUnit - Unit of pricing (e.g., "per month")
+ * @property {string} currency - Currency code (3 characters, default: "USD")
+ *
+ * @example
+ * ```typescript
+ * const pricing: PhoneNumberPricing = {
+ *   number_type: PhoneNumberType.LOCAL,
+ *   country: 'United States',
+ *   countryCode: 'US',
+ *   phoneNumberPrices: [
+ *     { base_price: '1.00', current_price: '1.00' }
+ *   ],
+ *   price: 1.00,
+ *   priceUnit: 'per month',
+ *   currency: 'USD'
+ * };
+ * ```
+ */
+export declare const PhoneNumberPricingSchema: z.ZodObject<{
+    number_type: z.ZodEnum<typeof PhoneNumberType>;
+    country: z.ZodString;
+    countryCode: z.ZodString;
+    phoneNumberPrices: z.ZodArray<z.ZodObject<{
+        base_price: z.ZodString;
+        current_price: z.ZodString;
+    }, z.core.$strip>>;
+    price: z.ZodNumber;
+    priceUnit: z.ZodString;
+    currency: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Type definition for phone number pricing.
+ */
+export type PhoneNumberPricing = z.infer<typeof PhoneNumberPricingSchema>;