Class VehiclesApi

VehiclesApi - object-oriented interface

Export

VehiclesApi

Hierarchy (View Summary, Expand)

BaseAPI
- VehiclesApi
  - VehiclesApiClient

Index

Constructors

Methods

Constructors

constructor

new VehiclesApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): VehiclesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns VehiclesApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getVehicles

getVehicles(
requestParameters: VehiclesApiGetVehiclesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<VehiclesResponse, any>>
Get the latest collection of vehicles
Parameters
- requestParameters: VehiclesApiGetVehiclesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VehiclesResponse, any>>
Throws
Memberof
VehiclesApi
- Defined in api-model/api/vehicles-api.ts:183