Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BaseAPI
    • RoutesApi

Index

Constructors

constructor

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

    • configuration: Configuration = ...

    Returns RoutesApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

createRoute

  • createRoute(requestParameters: CreateRouteRequest): Promise<RoutesCreateRouteResponseBody>

createRouteRaw

  • createRouteRaw(requestParameters: CreateRouteRequest): Promise<ApiResponse<RoutesCreateRouteResponseBody>>

fetchRoute

  • fetchRoute(requestParameters: FetchRouteRequest): Promise<RoutesFetchRouteResponseBody>

fetchRouteRaw

  • fetchRouteRaw(requestParameters: FetchRouteRequest): Promise<ApiResponse<RoutesFetchRouteResponseBody>>

fetchRoutes

  • fetchRoutes(requestParameters: FetchRoutesRequest): Promise<RoutesFetchRoutesResponseBody>

fetchRoutesRaw

  • fetchRoutesRaw(requestParameters: FetchRoutesRequest): Promise<ApiResponse<RoutesFetchRoutesResponseBody>>

getRoutesFeed

  • Subscribes to a feed of immutable, append-only updates for routes. The initial request to this feed endpoint returns a cursor, which can be used on the next request to fetch updated routes that have had state changes since that request. The legacy version of this endpoint can be found at samsara.com/api-legacy. Get route updates

    Parameters

    Returns Promise<RoutesGetRoutesFeedResponseBody>

getRoutesFeedRaw

  • getRoutesFeedRaw(requestParameters: GetRoutesFeedRequest): Promise<ApiResponse<RoutesGetRoutesFeedResponseBody>>
  • Subscribes to a feed of immutable, append-only updates for routes. The initial request to this feed endpoint returns a cursor, which can be used on the next request to fetch updated routes that have had state changes since that request. The legacy version of this endpoint can be found at samsara.com/api-legacy. Get route updates

    Parameters

    Returns Promise<ApiResponse<RoutesGetRoutesFeedResponseBody>>

patchRoute

  • patchRoute(requestParameters: PatchRouteRequest): Promise<RoutesPatchRouteResponseBody>
  • Update a route. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array. The legacy version of this endpoint (which uses PUT instead of PATCH) can be found at samsara.com/api-legacy. Update a route

    Parameters

    Returns Promise<RoutesPatchRouteResponseBody>

patchRouteRaw

  • patchRouteRaw(requestParameters: PatchRouteRequest): Promise<ApiResponse<RoutesPatchRouteResponseBody>>
  • Update a route. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array. The legacy version of this endpoint (which uses PUT instead of PATCH) can be found at samsara.com/api-legacy. Update a route

    Parameters

    Returns Promise<ApiResponse<RoutesPatchRouteResponseBody>>

Protected request

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

    • context: RequestOpts

    Returns Promise<Response>

v1deleteDispatchRouteById

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Delete a dispatch route and its associated jobs. Delete a route

    Parameters

    Returns Promise<void>

v1deleteDispatchRouteByIdRaw

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Delete a dispatch route and its associated jobs. Delete a route

    Parameters

    Returns Promise<ApiResponse<void>>

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