@phasesdk/api-client-for-economic/lib/modules/open/employees/Employees.d.ts

e-conomic REST API Library for Node.js is a powerful tool designed to simplify integration with the e-conomic platform for developers building Node.js applications. With this library, developers can effortlessly leverage the full functionality of the e-co

import OpenApi from "../../OpenApi";
import { AuthToken, EmployeeResponse } from "../../../types/Economic.type";
import { HttpResponse } from "../../../types/Http.type";
export type Employee = {
    access: boolean;
    groupNumber: number;
    name: string;
    number: number | null;
    email: string | null;
    objectVersion: string | null;
};
type CreateEmployee = {
    access: boolean;
    groupNumber: number;
    name: string;
    number: number | null;
    email: string | null;
    objectVersion: string | null;
    phone: string | null;
};
export default class Employees extends OpenApi {
    private version;
    getVersion(): string;
    setVersion(version: string): this;
    getUrlSegment(): string;
    constructor(authToken: AuthToken);
    /**
     * Use this endpoint to retrieve all Employees in bulk. Max number of items returned in a single call is 1000
     *
     * @see https://apis.e-conomic.com/#Projects..tag/Employees/operation/GetAllEmployees
     *
     * @returns {Promise<HttpResponse>}
     */
    getAll(): Promise<HttpResponse<EmployeeResponse<Employee[]>>>;
    /**
     * This endpoint is to load a collection of Employees with pagination.
     *
     * @see https://apis.e-conomic.com/#Projects..tag/Employees/operation/GetPageOfEmployees
     *
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     */
    get(offset?: number, limit?: number): Promise<HttpResponse<Employee[]>>;
    /**
     * This endpoint is to load a collection of Employees under an Employee Group with pagination.
     *
     * @param {number} groupNumber
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     */
    getEmployeesByEmployeeGroup(groupNumber: number, skipPages?: number, limit?: number): Promise<HttpResponse<Employee[]>>;
    /**
     * This endpoint is to load a single Employee by id/number.
     *
     * @see https://apis.e-conomic.com/#Projects..tag/Employees/operation/GetEmployeeById
     *
     * @param {number} number
     * @returns {Promise<HttpResponse>}
     */
    getFor(number: number): Promise<HttpResponse<Employee>>;
    /**
     * This endpoint is to to create a single Employee.
     *
     * @see https://apis.e-conomic.com/#Projects..tag/Employees/operation/CreateEmployee
     *
     * @param {CreateEmployee} createEmployee
     * @returns {Promise<HttpResponse>}
     */
    create(createEmployee: CreateEmployee): Promise<HttpResponse<Employee>>;
}
export {};