@phasesdk/api-client-for-economic/lib/modules/rest/Quotes.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("../RestApi"));
class Quotes extends RestApi_1.default {
    /**
     * @constructor
     */
    constructor(props) {
        super(props);
    }
    /**
     * This is the root for the quotes endpoint. From here you can navigate to draft, sent and archived quotes.
     *
     * @see https://restdocs.e-conomic.com/#quotes
     * @returns {Promise<HttpResponse>}
     *
     */
    get() {
        const requestObj = {
            method: "get",
            url: `/quotes`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This returns a collection of all draft quotes.
     *
     * @see https://restdocs.e-conomic.com/#get-quotes-drafts
     *
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     *
     */
    getDrafts(offset = 0, limit = 100) {
        const requestObj = {
            method: "get",
            url: `/quotes/drafts?skippages=${offset}&pagesize=${limit}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Returns a specific customer's quote drafts.
     *
     * @param {number} customerNumber
     * @returns {Promise<HttpResponse>}
     */
    getCustomerQuoteDrafts(customerNumber, skipPages = 0, limit = 100) {
        const requestObj = {
            method: "get",
            url: `/quotes/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 quote draft.
     *
     * @see https://restdocs.e-conomic.com/#get-quotes-drafts-quotenumber
     * @param {number} quoteNumber
     * @returns {Promise<HttpResponse<SingleDraftQuote>>}
     *
     */
    getDraft(quoteNumber) {
        const requestObj = {
            method: "get",
            url: `/quotes/drafts/${quoteNumber}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Create a new draft quote.
     * @see https://restdocs.e-conomic.com/#post-quotes-drafts
     * @param {DraftQuote} draftQuote
     * @returns {Promise<HttpResponse<SingleDraftQuote>>}
     */
    createDraftQuote(draftQuote) {
        const requestObj = {
            method: "post",
            url: `/quotes/drafts`,
            data: draftQuote,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Update an existing draft quote.
     * @see https://restdocs.e-conomic.com/#put-quotes-drafts-quotenumber
     * @param {number} quoteNumber
     * @param {DraftQuote} draftQuote
     * @returns {Promise<HttpResponse<SingleDraftQuote>>}
     */
    updateDraftQuote(quoteNumber, draftQuote) {
        const requestObj = {
            method: "put",
            url: `/quotes/drafts/${quoteNumber}`,
            data: draftQuote,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * Delete an existing draft quote.
     * @see https://restdocs.e-conomic.com/#delete-quotes-drafts-quotenumber
     * @param {number} quoteNumber
     * @returns {Promise<HttpResponse<void>>}
     */
    deleteDraftQuote(quoteNumber) {
        const requestObj = {
            method: "delete",
            url: `/quotes/drafts/${quoteNumber}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This returns a collection of all sent quotes.
     *
     * @see https://restdocs.e-conomic.com/#get-quotes-sent
     *
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     *
     */
    getAllSent(offset = 0, limit = 100) {
        const requestObj = {
            method: "get",
            url: `/quotes/sent?skippages=${offset}&pagesize=${limit}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This endpoint provides you with the entire document for a specific sent quote.
     *
     * @see https://restdocs.e-conomic.com/#get-quotes-sent-quotenumber
     *
     * @param {number} quoteNumber
     * @returns {Promise<HttpResponse<SentQuote>>}
     *
     */
    getSent(quoteNumber) {
        const requestObj = {
            method: "get",
            url: `/quotes/sent/${quoteNumber}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This returns a collection of all archived quotes.
     *
     * @see https://restdocs.e-conomic.com/#get-quotes-archived
     *
     * @param {number} offset
     * @param {number} limit
     * @returns {Promise<HttpResponse>}
     *
     */
    getAllArchived(offset = 0, limit = 100) {
        const requestObj = {
            method: "get",
            url: `/quotes/archived?skippages=${offset}&pagesize=${limit}`,
        };
        return this._httpRequest(requestObj);
    }
    /**
     * This endpoint provides you with the entire document for a specific archived quote. An archived quote is a quote that was first registered as sent and then upgraded to quote draft.
     *
     * @see https://restdocs.e-conomic.com/#get-quotes-archived-quotenumber
     *
     * @param {number} quoteNumber
     * @returns {Promise<HttpResponse>}
     *
     */
    getArchived(quoteNumber) {
        const requestObj = {
            method: "get",
            url: `/quotes/archived/${quoteNumber}`,
        };
        return this._httpRequest(requestObj);
    }
}
exports.default = Quotes;