boldsign/dist/api/userApi.d.ts

NodeJS client for boldsign

import { Authentication, Interceptor, ApiKeyAuth, ChangeTeamRequest, CreateUser, UpdateUser, UpdateUserMetaData, UserProperties, UserRecords } from '../model';
import { optionsI, returnTypeI } from './';
export declare class UserApi {
    protected _basePath: string;
    protected _defaultHeaders: any;
    protected _useQuerystring: boolean;
    protected authentications: {
        default: Authentication;
        Bearer: ApiKeyAuth;
        'X-API-KEY': ApiKeyAuth;
    };
    protected interceptors: Interceptor[];
    constructor(basePath?: string);
    set useQuerystring(value: boolean);
    set basePath(basePath: string);
    set defaultHeaders(defaultHeaders: any);
    get defaultHeaders(): any;
    get basePath(): string;
    setDefaultAuthentication(auth: Authentication): void;
    setApiKey(apikey: string): void;
    setAccessToken(accessToken: string): void;
    addInterceptor(interceptor: Interceptor): void;
    cancelInvitation(userId: string, options?: optionsI): Promise<returnTypeI>;
    changeTeam(userId: string, changeTeamRequest?: ChangeTeamRequest, options?: optionsI): Promise<returnTypeI>;
    createUser(createUser?: Array<CreateUser>, options?: optionsI): Promise<returnTypeI>;
    getUser(userId: string, options?: optionsI): Promise<UserProperties>;
    listUsers(page: number, pageSize?: number, search?: string, userId?: Array<string>, options?: optionsI): Promise<UserRecords>;
    resendInvitation(userId: string, options?: optionsI): Promise<returnTypeI>;
    updateMetaData(updateUserMetaData?: UpdateUserMetaData, options?: optionsI): Promise<returnTypeI>;
    updateUser(updateUser?: UpdateUser, options?: optionsI): Promise<returnTypeI>;
}