@phasesdk/api-client-for-economic
Version:
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
67 lines (66 loc) • 2.26 kB
TypeScript
import OpenApi from "../../OpenApi";
import { AuthToken, ProjectResponse } from "../../../types/Economic.type";
import { HttpResponse } from "../../../types/Http.type";
export type Project = {
name: string;
projectGroupNumber: number;
closedDate: string | null;
contactPersonId: number | null;
costPrice: number | null;
customerNumber: number | null;
deliveryDate: number | null;
deliveryLocationNumber: number | null;
departmentNumber: number | null;
description: string | null;
fixedPrice: number | null;
invoicedTotal: number | null;
isBarred: boolean;
isClosed: boolean;
isMainProject: boolean;
isMileageInvoiced: boolean;
lastUpdated: string | null;
mainProjectNumber: number | null;
mileage: number;
number: number;
objectVersion: string | null;
otherReference: string | null;
otherResponsibleEmployeeNumber: number | null;
responsibleEmployeeNumber: number | null;
salesPrice: number | null;
status: number | null;
self: string;
};
export default class Projects extends OpenApi {
private version;
getVersion(): string;
setVersion(version: string): this;
getUrlSegment(): string;
constructor(authToken: AuthToken);
/**
* Use this endpoint to retrieve all Projects in bulk. Max number of items returned in a single call is 1000
*
* @see https://apis.e-conomic.com/redoc.html#tag/Projects/operation/GetAllProjects
*
* @returns {Promise<HttpResponse>}
*/
getAll(): Promise<HttpResponse<ProjectResponse<Project[]>>>;
/**
* This endpoint is to load a collection of Projects with pagination.
*
* @see https://apis.e-conomic.com/#Projects..tag/Projects/operation/GetPageOfProjects
*
* @param {number} offset
* @param {number} limit
* @returns {Promise<HttpResponse>}
*/
get(offset?: number, limit?: number): Promise<HttpResponse<Project[]>>;
/**
* This endpoint is to load a single Project by id/number.
*
* @see https://apis.e-conomic.com/redoc.html#tag/Projects/operation/GetProjectById
*
* @param {number} id
* @returns {Promise<HttpResponse>}
*/
getFor(id: number): Promise<HttpResponse<Project>>;
}