Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BaseAPI
    • IndustrialApi

Index

Constructors

constructor

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

    • configuration: Configuration = ...

    Returns IndustrialApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

createIndustrialAsset

createIndustrialAssetRaw

deleteIndustrialAsset

deleteIndustrialAssetRaw

getDataInputDataFeed

  • Follow a continuous feed of all data input data points. Your first call to this endpoint will provide you with the most recent data points for each data input and a pagination object that contains an endCursor. You can provide the endCursor to the after parameter of this endpoint to get data point updates since that endCursor. If hasNextPage is false, no updates are readily available yet. We suggest waiting a minimum of 5 seconds before requesting updates. Follow a real-time feed of data points for data inputs

    Parameters

    Returns Promise<DataInputListResponse>

getDataInputDataFeedRaw

  • Follow a continuous feed of all data input data points. Your first call to this endpoint will provide you with the most recent data points for each data input and a pagination object that contains an endCursor. You can provide the endCursor to the after parameter of this endpoint to get data point updates since that endCursor. If hasNextPage is false, no updates are readily available yet. We suggest waiting a minimum of 5 seconds before requesting updates. Follow a real-time feed of data points for data inputs

    Parameters

    Returns Promise<ApiResponse<DataInputListResponse>>

getDataInputDataHistory

  • Returns all known data points during the given time range for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. List historical data points for data inputs

    Parameters

    Returns Promise<DataInputListResponse>

getDataInputDataHistoryRaw

  • Returns all known data points during the given time range for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. List historical data points for data inputs

    Parameters

    Returns Promise<ApiResponse<DataInputListResponse>>

getDataInputDataSnapshot

  • Returns last known data points for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. List most recent data points for data inputs

    Parameters

    Returns Promise<DataInputSnapshotResponse>

getDataInputDataSnapshotRaw

  • Returns last known data points for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. List most recent data points for data inputs

    Parameters

    Returns Promise<ApiResponse<DataInputSnapshotResponse>>

getDataInputs

getDataInputsRaw

  • getDataInputsRaw(requestParameters: GetDataInputsRequest): Promise<ApiResponse<DataInputsTinyResponse>>
  • Returns all data inputs, optionally filtered by tags or asset ids. List all data inputs

    Parameters

    Returns Promise<ApiResponse<DataInputsTinyResponse>>

getIndustrialAssets

getIndustrialAssetsRaw

getVisionRunsByCamera

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch runs by camera. Fetch runs by camera

    Parameters

    Returns Promise<object[]>

getVisionRunsByCameraRaw

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch runs by camera. Fetch runs by camera

    Parameters

    Returns Promise<ApiResponse<object[]>>

patchAssetDataOutputs

  • Writes values to multiple data outputs on an asset simultaneously. Only the provided data outputs will be updated. Writes to data outputs on an asset

    Parameters

    Returns Promise<AssetDataOutputsPatchAssetDataOutputsResponseBody>

patchAssetDataOutputsRaw

  • patchAssetDataOutputsRaw(requestParameters: PatchAssetDataOutputsRequest): Promise<ApiResponse<AssetDataOutputsPatchAssetDataOutputsResponseBody>>
  • Writes values to multiple data outputs on an asset simultaneously. Only the provided data outputs will be updated. Writes to data outputs on an asset

    Parameters

    Returns Promise<ApiResponse<AssetDataOutputsPatchAssetDataOutputsResponseBody>>

patchIndustrialAsset

patchIndustrialAssetRaw

Protected request

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

    • context: RequestOpts

    Returns Promise<Response>

v1getCameras

  • v1getCameras(): Promise<object[]>
  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch all cameras. Fetch industrial cameras

    Returns Promise<object[]>

v1getCamerasRaw

  • v1getCamerasRaw(): Promise<ApiResponse<object[]>>
  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch all cameras. Fetch industrial cameras

    Returns Promise<ApiResponse<object[]>>

v1getMachines

  • v1getMachines(): Promise<InlineResponse2008>
  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get machine objects. This method returns a list of the machine objects in the Samsara Cloud and information about them. Get machines

    Returns Promise<InlineResponse2008>

v1getMachinesHistory

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get historical data for machine objects. This method returns a set of historical data for all machines. Get machine history

    Parameters

    Returns Promise<V1MachineHistoryResponse>

v1getMachinesHistoryRaw

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get historical data for machine objects. This method returns a set of historical data for all machines. Get machine history

    Parameters

    Returns Promise<ApiResponse<V1MachineHistoryResponse>>

v1getMachinesRaw

  • v1getMachinesRaw(): Promise<ApiResponse<InlineResponse2008>>
  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get machine objects. This method returns a list of the machine objects in the Samsara Cloud and information about them. Get machines

    Returns Promise<ApiResponse<InlineResponse2008>>

v1getVisionLatestRunCamera

  • Fetch the latest run for a camera or program by default. If startedAtMs is supplied, fetch the specific run that corresponds to that start time. Fetch the latest run for a camera or program

    Parameters

    Returns Promise<V1VisionRunByCameraResponse>

v1getVisionLatestRunCameraRaw

  • Fetch the latest run for a camera or program by default. If startedAtMs is supplied, fetch the specific run that corresponds to that start time. Fetch the latest run for a camera or program

    Parameters

    Returns Promise<ApiResponse<V1VisionRunByCameraResponse>>

v1getVisionProgramsByCamera

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch configured programs on the camera. Fetch industrial camera programs

    Parameters

    Returns Promise<object[]>

v1getVisionProgramsByCameraRaw

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch configured programs on the camera. Fetch industrial camera programs

    Parameters

    Returns Promise<ApiResponse<object[]>>

v1getVisionRuns

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch runs. Fetch runs

    Parameters

    Returns Promise<V1VisionRunsResponse>

v1getVisionRunsByCameraAndProgram

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch runs by camera and program. Fetch runs by camera and program

    Parameters

    Returns Promise<V1VisionRunsByCameraAndProgramResponse>

v1getVisionRunsByCameraAndProgramRaw

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch runs by camera and program. Fetch runs by camera and program

    Parameters

    Returns Promise<ApiResponse<V1VisionRunsByCameraAndProgramResponse>>

v1getVisionRunsRaw

  • <n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Fetch runs. Fetch runs

    Parameters

    Returns Promise<ApiResponse<V1VisionRunsResponse>>

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