Class CustomerHandler

Index

Constructors

Methods

create getByContactNumber getByGroup getById list search

Constructors

constructor

new CustomerHandler(client: KiotVietClient): CustomerHandler
Parameters
- client: KiotVietClient
Returns CustomerHandler
- Defined in src/resources/customers.ts:7

Methods

create

create(customerData: CustomerCreateParams): Promise<Customer>
Create a new customer
Parameters
- customerData: CustomerCreateParams
  The customer data to create Documentation: POST /customers
Returns Promise<Customer>
- Defined in src/resources/customers.ts:34

getByContactNumber

getByContactNumber(contactNumber: string): Promise<null | Customer>
Get customer by contact number
Parameters
- contactNumber: string
  The customer's contact number
Returns Promise<null | Customer>
- Defined in src/resources/customers.ts:78

getByGroup

getByGroup(
groupId: number,
params?: Record<string, any>,
): Promise<KiotVietListResponse<Customer>>
Get customers by group ID
Parameters
- groupId: number
  The ID of the customer group
- params: Record<string, any> = {}
  Additional filter parameters
Returns Promise<KiotVietListResponse<Customer>>
- Defined in src/resources/customers.ts:64

getById

getById(customerId: number): Promise<Customer>
Get a customer by their ID
Parameters
- customerId: number
  The ID of the customer to retrieve Documentation: GET /customers/{id}
Returns Promise<Customer>
- Defined in src/resources/customers.ts:24

list

list(params?: Record<string, any>): Promise<KiotVietListResponse<Customer>>
List customers with optional filtering
Parameters
- params: Record<string, any> = {}
  Filter parameters (pageSize, currentItem) Documentation: GET /customers
Returns Promise<KiotVietListResponse<Customer>>
- Defined in src/resources/customers.ts:14

search

search(
query: string,
params?: Record<string, any>,
): Promise<KiotVietListResponse<Customer>>
Search customers by keyword
Parameters
- query: string
  Search query
- params: Record<string, any> = {}
  Additional filter parameters
Returns Promise<KiotVietListResponse<Customer>>
- Defined in src/resources/customers.ts:49