@gohighlevel/api-client/dist/lib/code/users/users.d.ts

Official SDK for HighLevel Public APIs

import { AxiosInstance, AxiosRequestConfig } from 'axios';
import * as Models from './models/users';
/**
 * Users Service
 * Documentation for users API
 */
export declare class Users {
    private client;
    constructor(httpClient: AxiosInstance);
    /**
     * Search Users
     * Search Users
     */
    searchUsers(params: {
        companyId: string;
        query?: string;
        skip?: string;
        limit?: string;
        locationId?: string;
        type?: string;
        role?: string;
        ids?: string;
        sort?: string;
        sortDirection?: string;
        enabled2waySync?: boolean;
    }, options?: AxiosRequestConfig & {
        preferredTokenType?: 'company' | 'location';
    }): Promise<Models.SearchUserSuccessfulResponseDto>;
    /**
     * Filter Users by Email
     * Filter users by company ID, deleted status, and email array
     */
    filterUsersByEmail(requestBody: Models.FilterByEmailDto, options?: AxiosRequestConfig & {
        preferredTokenType?: 'company' | 'location';
    }): Promise<Models.SearchUserSuccessfulResponseDto>;
    /**
     * Get User
     * Get User
     */
    getUser(params: {
        userId: string;
    }, options?: AxiosRequestConfig & {
        preferredTokenType?: 'company' | 'location';
    }): Promise<Models.UserSuccessfulResponseDto>;
    /**
     * Update User
     * Update User
     */
    updateUser(requestBody: Models.UpdateUserDto, options?: AxiosRequestConfig & {
        preferredTokenType?: 'company' | 'location';
    }): Promise<Models.UserSuccessfulResponseDto>;
    /**
     * Delete User
     * Delete User
     */
    deleteUser(options?: AxiosRequestConfig & {
        preferredTokenType?: 'company' | 'location';
    }): Promise<Models.DeleteUserSuccessfulResponseDto>;
    /**
     * Get User by Location
     * Get User by Location
     */
    getUserByLocation(params: {
        locationId: string;
    }, options?: AxiosRequestConfig): Promise<Models.LocationSuccessfulResponseDto>;
    /**
     * Create User
     * Create User
     */
    createUser(requestBody: Models.CreateUserDto, options?: AxiosRequestConfig & {
        preferredTokenType?: 'company' | 'location';
    }): Promise<Models.UserSuccessfulResponseDto>;
}
export default Users;
//# sourceMappingURL=users.d.ts.map