Class CustomersApi

CustomersApi - object-oriented interface

Export

Hierarchy

BaseAPI
- CustomersApi

Index

Constructors

constructor

new CustomersApi(configuration?, basePath?, axios?): CustomersApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns CustomersApi
Inherited from BaseAPI.constructor
- Defined in base.ts:56

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

createCustomer

createCustomer(requestParameters, options?): Promise<AxiosResponse<Customer, any>>
Creates a Customer.

Summary
Create a Customer

Throws

Memberof
CustomersApi
Parameters
- requestParameters: CustomersApiCreateCustomerRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<Customer, any>>
- Defined in api/customers-api.ts:599

deleteCustomer

deleteCustomer(requestParameters, options?): Promise<AxiosResponse<object, any>>
Deletes a Customer. This cannot be undone.

Summary
Delete a Customer

Throws

Memberof
CustomersApi
Parameters
- requestParameters: CustomersApiDeleteCustomerRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<object, any>>
- Defined in api/customers-api.ts:611

getCustomer

getCustomer(requestParameters, options?): Promise<AxiosResponse<Customer, any>>
Retrieves the details of an existing Customer.

Summary
Get a Customer

Throws

Memberof
CustomersApi
Parameters
- requestParameters: CustomersApiGetCustomerRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<Customer, any>>
- Defined in api/customers-api.ts:623

listCustomers

listCustomers(requestParameters, options?): Promise<AxiosResponse<ListCustomers200Response, any>>
Returns a list of Customers. The Customers are sorted with the most recently created appearing first.

Summary
List all Customers

Throws

Memberof
CustomersApi
Parameters
- requestParameters: CustomersApiListCustomersRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ListCustomers200Response, any>>
- Defined in api/customers-api.ts:635

updateCustomer

updateCustomer(requestParameters, options?): Promise<AxiosResponse<Customer, any>>
Updates a Customer by setting the values of the provided parameters. Any parameters not provided will be left unchanged.

Summary
Update a Customer

Throws

Memberof
CustomersApi
Parameters
- requestParameters: CustomersApiUpdateCustomerRequest
  
  Request parameters.
- Optional options: RawAxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<Customer, any>>
- Defined in api/customers-api.ts:647

Class CustomersApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns CustomersApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

createCustomer

Summary

Throws

Memberof

Parameters

requestParameters: CustomersApiCreateCustomerRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<Customer, any>>

deleteCustomer

Summary

Throws

Memberof

Parameters

requestParameters: CustomersApiDeleteCustomerRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<object, any>>

getCustomer

Summary

Throws

Memberof

Parameters

requestParameters: CustomersApiGetCustomerRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<Customer, any>>

listCustomers

Summary

Throws

Memberof

Parameters

requestParameters: CustomersApiListCustomersRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<ListCustomers200Response, any>>

updateCustomer

Summary

Throws

Memberof

Parameters

requestParameters: CustomersApiUpdateCustomerRequest

Optional options: RawAxiosRequestConfig<any>

Returns Promise<AxiosResponse<Customer, any>>

Settings

Member Visibility

Theme

On This Page

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>

`Optional` options: RawAxiosRequestConfig<any>