pancake-client-sdk
Version:
Official TypeScript SDK for Pancake POS API
58 lines (57 loc) • 1.67 kB
TypeScript
import { Product, ProductListParams, CreateProductRequest, UpdateStockRequest, ProductCategory, CreateCategoryRequest } from '../types/product';
import { BaseResource } from './base';
export declare class ProductResource extends BaseResource {
/**
* Get list of products
*/
list(params?: ProductListParams): Promise<{
data: Product[];
}>;
/**
* Get product by ID
*/
getById(productId: string): Promise<Product>;
/**
* Create new product
*/
create(data: CreateProductRequest): Promise<Product>;
/**
* Update product
*/
update(productId: string, data: Partial<Product>): Promise<Product>;
/**
* Update product stock
*/
updateStock(productId: string, data: UpdateStockRequest): Promise<Product>;
/**
* Update multiple variation stocks
*/
updateBulkStock(productId: string, variations: UpdateStockRequest[]): Promise<Product>;
/**
* Get product categories
*/
listCategories(): Promise<{
data: ProductCategory[];
}>;
/**
* Create product category
*/
createCategory(data: CreateCategoryRequest): Promise<ProductCategory>;
/**
* Update product category
*/
updateCategory(categoryId: number, data: Partial<ProductCategory>): Promise<ProductCategory>;
/**
* Delete product category
*/
deleteCategory(categoryId: number): Promise<void>;
/**
* Get product inventory history
*/
getInventoryHistory(productId: string, params?: {
from_date?: string;
to_date?: string;
page_size?: number;
page_number?: number;
}): Promise<any>;
}