Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VehicleStatsApi

Hierarchy

  • BaseAPI
    • VehicleStatsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = ...

Methods

getVehicleStats

  • Returns the last known stats of all vehicles at the given time. If no time is specified, the current time is used. Related guide: <a href="/docs/telematics" target="_blank">Telematics. Stats snapshot

    Parameters

    Returns Promise<VehicleStatsResponse>

getVehicleStatsFeed

  • Follow a feed of vehicle stats. Your first call to this endpoint will provide you with the most recent stats for each vehicle and an endCursor. You can the provide the endCursor value to the after query parameter to get all updates since the last call you made. If hasNextPage is false, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request. Related guide: <a href="/docs/telematics" target="_blank">Telematics. Stats feed

    Parameters

    Returns Promise<VehicleStatsListResponse>

getVehicleStatsFeedRaw

  • Follow a feed of vehicle stats. Your first call to this endpoint will provide you with the most recent stats for each vehicle and an endCursor. You can the provide the endCursor value to the after query parameter to get all updates since the last call you made. If hasNextPage is false, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request. Related guide: <a href="/docs/telematics" target="_blank">Telematics. Stats feed

    Parameters

    Returns Promise<ApiResponse<VehicleStatsListResponse>>

getVehicleStatsHistory

  • Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs. Related guide: <a href="/docs/telematics" target="_blank">Telematics. Historical stats

    Parameters

    Returns Promise<VehicleStatsListResponse>

getVehicleStatsHistoryRaw

  • Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs. Related guide: <a href="/docs/telematics" target="_blank">Telematics. Historical stats

    Parameters

    Returns Promise<ApiResponse<VehicleStatsListResponse>>

getVehicleStatsRaw

  • Returns the last known stats of all vehicles at the given time. If no time is specified, the current time is used. Related guide: <a href="/docs/telematics" target="_blank">Telematics. Stats snapshot

    Parameters

    Returns Promise<ApiResponse<VehicleStatsResponse>>

Protected request

  • request(context: RequestOpts): Promise<Response>

  • Parameters

    • context: RequestOpts

    Returns Promise<Response>

withMiddleware

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

  • Type parameters

    • T: BaseAPI<T>

    Parameters

    • Rest ...middlewares: Middleware[]

    Returns T

withPostMiddleware

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

  • 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

  • Type parameters

    • T: BaseAPI<T>

    Parameters

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

    Returns T

Generated using TypeDoc