@simplyhomes/sos-sdk/dist/client.d.ts

TypeScript SDK for Simply Homes SoS API v4

import { V4 } from './resources/v4';
/**
 * Options for configuring the SimplyHomes SDK client
 */
export interface ClientOptions {
    /** API key for authentication (optional) */
    apiKey?: string | null;
    /** Organization ID for multi-tenant requests (optional) */
    organizationId?: string | null;
    /** Bearer auth token for authentication (optional) */
    authToken?: string | null;
    /** Environment to use (local, staging, production) */
    environment?: 'local' | 'staging' | 'production';
    /** Custom base URL (overrides environment) */
    baseURL?: string;
    /** Request timeout in milliseconds */
    timeout?: number;
    /** Maximum number of retries for failed requests */
    maxRetries?: number;
    /** Custom fetch implementation */
    fetch?: typeof fetch;
}
/**
 * Main SDK client for Simply Homes SoS API v4
 *
 * @example
 * ```typescript
 * const sdk = new SimplyHomesSDK({
 *   environment: 'production',
 *   authToken: 'Bearer your-token-here',
 *   organizationId: 'your-org-id'
 * });
 *
 * // Use the SDK
 * const transactions = await sdk.v4.transactions.list.all();
 * ```
 */
export declare class SimplyHomesSDK {
    private config;
    /** V4 API resources */
    readonly v4: V4;
    constructor(options: ClientOptions);
    /**
     * Get base URL based on environment
     */
    private getBaseURL;
}
export default SimplyHomesSDK;
//# sourceMappingURL=client.d.ts.map