@phasesdk/api-client-for-economic/lib/modules/rest/Quotes.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 { CustomerInfo } from "./Customers";
import { Delivery, DeliveryLocation } from "./DeliveryLocation";
import { Lines, Note, Pdf, Recipient, References } from "./Invoices";
import { Templates } from "./Templates";
import { ProjectInfo } from "./Projects";
import { PaymentTerms } from "./PaymentTerms";
import { HttpResponse } from "../../types/Http.type";
import { AuthToken, QuoteResponse, Pagination } from "../../types/Economic.type";
import { Endpoints } from "./Common";
/**
 *  Represents the base `Quote` interface for all quote types.
 */
interface Quote {
    currency: string;
    customer: CustomerInfo;
    date: string;
    dueDate: string;
    delivery: Delivery;
    deliveryLocation: DeliveryLocation;
    grossAmount: number;
    netAmount: number;
    netAmountInBaseCurrency: number;
    notes: Note;
    paymentTerms: Pick<PaymentTerms, "paymentTermsNumber" | "paymentTermsType" | "name" | "self" | "description" | "daysOfCredit">;
    pdf: Pdf;
    project: ProjectInfo;
    recipient: Recipient;
    references: References;
    roundingAmount: number;
    self: string;
    vatAmount: number;
}
export type QuoteEndpoints = Pick<Endpoints, "archived" | "drafts" | "sent" | "self">;
type Soap = {
    quoteHandle: QuoteHandle;
};
type QuoteHandle = {
    id: number;
};
/**
 *  Represents a draft quote interface extending the base `Quote` interface.
 */
export interface DraftQuote extends Quote {
    costPriceInBaseCurrency: number;
    exchangeRate: number;
    grossAmountInBaseCurrency: number;
    lastUpdated: number;
    marginInBaseCurrency: number;
    marginPercentage: number;
    soap: Soap;
    templates: Pick<Templates, "self" | "upgradeInstructions">;
    quoteNumber: number;
}
/**
 *  Represents a single draft quote interface extending `DraftQuote` interface.
 */
export interface SingleDraftQuote extends DraftQuote {
    lines: Lines;
}
/**
 *  Represents a sent quote interface extending `DraftQuote` interface.
 */
export interface SentQuote extends DraftQuote {
}
/**
 *  Represents an archived quote interface extending `DraftQuote` interface.
 */
export interface ArchivedQuote extends DraftQuote {
}
export default class Quotes extends RestApi {
    /**
     * @constructor
     */
    constructor(props: AuthToken);
    /**
     * 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(): Promise<HttpResponse<QuoteEndpoints>>;
    /**
     * 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?: number, limit?: number): Promise<HttpResponse<QuoteResponse<DraftQuote[], Pagination>>>;
    /**
     * Returns a specific customer's quote drafts.
     *
     * @param {number} customerNumber
     * @returns {Promise<HttpResponse>}
     */
    getCustomerQuoteDrafts(customerNumber: number, skipPages?: number, limit?: number): Promise<HttpResponse<QuoteResponse<DraftQuote[], Pagination>>>;
    /**
     * 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: number): Promise<HttpResponse<SingleDraftQuote>>;
    /**
     * Create a new draft quote.
     * @see https://restdocs.e-conomic.com/#post-quotes-drafts
     * @param {DraftQuote} draftQuote
     * @returns {Promise<HttpResponse<SingleDraftQuote>>}
     */
    createDraftQuote(draftQuote: DraftQuote): Promise<HttpResponse<SingleDraftQuote>>;
    /**
     * 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: number, draftQuote: DraftQuote): Promise<HttpResponse<SingleDraftQuote>>;
    /**
     * Delete an existing draft quote.
     * @see https://restdocs.e-conomic.com/#delete-quotes-drafts-quotenumber
     * @param {number} quoteNumber
     * @returns {Promise<HttpResponse<void>>}
     */
    deleteDraftQuote(quoteNumber: number): Promise<HttpResponse<void>>;
    /**
     * 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?: number, limit?: number): Promise<HttpResponse<QuoteResponse<SentQuote[], Pagination>>>;
    /**
     * 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: number): Promise<HttpResponse<SentQuote>>;
    /**
     * 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?: number, limit?: number): Promise<HttpResponse<QuoteResponse<ArchivedQuote[], Pagination>>>;
    /**
     * 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: number): Promise<HttpResponse<ArchivedQuote>>;
}
export {};