Class SafetyApi

Hierarchy

BaseAPI
- SafetyApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new SafetyApi(configuration?: Configuration): SafetyApi

Inherited from runtime.BaseAPI.constructor
- Defined in runtime.ts:25
Parameters
- configuration: Configuration = ...
Returns SafetyApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

getSafetyEvents

getSafetyEvents(requestParameters: GetSafetyEventsRequest): Promise<SafetyEventsListResponse>

- Defined in apis/SafetyApi.ts:121
Fetch safety events for the organization in a given time period. List all safety events.

Parameters
- requestParameters: GetSafetyEventsRequest
Returns Promise<SafetyEventsListResponse>

getSafetyEventsRaw

getSafetyEventsRaw(requestParameters: GetSafetyEventsRequest): Promise<ApiResponse<SafetyEventsListResponse>>

- Defined in apis/SafetyApi.ts:70
Fetch safety events for the organization in a given time period. List all safety events.

Parameters
- requestParameters: GetSafetyEventsRequest
Returns Promise<ApiResponse<SafetyEventsListResponse>>

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from runtime.BaseAPI.request
- Defined in runtime.ts:47
Parameters
- context: RequestOpts
Returns Promise<Response>

v1getDriverSafetyScore

v1getDriverSafetyScore(requestParameters: V1getDriverSafetyScoreRequest): Promise<V1DriverSafetyScoreResponse>

- Defined in apis/SafetyApi.ts:169
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch the safety score for the driver. Fetch driver safety score

Parameters
- requestParameters: V1getDriverSafetyScoreRequest
Returns Promise<V1DriverSafetyScoreResponse>

v1getDriverSafetyScoreRaw

v1getDriverSafetyScoreRaw(requestParameters: V1getDriverSafetyScoreRequest): Promise<ApiResponse<V1DriverSafetyScoreResponse>>

- Defined in apis/SafetyApi.ts:130
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch the safety score for the driver. Fetch driver safety score

Parameters
- requestParameters: V1getDriverSafetyScoreRequest
Returns Promise<ApiResponse<V1DriverSafetyScoreResponse>>

v1getVehicleHarshEvent

v1getVehicleHarshEvent(requestParameters: V1getVehicleHarshEventRequest): Promise<V1VehicleHarshEventResponse>

- Defined in apis/SafetyApi.ts:209
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch harsh event details for a vehicle. Fetch harsh events

Parameters
- requestParameters: V1getVehicleHarshEventRequest
Returns Promise<V1VehicleHarshEventResponse>

v1getVehicleHarshEventRaw

v1getVehicleHarshEventRaw(requestParameters: V1getVehicleHarshEventRequest): Promise<ApiResponse<V1VehicleHarshEventResponse>>

- Defined in apis/SafetyApi.ts:178
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch harsh event details for a vehicle. Fetch harsh events

Parameters
- requestParameters: V1getVehicleHarshEventRequest
Returns Promise<ApiResponse<V1VehicleHarshEventResponse>>

v1getVehicleSafetyScore

v1getVehicleSafetyScore(requestParameters: V1getVehicleSafetyScoreRequest): Promise<V1VehicleSafetyScoreResponse>

- Defined in apis/SafetyApi.ts:257
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch the safety score for the vehicle. Fetch vehicle safety scores

Parameters
- requestParameters: V1getVehicleSafetyScoreRequest
Returns Promise<V1VehicleSafetyScoreResponse>

v1getVehicleSafetyScoreRaw

v1getVehicleSafetyScoreRaw(requestParameters: V1getVehicleSafetyScoreRequest): Promise<ApiResponse<V1VehicleSafetyScoreResponse>>

- Defined in apis/SafetyApi.ts:218
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch the safety score for the vehicle. Fetch vehicle safety scores

Parameters
- requestParameters: V1getVehicleSafetyScoreRequest
Returns Promise<ApiResponse<V1VehicleSafetyScoreResponse>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from runtime.BaseAPI.withMiddleware
- Defined in runtime.ts:31
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T

Inherited from runtime.BaseAPI.withPostMiddleware
- Defined in runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T

Inherited from runtime.BaseAPI.withPreMiddleware
- Defined in runtime.ts:37
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Generated using TypeDoc