wallee/build/src/api/HumanUserService.d.ts

TypeScript/JavaScript client for wallee

import http = require("http");
import Promise = require("bluebird");
import { Authentication } from '../auth/Authentication';
import { EntityExportRequest } from '../models/EntityExportRequest';
import { EntityQuery } from '../models/EntityQuery';
import { EntityQueryFilter } from '../models/EntityQueryFilter';
import { HumanUser } from '../models/HumanUser';
import { HumanUserCreate } from '../models/HumanUserCreate';
import { HumanUserUpdate } from '../models/HumanUserUpdate';
declare class HumanUserService {
    protected _basePath: string;
    protected _defaultHeaders: any;
    protected _useQuerystring: boolean;
    protected _timeout: number;
    protected _defaultAuthentication: Authentication;
    constructor(configuration: any);
    /**
    * Set timeout in seconds. Default timeout: 25 seconds
    * @param {number} timeout
    */
    set timeout(timeout: number);
    private setTimeout;
    set basePath(basePath: string);
    get basePath(): string;
    protected setDefaultAuthentication(auth: Authentication): void;
    private getVersion;
    /**
    * Deletes the entity with the given id.
    * @summary Delete
    * @param id
    * @param {*} [options] Override http request options.
    */
    _delete(id: number, options?: any): Promise<{
        response: http.IncomingMessage;
        body?: any;
    }>;
    /**
    * Exports the human users into a CSV file. The file will contain the properties defined in the request.
    * @summary Export
    * @param request The request controls the entries which are exported.
    * @param {*} [options] Override http request options.
    */
    _export(request: EntityExportRequest, options?: any): Promise<{
        response: http.IncomingMessage;
        body: string;
    }>;
    /**
    * Counts the number of items in the database as restricted by the given filter.
    * @summary Count
    * @param filter The filter which restricts the entities which are used to calculate the count.
    * @param {*} [options] Override http request options.
    */
    count(filter?: EntityQueryFilter, options?: any): Promise<{
        response: http.IncomingMessage;
        body: number;
    }>;
    /**
    * Creates the entity with the given properties.
    * @summary Create
    * @param entity The human user object with the properties which should be created.
    * @param {*} [options] Override http request options.
    */
    create(entity: HumanUserCreate, options?: any): Promise<{
        response: http.IncomingMessage;
        body: HumanUser;
    }>;
    /**
    * Reads the entity with the given 'id' and returns it.
    * @summary Read
    * @param id The id of the human user which should be returned.
    * @param {*} [options] Override http request options.
    */
    read(id: number, options?: any): Promise<{
        response: http.IncomingMessage;
        body: HumanUser;
    }>;
    /**
    * Searches for the entities as specified by the given query.
    * @summary Search
    * @param query The query restricts the human users which are returned by the search.
    * @param {*} [options] Override http request options.
    */
    search(query: EntityQuery, options?: any): Promise<{
        response: http.IncomingMessage;
        body: Array<HumanUser>;
    }>;
    /**
    * This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.
    * @summary Update
    * @param entity The object with all the properties which should be updated. The id and the version are required properties.
    * @param {*} [options] Override http request options.
    */
    update(entity: HumanUserUpdate, options?: any): Promise<{
        response: http.IncomingMessage;
        body: HumanUser;
    }>;
}
export { HumanUserService };