Class SurchargeHandler

Index

Constructors

Methods

create delete getById list update

Constructors

constructor

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

Methods

create

create(surchargeData: SurchargeCreateParams): Promise<Surcharge>
Create a new surcharge
Parameters
- surchargeData: SurchargeCreateParams
  The surcharge data to create
Returns Promise<Surcharge>
- Defined in src/resources/surcharges.ts:35

delete

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

getById

getById(surchargeId: number): Promise<Surcharge>
Get a surcharge by its ID
Parameters
- surchargeId: number
  The ID of the surcharge to retrieve
Returns Promise<Surcharge>
- Defined in src/resources/surcharges.ts:26

list

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

update

update(
surchargeId: number,
surchargeData: Partial<SurchargeUpdateParams>,
): Promise<Surcharge>
Update an existing surcharge
Parameters
- surchargeId: number
  The ID of the surcharge to update
- surchargeData: Partial<SurchargeUpdateParams>
  The surcharge data to update
Returns Promise<Surcharge>
- Defined in src/resources/surcharges.ts:45