import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"; import * as core from "../../../../core/index.js"; import * as Samsara from "../../../index.js"; import { AssetsClient } from "../resources/assets/client/Client.js"; export declare namespace IndustrialClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class IndustrialClient { protected readonly _options: NormalizedClientOptionsWithAuth; protected _assets: AssetsClient | undefined; constructor(options?: IndustrialClient.Options); get assets(): AssetsClient; /** * List all assets in the organization. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. Learn More. * * @param {Samsara.GetIndustrialAssetsRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.getIndustrialAssets() */ getIndustrialAssets(request?: Samsara.GetIndustrialAssetsRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __getIndustrialAssets; /** * Create an asset with optional configuration parameters. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. Learn More. * * @param {Samsara.AssetCreate} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.createIndustrialAsset({ * name: "name" * }) */ createIndustrialAsset(request: Samsara.AssetCreate, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __createIndustrialAsset; /** * Update an existing asset. Only the provided fields will be updated. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. Learn More. * * @param {Samsara.AssetPatch} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.patchIndustrialAsset({ * id: "id" * }) */ patchIndustrialAsset(request: Samsara.AssetPatch, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __patchIndustrialAsset; /** * Writes values to multiple data outputs on an asset simultaneously. Only the provided data outputs will be updated. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.AssetDataOutputsPatchAssetDataOutputsRequestBody} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.industrial.patchAssetDataOutputs({ * id: "id", * values: { * "key": "value" * } * }) */ patchAssetDataOutputs(request: Samsara.AssetDataOutputsPatchAssetDataOutputsRequestBody, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __patchAssetDataOutputs; /** * Returns all data inputs, optionally filtered by tags or asset ids. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * * @param {Samsara.GetDataInputsRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.getDataInputs() */ getDataInputs(request?: Samsara.GetDataInputsRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __getDataInputs; /** * Returns last known data points for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * * @param {Samsara.GetDataInputDataSnapshotRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.getDataInputDataSnapshot() */ getDataInputDataSnapshot(request?: Samsara.GetDataInputDataSnapshotRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __getDataInputDataSnapshot; /** * 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. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * * @param {Samsara.GetDataInputDataFeedRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.getDataInputDataFeed() */ getDataInputDataFeed(request?: Samsara.GetDataInputDataFeedRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __getDataInputDataFeed; /** * 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. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * * @param {Samsara.GetDataInputDataHistoryRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.getDataInputDataHistory({ * startTime: "startTime", * endTime: "endTime" * }) */ getDataInputDataHistory(request: Samsara.GetDataInputDataHistoryRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __getDataInputDataHistory; /** * > 🚧 This endpoint is still on our legacy API. * * Fetch all cameras. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. Learn More. * * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.v1GetCameras() */ v1GetCameras(requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __v1GetCameras; /** * > 🚧 This endpoint is still on our legacy API. * * Fetch configured programs on the camera. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. Learn More. * * @param {Samsara.V1GetVisionProgramsByCameraRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.v1GetVisionProgramsByCamera({ * camera_id: 1000000 * }) */ v1GetVisionProgramsByCamera(request: Samsara.V1GetVisionProgramsByCameraRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __v1GetVisionProgramsByCamera; /** * 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. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. Learn More. * * @param {Samsara.V1GetVisionLatestRunCameraRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.v1GetVisionLatestRunCamera({ * camera_id: 1000000 * }) */ v1GetVisionLatestRunCamera(request: Samsara.V1GetVisionLatestRunCameraRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __v1GetVisionLatestRunCamera; /** * > 🚧 This endpoint is still on our legacy API. * * Fetch runs. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. Learn More. * * @param {Samsara.V1GetVisionRunsRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.v1GetVisionRuns({ * durationMs: 1000000 * }) */ v1GetVisionRuns(request: Samsara.V1GetVisionRunsRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __v1GetVisionRuns; /** * > 🚧 This endpoint is still on our legacy API. * * Fetch runs by camera. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. Learn More. * * @param {Samsara.GetVisionRunsByCameraRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.getVisionRunsByCamera({ * camera_id: 1000000, * durationMs: 1000000 * }) */ getVisionRunsByCamera(request: Samsara.GetVisionRunsByCameraRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __getVisionRunsByCamera; /** * > 🚧 This endpoint is still on our legacy API. * * Fetch runs by camera and program. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. Learn More. * * @param {Samsara.V1GetVisionRunsByCameraAndProgramRequest} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.v1GetVisionRunsByCameraAndProgram({ * camera_id: 1000000, * program_id: 1000000, * started_at_ms: 1000000 * }) */ v1GetVisionRunsByCameraAndProgram(request: Samsara.V1GetVisionRunsByCameraAndProgramRequest, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __v1GetVisionRunsByCameraAndProgram; /** * > 🚧 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. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. Learn More. * * @param {Samsara.InlineObject3} request * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.v1GetMachinesHistory({ * endMs: 1462881998034, * startMs: 1462878398034 * }) */ v1GetMachinesHistory(request: Samsara.InlineObject3, requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __v1GetMachinesHistory; /** * > 🚧 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. * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * To use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. Learn More. * * @param {IndustrialClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.industrial.v1GetMachines() */ v1GetMachines(requestOptions?: IndustrialClient.RequestOptions): core.HttpResponsePromise; private __v1GetMachines; }