Class Customers

Customers - object-oriented interface

export

Hierarchy

BaseAPI
- Customers

Index

Constructors

constructor

Methods

Constructors

constructor

new Customers(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): Customers

Inherited from BaseAPI.constructor
- Defined in src/openapi/base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns Customers

Methods

create

create(customerParams: CustomerParams, options?: any): Promise<AxiosResponse<CustomerResult>>

- Defined in src/openapi/api.ts:4047
summary
Create a customer

throws
{RequiredError}

memberof
Customers

Parameters
- customerParams: CustomerParams
- Optional options: any
Returns Promise<AxiosResponse<CustomerResult>>

list

list(startingAfter?: string, options?: any): Promise<AxiosResponse<CustomerListResult>>

- Defined in src/openapi/api.ts:4059
summary
List customers

throws
{RequiredError}

memberof
Customers

Parameters
- Optional startingAfter: string
- Optional options: any
Returns Promise<AxiosResponse<CustomerListResult>>

retrieve

retrieve(customerId: string, options?: any): Promise<AxiosResponse<CustomerResult>>

- Defined in src/openapi/api.ts:4071
summary
Retrieve a customer

throws
{RequiredError}

memberof
Customers

Parameters
- customerId: string
  
  The customer's reference ID in your system
- Optional options: any
Returns Promise<AxiosResponse<CustomerResult>>

update

update(customerId: string, customerUpdateParams: CustomerUpdateParams, options?: any): Promise<AxiosResponse<CustomerResult>>

- Defined in src/openapi/api.ts:4084
summary
Update a customer

throws
{RequiredError}

memberof
Customers

Parameters
- customerId: string
  
  The customer's reference ID in your system
- customerUpdateParams: CustomerUpdateParams
- Optional options: any
Returns Promise<AxiosResponse<CustomerResult>>

Generated using TypeDoc