Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BaseAPI
    • EquipmentApi

Index

Constructors

constructor

  • new EquipmentApi(configuration?: Configuration): EquipmentApi
  • Parameters

    • configuration: Configuration = ...

    Returns EquipmentApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

getEquipment

getEquipmentLocations

  • Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs. Get most recent locations for all equipment

    Parameters

    Returns Promise<EquipmentLocationsResponse>

getEquipmentLocationsFeed

  • Follow a continuous feed of all equipment locations from Samsara AG24s. Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a pagination object that contains an endCursor. You can provide the endCursor to subsequent calls via the after parameter. The response will contain any equipment location updates since that endCursor. If hasNextPage is false, no updates are readily available yet. We'd suggest waiting a minimum of 5 seconds before requesting updates. Follow feed of equipment locations

    Parameters

    Returns Promise<EquipmentLocationsListResponse>

getEquipmentLocationsFeedRaw

  • Follow a continuous feed of all equipment locations from Samsara AG24s. Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a pagination object that contains an endCursor. You can provide the endCursor to subsequent calls via the after parameter. The response will contain any equipment location updates since that endCursor. If hasNextPage is false, no updates are readily available yet. We'd suggest waiting a minimum of 5 seconds before requesting updates. Follow feed of equipment locations

    Parameters

    Returns Promise<ApiResponse<EquipmentLocationsListResponse>>

getEquipmentLocationsHistory

  • Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs. Get historical equipment locations

    Parameters

    Returns Promise<EquipmentLocationsListResponse>

getEquipmentLocationsHistoryRaw

  • Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs. Get historical equipment locations

    Parameters

    Returns Promise<ApiResponse<EquipmentLocationsListResponse>>

getEquipmentLocationsRaw

  • Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs. Get most recent locations for all equipment

    Parameters

    Returns Promise<ApiResponse<EquipmentLocationsResponse>>

getEquipmentRaw

  • getEquipmentRaw(requestParameters: GetEquipmentRequest): Promise<ApiResponse<EquipmentResponse>>
  • Retrieves the unit of equipment with the given Samsara ID. Retrieve a unit of equipment

    Parameters

    Returns Promise<ApiResponse<EquipmentResponse>>

getEquipmentStats

  • Returns the last known stats for all equipment. This can be optionally filtered by tags or specific equipment IDs. Get most recent stats for all equipment

    Parameters

    Returns Promise<EquipmentStatsResponse>

getEquipmentStatsFeed

  • Follow a continuous feed of all equipment stats from Samsara AG24s. Your first call to this endpoint will provide you with the most recent stats for each unit of equipment and a pagination object that contains an endCursor. You can provide the endCursor to subsequent calls via the after parameter. The response will contain any equipment stats updates since that endCursor. If hasNextPage is false, no updates are readily available yet. Each stat type has a different refresh rate, but in general we'd suggest waiting a minimum of 5 seconds before requesting updates. Follow a feed of equipment stats

    Parameters

    Returns Promise<EquipmentStatsListResponse>

getEquipmentStatsFeedRaw

  • Follow a continuous feed of all equipment stats from Samsara AG24s. Your first call to this endpoint will provide you with the most recent stats for each unit of equipment and a pagination object that contains an endCursor. You can provide the endCursor to subsequent calls via the after parameter. The response will contain any equipment stats updates since that endCursor. If hasNextPage is false, no updates are readily available yet. Each stat type has a different refresh rate, but in general we'd suggest waiting a minimum of 5 seconds before requesting updates. Follow a feed of equipment stats

    Parameters

    Returns Promise<ApiResponse<EquipmentStatsListResponse>>

getEquipmentStatsHistory

  • Returns historical equipment status during the given time range. This can be optionally filtered by tags or specific equipment IDs. Get historical equipment stats

    Parameters

    Returns Promise<EquipmentStatsListResponse>

getEquipmentStatsHistoryRaw

  • Returns historical equipment status during the given time range. This can be optionally filtered by tags or specific equipment IDs. Get historical equipment stats

    Parameters

    Returns Promise<ApiResponse<EquipmentStatsListResponse>>

getEquipmentStatsRaw

  • Returns the last known stats for all equipment. This can be optionally filtered by tags or specific equipment IDs. Get most recent stats for all equipment

    Parameters

    Returns Promise<ApiResponse<EquipmentStatsResponse>>

listEquipment

  • Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a Samsara AG24 via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG24 is activated in your organization. List all equipment

    Parameters

    Returns Promise<EquipmentListResponse>

listEquipmentRaw

  • listEquipmentRaw(requestParameters: ListEquipmentRequest): Promise<ApiResponse<EquipmentListResponse>>
  • Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a Samsara AG24 via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG24 is activated in your organization. List all equipment

    Parameters

    Returns Promise<ApiResponse<EquipmentListResponse>>

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