Class DriverVehicleAssignmentsApi

Hierarchy

BaseAPI
- DriverVehicleAssignmentsApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new DriverVehicleAssignmentsApi(configuration?: Configuration): DriverVehicleAssignmentsApi

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

Properties

Protected configuration

configuration: Configuration = ...

Methods

getDriversVehicleAssignments

getDriversVehicleAssignments(requestParameters: GetDriversVehicleAssignmentsRequest): Promise<DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody>

- Defined in apis/DriverVehicleAssignmentsApi.ts:119
Get all vehicle assignments for the requested drivers in the requested time range. The only type of assignment supported right now are assignments created through the driver app. Get all vehicles assigned to a set of drivers

Parameters
- requestParameters: GetDriversVehicleAssignmentsRequest
Returns Promise<DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody>

getDriversVehicleAssignmentsRaw

getDriversVehicleAssignmentsRaw(requestParameters: GetDriversVehicleAssignmentsRequest): Promise<ApiResponse<DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody>>

- Defined in apis/DriverVehicleAssignmentsApi.ts:72
Get all vehicle assignments for the requested drivers in the requested time range. The only type of assignment supported right now are assignments created through the driver app. Get all vehicles assigned to a set of drivers

Parameters
- requestParameters: GetDriversVehicleAssignmentsRequest
Returns Promise<ApiResponse<DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody>>

Protected request

request(context: RequestOpts): Promise<Response>

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

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