@limitly/limitly-js/dist/modules/users.d.ts

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

import { HttpClient } from '../client';
import { User, CreateUserRequest, UpdateUserRequest, UserUsage, ApiKey, ApiResponse, PaginatedResponse, RequestOptions } from '../types';
/**
 * Module for managing Users
 */
export declare class UsersModule {
    private client;
    constructor(client: HttpClient);
    /**
     * Lists all users for the client
     */
    list(options?: RequestOptions): Promise<PaginatedResponse<User>>;
    /**
     * Creates a new user
     */
    create(data: CreateUserRequest, options?: RequestOptions): Promise<ApiResponse<User>>;
    /**
     * Gets a specific user by ID
     */
    get(userId: number, options?: RequestOptions): Promise<ApiResponse<User>>;
    /**
     * Updates an existing user
     */
    update(userId: number, data: UpdateUserRequest, options?: RequestOptions): Promise<ApiResponse<User>>;
    /**
     * Deletes a user
     */
    delete(userId: number, options?: RequestOptions): Promise<ApiResponse<{
        message: string;
    }>>;
    /**
     * Gets usage for a specific user
     */
    getUsage(userId: number, options?: RequestOptions): Promise<ApiResponse<UserUsage>>;
    /**
     * Gets all API Keys assigned to a specific user
     */
    getKeys(userId: number, options?: RequestOptions): Promise<PaginatedResponse<ApiKey>>;
    /**
     * Creates a new API Key for a specific user
     */
    createKey(userId: number, data: {
        name: string;
    }, options?: RequestOptions): Promise<ApiResponse<ApiKey>>;
}
//# sourceMappingURL=users.d.ts.map