bukku-client 0.1.0-test.0

package/dist/purchases/purchase-orders/index.js

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

package/dist/purchases/purchase-orders/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/purchases/purchase-orders/index.ts"],"names":[],"mappings":";AAAA,yCAAyC;;;AAazC,MAAa,iBAAiB;IAC5B,YAAoB,QAAiC;QAAjC,aAAQ,GAAR,QAAQ,CAAyB;IAAG,CAAC;IAEzD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,IAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,mBAAmB,EACnB,MAAM,EACN,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,MAAqC;QAErC,OAAO,IAAI,CAAC,QAAQ,CAClB,mBAAmB,EACnB,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,qBAAqB,EAAE,EAAE,EACzB,KAAK,CACN,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,EAAmB,EACnB,IAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,qBAAqB,EAAE,EAAE,EACzB,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,qBAAqB,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAChB,EAAmB,EACnB,IAA0C;QAE1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,qBAAqB,EAAE,EAAE,EACzB,OAAO,EACP,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;CACF;AAlGD,8CAkGC"}

package/dist/purchases/purchase-orders/type.d.ts

@@ -0,0 +1,182 @@
+import { BukkuEmailDetails, BukkuFileAttachment, BukkuAttachedFileResponse, BukkuListPagination, BukkuFormItem } from "../../common/type";
+/**
+ * Represents a form item for creating or updating a Bukku Purchase Order.
+ */
+export interface BukkuPurchaseOrderFormItemCreateParams {
+    /** 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" | 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?: BukkuPurchaseOrderFormItemCreateParams[];
+}
+/**
+ * Parameters for creating a Bukku Purchase Order.
+ * Based on POST /purchases/orders
+ */
+export interface BukkuPurchaseOrderCreateParams {
+    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: BukkuPurchaseOrderFormItemCreateParams[];
+    status: "draft" | "pending_approval" | "ready";
+    email?: BukkuEmailDetails;
+    files?: BukkuFileAttachment[];
+}
+/**
+ * Represents a Bukku Purchase Order object as returned by the API.
+ */
+export interface BukkuPurchaseOrder {
+    id: number;
+    contact_id: number;
+    contact_name: string;
+    number: string;
+    number2: string | null;
+    date: string;
+    currency_code: string;
+    currency_symbol: string;
+    exchange_rate: number;
+    billing_party: string | null;
+    show_shipping: boolean;
+    shipping_info: string | null;
+    shipping_party: string | null;
+    tag_ids: number[] | null;
+    tag_names: string[] | null;
+    term_id: number | null;
+    term_name: string | null;
+    title: string | null;
+    description: string | null;
+    remarks: string | null;
+    tax_mode: "inclusive" | "exclusive";
+    form_items: BukkuFormItem[];
+    amount: number;
+    status: string;
+    type: string;
+    short_link: string;
+    files: BukkuAttachedFileResponse[] | null;
+}
+/**
+ * Represents the API response structure when a purchase order is created or retrieved.
+ */
+export interface BukkuPurchaseOrderResponse {
+    transaction: BukkuPurchaseOrder;
+}
+/**
+ * Parameters for updating a Bukku Purchase Order.
+ * Based on PUT /purchases/orders/{id}
+ */
+export interface BukkuPurchaseOrderUpdateParams {
+    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: BukkuPurchaseOrderFormItemCreateParams[];
+    email?: BukkuEmailDetails;
+    files?: BukkuFileAttachment[];
+}
+/**
+ * Parameters for updating the status of a Bukku Purchase Order.
+ * Based on PATCH /purchases/orders/{id}
+ */
+export interface BukkuPurchaseOrderStatusUpdateParams {
+    status: "draft" | "pending_approval" | "ready" | "void";
+}
+/**
+ * Parameters for listing Bukku Purchase Orders (GET /purchases/orders).
+ */
+export interface BukkuPurchaseOrderListParams {
+    search?: string;
+    custom_search?: string;
+    contact_id?: number;
+    date_from?: string;
+    date_to?: string;
+    status?: "all" | "draft" | "pending_approval" | "ready" | "void";
+    email_status?: "UNSENT" | "PENDING" | "SENT" | "BOUNCED" | "OPENED" | "VIEWED";
+    transfer_status?: "ALL" | "OUTSTANDING" | "NOT_TRANSFERRED" | "PARTIAL_TRANSFERRED" | "TRANSFERRED";
+    page?: number;
+    page_size?: number;
+    sort_by?: "number" | "date" | "contact_name" | "number2" | "title" | "description" | "amount" | "created_at";
+    sort_dir?: "asc" | "desc";
+    [key: string]: any;
+}
+/**
+ * Represents a summary of a Bukku Purchase Order as it appears in a list.
+ */
+export interface BukkuPurchaseOrderListItem {
+    id: number;
+    contact_id: number;
+    contact_name: string;
+    number: string;
+    number2: string | null;
+    date: string;
+    currency_code: string;
+    currency_symbol: string;
+    exchange_rate: number;
+    billing_party?: string | null;
+    shipping_party?: string | null;
+    tag_names?: string[] | null;
+    title?: string | null;
+    description?: string | null;
+    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 purchase orders.
+ */
+export interface BukkuPurchaseOrderListApiResponse {
+    paging: BukkuListPagination;
+    transactions: BukkuPurchaseOrderListItem[];
+}
+//# sourceMappingURL=type.d.ts.map

package/dist/purchases/purchase-orders/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/purchases/purchase-orders/type.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,aAAa,EACd,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,iEAAiE;IACjE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,wDAAwD;IACxD,IAAI,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;IACjD,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,sCAAsC,EAAE,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,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,sCAAsC,EAAE,CAAC;IACrD,MAAM,EAAE,OAAO,GAAG,kBAAkB,GAAG,OAAO,CAAC;IAC/C,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,WAAW,GAAG,WAAW,CAAC;IACpC,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,yBAAyB,EAAE,GAAG,IAAI,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,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,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,sCAAsC,EAAE,CAAC;IACrD,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAE/B;AAED;;;GAGG;AACH,MAAM,WAAW,oCAAoC;IACnD,MAAM,EAAE,OAAO,GAAG,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAC;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAC;IACjE,YAAY,CAAC,EACT,QAAQ,GACR,SAAS,GACT,MAAM,GACN,SAAS,GACT,QAAQ,GACR,QAAQ,CAAC;IACb,eAAe,CAAC,EACd,KAAK,GACH,aAAa,GACb,iBAAiB,GACjB,qBAAqB,GACrB,aAAa,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EACJ,QAAQ,GACR,MAAM,GACN,cAAc,GACd,SAAS,GACT,OAAO,GACP,aAAa,GACb,QAAQ,GACR,YAAY,CAAC;IACjB,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,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;CAEpB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,mBAAmB,CAAC;IAC5B,YAAY,EAAE,0BAA0B,EAAE,CAAC;CAC5C"}

package/dist/purchases/purchase-orders/type.js

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

package/dist/purchases/purchase-orders/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../../src/purchases/purchase-orders/type.ts"],"names":[],"mappings":";AAAA,wCAAwC"}

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

@@ -0,0 +1,51 @@
+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 purchase refund.
+     * Endpoint: POST /purchases/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 purchase refunds.
+     * Endpoint: GET /purchases/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 purchase refund by its ID.
+     * Endpoint: GET /purchases/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 purchase refund.
+     * Endpoint: PUT /purchases/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>;
+    /**
+     * Updates the status of an existing purchase refund.
+     * Endpoint: PATCH /purchases/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>;
+    /**
+     * Deletes a purchase refund.
+     * Endpoint: DELETE /purchases/refunds/{id}
+     * @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>;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/purchases/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,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAS/E;;;;;OAKG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAQpD;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;IAStF;;;;;;OAMG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,WAAW,CAAC;IASlG;;;;;OAKG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjD"}

package/dist/purchases/refunds/index.js

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

package/dist/purchases/refunds/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/purchases/refunds/index.ts"],"names":[],"mappings":";AAAA,iCAAiC;;;AAajC,MAAa,UAAU;IACrB,YAAoB,QAAiC;QAAjC,aAAQ,GAAR,QAAQ,CAAyB;IAAG,CAAC;IAEzD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,IAA6B;QACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,oBAAoB,EACpB,MAAM,EACN,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,MAA8B;QACvC,OAAO,IAAI,CAAC,QAAQ,CAClB,oBAAoB,EACpB,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,sBAAsB,EAAE,EAAE,EAC1B,KAAK,CACN,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,EAAmB,EAAE,IAA6B;QAC7D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,sBAAsB,EAAE,EAAE,EAC1B,KAAK,EACL,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,EAAmB,EAAE,IAAmC;QACzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,sBAAsB,EAAE,EAAE,EAC1B,OAAO,EACP,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,sBAAsB,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;CACF;AAxFD,gCAwFC"}

package/dist/purchases/refunds/type.d.ts

@@ -0,0 +1,181 @@
+import { BukkuEmailDetails, BukkuFileAttachment, BukkuAttachedFileResponse, BukkuListPagination } from "../../common/type";
+import { BukkuBillLinkedItem } from "../bills/type";
+/**
+ * Represents a link item for creating/updating a Bukku Purchase Refund.
+ * Specifies which transactions the refund is applied to (e.g., linking to a credit note or payment).
+ */
+export interface BukkuRefundLinkItemCreateParams {
+    id?: number;
+    target_transaction_id: number;
+    apply_amount: number;
+}
+/**
+ * Represents a deposit item for creating/updating a Bukku Purchase Refund.
+ * This details how the refund is being issued (e.g., back to a bank account).
+ */
+export interface BukkuRefundDepositItemCreateParams {
+    id?: number;
+    payment_method_id?: number;
+    account_id: number;
+    amount: number;
+    number?: string;
+    fee_text?: string;
+    fee_account_id?: number;
+}
+/**
+ * Parameters for creating a Bukku Purchase Refund.
+ * Based on POST /purchases/refunds
+ */
+export interface BukkuRefundCreateParams {
+    contact_id: number;
+    number?: string;
+    number2?: string;
+    date: string;
+    currency_code: string;
+    exchange_rate: number;
+    tag_ids?: number[];
+    description?: string;
+    remarks?: string;
+    link_items?: BukkuRefundLinkItemCreateParams[];
+    deposit_items: BukkuRefundDepositItemCreateParams[];
+    status: "draft" | "pending_approval" | "ready";
+    email?: BukkuEmailDetails;
+    files?: BukkuFileAttachment[];
+}
+/**
+ * Represents a link item as returned in a Bukku Refund response (how refund is applied).
+ */
+export interface BukkuRefundAppliedLinkItem {
+    id: number;
+    target_transaction_id: number;
+    type: string;
+    number: string;
+    date: string;
+    description: string;
+    amount: number;
+    balance: number;
+}
+/**
+ * Represents a deposit item as returned in a Bukku Refund response.
+ */
+export interface BukkuRefundDepositItem {
+    id: number;
+    line: number;
+    payment_method_id: number | null;
+    account_id: number;
+    amount: number;
+    number: string | null;
+    fee_text: string | number | null;
+    fee_account_id: number | null;
+}
+/**
+ * Represents a Bukku Purchase Refund object as returned by the API.
+ * (Assumed structure based on other transaction types like Payment)
+ */
+export interface BukkuRefund {
+    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[] | null;
+    tag_names: string[] | null;
+    link_items: BukkuRefundAppliedLinkItem[] | null;
+    linked_items: BukkuBillLinkedItem[] | null;
+    deposit_items: BukkuRefundDepositItem[] | null;
+    remarks: string | null;
+    description: string | null;
+    balance: number;
+    status: string;
+    type: string;
+    short_link: string | null;
+    files: BukkuAttachedFileResponse[] | null;
+}
+/**
+ * Represents the API response structure when a refund is created or retrieved.
+ */
+export interface BukkuRefundResponse {
+    transaction: BukkuRefund;
+}
+/**
+ * Parameters for updating a Bukku Purchase Refund.
+ * (Assumed structure, similar to BukkuPaymentUpdateParams and refund create parameters)
+ */
+export interface BukkuRefundUpdateParams {
+    contact_id: number;
+    number: string;
+    number2?: string;
+    date: string;
+    currency_code: string;
+    exchange_rate: number;
+    tag_ids?: number[];
+    description?: string;
+    remarks?: string;
+    link_items?: BukkuRefundLinkItemCreateParams[];
+    deposit_items: BukkuRefundDepositItemCreateParams[];
+    email?: BukkuEmailDetails;
+    files?: BukkuFileAttachment[];
+}
+/**
+ * Parameters for updating the status of a Bukku Purchase Refund.
+ */
+export interface BukkuRefundStatusUpdateParams {
+    status: "draft" | "pending_approval" | "ready" | "void";
+}
+/**
+ * Parameters for listing Bukku Purchase Refunds.
+ * (Assumed structure, similar to BukkuPaymentListParams)
+ */
+export interface BukkuRefundListParams {
+    search?: string;
+    custom_search?: string;
+    contact_id?: number;
+    date_from?: string;
+    date_to?: string;
+    status?: "all" | "draft" | "pending_approval" | "ready" | "void";
+    payment_status?: "paid" | "outstanding";
+    email_status?: "UNSENT" | "PENDING" | "SENT" | "BOUNCED" | "OPENED" | "VIEWED";
+    account_id?: string;
+    page?: number;
+    page_size?: number;
+    sort_by?: "number" | "date" | "contact_name" | "number2" | "description" | "amount" | "created_at";
+    sort_dir?: "asc" | "desc";
+    [key: string]: any;
+}
+/**
+ * Represents a summary of a Bukku Purchase Refund as it might appear in a list.
+ * (Assumed structure, similar to BukkuPaymentListItem)
+ */
+export interface BukkuRefundListItem {
+    id: number;
+    contact_id: number;
+    contact_name: string;
+    number: string;
+    number2: string | null;
+    date: string;
+    currency_code: string;
+    currency_symbol: string;
+    exchange_rate: number;
+    amount: number;
+    status: string;
+    description?: string | null;
+    tag_names?: string[] | null;
+    file_count?: number;
+    short_link?: string;
+    created_by?: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Represents the API response structure for listing purchase refunds.
+ */
+export interface BukkuRefundListApiResponse {
+    paging: BukkuListPagination;
+    transactions: BukkuRefundListItem[];
+}
+//# sourceMappingURL=type.d.ts.map

package/dist/purchases/refunds/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/purchases/refunds/type.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EAEpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEpD;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,qBAAqB,EAAE,MAAM,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,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;IAEtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,+BAA+B,EAAE,CAAC;IAC/C,aAAa,EAAE,kCAAkC,EAAE,CAAC;IACpD,MAAM,EAAE,OAAO,GAAG,kBAAkB,GAAG,OAAO,CAAC;IAC/C,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,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,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,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;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,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,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,0BAA0B,EAAE,GAAG,IAAI,CAAC;IAChD,YAAY,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAC3C,aAAa,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC;IAC/C,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,GAAG,IAAI,CAAC;IAC1B,KAAK,EAAE,yBAAyB,EAAE,GAAG,IAAI,CAAC;CAE3C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,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;IAEtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,+BAA+B,EAAE,CAAC;IAC/C,aAAa,EAAE,kCAAkC,EAAE,CAAC;IACpD,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAE/B;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,OAAO,GAAG,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAC;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAC;IACjE,cAAc,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IACxC,YAAY,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC/E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EACJ,QAAQ,GACR,MAAM,GACN,cAAc,GACd,SAAS,GACT,aAAa,GACb,QAAQ,GACR,YAAY,CAAC;IACjB,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,IAAI,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;IAEf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC5B,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;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,YAAY,EAAE,mBAAmB,EAAE,CAAC;CACrC"}

package/dist/purchases/refunds/type.js

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

package/dist/purchases/refunds/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../../src/purchases/refunds/type.ts"],"names":[],"mappings":";AAAA,gCAAgC"}

package/dist/sales/credit-notes/index.d.ts

@@ -0,0 +1,52 @@
+import type { BukkuAPIRequestFunction } from "../../types";
+import { BukkuCreditNote, BukkuCreditNoteCreateParams, BukkuCreditNoteListParams, BukkuCreditNoteListApiResponse, BukkuCreditNoteUpdateParams, BukkuCreditNoteStatusUpdateParams } from "./type";
+export declare class CreditNotesAPI {
+    private _request;
+    constructor(_request: BukkuAPIRequestFunction);
+    /**
+     * Creates a new credit note.
+     * Endpoint: POST /sales/credit_notes
+     * @param data - The data for the new credit note.
+     * @returns A promise that resolves to the created credit note.
+     */
+    create(data: BukkuCreditNoteCreateParams): Promise<BukkuCreditNote>;
+    /**
+     * Retrieves a paginated list of credit notes.
+     * Endpoint: GET /sales/credit_notes
+     * @param params - Optional parameters for filtering and pagination.
+     * @returns A promise that resolves to the API response for listing credit notes.
+     */
+    list(params?: BukkuCreditNoteListParams): Promise<BukkuCreditNoteListApiResponse>;
+    /**
+     * Retrieves a specific credit note by its ID.
+     * Endpoint: GET /sales/credit_notes/{id}
+     * @param id - The ID of the credit note to retrieve.
+     * @returns A promise that resolves to the credit note.
+     */
+    get(id: string | number): Promise<BukkuCreditNote>;
+    /**
+     * Updates an existing credit note.
+     * Endpoint: PUT /sales/credit_notes/{id}
+     * @param id - The ID of the credit note to update.
+     * @param data - The data to update the credit note with.
+     * @returns A promise that resolves to the updated credit note.
+     */
+    update(id: string | number, data: BukkuCreditNoteUpdateParams): Promise<BukkuCreditNote>;
+    /**
+     * Deletes a credit note.
+     * Endpoint: DELETE /sales/credit_notes/{id}
+     * Note: Deletion policy for credit notes (e.g. status restrictions) should be verified with API documentation.
+     * @param id - The ID of the credit note to delete.
+     * @returns A promise that resolves when the credit note is deleted.
+     */
+    delete(id: string | number): Promise<void>;
+    /**
+     * Updates the status of an existing credit note.
+     * Endpoint: PATCH /sales/credit_notes/{id}
+     * @param id - The ID of the credit note to update.
+     * @param data - The data containing the new status.
+     * @returns A promise that resolves to the updated credit note.
+     */
+    updateStatus(id: string | number, data: BukkuCreditNoteStatusUpdateParams): Promise<BukkuCreditNote>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/sales/credit-notes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sales/credit-notes/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EACL,eAAe,EACf,2BAA2B,EAE3B,yBAAyB,EACzB,8BAA8B,EAC9B,2BAA2B,EAC3B,iCAAiC,EAClC,MAAM,QAAQ,CAAC;AAEhB,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,uBAAuB;IAErD;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,eAAe,CAAC;IASzE;;;;;OAKG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,8BAA8B,CAAC;IAS1C;;;;;OAKG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAQxD;;;;;;OAMG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,2BAA2B,GAChC,OAAO,CAAC,eAAe,CAAC;IAS3B;;;;;;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,iCAAiC,GACtC,OAAO,CAAC,eAAe,CAAC;CAQ5B"}