Class Customers

Customers resource handler

Index

Constructors

Methods

count create delete get getByEmail list search setDefaultAddress update

Constructors

constructor

new Customers(client): Customers
Parameters
- client: SapoClient
Returns Customers
- Defined in resources/customers.ts:15

Methods

count

count(params?): Promise<number>
Get total customer count
Parameters
- Optional params: Partial<CustomerListParams>
  Filter parameters
Returns Promise<number>
Total number of customers matching filters
- Defined in resources/customers.ts:74

create

create(data): Promise<Customer>
Create a new customer
Parameters
- data: CreateCustomerData
  Customer creation data
Returns Promise<Customer>
Created customer
- Defined in resources/customers.ts:41

delete

delete(id): Promise<void>
Delete a customer
Parameters
- id: number
  Customer ID
Returns Promise<void>
- Defined in resources/customers.ts:65

get

get(id): Promise<Customer>
Get a single customer by ID
Parameters
- id: number
  Customer ID
Returns Promise<Customer>
Customer details
- Defined in resources/customers.ts:31

getByEmail

getByEmail(email): Promise<null | Customer>
Get a customer by email
Parameters
- email: string
  Customer email address
Returns Promise<null | Customer>
Customer details or null if not found
- Defined in resources/customers.ts:100

list

list(params?): Promise<PaginatedResponse<Customer>>
Get a list of customers
Parameters
- Optional params: CustomerListParams
  Query parameters for filtering and pagination
Returns Promise<PaginatedResponse<Customer>>
Paginated list of customers
- Defined in resources/customers.ts:22

search

search(params): Promise<Customer[]>
Search for customers
Parameters
- params: CustomerSearchParams
  Search parameters
Returns Promise<Customer[]>
List of matching customers
- Defined in resources/customers.ts:87

setDefaultAddress

setDefaultAddress(customerId, addressId): Promise<Customer>
Set default address for customer
Parameters
- customerId: number
  Customer ID
- addressId: number
  Address ID
Returns Promise<Customer>
Updated customer
- Defined in resources/customers.ts:115

update

update(id, data): Promise<Customer>
Update an existing customer
Parameters
- id: number
  Customer ID
- data: Partial<CreateCustomerData>
  Customer update data
Returns Promise<Customer>
Updated customer
- Defined in resources/customers.ts:54