Class BranchHandler

Index

Constructors

Methods

create delete getById list update

Constructors

constructor

new BranchHandler(client: KiotVietClient): BranchHandler
Parameters
- client: KiotVietClient
Returns BranchHandler
- Defined in src/resources/branches.ts:5

Methods

create

create(branchData: BranchCreateParams): Promise<Branch>
Create a new branch
Parameters
- branchData: BranchCreateParams
  The branch data to create
Returns Promise<Branch>
- Defined in src/resources/branches.ts:29

delete

delete(branchId: number): Promise<void>
Delete a branch
Parameters
- branchId: number
  The ID of the branch to delete
Returns Promise<void>
- Defined in src/resources/branches.ts:48

getById

getById(branchId: number): Promise<Branch>
Get a branch by its ID
Parameters
- branchId: number
  The ID of the branch to retrieve
Returns Promise<Branch>
- Defined in src/resources/branches.ts:20

list

list(params?: BranchListParams): Promise<BranchListResponse>
List branches with optional filtering and pagination
Parameters
- params: BranchListParams = {}
  Filter and pagination parameters
Returns Promise<BranchListResponse>
- Defined in src/resources/branches.ts:11

update

update(
branchId: number,
branchData: Partial<BranchUpdateParams>,
): Promise<Branch>
Update an existing branch
Parameters
- branchId: number
  The ID of the branch to update
- branchData: Partial<BranchUpdateParams>
  The branch data to update
Returns Promise<Branch>
- Defined in src/resources/branches.ts:39