Class CategoryHandler

Index

Constructors

Methods

create delete getById getHierarchical list update

Constructors

constructor

new CategoryHandler(client: KiotVietClient): CategoryHandler
Parameters
- client: KiotVietClient
Returns CategoryHandler
- Defined in src/resources/categories.ts:11

Methods

create

create(categoryData: CategoryCreateParams): Promise<Category>
Create a new category
Parameters
- categoryData: CategoryCreateParams
  The category data to create
Returns Promise<Category>
- Defined in src/resources/categories.ts:35

delete

delete(categoryId: number): Promise<void>
Delete a category
Parameters
- categoryId: number
  The ID of the category to delete
Returns Promise<void>
- Defined in src/resources/categories.ts:54

getById

getById(categoryId: number): Promise<Category>
Get a category by its ID
Parameters
- categoryId: number
  The ID of the category to retrieve
Returns Promise<Category>
- Defined in src/resources/categories.ts:26

getHierarchical

getHierarchical(
params?: Omit<CategoryListParams, "hierarchicalData">,
): Promise<CategoryListResponse>
Get categories with hierarchical structure
Parameters
- params: Omit<CategoryListParams, "hierarchicalData"> = {}
  Filter and pagination parameters
Returns Promise<CategoryListResponse>
- Defined in src/resources/categories.ts:62

list

list(params?: CategoryListParams): Promise<CategoryListResponse>
List categories with optional filtering and pagination
Parameters
- params: CategoryListParams = {}
  Filter and pagination parameters
Returns Promise<CategoryListResponse>
- Defined in src/resources/categories.ts:17

update

update(
categoryId: number,
categoryData: Partial<CategoryUpdateParams>,
): Promise<Category>
Update an existing category
Parameters
- categoryId: number
  The ID of the category to update
- categoryData: Partial<CategoryUpdateParams>
  The category data to update
Returns Promise<Category>
- Defined in src/resources/categories.ts:45