@land-catalyst/batch-data-sdk 1.1.12

package/dist/client.d.ts

@@ -0,0 +1,435 @@
+import { AxiosInstance, AxiosResponse, AxiosError, InternalAxiosRequestConfig } from "axios";
+import { IBatchDataClient } from "./client.interface";
+import { ILogger } from "./logger.interface";
+import { PropertySubscriptionRequest, PropertySubscriptionResponse, PropertySearchRequest, PropertySearchResponse, AddressVerifyRequest, AddressVerifyResponse, AddressAutocompleteRequest, AddressAutocompleteResponse, AddressGeocodeRequest, AddressGeocodeResponse, AddressReverseGeocodeRequest, AddressReverseGeocodeResponse, PropertyLookupRequest, PropertyLookupResponse, PropertyLookupAsyncRequest, PropertyLookupAsyncResponse, PropertySearchAsyncRequest, PropertySearchAsyncResponse, PropertySkipTraceRequest, PropertySkipTraceResponse, PropertySkipTraceAsyncRequest, PropertySkipTraceAsyncResponse, PhoneVerificationRequest, PhoneVerificationResponse, PhoneVerificationAsyncRequest, PhoneVerificationAsyncResponse, PhoneDNCRequest, PhoneDNCResponse, PhoneDNCAsyncRequest, PhoneDNCAsyncResponse, PhoneTCPARequest, PhoneTCPAResponse, PhoneTCPAAsyncRequest, PhoneTCPAAsyncResponse, GetPropertySubscriptionsResponse, GetPropertySubscriptionDetailResponse, DeletePropertySubscriptionResponse, PropertyPermitRequest, PropertyPermitResponse, PropertySkipTraceV3Request, PropertySkipTraceV3Response, PropertySkipTraceV3AsyncRequest, PropertySkipTraceV3AsyncResponse } from "./types";
+/**
+ * Middleware function that executes before an HTTP request is sent.
+ * Can modify the request config or perform side effects (logging, metrics, etc.).
+ *
+ * @param config The axios request configuration
+ * @returns The (potentially modified) request configuration, or a Promise that resolves to it
+ */
+export type RequestMiddleware = (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>;
+/**
+ * Middleware function that executes after an HTTP response is received.
+ * Can modify the response or perform side effects (logging, metrics, etc.).
+ *
+ * @param response The axios response
+ * @returns The (potentially modified) response, or a Promise that resolves to it
+ */
+export type ResponseMiddleware = (response: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>;
+/**
+ * Middleware function that executes when an HTTP request fails.
+ * Can handle errors, transform them, or perform side effects.
+ *
+ * @param error The axios error
+ * @returns A rejected Promise (to propagate the error) or a resolved Promise with a response (to recover from the error)
+ */
+export type ErrorMiddleware = (error: AxiosError) => Promise<AxiosResponse | AxiosError> | AxiosResponse | AxiosError;
+/**
+ * HTTP Middleware configuration
+ */
+export interface HttpMiddleware {
+    /**
+     * Middleware functions to execute before requests are sent
+     */
+    onRequest?: RequestMiddleware[];
+    /**
+     * Middleware functions to execute after successful responses
+     */
+    onResponse?: ResponseMiddleware[];
+    /**
+     * Middleware functions to execute when requests fail
+     */
+    onError?: ErrorMiddleware[];
+}
+/**
+ * Webhook URLs for a single async endpoint
+ */
+export interface AsyncWebhookUrls {
+    /**
+     * Webhook URL for successful responses
+     */
+    url: string;
+    /**
+     * Optional webhook URL for error responses
+     */
+    errorUrl?: string;
+}
+/**
+ * Webhook URL configuration for async API requests
+ * Allows specifying webhook URLs per endpoint type, with fallback to defaults
+ */
+export interface AsyncWebhookConfiguration {
+    /**
+     * Default webhook URLs used as fallback for all async endpoints
+     */
+    default?: AsyncWebhookUrls;
+    /**
+     * Webhook URLs for property lookup async requests
+     */
+    propertyLookup?: AsyncWebhookUrls;
+    /**
+     * Webhook URLs for property search async requests
+     */
+    propertySearch?: AsyncWebhookUrls;
+    /**
+     * Webhook URLs for skip trace async requests (v1)
+     */
+    skipTrace?: AsyncWebhookUrls;
+    /**
+     * Webhook URLs for skip trace async requests (v3)
+     */
+    skipTraceV3?: AsyncWebhookUrls;
+    /**
+     * Webhook URLs for phone verification async requests
+     */
+    phoneVerification?: AsyncWebhookUrls;
+    /**
+     * Webhook URLs for phone DNC async requests
+     */
+    phoneDNC?: AsyncWebhookUrls;
+    /**
+     * Webhook URLs for phone TCPA async requests
+     */
+    phoneTCPA?: AsyncWebhookUrls;
+    /**
+     * Webhook URLs for property subscription requests
+     */
+    propertySubscription?: AsyncWebhookUrls;
+}
+/**
+ * BatchData API Client Options
+ */
+export interface BatchDataClientOptions {
+    /**
+     * BatchData API key (required)
+     */
+    apiKey: string;
+    /**
+     * Optional logger implementation (defaults to ConsoleLogger)
+     */
+    logger?: ILogger;
+    /**
+     * Optional timeout in milliseconds (defaults to 30000)
+     */
+    timeout?: number;
+    /**
+     * Optional base URLs (for testing or custom endpoints)
+     */
+    v1BaseUrl?: string;
+    v2BaseUrl?: string;
+    v3BaseUrl?: string;
+    /**
+     * Optional HTTP middleware for intercepting requests and responses
+     */
+    middleware?: HttpMiddleware;
+    /**
+     * Optional webhook URL configuration for async requests
+     * Allows specifying webhook URLs per endpoint type, with fallback to defaults
+     */
+    webhooks?: AsyncWebhookConfiguration;
+}
+/**
+ * BatchData API Client
+ *
+ * Pure API client that makes HTTP calls to BatchData.io endpoints.
+ * No business logic - just handles HTTP communication with the API.
+ */
+export declare class BatchDataClient implements IBatchDataClient {
+    protected readonly v1BaseUrl: string;
+    protected readonly v2BaseUrl: string;
+    protected readonly v3BaseUrl: string;
+    protected readonly axiosInstance: AxiosInstance;
+    protected readonly logger: ILogger;
+    private readonly webhooks?;
+    constructor(options: BatchDataClientOptions);
+    /**
+     * Set up axios interceptors from middleware configuration
+     * @param middleware The middleware configuration
+     */
+    protected setupMiddleware(middleware: HttpMiddleware): void;
+    /**
+     * Apply default webhook URLs to an async request if they're not already set.
+     * This helper ensures that if webhook URLs are configured in the client,
+     * they will be used for async requests that don't explicitly specify webhook URLs.
+     *
+     * @param request The async request to modify
+     * @param endpointType The type of async endpoint (e.g., 'propertyLookup', 'propertySearch')
+     * @returns The request with webhook URLs applied (if needed)
+     */
+    private applyDefaultWebhookUrls;
+    /**
+     * Apply default webhook URLs to a property subscription request if they're not already set.
+     * This helper ensures that if webhook URLs are configured in the client,
+     * they will be used for property subscriptions that don't explicitly specify webhook URLs.
+     *
+     * @param request The property subscription request to modify
+     * @returns The request with webhook URLs applied (if needed)
+     */
+    private applyPropertySubscriptionWebhooks;
+    /**
+     * Add a request middleware function that executes before requests are sent.
+     * Useful for adding headers, logging, metrics, etc.
+     *
+     * @param middleware The middleware function
+     * @returns The interceptor ID (can be used to remove the interceptor later)
+     *
+     * @example
+     * ```typescript
+     * const client = new BatchDataClient({ apiKey: "..." });
+     * client.addRequestMiddleware((config) => {
+     *   console.log(`Making request to ${config.url}`);
+     *   config.headers["X-Custom-Header"] = "value";
+     *   return config;
+     * });
+     * ```
+     */
+    addRequestMiddleware(middleware: RequestMiddleware): number;
+    /**
+     * Add a response middleware function that executes after successful responses.
+     * Useful for logging, metrics, response transformation, etc.
+     *
+     * @param middleware The middleware function
+     * @returns The interceptor ID (can be used to remove the interceptor later)
+     *
+     * @example
+     * ```typescript
+     * const client = new BatchDataClient({ apiKey: "..." });
+     * client.addResponseMiddleware((response) => {
+     *   console.log(`Received response: ${response.status}`);
+     *   return response;
+     * });
+     * ```
+     */
+    addResponseMiddleware(middleware: ResponseMiddleware): number;
+    /**
+     * Add an error middleware function that executes when requests fail.
+     * Useful for error handling, retry logic, error transformation, etc.
+     *
+     * @param middleware The middleware function
+     * @returns The interceptor ID (can be used to remove the interceptor later)
+     *
+     * @example
+     * ```typescript
+     * const client = new BatchDataClient({ apiKey: "..." });
+     * client.addErrorMiddleware(async (error) => {
+     *   if (error.response?.status === 429) {
+     *     // Retry logic here
+     *   }
+     *   throw error; // Re-throw to propagate
+     * });
+     * ```
+     */
+    addErrorMiddleware(middleware: ErrorMiddleware): number;
+    /**
+     * Remove a request interceptor by ID
+     * @param id The interceptor ID returned from addRequestMiddleware
+     */
+    removeRequestMiddleware(id: number): void;
+    /**
+     * Remove a response interceptor by ID
+     * @param id The interceptor ID returned from addResponseMiddleware or addErrorMiddleware
+     */
+    removeResponseMiddleware(id: number): void;
+    /**
+     * Wrapper for axios calls that handles error logging consistently
+     * @param axiosCall The axios call to execute
+     * @param errorMessagePrefix Prefix for the error message (e.g., "Failed to search properties")
+     * @param url The URL being called (for error details)
+     * @returns Object containing the response data and status
+     */
+    private handleApiCall;
+    /**
+     * Create a property subscription (v2 API)
+     * POST /api/v2/property-subscription
+     */
+    createPropertySubscription(request: PropertySubscriptionRequest): Promise<PropertySubscriptionResponse>;
+    /**
+     * Search for properties (v1 API)
+     * POST /api/v1/property/search
+     *
+     * @param searchCriteria Search criteria
+     * @param options Request options
+     * @param options.take Number of properties to return (0 for count-only)
+     * @param options.skip Number of properties to skip for pagination
+     * @returns Property search API response
+     */
+    searchProperties(request: PropertySearchRequest): Promise<PropertySearchResponse>;
+    /**
+     * Get the count of properties matching the search criteria
+     * @param searchCriteria Search criteria to match properties
+     * @returns Number of matching properties, or null if the endpoint is unavailable
+     */
+    getPropertyCount(searchRequest: PropertySearchRequest): Promise<number | null>;
+    /**
+     * Verify and normalize addresses (v1 API)
+     * POST /api/v1/address/verify
+     *
+     * @param request Address verification request
+     * @returns Address verification API response
+     */
+    verifyAddress(request: AddressVerifyRequest): Promise<AddressVerifyResponse>;
+    /**
+     * Get address autocomplete suggestions (v1 API)
+     * POST /api/v1/address/autocomplete
+     *
+     * Note: This endpoint requires a Referer header per API documentation.
+     * For server-side usage, a default Referer is set.
+     *
+     * @param request Address autocomplete request
+     * @returns Address autocomplete API response
+     */
+    autocompleteAddress(request: AddressAutocompleteRequest): Promise<AddressAutocompleteResponse>;
+    /**
+     * Geocode an address to coordinates (v1 API)
+     * POST /api/v1/address/geocode
+     *
+     * @param request Address geocode request
+     * @returns Address geocode API response
+     */
+    geocodeAddress(request: AddressGeocodeRequest): Promise<AddressGeocodeResponse>;
+    /**
+     * Reverse geocode coordinates to an address (v1 API)
+     * POST /api/v1/address/reverse-geocode
+     *
+     * @param request Address reverse geocode request
+     * @returns Address reverse geocode API response
+     */
+    reverseGeocodeAddress(request: AddressReverseGeocodeRequest): Promise<AddressReverseGeocodeResponse>;
+    /**
+     * Lookup property details by address, propertyId, hash, or APN (v1 API)
+     * POST /api/v1/property/lookup/all-attributes
+     *
+     * @param request Property lookup request
+     * @returns Property lookup API response
+     */
+    lookupProperty(request: PropertyLookupRequest): Promise<PropertyLookupResponse>;
+    /**
+     * Lookup property details asynchronously (v1 API)
+     * POST /api/v1/property/lookup/async
+     *
+     * @param request Property lookup async request
+     * @returns Property lookup async API response
+     */
+    lookupPropertyAsync(request: PropertyLookupAsyncRequest): Promise<PropertyLookupAsyncResponse>;
+    /**
+     * Search for properties asynchronously (v1 API)
+     * POST /api/v1/property/search/async
+     *
+     * @param request Property search async request
+     * @returns Property search async API response
+     */
+    searchPropertiesAsync(request: PropertySearchAsyncRequest): Promise<PropertySearchAsyncResponse>;
+    /**
+     * Skip trace property owners (v1 API)
+     * POST /api/v1/property/skip-trace
+     *
+     * @param request Property skip trace request
+     * @returns Property skip trace API response
+     */
+    skipTraceProperty(request: PropertySkipTraceRequest): Promise<PropertySkipTraceResponse>;
+    /**
+     * Skip trace property owners asynchronously (v1 API)
+     * POST /api/v1/property/skip-trace/async
+     *
+     * @param request Property skip trace async request
+     * @returns Property skip trace async API response
+     */
+    skipTracePropertyAsync(request: PropertySkipTraceAsyncRequest): Promise<PropertySkipTraceAsyncResponse>;
+    /**
+     * Verify phone numbers (v1 API)
+     * POST /api/v1/phone/verification
+     *
+     * @param request Phone verification request
+     * @returns Phone verification API response
+     */
+    verifyPhone(request: PhoneVerificationRequest): Promise<PhoneVerificationResponse>;
+    /**
+     * Verify phone numbers asynchronously (v1 API)
+     * POST /api/v1/phone/verification/async
+     *
+     * @param request Phone verification async request
+     * @returns Phone verification async API response
+     */
+    verifyPhoneAsync(request: PhoneVerificationAsyncRequest): Promise<PhoneVerificationAsyncResponse>;
+    /**
+     * Check phone numbers against DNC (Do Not Call) list (v1 API)
+     * POST /api/v1/phone/dnc
+     *
+     * @param request Phone DNC request
+     * @returns Phone DNC API response
+     */
+    checkPhoneDNC(request: PhoneDNCRequest): Promise<PhoneDNCResponse>;
+    /**
+     * Check phone numbers against DNC list asynchronously (v1 API)
+     * POST /api/v1/phone/dnc/async
+     *
+     * @param request Phone DNC async request
+     * @returns Phone DNC async API response
+     */
+    checkPhoneDNCAsync(request: PhoneDNCAsyncRequest): Promise<PhoneDNCAsyncResponse>;
+    /**
+     * Check phone numbers for TCPA compliance (v1 API)
+     * POST /api/v1/phone/tcpa
+     *
+     * @param request Phone TCPA request
+     * @returns Phone TCPA API response
+     */
+    checkPhoneTCPA(request: PhoneTCPARequest): Promise<PhoneTCPAResponse>;
+    /**
+     * Check phone numbers for TCPA compliance asynchronously (v1 API)
+     * POST /api/v1/phone/tcpa/async
+     *
+     * @param request Phone TCPA async request
+     * @returns Phone TCPA async API response
+     */
+    checkPhoneTCPAAsync(request: PhoneTCPAAsyncRequest): Promise<PhoneTCPAAsyncResponse>;
+    /**
+     * Get all property subscriptions (v2 API)
+     * GET /api/v2/property-subscription
+     *
+     * @returns Array of property subscriptions
+     */
+    getPropertySubscriptions(): Promise<GetPropertySubscriptionsResponse>;
+    /**
+     * Get property subscription by ID (v2 API)
+     * GET /api/v2/property-subscription/{id}
+     *
+     * @param id Subscription ID
+     * @returns Property subscription detail
+     */
+    getPropertySubscription(id: string): Promise<GetPropertySubscriptionDetailResponse>;
+    /**
+     * Delete property subscription (v2 API)
+     * DELETE /api/v2/property-subscription/{id}
+     *
+     * @param id Subscription ID
+     * @returns Delete response
+     */
+    deletePropertySubscription(id: string): Promise<DeletePropertySubscriptionResponse>;
+    /**
+     * Get property permits (v2 API)
+     * POST /api/v2/property/get-property-permits
+     *
+     * @param request Property permit request
+     * @returns Property permit API response
+     */
+    getPropertyPermit(request: PropertyPermitRequest): Promise<PropertyPermitResponse>;
+    /**
+     * Skip trace property owners (v3 API)
+     * POST /api/v3/property/skip-trace
+     *
+     * @param request Property skip trace v3 request
+     * @returns Property skip trace v3 API response
+     */
+    skipTracePropertyV3(request: PropertySkipTraceV3Request): Promise<PropertySkipTraceV3Response>;
+    /**
+     * Skip trace property owners asynchronously (v3 API)
+     * POST /api/v3/property/skip-trace/async
+     *
+     * @param request Property skip trace v3 async request
+     * @returns Property skip trace v3 async API response
+     */
+    skipTracePropertyV3Async(request: PropertySkipTraceV3AsyncRequest): Promise<PropertySkipTraceV3AsyncResponse>;
+}

package/dist/client.interface.d.ts

@@ -0,0 +1,210 @@
+import { PropertySubscriptionRequest, PropertySubscriptionResponse, PropertySearchRequest, PropertySearchResponse, AddressVerifyRequest, AddressVerifyResponse, AddressAutocompleteRequest, AddressAutocompleteResponse, AddressGeocodeRequest, AddressGeocodeResponse, AddressReverseGeocodeRequest, AddressReverseGeocodeResponse, PropertyLookupRequest, PropertyLookupResponse, PropertyLookupAsyncRequest, PropertyLookupAsyncResponse, PropertySearchAsyncRequest, PropertySearchAsyncResponse, PropertySkipTraceRequest, PropertySkipTraceResponse, PropertySkipTraceAsyncRequest, PropertySkipTraceAsyncResponse, PhoneVerificationRequest, PhoneVerificationResponse, PhoneVerificationAsyncRequest, PhoneVerificationAsyncResponse, PhoneDNCRequest, PhoneDNCResponse, PhoneDNCAsyncRequest, PhoneDNCAsyncResponse, PhoneTCPARequest, PhoneTCPAResponse, PhoneTCPAAsyncRequest, PhoneTCPAAsyncResponse, GetPropertySubscriptionsResponse, GetPropertySubscriptionDetailResponse, DeletePropertySubscriptionResponse, PropertyPermitRequest, PropertyPermitResponse, PropertySkipTraceV3Request, PropertySkipTraceV3Response, PropertySkipTraceV3AsyncRequest, PropertySkipTraceV3AsyncResponse } from "./types";
+/**
+ * BatchData API Client Interface
+ *
+ * Pure API client that makes HTTP calls to BatchData.io endpoints.
+ * No business logic - just API communication.
+ */
+export interface IBatchDataClient {
+    /**
+     * Create a property subscription (v2 API)
+     * POST /api/v2/property-subscription
+     *
+     * @see PropertySubscriptionBuilder For fluent construction of requests
+     */
+    createPropertySubscription(request: PropertySubscriptionRequest): Promise<PropertySubscriptionResponse>;
+    /**
+     * Search for properties (v1 API)
+     * POST /api/v1/property/search
+     *
+     * @param request Property search request
+     * @param request.searchCriteria Search criteria for property search
+     * @param request.options Request options (pagination, distance, bounding box, filters, etc.)
+     * @returns Property search API response
+     * @see PropertySearchRequestBuilder For fluent construction of requests
+     */
+    searchProperties(request: PropertySearchRequest): Promise<PropertySearchResponse>;
+    /**
+     * Get the count of properties matching the search criteria
+     * @param searchCriteria Search criteria to match properties
+     * @returns Number of matching properties, or null if the endpoint is unavailable
+     */
+    getPropertyCount(searchRequest: PropertySearchRequest): Promise<number | null>;
+    /**
+     * Verify and normalize addresses (v1 API)
+     * POST /api/v1/address/verify
+     *
+     * @param request Address verification request
+     * @returns Address verification API response
+     */
+    verifyAddress(request: AddressVerifyRequest): Promise<AddressVerifyResponse>;
+    /**
+     * Get address autocomplete suggestions (v1 API)
+     * POST /api/v1/address/autocomplete
+     *
+     * @param request Address autocomplete request
+     * @returns Address autocomplete API response
+     */
+    autocompleteAddress(request: AddressAutocompleteRequest): Promise<AddressAutocompleteResponse>;
+    /**
+     * Geocode an address to coordinates (v1 API)
+     * POST /api/v1/address/geocode
+     *
+     * @param request Address geocode request
+     * @returns Address geocode API response
+     */
+    geocodeAddress(request: AddressGeocodeRequest): Promise<AddressGeocodeResponse>;
+    /**
+     * Reverse geocode coordinates to an address (v1 API)
+     * POST /api/v1/address/reverse-geocode
+     *
+     * @param request Address reverse geocode request
+     * @returns Address reverse geocode API response
+     */
+    reverseGeocodeAddress(request: AddressReverseGeocodeRequest): Promise<AddressReverseGeocodeResponse>;
+    /**
+     * Lookup property details by address, propertyId, hash, or APN (v1 API)
+     * POST /api/v1/property/lookup/all-attributes
+     *
+     * @param request Property lookup request
+     * @param request.requests Array of property lookup items (address, propertyId, hash, APN, etc.)
+     * @param request.options Request options (pagination, distance, bounding box, filters, webhooks, etc.)
+     * @returns Property lookup API response
+     * @see PropertyLookupRequestBuilder For fluent construction of requests
+     */
+    lookupProperty(request: PropertyLookupRequest): Promise<PropertyLookupResponse>;
+    /**
+     * Lookup property details asynchronously (v1 API)
+     * POST /api/v1/property/lookup/async
+     *
+     * @param request Property lookup async request
+     * @param request.requests Array of property lookup items (address, propertyId, hash, APN, etc.)
+     * @param request.options Request options (pagination, distance, bounding box, filters, webhooks, etc.)
+     * @returns Property lookup async API response (status only; full results delivered via webhook)
+     * @see PropertyLookupAsyncRequestBuilder For fluent construction of requests
+     */
+    lookupPropertyAsync(request: PropertyLookupAsyncRequest): Promise<PropertyLookupAsyncResponse>;
+    /**
+     * Search for properties asynchronously (v1 API)
+     * POST /api/v1/property/search/async
+     *
+     * @param request Property search async request
+     * @param request.searchCriteria Search criteria for property search
+     * @param request.options Request options (pagination, distance, bounding box, filters, webhooks, etc.)
+     * @returns Property search async API response (status only; full results delivered via webhook)
+     * @see PropertySearchAsyncRequestBuilder For fluent construction of requests
+     */
+    searchPropertiesAsync(request: PropertySearchAsyncRequest): Promise<PropertySearchAsyncResponse>;
+    /**
+     * Skip trace property owners (v1 API)
+     * POST /api/v1/property/skip-trace
+     *
+     * @param request Property skip trace request
+     * @returns Property skip trace API response
+     */
+    skipTraceProperty(request: PropertySkipTraceRequest): Promise<PropertySkipTraceResponse>;
+    /**
+     * Skip trace property owners asynchronously (v1 API)
+     * POST /api/v1/property/skip-trace/async
+     *
+     * @param request Property skip trace async request
+     * @returns Property skip trace async API response
+     */
+    skipTracePropertyAsync(request: PropertySkipTraceAsyncRequest): Promise<PropertySkipTraceAsyncResponse>;
+    /**
+     * Verify phone numbers (v1 API)
+     * POST /api/v1/phone/verification
+     *
+     * @param request Phone verification request
+     * @returns Phone verification API response
+     */
+    verifyPhone(request: PhoneVerificationRequest): Promise<PhoneVerificationResponse>;
+    /**
+     * Verify phone numbers asynchronously (v1 API)
+     * POST /api/v1/phone/verification/async
+     *
+     * @param request Phone verification async request
+     * @returns Phone verification async API response
+     */
+    verifyPhoneAsync(request: PhoneVerificationAsyncRequest): Promise<PhoneVerificationAsyncResponse>;
+    /**
+     * Check phone numbers against DNC (Do Not Call) list (v1 API)
+     * POST /api/v1/phone/dnc
+     *
+     * @param request Phone DNC request
+     * @returns Phone DNC API response
+     */
+    checkPhoneDNC(request: PhoneDNCRequest): Promise<PhoneDNCResponse>;
+    /**
+     * Check phone numbers against DNC list asynchronously (v1 API)
+     * POST /api/v1/phone/dnc/async
+     *
+     * @param request Phone DNC async request
+     * @returns Phone DNC async API response
+     */
+    checkPhoneDNCAsync(request: PhoneDNCAsyncRequest): Promise<PhoneDNCAsyncResponse>;
+    /**
+     * Check phone numbers for TCPA compliance (v1 API)
+     * POST /api/v1/phone/tcpa
+     *
+     * @param request Phone TCPA request
+     * @returns Phone TCPA API response
+     */
+    checkPhoneTCPA(request: PhoneTCPARequest): Promise<PhoneTCPAResponse>;
+    /**
+     * Check phone numbers for TCPA compliance asynchronously (v1 API)
+     * POST /api/v1/phone/tcpa/async
+     *
+     * @param request Phone TCPA async request
+     * @returns Phone TCPA async API response
+     */
+    checkPhoneTCPAAsync(request: PhoneTCPAAsyncRequest): Promise<PhoneTCPAAsyncResponse>;
+    /**
+     * Get all property subscriptions (v2 API)
+     * GET /api/v2/property-subscription
+     *
+     * @returns Array of property subscriptions
+     */
+    getPropertySubscriptions(): Promise<GetPropertySubscriptionsResponse>;
+    /**
+     * Get property subscription by ID (v2 API)
+     * GET /api/v2/property-subscription/{id}
+     *
+     * @param id Subscription ID
+     * @returns Property subscription detail
+     */
+    getPropertySubscription(id: string): Promise<GetPropertySubscriptionDetailResponse>;
+    /**
+     * Delete property subscription (v2 API)
+     * DELETE /api/v2/property-subscription/{id}
+     *
+     * @param id Subscription ID
+     * @returns Delete response
+     */
+    deletePropertySubscription(id: string): Promise<DeletePropertySubscriptionResponse>;
+    /**
+     * Get property permits (v2 API)
+     * POST /api/v2/property/permit
+     *
+     * @param request Property permit request
+     * @returns Property permit API response
+     * @see PropertyPermitRequestBuilder For fluent construction of requests
+     */
+    getPropertyPermit(request: PropertyPermitRequest): Promise<PropertyPermitResponse>;
+    /**
+     * Skip trace property owners (v3 API)
+     * POST /api/v3/property/skip-trace
+     *
+     * @param request Property skip trace v3 request
+     * @returns Property skip trace v3 API response
+     */
+    skipTracePropertyV3(request: PropertySkipTraceV3Request): Promise<PropertySkipTraceV3Response>;
+    /**
+     * Skip trace property owners asynchronously (v3 API)
+     * POST /api/v3/property/skip-trace/async
+     *
+     * @param request Property skip trace v3 async request
+     * @returns Property skip trace v3 async API response
+     */
+    skipTracePropertyV3Async(request: PropertySkipTraceV3AsyncRequest): Promise<PropertySkipTraceV3AsyncResponse>;
+}

package/dist/client.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });