DriversApi | samsara-js-sdk

Hierarchy

BaseAPI
- DriversApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new DriversApi(configuration?: Configuration): DriversApi

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

Properties

Protected configuration

configuration: Configuration = ...

Methods

createDriver

createDriver(requestParameters: CreateDriverOperationRequest): Promise<DriverResponse>

- Defined in apis/DriversApi.ts:93
Add a driver to the organization. Create a driver

Parameters
- requestParameters: CreateDriverOperationRequest
Returns Promise<DriverResponse>

createDriverRaw

createDriverRaw(requestParameters: CreateDriverOperationRequest): Promise<ApiResponse<DriverResponse>>

- Defined in apis/DriversApi.ts:67
Add a driver to the organization. Create a driver

Parameters
- requestParameters: CreateDriverOperationRequest
Returns Promise<ApiResponse<DriverResponse>>

getDriver

getDriver(requestParameters: GetDriverRequest): Promise<DriverResponse>

- Defined in apis/DriversApi.ts:125
Get information about a driver. Retrieve a driver

Parameters
- requestParameters: GetDriverRequest
Returns Promise<DriverResponse>

getDriverRaw

getDriverRaw(requestParameters: GetDriverRequest): Promise<ApiResponse<DriverResponse>>

- Defined in apis/DriversApi.ts:102
Get information about a driver. Retrieve a driver

Parameters
- requestParameters: GetDriverRequest
Returns Promise<ApiResponse<DriverResponse>>

listDrivers

listDrivers(requestParameters: ListDriversRequest): Promise<ListDriversResponse>

- Defined in apis/DriversApi.ts:181
Get all drivers in organization. List all drivers

Parameters
- requestParameters: ListDriversRequest
Returns Promise<ListDriversResponse>

listDriversRaw

listDriversRaw(requestParameters: ListDriversRequest): Promise<ApiResponse<ListDriversResponse>>

- Defined in apis/DriversApi.ts:134
Get all drivers in organization. List all drivers

Parameters
- requestParameters: ListDriversRequest
Returns Promise<ApiResponse<ListDriversResponse>>

Protected request

request(context: RequestOpts): Promise<Response>

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

updateDriver

updateDriver(requestParameters: UpdateDriverOperationRequest): Promise<DriverResponse>

- Defined in apis/DriversApi.ts:220
Update a specific driver's information. This can also be used to activate or de-activate a given driver by setting the driverActivationStatus field. If the driverActivationStatus field is 'deactivated' then the user can also specify the deactivatedAtTime. The deactivatedAtTime cannot be more than 6 months in the past and must not come before the dirver's latest active HOS log. It will be considered an error if deactivatedAtTime is provided with a driverActivationStatus of active. Update a driver

Parameters
- requestParameters: UpdateDriverOperationRequest
Returns Promise<DriverResponse>

updateDriverRaw

updateDriverRaw(requestParameters: UpdateDriverOperationRequest): Promise<ApiResponse<DriverResponse>>

- Defined in apis/DriversApi.ts:190
Update a specific driver's information. This can also be used to activate or de-activate a given driver by setting the driverActivationStatus field. If the driverActivationStatus field is 'deactivated' then the user can also specify the deactivatedAtTime. The deactivatedAtTime cannot be more than 6 months in the past and must not come before the dirver's latest active HOS log. It will be considered an error if deactivatedAtTime is provided with a driverActivationStatus of active. Update a driver

Parameters
- requestParameters: UpdateDriverOperationRequest
Returns Promise<ApiResponse<DriverResponse>>

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns DriversApi

Properties

Protected configuration

Methods

createDriver

Parameters

requestParameters: CreateDriverOperationRequest

Returns Promise<DriverResponse>

createDriverRaw

Parameters

requestParameters: CreateDriverOperationRequest

Returns Promise<ApiResponse<DriverResponse>>

getDriver

Parameters

requestParameters: GetDriverRequest

Returns Promise<DriverResponse>

getDriverRaw

Parameters

requestParameters: GetDriverRequest

Returns Promise<ApiResponse<DriverResponse>>

listDrivers

Parameters

requestParameters: ListDriversRequest

Returns Promise<ListDriversResponse>

listDriversRaw

Parameters

requestParameters: ListDriversRequest

Returns Promise<ApiResponse<ListDriversResponse>>

Protected request

Parameters

context: RequestOpts

Returns Promise<Response>

updateDriver

Parameters

requestParameters: UpdateDriverOperationRequest

Returns Promise<DriverResponse>

updateDriverRaw

Parameters

requestParameters: UpdateDriverOperationRequest

Returns Promise<ApiResponse<DriverResponse>>

withMiddleware

Type parameters

T: BaseAPI<T>

Parameters

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type parameters

T: BaseAPI<T>

Parameters

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

Returns T

withPreMiddleware

Type parameters

T: BaseAPI<T>

Parameters

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

Returns T