bukku-client 0.1.0-test.0

package/dist/sales/payments/type.d.ts

@@ -0,0 +1,242 @@
+import { BukkuEmailDetails, BukkuFileAttachment, BukkuListPagination } from "../../common/type";
+/**
+ * Represents a link item for creating a Bukku Payment, specifying where credit is applied.
+ */
+export interface BukkuPaymentLinkItemCreateParams {
+    /** The id of the link item, required when you're updating an item. */
+    id?: number;
+    /** The target transaction to apply the amount to. */
+    target_transaction_id: number;
+    /** The amount to apply. */
+    apply_amount: number;
+}
+/**
+ * Represents a deposit item for creating a Bukku Payment.
+ */
+export interface BukkuPaymentDepositItemCreateParams {
+    /** The id of the deposit item, required when you're updating an item. */
+    id?: number;
+    /** The id of the payment method. */
+    payment_method_id?: number;
+    /** The deposit account for the payment. */
+    account_id: number;
+    /** The amount received. */
+    amount: number;
+    /** The payment reference number. */
+    number?: string;
+    /** The fee incurred for the amount paid. Include '%', if it's a percentage. */
+    fee_text?: string;
+    /** The account for the fee incurred, required if the fee_text is present. */
+    fee_account_id?: number;
+}
+/**
+ * Parameters for creating a Bukku Payment.
+ * Based on POST /sales/payments
+ */
+export interface BukkuPaymentCreateParams {
+    contact_id: number;
+    number?: string;
+    number2?: string;
+    date: string;
+    currency_code: string;
+    exchange_rate: number;
+    amount: number;
+    tag_ids?: number[];
+    description?: string;
+    remarks?: string;
+    link_items?: Array<BukkuPaymentLinkItemCreateParams>;
+    deposit_items: Array<BukkuPaymentDepositItemCreateParams>;
+    status: "draft" | "pending_approval" | "ready";
+    email?: BukkuEmailDetails;
+    files?: Array<BukkuFileAttachment>;
+}
+/**
+ * Represents a link item in a Bukku Payment response (credit applied to).
+ * Based on `link_items` in the sample response.
+ */
+export interface BukkuPaymentLinkItem {
+    id: number;
+    target_transaction_id: number;
+    type: string;
+    number: string;
+    date: string;
+    description?: string;
+    amount: number;
+    balance: number;
+}
+/**
+ * Represents a linked item in a Bukku Payment response (origin of credit).
+ * Based on `linked_items` in the sample response. Note: This appears to show what this payment is linked FROM,
+ * which is unusual for a payment creation but present in the sample.
+ * It might represent allocations if this payment is e.g. from a credit note.
+ * For a standard payment against an invoice, `link_items` is more typical for "what this payment pays".
+ */
+export interface BukkuPaymentLinkedItem {
+    id: number;
+    origin_transaction_id: number;
+    type: string;
+    number: string;
+    date: string;
+    amount: number;
+    balance: number;
+    apply_amount: number;
+}
+/**
+ * Represents a deposit item within a Bukku Payment response.
+ */
+export interface BukkuPaymentDepositItem {
+    id: number;
+    line: number;
+    payment_method_id: number;
+    account_id: number;
+    amount: number;
+    number: string | null;
+    fee_text: number | string | null;
+    fee_account_id: number | null;
+}
+/**
+ * Represents the detailed file information within a Bukku Payment's file entry.
+ */
+export interface BukkuPaymentFileDetail {
+    id: number;
+    url: string;
+    filename: string;
+    mime_type: string;
+    size: number;
+    created_at: string;
+}
+/**
+ * Represents a file entry attached to a Bukku Payment.
+ */
+export interface BukkuPaymentFileEntry {
+    id: number;
+    file_id: number;
+    file: BukkuPaymentFileDetail[];
+    is_shared: boolean;
+    created_at: string;
+}
+/**
+ * Represents a Bukku Payment object as returned by the API.
+ */
+export interface BukkuPayment {
+    id: number;
+    contact_id: number;
+    contact_name: string;
+    date: string;
+    currency_code: string;
+    currency_symbol: string;
+    exchange_rate: number;
+    amount: number;
+    number: string;
+    number2?: string | null;
+    tag_ids: number[];
+    tag_names: string[];
+    link_items: BukkuPaymentLinkItem[];
+    linked_items: BukkuPaymentLinkedItem[];
+    deposit_items: BukkuPaymentDepositItem[];
+    remarks: string | null;
+    description: string | null;
+    balance: number;
+    status: string;
+    type: string;
+    short_link: string;
+    files: BukkuPaymentFileEntry[];
+}
+/**
+ * Represents the API response structure when a payment is created or retrieved.
+ */
+export interface BukkuPaymentResponse {
+    transaction: BukkuPayment;
+}
+/**
+ * Parameters for updating a Bukku Payment.
+ * 'status' is typically managed by a separate PATCH endpoint.
+ * 'number' becomes a required field for update.
+ */
+export interface BukkuPaymentUpdateParams {
+    contact_id: number;
+    number: string;
+    number2?: string;
+    date: string;
+    currency_code: string;
+    exchange_rate: number;
+    amount: number;
+    tag_ids?: number[];
+    description?: string;
+    remarks?: string;
+    link_items?: Array<BukkuPaymentLinkItemCreateParams>;
+    deposit_items: Array<BukkuPaymentDepositItemCreateParams>;
+    email?: BukkuEmailDetails;
+    files?: Array<BukkuFileAttachment>;
+}
+/**
+ * Parameters for updating the status of a Bukku Payment.
+ */
+export interface BukkuPaymentStatusUpdateParams {
+    /** The new status for the payment. */
+    status: "ready" | "draft" | "pending_approval" | "void";
+}
+/**
+ * Parameters for listing Bukku Payments (GET /sales/payments - assumed endpoint).
+ */
+export interface BukkuPaymentListParams {
+    /** Search for keywords in No., Reference No., Description, Contact Name. Max 100 chars. */
+    search?: string;
+    /** Search for keywords within custom fields. Max 100 chars. */
+    custom_search?: string;
+    /** Search by contact ID. */
+    contact_id?: number;
+    /** Search for transactions on and after the date (YYYY-MM-DD). */
+    date_from?: string;
+    /** Search for transactions on and before the date (YYYY-MM-DD). */
+    date_to?: string;
+    /** Search by status, default to All but Void. */
+    status?: "all" | "draft" | "pending_approval" | "ready" | "void";
+    /** Filter by payment status. */
+    payment_status?: "paid" | "outstanding";
+    /** Search by the latest email status. */
+    email_status?: "UNSENT" | "PENDING" | "SENT" | "BOUNCED" | "OPENED" | "VIEWED";
+    /** Filter by accounts in Current Assets, Non-Current Assets, Current Liabilities and Equity. */
+    account_id?: string;
+    /** Sort by field. */
+    sort_by?: "number" | "date" | "contact_name" | "number2" | "description" | "amount" | "balance" | "created_at";
+    /** Sort the list in ascending or descending order. */
+    sort_dir?: "asc" | "desc";
+    /** The current page number. Default: 1, Min: 1. */
+    page?: number;
+    /** Number of records per page. Default: 30. */
+    page_size?: number;
+    [key: string]: any;
+}
+/**
+ * Represents a summary of a Bukku Payment as it appears in a list.
+ */
+export interface BukkuPaymentListItem {
+    id: number;
+    number: string;
+    number2?: string | null;
+    contact_id: number;
+    contact_name: string;
+    contact_email?: string;
+    date: string;
+    currency_code: string;
+    currency_symbol: string;
+    exchange_rate: number;
+    amount: number;
+    balance?: number;
+    status: string;
+    email_status?: string;
+    file_count?: number;
+    short_link?: string;
+    created_by?: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Represents the API response structure for listing payments.
+ */
+export interface BukkuPaymentListApiResponse {
+    paging: BukkuListPagination;
+    transactions: BukkuPaymentListItem[];
+}
+//# sourceMappingURL=type.d.ts.map

package/dist/sales/payments/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/sales/payments/type.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAI3B;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,sEAAsE;IACtE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,qDAAqD;IACrD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,yEAAyE;IACzE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6EAA6E;IAC7E,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACrD,aAAa,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAC1D,MAAM,EAAE,OAAO,GAAG,kBAAkB,GAAG,OAAO,CAAC;IAC/C,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACpC;AAID;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB,EAAE,MAAM,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,qBAAqB,EAAE,MAAM,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,sBAAsB,EAAE,CAAC;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,EAAE,oBAAoB,EAAE,CAAC;IACnC,YAAY,EAAE,sBAAsB,EAAE,CAAC;IACvC,aAAa,EAAE,uBAAuB,EAAE,CAAC;IACzC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,qBAAqB,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,YAAY,CAAC;CAC3B;AAID;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACrD,aAAa,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAC1D,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,sCAAsC;IACtC,MAAM,EAAE,OAAO,GAAG,OAAO,GAAG,kBAAkB,GAAG,MAAM,CAAC;CACzD;AAID;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,2FAA2F;IAC3F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,MAAM,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAC;IACjE,gCAAgC;IAChC,cAAc,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IACxC,yCAAyC;IACzC,YAAY,CAAC,EACT,QAAQ,GACR,SAAS,GACT,MAAM,GACN,SAAS,GACT,QAAQ,GACR,QAAQ,CAAC;IACb,gGAAgG;IAChG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qBAAqB;IACrB,OAAO,CAAC,EACJ,QAAQ,GACR,MAAM,GACN,cAAc,GACd,SAAS,GACT,aAAa,GACb,QAAQ,GACR,SAAS,GACT,YAAY,CAAC;IACjB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC1B,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CAEpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,YAAY,EAAE,oBAAoB,EAAE,CAAC;CACtC"}

package/dist/sales/payments/type.js

@@ -0,0 +1,4 @@
+"use strict";
+// src/sales/payments/type.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=type.js.map

package/dist/sales/payments/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../../src/sales/payments/type.ts"],"names":[],"mappings":";AAAA,6BAA6B"}

package/dist/sales/quotations/index.d.ts

@@ -0,0 +1,51 @@
+import type { BukkuAPIRequestFunction } from "../../types";
+import { BukkuQuotationCreateParams, BukkuQuotation, BukkuQuotationListParams, BukkuQuotationListApiResponse, BukkuQuotationUpdateParams, BukkuQuotationStatusUpdateParams } from "./type";
+export declare class QuotationsAPI {
+    private _request;
+    constructor(_request: BukkuAPIRequestFunction);
+    /**
+     * Creates a new quotation.
+     * Endpoint: POST /sales/quotes
+     * @param data - The data for the new quotation.
+     * @returns A promise that resolves to the created quotation.
+     */
+    create(data: BukkuQuotationCreateParams): Promise<BukkuQuotation>;
+    /**
+     * Retrieves a paginated list of quotations.
+     * Endpoint: GET /sales/quotes
+     * @param params - Optional parameters for filtering and pagination.
+     * @returns A promise that resolves to the API response for listing quotations.
+     */
+    list(params?: BukkuQuotationListParams): Promise<BukkuQuotationListApiResponse>;
+    /**
+     * Retrieves a specific quotation by its ID.
+     * Endpoint: GET /sales/quotes/{id}
+     * @param id - The ID of the quotation to retrieve.
+     * @returns A promise that resolves to the quotation.
+     */
+    get(id: string | number): Promise<BukkuQuotation>;
+    /**
+     * Updates an existing quotation.
+     * Endpoint: PUT /sales/quotes/{id}
+     * @param id - The ID of the quotation to update.
+     * @param data - The data to update the quotation with.
+     * @returns A promise that resolves to the updated quotation.
+     */
+    update(id: string | number, data: BukkuQuotationUpdateParams): Promise<BukkuQuotation>;
+    /**
+     * Deletes a quotation.
+     * Endpoint: DELETE /sales/quotes/{id}
+     * @param id - The ID of the quotation to delete.
+     * @returns A promise that resolves when the quotation is deleted.
+     */
+    delete(id: string | number): Promise<void>;
+    /**
+     * Updates the status of an existing quotation.
+     * Endpoint: PATCH /sales/quotes/{id}
+     * @param id - The ID of the quotation to update.
+     * @param data - The data containing the new status.
+     * @returns A promise that resolves to the updated quotation.
+     */
+    updateStatus(id: string | number, data: BukkuQuotationStatusUpdateParams): Promise<BukkuQuotation>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/sales/quotations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sales/quotations/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EACL,0BAA0B,EAC1B,cAAc,EAEd,wBAAwB,EACxB,6BAA6B,EAC7B,0BAA0B,EAC1B,gCAAgC,EACjC,MAAM,QAAQ,CAAC;AAEhB,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,uBAAuB;IAErD;;;;;OAKG;IACG,MAAM,CACV,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,cAAc,CAAC;IAS1B;;;;;OAKG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,wBAAwB,GAChC,OAAO,CAAC,6BAA6B,CAAC;IASzC;;;;;OAKG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAQvD;;;;;;OAMG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,cAAc,CAAC;IAS1B;;;;;OAKG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD;;;;;;OAMG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,gCAAgC,GACrC,OAAO,CAAC,cAAc,CAAC;CAQ3B"}

package/dist/sales/quotations/index.js

@@ -0,0 +1,71 @@
+"use strict";
+// src/sales/quotations/index.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuotationsAPI = void 0;
+class QuotationsAPI {
+    constructor(_request) {
+        this._request = _request;
+    }
+    /**
+     * Creates a new quotation.
+     * Endpoint: POST /sales/quotes
+     * @param data - The data for the new quotation.
+     * @returns A promise that resolves to the created quotation.
+     */
+    async create(data) {
+        const response = await this._request("/sales/quotes", "POST", data);
+        return response.transaction;
+    }
+    /**
+     * Retrieves a paginated list of quotations.
+     * Endpoint: GET /sales/quotes
+     * @param params - Optional parameters for filtering and pagination.
+     * @returns A promise that resolves to the API response for listing quotations.
+     */
+    async list(params) {
+        return this._request("/sales/quotes", "GET", undefined, params);
+    }
+    /**
+     * Retrieves a specific quotation by its ID.
+     * Endpoint: GET /sales/quotes/{id}
+     * @param id - The ID of the quotation to retrieve.
+     * @returns A promise that resolves to the quotation.
+     */
+    async get(id) {
+        const response = await this._request(`/sales/quotes/${id}`, "GET");
+        return response.transaction;
+    }
+    /**
+     * Updates an existing quotation.
+     * Endpoint: PUT /sales/quotes/{id}
+     * @param id - The ID of the quotation to update.
+     * @param data - The data to update the quotation with.
+     * @returns A promise that resolves to the updated quotation.
+     */
+    async update(id, data) {
+        const response = await this._request(`/sales/quotes/${id}`, "PUT", data);
+        return response.transaction;
+    }
+    /**
+     * Deletes a quotation.
+     * Endpoint: DELETE /sales/quotes/{id}
+     * @param id - The ID of the quotation to delete.
+     * @returns A promise that resolves when the quotation is deleted.
+     */
+    async delete(id) {
+        await this._request(`/sales/quotes/${id}`, "DELETE");
+    }
+    /**
+     * Updates the status of an existing quotation.
+     * Endpoint: PATCH /sales/quotes/{id}
+     * @param id - The ID of the quotation to update.
+     * @param data - The data containing the new status.
+     * @returns A promise that resolves to the updated quotation.
+     */
+    async updateStatus(id, data) {
+        const response = await this._request(`/sales/quotes/${id}`, "PATCH", data);
+        return response.transaction;
+    }
+}
+exports.QuotationsAPI = QuotationsAPI;
+//# sourceMappingURL=index.js.map

package/dist/sales/quotations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sales/quotations/index.ts"],"names":[],"mappings":";AAAA,gCAAgC;;;AAahC,MAAa,aAAa;IACxB,YAAoB,QAAiC;QAAjC,aAAQ,GAAR,QAAQ,CAAyB;IAAG,CAAC;IAEzD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,IAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,eAAe,EACf,MAAM,EACN,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,MAAiC;QAEjC,OAAO,IAAI,CAAC,QAAQ,CAClB,eAAe,EACf,KAAK,EACL,SAAS,EACT,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,EAAmB;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,iBAAiB,EAAE,EAAE,EACrB,KAAK,CACN,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,EAAmB,EACnB,IAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,iBAAiB,EAAE,EAAE,EACrB,KAAK,EACL,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EAAmB;QAC9B,MAAM,IAAI,CAAC,QAAQ,CAAO,iBAAiB,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAChB,EAAmB,EACnB,IAAsC;QAEtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,iBAAiB,EAAE,EAAE,EACrB,OAAO,EACP,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;CACF;AAlGD,sCAkGC"}

package/dist/sales/quotations/type.d.ts

@@ -0,0 +1,202 @@
+import { BukkuEmailDetails } from "../../common/type";
+import { BukkuFileAttachment } from "../../common/type";
+import { BukkuListPagination } from "../../common/type";
+import { BukkuAttachedFileResponse } from "../../common/type";
+/**
+ * Represents a form item for creating or updating a Bukku Quotation.
+ * This defines the fields expected when providing form items in a create/update payload.
+ */
+export interface BukkuQuotationFormItemCreateParams {
+    /** The id of the item, required when you're updating an item. */
+    id?: number;
+    /** The type of the item, leave null for normal item. */
+    type?: "bundle" | "subtitle" | "subtotal" | "bundle_item" | null;
+    /** The account of the item, required for normal item. */
+    account_id?: number;
+    /** The description of the item, required for normal / bundle & subtitle items. */
+    description?: string;
+    /** The service date of the item, following format YYYY-MM-DD. */
+    service_date?: string;
+    /** The product of the item. */
+    product_id?: number;
+    /** The product unit / UOM of the product, leave blank to use the product's default unit. */
+    product_unit_id?: number;
+    /** The location of the product, used for inventory product, leave blank to use the system default location. */
+    location_id?: number;
+    /** The unit price of the item, supports up to 4 decimal points, required for normal items. */
+    unit_price?: number;
+    /** The quantity of the item, supports up to 4 decimal points, required for normal items. */
+    quantity?: number;
+    /** The discount of the item, supports value (eg. 255.12) or percentage (eg. 10%). Max 14 chars. */
+    discount?: string;
+    /** The tax code of the item. */
+    tax_code_id?: number;
+    /** The child items, used by bundle. */
+    children?: BukkuQuotationFormItemCreateParams[];
+}
+/**
+ * Parameters for creating a Bukku Quotation.
+ * Based on POST /sales/quotes
+ */
+export interface BukkuQuotationCreateParams {
+    contact_id: number;
+    number?: string;
+    number2?: string;
+    date: string;
+    currency_code: string;
+    exchange_rate: number;
+    billing_party?: string;
+    show_shipping?: boolean;
+    shipping_party?: string;
+    shipping_info?: string;
+    tag_ids?: number[];
+    term_id?: number;
+    title?: string;
+    description?: string;
+    remarks?: string;
+    tax_mode: "inclusive" | "exclusive";
+    form_items: Array<BukkuQuotationFormItemCreateParams>;
+    status: "draft" | "pending_approval" | "ready";
+    email?: BukkuEmailDetails;
+    files?: Array<BukkuFileAttachment>;
+}
+/**
+ * Parameters for updating a Bukku Quotation.
+ * This is similar to BukkuQuotationCreateParams but typically omits fields like 'status'
+ * which are managed by specific actions (e.g., PATCH for status update).
+ */
+export interface BukkuQuotationUpdateParams {
+    contact_id: number;
+    number?: string;
+    number2?: string;
+    date: string;
+    currency_code: string;
+    exchange_rate: number;
+    billing_party?: string;
+    show_shipping?: boolean;
+    shipping_party?: string;
+    shipping_info?: string;
+    tag_ids?: number[];
+    term_id?: number;
+    title?: string;
+    description?: string;
+    remarks?: string;
+    tax_mode: "inclusive" | "exclusive";
+    form_items: Array<BukkuQuotationFormItemCreateParams>;
+    email?: BukkuEmailDetails;
+    files?: Array<BukkuFileAttachment>;
+}
+/**
+ * Represents a Bukku Quotation object as returned by the API (e.g., in the 'transaction' field of a response).
+ */
+export interface BukkuQuotation {
+    id: number;
+    contact_id: number;
+    contact_name?: string;
+    number?: string;
+    number2?: string;
+    date: string;
+    currency_code: string;
+    currency_symbol?: string;
+    exchange_rate: number;
+    billing_party?: string;
+    show_shipping?: boolean;
+    shipping_info?: string;
+    shipping_party?: string;
+    tag_ids?: number[];
+    tag_names?: string[];
+    term_id?: number;
+    term_name?: string;
+    title?: string;
+    description?: string;
+    remarks?: string;
+    tax_mode: "inclusive" | "exclusive";
+    amount?: number;
+    status: string;
+    type?: string;
+    short_link?: string;
+    files?: BukkuAttachedFileResponse[];
+    created_at?: string;
+    updated_at?: string;
+}
+/**
+ * Represents the API response structure when a quotation is created or retrieved.
+ */
+export interface BukkuQuotationResponse {
+    transaction: BukkuQuotation;
+}
+/**
+ * Parameters for listing Bukku Quotations (GET /sales/quotes).
+ */
+export interface BukkuQuotationListParams {
+    /** Search for keywords in No., Reference No., Title, Remarks, Description, Contact Name, Billing Party & Shipping Party. Max 100 chars. */
+    search?: string;
+    /** Search for keywords within custom fields, use format DD/MM/YYYY for a date. Max 100 chars. */
+    custom_search?: string;
+    /** Search by contact ID. */
+    contact_id?: number;
+    /** Search for transactions on and after the date (YYYY-MM-DD). */
+    date_from?: string;
+    /** Search for transactions on and before the date (YYYY-MM-DD). */
+    date_to?: string;
+    /** Search by status, default to All but Void. */
+    status?: "all" | "draft" | "pending_approval" | "ready" | "void";
+    /** Search by the latest email status. */
+    email_status?: "UNSENT" | "PENDING" | "SENT" | "BOUNCED" | "OPENED" | "VIEWED";
+    /** Search by transfer status. */
+    transfer_status?: "ALL" | "NOT_TRANSFERRED" | "PARTIAL_TRANSFERRED" | "TRANSFERRED";
+    /** The current page number. Default: 1, Min: 1. */
+    page?: number;
+    /** Number of records per page. Default: 30. */
+    page_size?: number;
+    /** Sort by field. */
+    sort_by?: "number" | "date" | "contact_name" | "number2" | "title" | "description" | "amount" | "created_at";
+    /** Sort the list in ascending or descending order. */
+    sort_dir?: "asc" | "desc";
+    [key: string]: any;
+}
+/**
+ * Represents a summary of a Bukku Quotation as it appears in a list.
+ */
+export interface BukkuQuotationListItem {
+    id: number;
+    number?: string;
+    number2?: string;
+    contact_id: number;
+    contact_name?: string;
+    contact_email?: string;
+    date: string;
+    billing_party?: string;
+    shipping_party?: string;
+    tag_names?: string[];
+    title?: string;
+    description?: string;
+    currency_code: string;
+    currency_symbol?: string;
+    exchange_rate: number;
+    amount?: number;
+    status: string;
+    transfer_status?: string;
+    email_status?: string;
+    file_count?: number;
+    short_link?: string;
+    created_by?: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Represents the API response structure for listing quotations.
+ */
+export interface BukkuQuotationListApiResponse {
+    paging: BukkuListPagination;
+    transactions: BukkuQuotationListItem[];
+}
+/**
+ * Parameters for updating the status of a Bukku Quotation.
+ * Based on PATCH /sales/quotes/{id}
+ */
+export interface BukkuQuotationStatusUpdateParams {
+    /** The new status for the quotation. */
+    status: "ready" | "draft" | "pending_approval" | "void";
+}
+//# sourceMappingURL=type.d.ts.map

package/dist/sales/quotations/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/sales/quotations/type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,iEAAiE;IACjE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,wDAAwD;IACxD,IAAI,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,GAAG,IAAI,CAAC;IACjE,yDAAyD;IACzD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kFAAkF;IAClF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4FAA4F;IAC5F,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+GAA+G;IAC/G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,kCAAkC,EAAE,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,WAAW,GAAG,WAAW,CAAC;IACpC,UAAU,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,MAAM,EAAE,OAAO,GAAG,kBAAkB,GAAG,OAAO,CAAC;IAC/C,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,WAAW,GAAG,WAAW,CAAC;IACpC,UAAU,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CAEpC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,WAAW,GAAG,WAAW,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CAGrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,cAAc,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,2IAA2I;IAC3I,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iGAAiG;IACjG,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,MAAM,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAC;IACjE,yCAAyC;IACzC,YAAY,CAAC,EACT,QAAQ,GACR,SAAS,GACT,MAAM,GACN,SAAS,GACT,QAAQ,GACR,QAAQ,CAAC;IACb,iCAAiC;IACjC,eAAe,CAAC,EACZ,KAAK,GACL,iBAAiB,GACjB,qBAAqB,GACrB,aAAa,CAAC;IAClB,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,OAAO,CAAC,EACJ,QAAQ,GACR,MAAM,GACN,cAAc,GACd,SAAS,GACT,OAAO,GACP,aAAa,GACb,QAAQ,GACR,YAAY,CAAC;IACjB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE1B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CAGpB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,YAAY,EAAE,sBAAsB,EAAE,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,wCAAwC;IACxC,MAAM,EAAE,OAAO,GAAG,OAAO,GAAG,kBAAkB,GAAG,MAAM,CAAC;CACzD"}

package/dist/sales/quotations/type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=type.js.map

package/dist/sales/quotations/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../../src/sales/quotations/type.ts"],"names":[],"mappings":""}

package/dist/sales/refunds/index.d.ts

@@ -0,0 +1,52 @@
+import type { BukkuAPIRequestFunction } from "../../types";
+import { BukkuRefund, BukkuRefundCreateParams, BukkuRefundListParams, BukkuRefundListApiResponse, BukkuRefundUpdateParams, BukkuRefundStatusUpdateParams } from "./type";
+export declare class RefundsAPI {
+    private _request;
+    constructor(_request: BukkuAPIRequestFunction);
+    /**
+     * Creates a new refund.
+     * Endpoint: POST /sales/refunds
+     * @param data - The data for the new refund.
+     * @returns A promise that resolves to the created refund.
+     */
+    create(data: BukkuRefundCreateParams): Promise<BukkuRefund>;
+    /**
+     * Retrieves a paginated list of refunds.
+     * Endpoint: GET /sales/refunds
+     * @param params - Optional parameters for filtering and pagination.
+     * @returns A promise that resolves to the API response for listing refunds.
+     */
+    list(params?: BukkuRefundListParams): Promise<BukkuRefundListApiResponse>;
+    /**
+     * Retrieves a specific refund by its ID.
+     * Endpoint: GET /sales/refunds/{id}
+     * @param id - The ID of the refund to retrieve.
+     * @returns A promise that resolves to the refund.
+     */
+    get(id: string | number): Promise<BukkuRefund>;
+    /**
+     * Updates an existing refund.
+     * Endpoint: PUT /sales/refunds/{id}
+     * @param id - The ID of the refund to update.
+     * @param data - The data to update the refund with.
+     * @returns A promise that resolves to the updated refund.
+     */
+    update(id: string | number, data: BukkuRefundUpdateParams): Promise<BukkuRefund>;
+    /**
+     * Deletes a refund.
+     * Endpoint: DELETE /sales/refunds/{id}
+     * Note: Only transactions with draft and void statuses can be deleted.
+     * @param id - The ID of the refund to delete.
+     * @returns A promise that resolves when the refund is deleted.
+     */
+    delete(id: string | number): Promise<void>;
+    /**
+     * Updates the status of an existing refund.
+     * Endpoint: PATCH /sales/refunds/{id}
+     * @param id - The ID of the refund to update.
+     * @param data - The data containing the new status.
+     * @returns A promise that resolves to the updated refund.
+     */
+    updateStatus(id: string | number, data: BukkuRefundStatusUpdateParams): Promise<BukkuRefund>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/sales/refunds/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sales/refunds/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EACL,WAAW,EACX,uBAAuB,EAEvB,qBAAqB,EACrB,0BAA0B,EAC1B,uBAAuB,EACvB,6BAA6B,EAC9B,MAAM,QAAQ,CAAC;AAEhB,qBAAa,UAAU;IACT,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,uBAAuB;IAErD;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;IASjE;;;;;OAKG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,qBAAqB,GAC7B,OAAO,CAAC,0BAA0B,CAAC;IAStC;;;;;OAKG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAQpD;;;;;;OAMG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,uBAAuB,GAC5B,OAAO,CAAC,WAAW,CAAC;IASvB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD;;;;;;OAMG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,6BAA6B,GAClC,OAAO,CAAC,WAAW,CAAC;CAQxB"}