@phasesdk/api-client-for-economic/lib/modules/rest/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 RestApi from "../RestApi";
import { AuthToken } from "../../types/Economic.type";
import { HttpResponse } from "../../types/Http.type";
import { EconomicResponse, Pagination } from "../../types/Economic.type";
export type Employee = {
    employeeNumber: number;
    self: string;
    name: string;
    phone: string;
};
export type EmployeeInfo = Pick<Employee, "employeeNumber" | "self">;
export type CreateEmployee = {
    name: string;
    phone: string;
};
export default class Employees extends RestApi {
    /**
     * @constructor
     */
    constructor(props: AuthToken);
    getUrl(): string;
    /**
     * Get collection of employees.
     * @see https://restdocs.e-conomic.com/#get-employees
     *
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     */
    get(offset?: number, limit?: number): Promise<HttpResponse<EconomicResponse<Employee[], Pagination, any>>>;
    /**
     * Get a specific employee
     * @see https://restdocs.e-conomic.com/#get-employees-employeenumber
     * @param {number} employeeNumber
     * @returns {Promise<HttpResponse>}
     */
    getFor(employeeNumber: number): Promise<HttpResponse<Employee>>;
    /**
     * Create a new employee
     * @see https://restdocs.e-conomic.com/#post-employees
     * @param {CreateEmployee} employee
     * @returns {Promise<HttpResponse<Employee>>}
     */
    createEmployee(employee: CreateEmployee): Promise<HttpResponse<Employee>>;
    /**
     * Update an existing employee
     * @see https://restdocs.e-conomic.com/#put-employees-employeenumber
     * @param {number} employeeNumber
     * @param {Partial<CreateEmployee>} employee
     * @returns {Promise<HttpResponse<Employee>>}
     */
    updateEmployee(employeeNumber: number, employee: Partial<CreateEmployee>): Promise<HttpResponse<Employee>>;
    /**
     * Delete an existing employee
     * @see https://restdocs.e-conomic.com/#delete-employees-employeenumber
     * @param {number} employeeNumber
     * @returns {Promise<HttpResponse<void>>}
     */
    deleteEmployee(employeeNumber: number): Promise<HttpResponse<void>>;
}