Class VehiclesApi

Hierarchy

BaseAPI
- VehiclesApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new VehiclesApi(configuration?: Configuration): VehiclesApi

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

Properties

Protected configuration

configuration: Configuration = ...

Methods

getVehicle

getVehicle(requestParameters: GetVehicleRequest): Promise<VehicleResponse>

- Defined in apis/VehiclesApi.ts:80
Get information about a specific vehicle. Retrieve a vehicle

Parameters
- requestParameters: GetVehicleRequest
Returns Promise<VehicleResponse>

getVehicleRaw

getVehicleRaw(requestParameters: GetVehicleRequest): Promise<ApiResponse<VehicleResponse>>

- Defined in apis/VehiclesApi.ts:57
Get information about a specific vehicle. Retrieve a vehicle

Parameters
- requestParameters: GetVehicleRequest
Returns Promise<ApiResponse<VehicleResponse>>

listVehicles

listVehicles(requestParameters: ListVehiclesRequest): Promise<ListVehiclesResponse>

- Defined in apis/VehiclesApi.ts:124
Returns a list of all vehicles. List all vehicles

Parameters
- requestParameters: ListVehiclesRequest
Returns Promise<ListVehiclesResponse>

listVehiclesRaw

listVehiclesRaw(requestParameters: ListVehiclesRequest): Promise<ApiResponse<ListVehiclesResponse>>

- Defined in apis/VehiclesApi.ts:89
Returns a list of all vehicles. List all vehicles

Parameters
- requestParameters: ListVehiclesRequest
Returns Promise<ApiResponse<ListVehiclesResponse>>

Protected request

request(context: RequestOpts): Promise<Response>

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

updateVehicle

updateVehicle(requestParameters: UpdateVehicleOperationRequest): Promise<VehicleResponse>

- Defined in apis/VehiclesApi.ts:163
Updates the given Vehicle object. Note: Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API. You are able to update many of the fields of a Vehicle. Note: There are no required fields in the request body, and you only need to provide the fields you wish to update. Update a vehicle

Parameters
- requestParameters: UpdateVehicleOperationRequest
Returns Promise<VehicleResponse>

updateVehicleRaw

updateVehicleRaw(requestParameters: UpdateVehicleOperationRequest): Promise<ApiResponse<VehicleResponse>>

- Defined in apis/VehiclesApi.ts:133
Updates the given Vehicle object. Note: Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API. You are able to update many of the fields of a Vehicle. Note: There are no required fields in the request body, and you only need to provide the fields you wish to update. Update a vehicle

Parameters
- requestParameters: UpdateVehicleOperationRequest
Returns Promise<ApiResponse<VehicleResponse>>

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