Class Customers

Customers resource for creating and managing customer records

Index

Constructors

Methods

create lookup page search update

Constructors

constructor

new Customers(httpClient: HttpClient): Customers
Parameters
- httpClient: HttpClient
Returns Customers
- Defined in src/resources/customers.ts:19

Methods

create

create(request: CreateCustomerRequest): Promise<Customer>
Parameters
- request: CreateCustomerRequest
Returns Promise<Customer>
- Defined in src/resources/customers.ts:21

lookup

lookup(request: LookupCustomerRequest): Promise<Customer>
Parameters
- request: LookupCustomerRequest
Returns Promise<Customer>
- Defined in src/resources/customers.ts:28

page

page(request?: PageCustomersRequest): Promise<CustomerPage>
Parameters
- request: PageCustomersRequest = {}
Returns Promise<CustomerPage>
- Defined in src/resources/customers.ts:44

search

search(request: ResourceSearchRequest): Promise<ResourceSearchPage>
Parameters
- request: ResourceSearchRequest
Returns Promise<ResourceSearchPage>
- Defined in src/resources/customers.ts:48

update

update(
request: UpdateCustomerRequest,
options?: RequestOptions,
): Promise<Customer>
Parameters
- request: UpdateCustomerRequest
- options: RequestOptions = {}
Returns Promise<Customer>
- Defined in src/resources/customers.ts:35