bukku-client 0.1.0-test.0

package/dist/products/products/type.d.ts

@@ -0,0 +1,270 @@
+import { BukkuListPagination } from "../../common/type";
+/**
+ * Represents a unit for a product when creating or updating.
+ */
+export interface BukkuProductUnitParams {
+    /** The ID of the unit, required when updating an existing unit. Omit for new units. */
+    id?: number;
+    label: string;
+    rate: number;
+    sale_price?: number;
+    purchase_price?: number;
+    is_base?: boolean;
+    is_sale_default?: boolean;
+    is_purchase_default?: boolean;
+}
+/**
+ * Represents a custom sale price for a product when creating or updating.
+ */
+export interface BukkuProductSalePriceParams {
+    /** The ID of the sale price entry, required when updating an existing one. Omit for new entries. */
+    id?: number;
+    price_level_id?: number;
+    contact_id?: number;
+    date_from?: string;
+    date_to?: string;
+    product_unit_id: number;
+    minimum_quantity: number;
+    currency_code: string;
+    unit_price?: number;
+}
+/**
+ * Represents a custom purchase price for a product when creating or updating.
+ */
+export interface BukkuProductPurchasePriceParams {
+    /** The ID of the purchase price entry, required when updating an existing one. Omit for new entries. */
+    id?: number;
+    price_level_id?: number;
+    contact_id?: number;
+    date_from?: string;
+    date_to?: string;
+    product_unit_id: number;
+    minimum_quantity: number;
+    currency_code: string;
+    unit_price?: number;
+}
+/**
+ * Parameters for creating a new Product.
+ * Based on POST /products
+ */
+export interface BukkuProductCreateParams {
+    name: string;
+    sku?: string;
+    classification_code?: string | null;
+    is_selling: boolean;
+    sale_description?: string;
+    sale_account_id?: number;
+    sale_tax_code_id?: number;
+    is_buying: boolean;
+    purchase_description?: string;
+    purchase_account_id?: number;
+    purchase_tax_code_id?: number;
+    track_inventory: boolean;
+    inventory_account_id?: number;
+    quantity_low_alert?: number;
+    bin_location?: string;
+    remarks?: string;
+    units: BukkuProductUnitParams[];
+    group_ids?: number[];
+    sale_prices?: BukkuProductSalePriceParams[];
+    purchase_prices?: BukkuProductPurchasePriceParams[];
+}
+/**
+ * Represents a Unit of a Product as returned by the API.
+ */
+export interface BukkuProductUnitResponse {
+    id: number;
+    label: string;
+    rate: number;
+    sale_price: number | null;
+    purchase_price: number | null;
+    is_base: boolean;
+    is_sale_default: boolean;
+    is_purchase_default: boolean;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Represents a Custom Sale Price of a Product as returned by the API.
+ */
+export interface BukkuProductSalePriceResponse {
+    id: number;
+    price_level_id: number | null;
+    contact_id: number | null;
+    date_from: string | null;
+    date_to: string | null;
+    minimum_quantity: number;
+    product_unit_id: number;
+    currency_code: string;
+    unit_price: number | null;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Represents a Custom Purchase Price of a Product as returned by the API.
+ */
+export interface BukkuProductPurchasePriceResponse {
+    id: number;
+    price_level_id: number | null;
+    contact_id: number | null;
+    date_from: string | null;
+    date_to: string | null;
+    minimum_quantity: number;
+    product_unit_id: number;
+    currency_code: string;
+    unit_price: number | null;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Represents a Product object as returned by the API.
+ */
+export interface BukkuProduct {
+    id: number;
+    name: string;
+    sku: string | null;
+    classification_code: string | null;
+    type: string;
+    is_selling: boolean;
+    sale_description: string | null;
+    sale_account_id: number | null;
+    sale_tax_code_id: number | null;
+    is_buying: boolean;
+    purchase_description: string | null;
+    purchase_account_id: number | null;
+    purchase_tax_code_id: number | null;
+    track_inventory: boolean;
+    inventory_account_id: number | null;
+    quantity_low_alert: number | null;
+    quantity: number | null;
+    bin_location: string | null;
+    remarks: string | null;
+    units: BukkuProductUnitResponse[] | null;
+    group_ids: number[] | null;
+    sale_prices: BukkuProductSalePriceResponse[] | null;
+    purchase_prices: BukkuProductPurchasePriceResponse[] | null;
+    is_archived: boolean;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Represents the API response structure when a product is created or retrieved.
+ */
+export interface BukkuProductResponse {
+    product: BukkuProduct;
+}
+/**
+ * Parameters for listing Bukku Products.
+ * Based on GET /products query parameters
+ */
+export interface BukkuProductListParams {
+    /** Search for keywords in Name, SKU, Sale Description, Purchase Description, Remarks. <= 60 characters */
+    search?: string;
+    /** Search by the stock level of product. */
+    stock_level?: "all" | "no_stock" | "low_stock";
+    /** Search by product mode. */
+    mode?: "sale" | "purchase";
+    /** Search by product type. */
+    type?: "product" | "bundle";
+    /** Whether to include soft deleted products. */
+    include_archived?: boolean;
+    /** 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?: "name" | "sku" | "sale_price" | "purchase_price" | "quantity";
+    /** Sort the list in ascending or descending order. */
+    sort_dir?: "asc" | "desc";
+    [key: string]: any;
+}
+/**
+ * Represents a summary of a Bukku Product as it appears in a list.
+ * This should align with the fields returned by the GET /products endpoint for list items.
+ * Based on the full BukkuProduct, but might be a subset.
+ */
+export interface BukkuProductListItem {
+    id: number;
+    name: string;
+    sku: string | null;
+    classification_code: string | null;
+    type: string;
+    is_selling: boolean;
+    sale_description: string | null;
+    sale_account_id: number | null;
+    sale_tax_code_id: number | null;
+    is_buying: boolean;
+    purchase_description: string | null;
+    purchase_account_id: number | null;
+    purchase_tax_code_id: number | null;
+    track_inventory: boolean;
+    inventory_account_id: number | null;
+    quantity_low_alert: number | null;
+    quantity: number | null;
+    bin_location: string | null;
+    remarks: string | null;
+    is_archived: boolean;
+    created_at: string;
+    updated_at: string;
+    sale_price?: number | null;
+    purchase_price?: number | null;
+}
+/**
+ * Represents the API response structure for listing products.
+ */
+export interface BukkuProductListApiResponse {
+    paging: BukkuListPagination;
+    products: BukkuProductListItem[];
+}
+/**
+ * Parameters for updating an existing Product.
+ * Based on PUT /products/{productId}
+ * Fields that are required for creation are also required for update.
+ */
+export interface BukkuProductUpdateParams {
+    name: string;
+    sku?: string;
+    classification_code?: string | null;
+    is_selling: boolean;
+    sale_description?: string;
+    sale_account_id?: number;
+    sale_tax_code_id?: number;
+    is_buying: boolean;
+    purchase_description?: string;
+    purchase_account_id?: number;
+    purchase_tax_code_id?: number;
+    track_inventory: boolean;
+    inventory_account_id?: number;
+    quantity_low_alert?: number;
+    bin_location?: string;
+    remarks?: string;
+    /**
+     * Array of product units.
+     * When updating, include 'id' for existing units to modify them.
+     * Omit 'id' for new units to add them.
+     * Units not included in the array might be removed (API behavior dependent).
+     */
+    units: BukkuProductUnitParams[];
+    group_ids?: number[];
+    /**
+     * Array of product custom sale prices.
+     * Include 'id' for existing entries to modify. Omit for new entries.
+     * Entries not included might be removed.
+     */
+    sale_prices?: BukkuProductSalePriceParams[];
+    /**
+     * Array of product custom purchase prices.
+     * Include 'id' for existing entries to modify. Omit for new entries.
+     * Entries not included might be removed.
+     */
+    purchase_prices?: BukkuProductPurchasePriceParams[];
+    is_archived?: boolean;
+}
+/**
+ * Parameters for archiving or unarchiving a Product.
+ * Based on PATCH /products/{productId}
+ */
+export interface BukkuProductArchiveParams {
+    is_archived: boolean;
+}
+//# sourceMappingURL=type.d.ts.map

package/dist/products/products/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/products/products/type.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,uFAAuF;IACvF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oGAAoG;IACpG,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,wGAAwG;IACxG,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,OAAO,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,OAAO,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAC5C,eAAe,CAAC,EAAE,+BAA+B,EAAE,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,OAAO,CAAC;IACzB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,eAAe,EAAE,OAAO,CAAC;IACzB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,wBAAwB,EAAE,GAAG,IAAI,CAAC;IACzC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,6BAA6B,EAAE,GAAG,IAAI,CAAC;IACpD,eAAe,EAAE,iCAAiC,EAAE,GAAG,IAAI,CAAC;IAC5D,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,YAAY,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,0GAA0G;IAC1G,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,WAAW,CAAC;IAC/C,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAC3B,8BAA8B;IAC9B,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC5B,gDAAgD;IAChD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,GAAG,gBAAgB,GAAG,UAAU,CAAC;IACxE,sDAAsD;IACtD,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,eAAe,EAAE,OAAO,CAAC;IACzB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAIvB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,OAAO,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,OAAO,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;;;OAIG;IACH,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAC5C;;;;OAIG;IACH,eAAe,CAAC,EAAE,+BAA+B,EAAE,CAAC;IACpD,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,OAAO,CAAC;CACtB"}

package/dist/products/products/type.js

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

package/dist/products/products/type.js.map

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/purchases/bills/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EACL,SAAS,EACT,qBAAqB,EAErB,mBAAmB,EACnB,wBAAwB,EACxB,qBAAqB,EACrB,2BAA2B,EAC5B,MAAM,QAAQ,CAAC;AAEhB,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,uBAAuB;IAErD;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IAS7D;;;;;OAKG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAS3E;;;;;OAKG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQlD;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IASlF;;;;;;OAMG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,SAAS,CAAC;IAY9F;;;;;OAKG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjD"}

package/dist/purchases/bills/index.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/purchases/bills/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAa/B,MAAa,QAAQ;IACnB,YAAoB,QAAiC;QAAjC,aAAQ,GAAR,QAAQ,CAAyB;IAAG,CAAC;IAEzD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,IAA2B;QACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,kBAAkB,EAClB,MAAM,EACN,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,MAA4B;QACrC,OAAO,IAAI,CAAC,QAAQ,CAClB,kBAAkB,EAClB,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,oBAAoB,EAAE,EAAE,EACxB,KAAK,CACN,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,EAAmB,EAAE,IAA2B;QAC3D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,oBAAoB,EAAE,EAAE,EACxB,KAAK,EACL,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAC,EAAmB,EAAE,IAAiC;QACvE,0EAA0E;QAC1E,iDAAiD;QACjD,4EAA4E;QAC5E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAClC,oBAAoB,EAAE,EAAE,EAAE,kEAAkE;QAC5F,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,oBAAoB,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAChE,CAAC;CACF;AA3FD,4BA2FC"}

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

@@ -0,0 +1,254 @@
+import { // Assuming this might be needed for update/create later
+BukkuFileAttachment, // For create/update
+BukkuAttachedFileResponse, // For response
+BukkuListPagination, BukkuFormItem } from "../../common/type";
+/**
+ * Represents a form item for creating a Bukku Bill.
+ * Based on the form_items array in the POST /purchases/bills request body.
+ */
+export interface BukkuBillFormItemCreateParams {
+    id?: number;
+    transfer_item_id?: number;
+    type?: "bundle" | "subtitle" | "subtotal" | null;
+    account_id?: number;
+    description?: string;
+    service_date?: string;
+    product_id?: number;
+    product_unit_id?: number;
+    location_id?: number;
+    unit_price?: number;
+    quantity?: number;
+    discount?: string;
+    tax_code_id?: number;
+    classification_code?: string;
+    children?: BukkuBillFormItemCreateParams[];
+}
+/**
+ * Represents a deposit item for creating a Bukku Bill.
+ * Based on the deposit_items array in the POST /purchases/bills request body.
+ */
+export interface BukkuBillDepositItemCreateParams {
+    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 Bill.
+ * Based on POST /purchases/bills
+ */
+export interface BukkuBillCreateParams {
+    payment_mode: "cash" | "credit" | "claim";
+    contact_id: number;
+    contact2_id?: number;
+    number?: string;
+    number2?: string;
+    date: string;
+    term_id?: number;
+    due_date?: string;
+    currency_code: string;
+    exchange_rate: number;
+    billing_party?: string;
+    tag_ids?: number[];
+    description?: string;
+    remarks?: string;
+    tax_mode: "inclusive" | "exclusive";
+    form_items: BukkuBillFormItemCreateParams[];
+    deposit_items?: BukkuBillDepositItemCreateParams[];
+    status: "draft" | "pending_approval" | "ready";
+    files?: BukkuFileAttachment[];
+    customs_form_no?: string | null;
+    customs_k2_form_no?: string | null;
+    incoterms?: string | null;
+    myinvois_action?: "NORMAL" | "VALIDATE" | "EXTERNAL";
+}
+/**
+ * Represents a term item within a Bukku Bill response.
+ */
+export interface BukkuBillTermItem {
+    id: number;
+    term_id: number;
+    term_name: string;
+    date: string;
+    payment_due: string;
+    description: string;
+    amount: number;
+    balance: number;
+}
+/**
+ * Represents a deposit item as returned in a Bukku Bill response.
+ */
+export interface BukkuBillDepositItem {
+    id: number;
+    line: number;
+    payment_method_id: number;
+    account_id: number;
+    amount: number;
+    number: string;
+    fee_text: string | null;
+    fee_account_id: number | null;
+}
+/**
+ * Represents a linked item as returned in a Bukku Bill response.
+ */
+export interface BukkuBillLinkedItem {
+    id: number;
+    origin_transaction_id: number;
+    type: string;
+    number: string;
+    date: string;
+    amount: number;
+    balance: number;
+    apply_amount: number;
+}
+/**
+ * Represents a Bukku Bill object as returned by the API.
+ * Based on the response sample for POST /purchases/bills
+ */
+export interface BukkuBill {
+    id: number;
+    payment_mode: "cash" | "credit" | "claim";
+    contact_id: number;
+    contact_name: string;
+    contact2_id: number | null;
+    contact2_name: string | null;
+    number: string;
+    number2: string | null;
+    date: string;
+    term_id: number | null;
+    term_name: string | null;
+    term_items: BukkuBillTermItem[] | null;
+    due_date: string | null;
+    currency_code: string;
+    currency_symbol: string;
+    exchange_rate: number;
+    billing_party: string | null;
+    tag_ids: number[] | null;
+    tag_names: string[] | null;
+    description: string | null;
+    remarks: string | null;
+    tax_mode: "inclusive" | "exclusive";
+    form_items: BukkuFormItem[];
+    deposit_items: BukkuBillDepositItem[] | null;
+    linked_items: BukkuBillLinkedItem[] | null;
+    amount: number;
+    balance: number;
+    status: string;
+    type: string;
+    files: BukkuAttachedFileResponse[] | null;
+    customs_form_no: string | null;
+    customs_k2_form_no: string | null;
+    incoterms: string | null;
+    myinvois_action: "NORMAL" | "VALIDATE" | "EXTERNAL" | null;
+    myinvois_document_uuid: string | null;
+    myinvois_document_long_id: string | null;
+    myinvois_document_status: string | null;
+    issued_at: string | null;
+    validated_at: string | null;
+    rejected_at: string | null;
+    reject_message: string | null;
+    cancelled_at: string | null;
+    cancel_message: string | null;
+    short_link?: string;
+}
+/**
+ * Represents the API response structure when a bill is created or retrieved.
+ */
+export interface BukkuBillResponse {
+    transaction: BukkuBill;
+}
+/**
+ * Parameters for updating a Bukku Bill.
+ * Based on PUT /purchases/bills/{id}
+ */
+export interface BukkuBillUpdateParams {
+    payment_mode: "cash" | "credit" | "claim";
+    contact_id: number;
+    contact2_id?: number;
+    number: string;
+    number2?: string;
+    date: string;
+    term_id?: number;
+    due_date?: string;
+    currency_code: string;
+    exchange_rate: number;
+    billing_party?: string;
+    tag_ids?: number[];
+    description?: string;
+    remarks?: string;
+    tax_mode: "inclusive" | "exclusive";
+    form_items: BukkuBillFormItemCreateParams[];
+    deposit_items?: BukkuBillDepositItemCreateParams[];
+    files?: BukkuFileAttachment[];
+    customs_form_no?: string | null;
+    customs_k2_form_no?: string | null;
+    incoterms?: string | null;
+    myinvois_action?: "NORMAL" | "VALIDATE" | "EXTERNAL";
+}
+/**
+ * Parameters for updating the status of a Bukku Bill.
+ * Typically includes a status field.
+ */
+export interface BukkuBillStatusUpdateParams {
+    status: "draft" | "pending_approval" | "ready" | "void";
+}
+/**
+ * Parameters for listing Bukku Bills.
+ * This would include filters, pagination, sorting.
+ */
+export interface BukkuBillListParams {
+    search?: string;
+    custom_search?: string;
+    contact_id?: number;
+    date_from?: string;
+    date_to?: string;
+    status?: "all" | "draft" | "pending_approval" | "ready" | "void";
+    payment_mode?: "credit" | "cash" | "claim";
+    payment_status?: "PAID" | "OUTSTANDING" | "OVERDUE";
+    page?: number;
+    page_size?: number;
+    sort_by?: "number" | "date" | "contact_name" | "contact2_name" | "number2" | "description" | "amount" | "balance" | "created_at";
+    sort_dir?: "asc" | "desc";
+    [key: string]: any;
+}
+/**
+ * Represents a summary of a Bukku Bill as it appears in a list.
+ */
+export interface BukkuBillListItem {
+    id: number;
+    payment_mode: string;
+    contact_id: number;
+    contact_name: string;
+    contact2_name?: string | null;
+    number: string;
+    number2: string | null;
+    date: string;
+    due_date?: string | null;
+    currency_code: string;
+    currency_symbol: string;
+    exchange_rate: number;
+    billing_party?: string | null;
+    tag_names?: string[] | null;
+    description?: string | null;
+    amount: number;
+    balance?: number;
+    status: string;
+    file_count?: number;
+    short_link?: string;
+    created_by?: string;
+    created_at: string;
+    updated_at: string;
+    myinvois_document_status?: string | null;
+    myinvois_document_uuid?: string | null;
+}
+/**
+ * Represents the API response structure for listing bills.
+ */
+export interface BukkuBillListApiResponse {
+    paging: BukkuListPagination;
+    transactions: BukkuBillListItem[];
+}
+//# sourceMappingURL=type.d.ts.map