@bibike/erp-sdk 1.1.2 → 1.1.5

package/dist/index.d.mts

@@ -69,6 +69,12 @@ interface User {
     organization_name?: string;
     permissions?: string[];
 }
+interface ProductImage {
+    id: number;
+    url: string;
+    is_primary: boolean;
+    display_order: number;
+}
 interface Product {
     id: number;
     organization_id: number;
@@ -83,9 +89,12 @@ interface Product {
     unit_price: number;
     cost_price?: number;
     reorder_level?: number;
+    total_stock?: number;
     is_active: boolean;
+    images?: ProductImage[];
     created_at: string;
     updated_at?: string;
+    deleted_at?: string | null;
 }
 interface CreateProductInput {
     name: string;
@@ -183,6 +192,7 @@ interface SaleItem {
     total: number;
 }
 interface CreateSaleInput {
+    location_id?: number;
     customer_id?: number;
     warehouse_id?: number;
     shop_id?: number;
@@ -543,6 +553,17 @@ interface Location {
     address?: string;
     is_active: boolean;
 }
+interface LocationInventoryItem {
+    product_id: number;
+    product_name: string;
+    sku?: string;
+    barcode?: string;
+    category?: string;
+    unit_price: number;
+    quantity: number;
+    reserved_quantity?: number;
+    available_quantity?: number;
+}
 
 /**
  * Bibike ERP SDK Client
@@ -769,12 +790,42 @@ declare class BibikeClient {
         dashboard: () => Promise<ApiResponse<DashboardStats>>;
     };
     readonly locations: {
+        /**
+         * @deprecated Use `locations.all()` instead. This method requires legacy
+         * `warehouses.view` permission which may not be available to all users.
+         * The unified locations API uses location scoping for access control.
+         */
         warehouses: () => Promise<ApiResponse<Warehouse[]>>;
+        /**
+         * @deprecated Use `locations.all()` instead. This method requires legacy
+         * `shops.view` permission which may not be available to all users.
+         * The unified locations API uses location scoping for access control.
+         */
         shops: () => Promise<ApiResponse<Shop[]>>;
+        /**
+         * Get all locations using the unified locations API.
+         * Uses location scoping for access control (no legacy permissions required).
+         * @param params.type_id - Filter by location type ID
+         * @param params.capability - Filter by capability: 'sellable', 'receivable', 'stockable', 'transferable'
+         */
         all: (params?: {
             type_id?: number;
             capability?: string;
         }) => Promise<ApiResponse<Location[]>>;
+        /**
+         * Get locations by capability (e.g., sellable locations for POS)
+         * @param capability - One of: 'sellable', 'receivable', 'stockable', 'transferable'
+         */
+        byCapability: (capability: "sellable" | "receivable" | "stockable" | "transferable") => Promise<ApiResponse<Location[]>>;
+        /**
+         * Get inventory for a specific location
+         * Returns products with stock quantities at the specified location
+         * @param locationId - The location ID to get inventory for
+         */
+        inventory: (locationId: number) => Promise<ApiResponse<{
+            location: Location;
+            inventory: LocationInventoryItem[];
+        }>>;
     };
     private request;
 }
@@ -784,4 +835,4 @@ declare class BibikeApiError extends Error {
     constructor(message: string, statusCode: number, code?: string | undefined);
 }
 
-export { type Account, type Activity, type ApiResponse, type Attendance, type AuthResponse, BibikeApiError, BibikeClient, type BibikeConfig, type CreateAdjustmentInput, type CreateCustomerInput, type CreateJournalEntryInput, type CreateProductInput, type CreatePurchaseOrderInput, type CreateSaleInput, type CreateSupplierInput, type CreateTransferInput, type CreateWebhookInput, type Customer, type DashboardStats, type DateRangeParams, type Department, type Employee, type InventoryItem, type InventoryReport, type JournalEntry, type JournalLine, type Lead, type LeaveRequest, type Location, type LoginCredentials, type LoginResponse, type Opportunity, type POSSession, type PaginatedResponse, type PaginationParams, type Position, type Product, type ProfitLossReport, type PurchaseOrder, type PurchaseOrderItem, type PurchaseRequisition, type Quotation, type Sale, type SaleItem, type SalesOrder, type SalesReport, type Shop, type StockAdjustment, type StockTransfer, type StockTransferItem, type Supplier, type TaxRate, type TwoFactorRequiredResponse, type TwoFactorVerifyInput, type UpdateProductInput, type User, type Warehouse, type Webhook, type WebhookDelivery, type WebhookEvent };
+export { type Account, type Activity, type ApiResponse, type Attendance, type AuthResponse, BibikeApiError, BibikeClient, type BibikeConfig, type CreateAdjustmentInput, type CreateCustomerInput, type CreateJournalEntryInput, type CreateProductInput, type CreatePurchaseOrderInput, type CreateSaleInput, type CreateSupplierInput, type CreateTransferInput, type CreateWebhookInput, type Customer, type DashboardStats, type DateRangeParams, type Department, type Employee, type InventoryItem, type InventoryReport, type JournalEntry, type JournalLine, type Lead, type LeaveRequest, type Location, type LocationInventoryItem, type LoginCredentials, type LoginResponse, type Opportunity, type POSSession, type PaginatedResponse, type PaginationParams, type Position, type Product, type ProductImage, type ProfitLossReport, type PurchaseOrder, type PurchaseOrderItem, type PurchaseRequisition, type Quotation, type Sale, type SaleItem, type SalesOrder, type SalesReport, type Shop, type StockAdjustment, type StockTransfer, type StockTransferItem, type Supplier, type TaxRate, type TwoFactorRequiredResponse, type TwoFactorVerifyInput, type UpdateProductInput, type User, type Warehouse, type Webhook, type WebhookDelivery, type WebhookEvent };

package/dist/index.d.ts

@@ -69,6 +69,12 @@ interface User {
     organization_name?: string;
     permissions?: string[];
 }
+interface ProductImage {
+    id: number;
+    url: string;
+    is_primary: boolean;
+    display_order: number;
+}
 interface Product {
     id: number;
     organization_id: number;
@@ -83,9 +89,12 @@ interface Product {
     unit_price: number;
     cost_price?: number;
     reorder_level?: number;
+    total_stock?: number;
     is_active: boolean;
+    images?: ProductImage[];
     created_at: string;
     updated_at?: string;
+    deleted_at?: string | null;
 }
 interface CreateProductInput {
     name: string;
@@ -183,6 +192,7 @@ interface SaleItem {
     total: number;
 }
 interface CreateSaleInput {
+    location_id?: number;
     customer_id?: number;
     warehouse_id?: number;
     shop_id?: number;
@@ -543,6 +553,17 @@ interface Location {
     address?: string;
     is_active: boolean;
 }
+interface LocationInventoryItem {
+    product_id: number;
+    product_name: string;
+    sku?: string;
+    barcode?: string;
+    category?: string;
+    unit_price: number;
+    quantity: number;
+    reserved_quantity?: number;
+    available_quantity?: number;
+}
 
 /**
  * Bibike ERP SDK Client
@@ -769,12 +790,42 @@ declare class BibikeClient {
         dashboard: () => Promise<ApiResponse<DashboardStats>>;
     };
     readonly locations: {
+        /**
+         * @deprecated Use `locations.all()` instead. This method requires legacy
+         * `warehouses.view` permission which may not be available to all users.
+         * The unified locations API uses location scoping for access control.
+         */
         warehouses: () => Promise<ApiResponse<Warehouse[]>>;
+        /**
+         * @deprecated Use `locations.all()` instead. This method requires legacy
+         * `shops.view` permission which may not be available to all users.
+         * The unified locations API uses location scoping for access control.
+         */
         shops: () => Promise<ApiResponse<Shop[]>>;
+        /**
+         * Get all locations using the unified locations API.
+         * Uses location scoping for access control (no legacy permissions required).
+         * @param params.type_id - Filter by location type ID
+         * @param params.capability - Filter by capability: 'sellable', 'receivable', 'stockable', 'transferable'
+         */
         all: (params?: {
             type_id?: number;
             capability?: string;
         }) => Promise<ApiResponse<Location[]>>;
+        /**
+         * Get locations by capability (e.g., sellable locations for POS)
+         * @param capability - One of: 'sellable', 'receivable', 'stockable', 'transferable'
+         */
+        byCapability: (capability: "sellable" | "receivable" | "stockable" | "transferable") => Promise<ApiResponse<Location[]>>;
+        /**
+         * Get inventory for a specific location
+         * Returns products with stock quantities at the specified location
+         * @param locationId - The location ID to get inventory for
+         */
+        inventory: (locationId: number) => Promise<ApiResponse<{
+            location: Location;
+            inventory: LocationInventoryItem[];
+        }>>;
     };
     private request;
 }
@@ -784,4 +835,4 @@ declare class BibikeApiError extends Error {
     constructor(message: string, statusCode: number, code?: string | undefined);
 }
 
-export { type Account, type Activity, type ApiResponse, type Attendance, type AuthResponse, BibikeApiError, BibikeClient, type BibikeConfig, type CreateAdjustmentInput, type CreateCustomerInput, type CreateJournalEntryInput, type CreateProductInput, type CreatePurchaseOrderInput, type CreateSaleInput, type CreateSupplierInput, type CreateTransferInput, type CreateWebhookInput, type Customer, type DashboardStats, type DateRangeParams, type Department, type Employee, type InventoryItem, type InventoryReport, type JournalEntry, type JournalLine, type Lead, type LeaveRequest, type Location, type LoginCredentials, type LoginResponse, type Opportunity, type POSSession, type PaginatedResponse, type PaginationParams, type Position, type Product, type ProfitLossReport, type PurchaseOrder, type PurchaseOrderItem, type PurchaseRequisition, type Quotation, type Sale, type SaleItem, type SalesOrder, type SalesReport, type Shop, type StockAdjustment, type StockTransfer, type StockTransferItem, type Supplier, type TaxRate, type TwoFactorRequiredResponse, type TwoFactorVerifyInput, type UpdateProductInput, type User, type Warehouse, type Webhook, type WebhookDelivery, type WebhookEvent };
+export { type Account, type Activity, type ApiResponse, type Attendance, type AuthResponse, BibikeApiError, BibikeClient, type BibikeConfig, type CreateAdjustmentInput, type CreateCustomerInput, type CreateJournalEntryInput, type CreateProductInput, type CreatePurchaseOrderInput, type CreateSaleInput, type CreateSupplierInput, type CreateTransferInput, type CreateWebhookInput, type Customer, type DashboardStats, type DateRangeParams, type Department, type Employee, type InventoryItem, type InventoryReport, type JournalEntry, type JournalLine, type Lead, type LeaveRequest, type Location, type LocationInventoryItem, type LoginCredentials, type LoginResponse, type Opportunity, type POSSession, type PaginatedResponse, type PaginationParams, type Position, type Product, type ProductImage, type ProfitLossReport, type PurchaseOrder, type PurchaseOrderItem, type PurchaseRequisition, type Quotation, type Sale, type SaleItem, type SalesOrder, type SalesReport, type Shop, type StockAdjustment, type StockTransfer, type StockTransferItem, type Supplier, type TaxRate, type TwoFactorRequiredResponse, type TwoFactorVerifyInput, type UpdateProductInput, type User, type Warehouse, type Webhook, type WebhookDelivery, type WebhookEvent };

package/dist/index.js

@@ -324,14 +324,45 @@ var BibikeClient = class {
     };
     // ============ Locations ============
     this.locations = {
+      /**
+       * @deprecated Use `locations.all()` instead. This method requires legacy
+       * `warehouses.view` permission which may not be available to all users.
+       * The unified locations API uses location scoping for access control.
+       */
       warehouses: async () => {
         return this.request("warehouses", "list");
       },
+      /**
+       * @deprecated Use `locations.all()` instead. This method requires legacy
+       * `shops.view` permission which may not be available to all users.
+       * The unified locations API uses location scoping for access control.
+       */
       shops: async () => {
         return this.request("shops", "list");
       },
+      /**
+       * Get all locations using the unified locations API.
+       * Uses location scoping for access control (no legacy permissions required).
+       * @param params.type_id - Filter by location type ID
+       * @param params.capability - Filter by capability: 'sellable', 'receivable', 'stockable', 'transferable'
+       */
       all: async (params) => {
         return this.request("locations", "list", "GET", void 0, params);
+      },
+      /**
+       * Get locations by capability (e.g., sellable locations for POS)
+       * @param capability - One of: 'sellable', 'receivable', 'stockable', 'transferable'
+       */
+      byCapability: async (capability) => {
+        return this.request("locations", "by_capability", "GET", void 0, { capability });
+      },
+      /**
+       * Get inventory for a specific location
+       * Returns products with stock quantities at the specified location
+       * @param locationId - The location ID to get inventory for
+       */
+      inventory: async (locationId) => {
+        return this.request("locations", "inventory", "GET", void 0, { id: locationId });
       }
     };
     this.baseUrl = config.baseUrl.replace(/\/$/, "");

package/dist/index.mjs

@@ -297,14 +297,45 @@ var BibikeClient = class {
     };
     // ============ Locations ============
     this.locations = {
+      /**
+       * @deprecated Use `locations.all()` instead. This method requires legacy
+       * `warehouses.view` permission which may not be available to all users.
+       * The unified locations API uses location scoping for access control.
+       */
       warehouses: async () => {
         return this.request("warehouses", "list");
       },
+      /**
+       * @deprecated Use `locations.all()` instead. This method requires legacy
+       * `shops.view` permission which may not be available to all users.
+       * The unified locations API uses location scoping for access control.
+       */
       shops: async () => {
         return this.request("shops", "list");
       },
+      /**
+       * Get all locations using the unified locations API.
+       * Uses location scoping for access control (no legacy permissions required).
+       * @param params.type_id - Filter by location type ID
+       * @param params.capability - Filter by capability: 'sellable', 'receivable', 'stockable', 'transferable'
+       */
       all: async (params) => {
         return this.request("locations", "list", "GET", void 0, params);
+      },
+      /**
+       * Get locations by capability (e.g., sellable locations for POS)
+       * @param capability - One of: 'sellable', 'receivable', 'stockable', 'transferable'
+       */
+      byCapability: async (capability) => {
+        return this.request("locations", "by_capability", "GET", void 0, { capability });
+      },
+      /**
+       * Get inventory for a specific location
+       * Returns products with stock quantities at the specified location
+       * @param locationId - The location ID to get inventory for
+       */
+      inventory: async (locationId) => {
+        return this.request("locations", "inventory", "GET", void 0, { id: locationId });
       }
     };
     this.baseUrl = config.baseUrl.replace(/\/$/, "");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bibike/erp-sdk",
-  "version": "1.1.2",
+  "version": "1.1.5",
   "description": "TypeScript SDK for Bibike ERP API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",