netsparker-cloud/dist/api/teamMembersApi.d.ts

JavaScript client for consuming the Netsparker Cloud API.

/**
 * Netsparker Enterprise API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/// <reference types="node" />
import http from 'http';
import { NewUserApiModel } from '../model/newUserApiModel';
import { TimezoneApiModel } from '../model/timezoneApiModel';
import { UpdateUserApiModel } from '../model/updateUserApiModel';
import { UserApiModel } from '../model/userApiModel';
import { UserApiTokenModel } from '../model/userApiTokenModel';
import { UserListApiResult } from '../model/userListApiResult';
import { Authentication, Interceptor } from '../model/models';
export declare enum TeamMembersApiApiKeys {
}
export declare class TeamMembersApi {
    protected _basePath: string;
    protected _defaultHeaders: any;
    protected _useQuerystring: boolean;
    protected authentications: {
        default: Authentication;
    };
    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(key: TeamMembersApiApiKeys, value: string): void;
    addInterceptor(interceptor: Interceptor): void;
    /**
     *
     * @summary Deletes a user.
     * @param id The identifier of the user.
     */
    teamMembersDelete(id: string, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: string;
    }>;
    /**
     *
     * @summary Gets user by id.
     * @param id The id of the user.
     */
    teamMembersGet(id: string, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: UserApiModel;
    }>;
    /**
     *
     * @summary Gets user api token.
     * @param email User email address.
     */
    teamMembersGetApiToken(email: string, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: UserApiTokenModel;
    }>;
    /**
     *
     * @summary Gets user by email.
     * @param email The email address of the user.
     */
    teamMembersGetByEmail(email: string, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: UserApiModel;
    }>;
    /**
     *
     * @summary Gets a list all of the time zones.
     */
    teamMembersGetTimezones(options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: TimezoneApiModel;
    }>;
    /**
     *
     * @summary Gets the list of users.
     * @param page The page index.
     * @param pageSize The page size. Page size can be any value between 1 and 200.
     */
    teamMembersList(page?: number, pageSize?: number, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: UserListApiResult;
    }>;
    /**
     *
     * @summary Creates a new member.
     * @param model The model.
     */
    teamMembersNew(model: NewUserApiModel, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: object;
    }>;
    /**
     *
     * @summary Updates an user.
     * @param model The model.
     */
    teamMembersUpdate(model: UpdateUserApiModel, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: UserApiModel;
    }>;
}