@phasesdk/api-client-for-economic/lib/modules/rest/Orders.js

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

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const RestApi_1 = __importDefault(require("../../modules/RestApi"));
class Orders extends RestApi_1.default {
    /**
     * @constructor
     */
    constructor(props) {
        super(props);
    }
    /**
     * This is the root for the orders endpoint. From here you can navigate to draft, sent and archived orders.
     *
     * @see https://restdocs.e-conomic.com/#orders
     * @returns {Promise<HttpResponse>}
     *
     */
    get() {
        const requestObj = {
            method: "get",
            url: `/orders`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This returns a collection of all draft orders.
     *
     * @see https://restdocs.e-conomic.com/#get-orders-drafts
     *
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     *
     */
    getDrafts(offset = 0, limit = 100) {
        const requestObj = {
            method: "get",
            url: `/orders/drafts?skippages=${offset}&pagesize=${limit}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Returns a specific customer's order drafts.
     *
     * @param {number} customerNumber
     * @returns {Promise<HttpResponse>}
     */
    getCustomerOrderDrafts(customerNumber, skipPages = 0, limit = 100) {
        const requestObj = {
            method: "get",
            url: `/orders/drafts?skippages=${skipPages}&pagesize=${limit}&filter=customer.customerNumber$eq:${customerNumber}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This endpoint provides you with the entire document for a specific order draft.
     *
     * @see https://restdocs.e-conomic.com/#get-orders-drafts-ordernumber
     * @param {number} orderNumber
     * @returns {Promise<HttpResponse>}
     *
     */
    getDraft(orderNumber) {
        const requestObj = {
            method: "get",
            url: `/orders/drafts/${orderNumber}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Create a new draft order.
     * @see https://restdocs.e-conomic.com/#post-orders-drafts
     * @param {DraftOrder} draftOrder
     * @returns {Promise<HttpResponse<SingleDraftOrder>>}
     */
    createDraftOrder(draftOrder) {
        const requestObj = {
            method: "post",
            url: `/orders/drafts`,
            data: draftOrder,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Update an existing draft order.
     * @see https://restdocs.e-conomic.com/#put-orders-drafts-ordernumber
     * @param {number} orderNumber
     * @param {DraftOrder} draftOrder
     * @returns {Promise<HttpResponse<SingleDraftOrder>>}
     */
    updateDraftOrder(orderNumber, draftOrder) {
        const requestObj = {
            method: "put",
            url: `/orders/drafts/${orderNumber}`,
            data: draftOrder,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Delete an existing draft order.
     * @see https://restdocs.e-conomic.com/#delete-orders-drafts-ordernumber
     * @param {number} orderNumber
     * @returns {Promise<HttpResponse<void>>}
     */
    deleteDraftOrder(orderNumber) {
        const requestObj = {
            method: "delete",
            url: `/orders/drafts/${orderNumber}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This returns a collection of all sent orders.
     *
     * @see https://restdocs.e-conomic.com/#get-orders-sent
     *
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     *
     */
    getAllSent(offset = 0, limit = 100) {
        const requestObj = {
            method: "get",
            url: `/orders/sent?skippages=${offset}&pagesize=${limit}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This endpoint provides you with the entire document for a specific sent order.
     *
     * @see https://restdocs.e-conomic.com/#get-orders-sent-ordernumber
     *
     * @param {number} orderNumber
     * @returns {Promise<HttpResponse>}
     *
     */
    getSent(orderNumber) {
        const requestObj = {
            method: "get",
            url: `/orders/sent/${orderNumber}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Create sent order
     *
     * @param {SentOrderUpdate} sentOrder
     * @returns {Promise<HttpResponse<DraftOrder>>}
     */
    sentDraftOrder(sentOrder) {
        const requestObj = {
            method: "post",
            url: `/orders/sent`,
            data: sentOrder,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This returns a collection of all archived orders.
     *
     * @see https://restdocs.e-conomic.com/#get-orders-archived
     *
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     *
     */
    getAllArchived(offset = 0, limit = 100) {
        const requestObj = {
            method: "get",
            url: `/orders/archived?skippages=${offset}&pagesize=${limit}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This endpoint provides you with the entire document for a specific archived order. An archived order is an order that was first registered as sent and then upgraded to invoice draft.
     *
     * @see https://restdocs.e-conomic.com/#get-orders-archived-ordernumber
     *
     * @param {number} orderNumber
     * @returns {Promise<HttpResponse>}
     *
     */
    getArchived(orderNumber) {
        const requestObj = {
            method: "get",
            url: `/orders/archived/${orderNumber}`,
        };
        return this._httpRequest(requestObj);
    }
}
exports.default = Orders;