@limitly/limitly-js/dist/index.d.ts

Official Node.js SDK for Limitly - API Key management, plans, users and request validation

import { HttpClient } from './client';
import { ApiKeysModule } from './modules/api-keys';
import { PlansModule } from './modules/plans';
import { UsersModule } from './modules/users';
import { ValidationModule } from './modules/validation';
import { LimitlyConfig } from './types';
/**
 * Main Limitly SDK client
 *
 * @example
 * ```typescript
 * import { Limitly } from '@limitly/sdk';
 *
 * const limitly = new Limitly({
 *   apiKey: 'your_limitly_api_key'
 * });
 *
 * // Validate a request
 * const result = await limitly.validation.validate(
 *   'user_api_key',
 *   '/api/users',
 *   'GET'
 * );
 *
 * if (result.success) {
 *   console.log('Request allowed');
 * } else {
 *   console.log('Request denied:', result.error);
 * }
 * ```
 */
export declare class Limitly {
    readonly apiKeys: ApiKeysModule;
    readonly plans: PlansModule;
    readonly users: UsersModule;
    readonly validation: ValidationModule;
    private client;
    constructor(config: LimitlyConfig);
    /**
     * Gets the internal HTTP client
     * Useful for debugging and testing
     */
    getClient(): HttpClient;
}
export * from './types';
export { HttpClient } from './client';
export { ApiKeysModule } from './modules/api-keys';
export { PlansModule } from './modules/plans';
export { UsersModule } from './modules/users';
export { ValidationModule } from './modules/validation';
export default Limitly;
//# sourceMappingURL=index.d.ts.map