Class Api

Hierarchy

APIGroup
- Api

Index

Constructors

constructor

Properties

axios

Methods

Constructors

constructor

new Api(axios: AxiosInstance): Api

Inherited from APIGroup.constructor
- Defined in models/common.ts:44
Parameters
- axios: AxiosInstance
Returns Api

Properties

Protected axios

axios: AxiosInstance

Methods

create

create(params: CreateCustomerRequest): Promise<Customer>

- Defined in models/customers.ts:81
Create a new customer

Parameters
- params: CreateCustomerRequest
  
  Customer information
Returns Promise<Customer>

createContact

createContact(customerId: number, contact: CustomerContact): Promise<Customer>

- Defined in models/customers.ts:85
Parameters
- customerId: number
- contact: CustomerContact
Returns Promise<Customer>

search

search(params: CustomerSearchRequest): Promise<Array<Customer>>

- Defined in models/customers.ts:69
Search existing customers

Parameters
- params: CustomerSearchRequest
  
  Search query parameters
Returns Promise<Array<Customer>>

Generated using TypeDoc