/**
* Samsara API
* # Overview Something new! Welcome Samsara\'s new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what\'s changed and learn how to get started.
Want to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).
*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can\'t find an API that you\'re looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*
Submit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)! Samsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets. The Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you\'re familiar with what you can build with a REST API, then this will be your go-to API reference. Visit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview. If you have any questions, please visit https://samsara.com/help. ## Endpoints All our APIs can be accessed through HTTP requests to URLs like: ``` https://api.samsara.com/ ``` For EU customers, this URL will be: ``` https://api.eu.samsara.com/ ``` Note Legacy endpoints will have the URL: `https://api.samsara.com/v1/` or `https://api.eu.samsara.com/v1/` ## Authentication To authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings->Organization->API Tokens`. Your API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. Authentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password: ```curl Authorization: Bearer {access_token} ``` All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail. ### OAuth2 If building an application for our marketplace, our API is accessible via. OAuth2 as well. | Type | Value | | ------------- |:-------------:| | Security scheme | OAuth2 | | OAuth2 Flow | accessCode | | Authorization URL | https://api.samsara.com/oauth2/authorize | | Token URL | https://api.samsara.com/oauth2/token | ## Common Patterns You can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures).
*
* The version of the OpenAPI document: 2024-11-18
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { RequestArgs, BaseAPI } from '../base';
import { AssetCreate } from '../samsara-models';
import { AssetDataOutputsPatchAssetDataOutputsRequestBody } from '../samsara-models';
import { AssetDataOutputsPatchAssetDataOutputsResponseBody } from '../samsara-models';
import { AssetPatch } from '../samsara-models';
import { DataInputListResponse } from '../samsara-models';
import { DataInputSnapshotResponse } from '../samsara-models';
import { DataInputsTinyResponse } from '../samsara-models';
import { InlineObject3 } from '../samsara-models';
import { InlineResponse200 } from '../samsara-models';
import { InlineResponse2008 } from '../samsara-models';
import { ListIndustrialAssetsResponse } from '../samsara-models';
import { V1MachineHistoryResponse } from '../samsara-models';
import { V1ProgramsForTheCameraResponseInner } from '../samsara-models';
import { V1VisionCamerasResponseInner } from '../samsara-models';
import { V1VisionRunByCameraResponse } from '../samsara-models';
import { V1VisionRunsByCameraAndProgramResponse } from '../samsara-models';
import { V1VisionRunsByCameraResponseInner } from '../samsara-models';
import { V1VisionRunsResponse } from '../samsara-models';
/**
* IndustrialApi - axios parameter creator
* @export
*/
export declare const IndustrialApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* 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.
* @summary Create an asset
* @param {AssetCreate} [asset] The asset to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createIndustrialAsset: (asset?: AssetCreate, options?: RawAxiosRequestConfig) => Promise;
/**
* Delete asset. **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.
* @summary Delete an existing asset
* @param {string} id Id of the asset to be deleted.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteIndustrialAsset: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Follow a real-time feed of data points for data inputs
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [dataInputIds] A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataFeed: (after?: string, parentTagIds?: Array, tagIds?: Array, dataInputIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary List historical data points for data inputs
* @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [dataInputIds] A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataHistory: (startTime: string, endTime: string, after?: string, parentTagIds?: Array, tagIds?: Array, dataInputIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary List most recent data points for data inputs
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [dataInputIds] A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataSnapshot: (after?: string, parentTagIds?: Array, tagIds?: Array, dataInputIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary List all data inputs
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputs: (limit?: number, after?: string, parentTagIds?: Array, tagIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary List all assets
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIndustrialAssets: (limit?: number, after?: string, parentTagIds?: Array, tagIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Fetch runs by camera
* @param {number} cameraId The camera_id should be valid for the given accessToken.
* @param {number} durationMs DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
* @param {number} [endMs] EndMs is an optional param. It will default to the current time.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVisionRunsByCamera: (cameraId: number, durationMs: number, endMs?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Writes to data outputs on an asset
* @param {string} id Asset ID
* @param {AssetDataOutputsPatchAssetDataOutputsRequestBody} patchAssetDataOutputsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchAssetDataOutputs: (id: string, patchAssetDataOutputsRequestBody: AssetDataOutputsPatchAssetDataOutputsRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Update an asset
* @param {string} id Id of the asset to be updated
* @param {AssetPatch} [asset] The updated asset fields
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchIndustrialAsset: (id: string, asset?: AssetPatch, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Fetch industrial cameras
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getCameras: (options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Get machines
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getMachines: (options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Get machine history
* @param {InlineObject3} historyParam
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getMachinesHistory: (historyParam: InlineObject3, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Fetch the latest run for a camera or program
* @param {number} cameraId The camera_id should be valid for the given accessToken.
* @param {number} [programId] The configured program\'s ID on the camera.
* @param {number} [startedAtMs] EndMs is an optional param. It will default to the current time.
* @param {string} [include] Include is a filter parameter. Accepts \'pass\', \'reject\' or \'no_read\'.
* @param {number} [limit] Limit is an integer value from 1 to 1,000.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionLatestRunCamera: (cameraId: number, programId?: number, startedAtMs?: number, include?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Fetch industrial camera programs
* @param {number} cameraId The camera_id should be valid for the given accessToken.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionProgramsByCamera: (cameraId: number, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Fetch runs
* @param {number} durationMs DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
* @param {number} [endMs] EndMs is an optional param. It will default to the current time.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionRuns: (durationMs: number, endMs?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary Fetch runs by camera and program
* @param {number} cameraId The camera_id should be valid for the given accessToken.
* @param {number} programId The configured program\'s ID on the camera.
* @param {number} startedAtMs Started_at_ms is a required param. Indicates the start time of the run to be fetched.
* @param {string} [include] Include is a filter parameter. Accepts \'pass\', \'reject\' or \'no_read\'.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionRunsByCameraAndProgram: (cameraId: number, programId: number, startedAtMs: number, include?: string, options?: RawAxiosRequestConfig) => Promise;
};
/**
* IndustrialApi - functional programming interface
* @export
*/
export declare const IndustrialApiFp: (configuration?: Configuration) => {
/**
* 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.
* @summary Create an asset
* @param {AssetCreate} [asset] The asset to create
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createIndustrialAsset(asset?: AssetCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Delete asset. **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.
* @summary Delete an existing asset
* @param {string} id Id of the asset to be deleted.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteIndustrialAsset(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary Follow a real-time feed of data points for data inputs
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [dataInputIds] A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataFeed(after?: string, parentTagIds?: Array, tagIds?: Array, dataInputIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary List historical data points for data inputs
* @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [dataInputIds] A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataHistory(startTime: string, endTime: string, after?: string, parentTagIds?: Array, tagIds?: Array, dataInputIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary List most recent data points for data inputs
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [dataInputIds] A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataSnapshot(after?: string, parentTagIds?: Array, tagIds?: Array, dataInputIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary List all data inputs
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputs(limit?: number, after?: string, parentTagIds?: Array, tagIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary List all assets
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [assetIds] A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIndustrialAssets(limit?: number, after?: string, parentTagIds?: Array, tagIds?: Array, assetIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary Fetch runs by camera
* @param {number} cameraId The camera_id should be valid for the given accessToken.
* @param {number} durationMs DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
* @param {number} [endMs] EndMs is an optional param. It will default to the current time.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVisionRunsByCamera(cameraId: number, durationMs: number, endMs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* 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.
* @summary Writes to data outputs on an asset
* @param {string} id Asset ID
* @param {AssetDataOutputsPatchAssetDataOutputsRequestBody} patchAssetDataOutputsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchAssetDataOutputs(id: string, patchAssetDataOutputsRequestBody: AssetDataOutputsPatchAssetDataOutputsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary Update an asset
* @param {string} id Id of the asset to be updated
* @param {AssetPatch} [asset] The updated asset fields
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchIndustrialAsset(id: string, asset?: AssetPatch, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary Fetch industrial cameras
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getCameras(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* 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.
* @summary Get machines
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getMachines(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary Get machine history
* @param {InlineObject3} historyParam
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getMachinesHistory(historyParam: InlineObject3, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary Fetch the latest run for a camera or program
* @param {number} cameraId The camera_id should be valid for the given accessToken.
* @param {number} [programId] The configured program\'s ID on the camera.
* @param {number} [startedAtMs] EndMs is an optional param. It will default to the current time.
* @param {string} [include] Include is a filter parameter. Accepts \'pass\', \'reject\' or \'no_read\'.
* @param {number} [limit] Limit is an integer value from 1 to 1,000.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionLatestRunCamera(cameraId: number, programId?: number, startedAtMs?: number, include?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary Fetch industrial camera programs
* @param {number} cameraId The camera_id should be valid for the given accessToken.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionProgramsByCamera(cameraId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* 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.
* @summary Fetch runs
* @param {number} durationMs DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
* @param {number} [endMs] EndMs is an optional param. It will default to the current time.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionRuns(durationMs: number, endMs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary Fetch runs by camera and program
* @param {number} cameraId The camera_id should be valid for the given accessToken.
* @param {number} programId The configured program\'s ID on the camera.
* @param {number} startedAtMs Started_at_ms is a required param. Indicates the start time of the run to be fetched.
* @param {string} [include] Include is a filter parameter. Accepts \'pass\', \'reject\' or \'no_read\'.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionRunsByCameraAndProgram(cameraId: number, programId: number, startedAtMs: number, include?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* IndustrialApi - factory interface
* @export
*/
export declare const IndustrialApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* 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.
* @summary Create an asset
* @param {IndustrialApiCreateIndustrialAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createIndustrialAsset(requestParameters?: IndustrialApiCreateIndustrialAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Delete asset. **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.
* @summary Delete an existing asset
* @param {IndustrialApiDeleteIndustrialAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteIndustrialAsset(requestParameters: IndustrialApiDeleteIndustrialAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary Follow a real-time feed of data points for data inputs
* @param {IndustrialApiGetDataInputDataFeedRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataFeed(requestParameters?: IndustrialApiGetDataInputDataFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary List historical data points for data inputs
* @param {IndustrialApiGetDataInputDataHistoryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataHistory(requestParameters: IndustrialApiGetDataInputDataHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary List most recent data points for data inputs
* @param {IndustrialApiGetDataInputDataSnapshotRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputDataSnapshot(requestParameters?: IndustrialApiGetDataInputDataSnapshotRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary List all data inputs
* @param {IndustrialApiGetDataInputsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDataInputs(requestParameters?: IndustrialApiGetDataInputsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary List all assets
* @param {IndustrialApiGetIndustrialAssetsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIndustrialAssets(requestParameters?: IndustrialApiGetIndustrialAssetsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary Fetch runs by camera
* @param {IndustrialApiGetVisionRunsByCameraRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVisionRunsByCamera(requestParameters: IndustrialApiGetVisionRunsByCameraRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* 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.
* @summary Writes to data outputs on an asset
* @param {IndustrialApiPatchAssetDataOutputsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchAssetDataOutputs(requestParameters: IndustrialApiPatchAssetDataOutputsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary Update an asset
* @param {IndustrialApiPatchIndustrialAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchIndustrialAsset(requestParameters: IndustrialApiPatchIndustrialAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary Fetch industrial cameras
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getCameras(options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* 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.
* @summary Get machines
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getMachines(options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary Get machine history
* @param {IndustrialApiV1getMachinesHistoryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getMachinesHistory(requestParameters: IndustrialApiV1getMachinesHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary Fetch the latest run for a camera or program
* @param {IndustrialApiV1getVisionLatestRunCameraRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionLatestRunCamera(requestParameters: IndustrialApiV1getVisionLatestRunCameraRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary Fetch industrial camera programs
* @param {IndustrialApiV1getVisionProgramsByCameraRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionProgramsByCamera(requestParameters: IndustrialApiV1getVisionProgramsByCameraRequest, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* 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.
* @summary Fetch runs
* @param {IndustrialApiV1getVisionRunsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionRuns(requestParameters: IndustrialApiV1getVisionRunsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary Fetch runs by camera and program
* @param {IndustrialApiV1getVisionRunsByCameraAndProgramRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getVisionRunsByCameraAndProgram(requestParameters: IndustrialApiV1getVisionRunsByCameraAndProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for createIndustrialAsset operation in IndustrialApi.
* @export
* @interface IndustrialApiCreateIndustrialAssetRequest
*/
export interface IndustrialApiCreateIndustrialAssetRequest {
/**
* The asset to create
* @type {AssetCreate}
* @memberof IndustrialApiCreateIndustrialAsset
*/
readonly asset?: AssetCreate;
}
/**
* Request parameters for deleteIndustrialAsset operation in IndustrialApi.
* @export
* @interface IndustrialApiDeleteIndustrialAssetRequest
*/
export interface IndustrialApiDeleteIndustrialAssetRequest {
/**
* Id of the asset to be deleted.
* @type {string}
* @memberof IndustrialApiDeleteIndustrialAsset
*/
readonly id: string;
}
/**
* Request parameters for getDataInputDataFeed operation in IndustrialApi.
* @export
* @interface IndustrialApiGetDataInputDataFeedRequest
*/
export interface IndustrialApiGetDataInputDataFeedRequest {
/**
* If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @type {string}
* @memberof IndustrialApiGetDataInputDataFeed
*/
readonly after?: string;
/**
* A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataFeed
*/
readonly parentTagIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataFeed
*/
readonly tagIds?: Array;
/**
* A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataFeed
*/
readonly dataInputIds?: Array;
/**
* A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataFeed
*/
readonly assetIds?: Array;
}
/**
* Request parameters for getDataInputDataHistory operation in IndustrialApi.
* @export
* @interface IndustrialApiGetDataInputDataHistoryRequest
*/
export interface IndustrialApiGetDataInputDataHistoryRequest {
/**
* A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @type {string}
* @memberof IndustrialApiGetDataInputDataHistory
*/
readonly startTime: string;
/**
* An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @type {string}
* @memberof IndustrialApiGetDataInputDataHistory
*/
readonly endTime: string;
/**
* If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @type {string}
* @memberof IndustrialApiGetDataInputDataHistory
*/
readonly after?: string;
/**
* A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataHistory
*/
readonly parentTagIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataHistory
*/
readonly tagIds?: Array;
/**
* A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataHistory
*/
readonly dataInputIds?: Array;
/**
* A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataHistory
*/
readonly assetIds?: Array;
}
/**
* Request parameters for getDataInputDataSnapshot operation in IndustrialApi.
* @export
* @interface IndustrialApiGetDataInputDataSnapshotRequest
*/
export interface IndustrialApiGetDataInputDataSnapshotRequest {
/**
* If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @type {string}
* @memberof IndustrialApiGetDataInputDataSnapshot
*/
readonly after?: string;
/**
* A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataSnapshot
*/
readonly parentTagIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataSnapshot
*/
readonly tagIds?: Array;
/**
* A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataSnapshot
*/
readonly dataInputIds?: Array;
/**
* A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @type {Array}
* @memberof IndustrialApiGetDataInputDataSnapshot
*/
readonly assetIds?: Array;
}
/**
* Request parameters for getDataInputs operation in IndustrialApi.
* @export
* @interface IndustrialApiGetDataInputsRequest
*/
export interface IndustrialApiGetDataInputsRequest {
/**
* The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @type {number}
* @memberof IndustrialApiGetDataInputs
*/
readonly limit?: number;
/**
* If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @type {string}
* @memberof IndustrialApiGetDataInputs
*/
readonly after?: string;
/**
* A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @type {Array}
* @memberof IndustrialApiGetDataInputs
*/
readonly parentTagIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {Array}
* @memberof IndustrialApiGetDataInputs
*/
readonly tagIds?: Array;
/**
* A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @type {Array}
* @memberof IndustrialApiGetDataInputs
*/
readonly assetIds?: Array;
}
/**
* Request parameters for getIndustrialAssets operation in IndustrialApi.
* @export
* @interface IndustrialApiGetIndustrialAssetsRequest
*/
export interface IndustrialApiGetIndustrialAssetsRequest {
/**
* The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @type {number}
* @memberof IndustrialApiGetIndustrialAssets
*/
readonly limit?: number;
/**
* If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @type {string}
* @memberof IndustrialApiGetIndustrialAssets
*/
readonly after?: string;
/**
* A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @type {Array}
* @memberof IndustrialApiGetIndustrialAssets
*/
readonly parentTagIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {Array}
* @memberof IndustrialApiGetIndustrialAssets
*/
readonly tagIds?: Array;
/**
* A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @type {Array}
* @memberof IndustrialApiGetIndustrialAssets
*/
readonly assetIds?: Array;
}
/**
* Request parameters for getVisionRunsByCamera operation in IndustrialApi.
* @export
* @interface IndustrialApiGetVisionRunsByCameraRequest
*/
export interface IndustrialApiGetVisionRunsByCameraRequest {
/**
* The camera_id should be valid for the given accessToken.
* @type {number}
* @memberof IndustrialApiGetVisionRunsByCamera
*/
readonly cameraId: number;
/**
* DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
* @type {number}
* @memberof IndustrialApiGetVisionRunsByCamera
*/
readonly durationMs: number;
/**
* EndMs is an optional param. It will default to the current time.
* @type {number}
* @memberof IndustrialApiGetVisionRunsByCamera
*/
readonly endMs?: number;
}
/**
* Request parameters for patchAssetDataOutputs operation in IndustrialApi.
* @export
* @interface IndustrialApiPatchAssetDataOutputsRequest
*/
export interface IndustrialApiPatchAssetDataOutputsRequest {
/**
* Asset ID
* @type {string}
* @memberof IndustrialApiPatchAssetDataOutputs
*/
readonly id: string;
/**
*
* @type {AssetDataOutputsPatchAssetDataOutputsRequestBody}
* @memberof IndustrialApiPatchAssetDataOutputs
*/
readonly patchAssetDataOutputsRequestBody: AssetDataOutputsPatchAssetDataOutputsRequestBody;
}
/**
* Request parameters for patchIndustrialAsset operation in IndustrialApi.
* @export
* @interface IndustrialApiPatchIndustrialAssetRequest
*/
export interface IndustrialApiPatchIndustrialAssetRequest {
/**
* Id of the asset to be updated
* @type {string}
* @memberof IndustrialApiPatchIndustrialAsset
*/
readonly id: string;
/**
* The updated asset fields
* @type {AssetPatch}
* @memberof IndustrialApiPatchIndustrialAsset
*/
readonly asset?: AssetPatch;
}
/**
* Request parameters for v1getMachinesHistory operation in IndustrialApi.
* @export
* @interface IndustrialApiV1getMachinesHistoryRequest
*/
export interface IndustrialApiV1getMachinesHistoryRequest {
/**
*
* @type {InlineObject3}
* @memberof IndustrialApiV1getMachinesHistory
*/
readonly historyParam: InlineObject3;
}
/**
* Request parameters for v1getVisionLatestRunCamera operation in IndustrialApi.
* @export
* @interface IndustrialApiV1getVisionLatestRunCameraRequest
*/
export interface IndustrialApiV1getVisionLatestRunCameraRequest {
/**
* The camera_id should be valid for the given accessToken.
* @type {number}
* @memberof IndustrialApiV1getVisionLatestRunCamera
*/
readonly cameraId: number;
/**
* The configured program\'s ID on the camera.
* @type {number}
* @memberof IndustrialApiV1getVisionLatestRunCamera
*/
readonly programId?: number;
/**
* EndMs is an optional param. It will default to the current time.
* @type {number}
* @memberof IndustrialApiV1getVisionLatestRunCamera
*/
readonly startedAtMs?: number;
/**
* Include is a filter parameter. Accepts \'pass\', \'reject\' or \'no_read\'.
* @type {string}
* @memberof IndustrialApiV1getVisionLatestRunCamera
*/
readonly include?: string;
/**
* Limit is an integer value from 1 to 1,000.
* @type {number}
* @memberof IndustrialApiV1getVisionLatestRunCamera
*/
readonly limit?: number;
}
/**
* Request parameters for v1getVisionProgramsByCamera operation in IndustrialApi.
* @export
* @interface IndustrialApiV1getVisionProgramsByCameraRequest
*/
export interface IndustrialApiV1getVisionProgramsByCameraRequest {
/**
* The camera_id should be valid for the given accessToken.
* @type {number}
* @memberof IndustrialApiV1getVisionProgramsByCamera
*/
readonly cameraId: number;
}
/**
* Request parameters for v1getVisionRuns operation in IndustrialApi.
* @export
* @interface IndustrialApiV1getVisionRunsRequest
*/
export interface IndustrialApiV1getVisionRunsRequest {
/**
* DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched
* @type {number}
* @memberof IndustrialApiV1getVisionRuns
*/
readonly durationMs: number;
/**
* EndMs is an optional param. It will default to the current time.
* @type {number}
* @memberof IndustrialApiV1getVisionRuns
*/
readonly endMs?: number;
}
/**
* Request parameters for v1getVisionRunsByCameraAndProgram operation in IndustrialApi.
* @export
* @interface IndustrialApiV1getVisionRunsByCameraAndProgramRequest
*/
export interface IndustrialApiV1getVisionRunsByCameraAndProgramRequest {
/**
* The camera_id should be valid for the given accessToken.
* @type {number}
* @memberof IndustrialApiV1getVisionRunsByCameraAndProgram
*/
readonly cameraId: number;
/**
* The configured program\'s ID on the camera.
* @type {number}
* @memberof IndustrialApiV1getVisionRunsByCameraAndProgram
*/
readonly programId: number;
/**
* Started_at_ms is a required param. Indicates the start time of the run to be fetched.
* @type {number}
* @memberof IndustrialApiV1getVisionRunsByCameraAndProgram
*/
readonly startedAtMs: number;
/**
* Include is a filter parameter. Accepts \'pass\', \'reject\' or \'no_read\'.
* @type {string}
* @memberof IndustrialApiV1getVisionRunsByCameraAndProgram
*/
readonly include?: string;
}
/**
* IndustrialApi - object-oriented interface
* @export
* @class IndustrialApi
* @extends {BaseAPI}
*/
export declare class IndustrialApi extends BaseAPI {
/**
* 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.
* @summary Create an asset
* @param {IndustrialApiCreateIndustrialAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
createIndustrialAsset(requestParameters?: IndustrialApiCreateIndustrialAssetRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Delete asset. **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.
* @summary Delete an existing asset
* @param {IndustrialApiDeleteIndustrialAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
deleteIndustrialAsset(requestParameters: IndustrialApiDeleteIndustrialAssetRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Follow a real-time feed of data points for data inputs
* @param {IndustrialApiGetDataInputDataFeedRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
getDataInputDataFeed(requestParameters?: IndustrialApiGetDataInputDataFeedRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary List historical data points for data inputs
* @param {IndustrialApiGetDataInputDataHistoryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
getDataInputDataHistory(requestParameters: IndustrialApiGetDataInputDataHistoryRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary List most recent data points for data inputs
* @param {IndustrialApiGetDataInputDataSnapshotRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
getDataInputDataSnapshot(requestParameters?: IndustrialApiGetDataInputDataSnapshotRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary List all data inputs
* @param {IndustrialApiGetDataInputsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
getDataInputs(requestParameters?: IndustrialApiGetDataInputsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary List all assets
* @param {IndustrialApiGetIndustrialAssetsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
getIndustrialAssets(requestParameters?: IndustrialApiGetIndustrialAssetsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Fetch runs by camera
* @param {IndustrialApiGetVisionRunsByCameraRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
getVisionRunsByCamera(requestParameters: IndustrialApiGetVisionRunsByCameraRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Writes to data outputs on an asset
* @param {IndustrialApiPatchAssetDataOutputsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
patchAssetDataOutputs(requestParameters: IndustrialApiPatchAssetDataOutputsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Update an asset
* @param {IndustrialApiPatchIndustrialAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
patchIndustrialAsset(requestParameters: IndustrialApiPatchIndustrialAssetRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Fetch industrial cameras
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
v1getCameras(options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Get machines
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
v1getMachines(options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Get machine history
* @param {IndustrialApiV1getMachinesHistoryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
v1getMachinesHistory(requestParameters: IndustrialApiV1getMachinesHistoryRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Fetch the latest run for a camera or program
* @param {IndustrialApiV1getVisionLatestRunCameraRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
v1getVisionLatestRunCamera(requestParameters: IndustrialApiV1getVisionLatestRunCameraRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Fetch industrial camera programs
* @param {IndustrialApiV1getVisionProgramsByCameraRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
v1getVisionProgramsByCamera(requestParameters: IndustrialApiV1getVisionProgramsByCameraRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Fetch runs
* @param {IndustrialApiV1getVisionRunsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
v1getVisionRuns(requestParameters: IndustrialApiV1getVisionRunsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* 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.
* @summary Fetch runs by camera and program
* @param {IndustrialApiV1getVisionRunsByCameraAndProgramRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IndustrialApi
*/
v1getVisionRunsByCameraAndProgram(requestParameters: IndustrialApiV1getVisionRunsByCameraAndProgramRequest, options?: RawAxiosRequestConfig): Promise>;
}