edge-impulse-api 1.22.1 → 1.22.2

package/build/library/sdk/model/rawSamplePayload.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Sensor } from './sensor';
+/**
+* Sensor readings and metadata
+*/
+export declare class RawSamplePayload {
+    /**
+    * Unique identifier for this device. **Only** set this when the device has a globally unique identifier (e.g. MAC address).
+    */
+    'deviceName'?: string;
+    /**
+    * Device type, for example the exact model of the device. Should be the same for all similar devices.
+    */
+    'deviceType': string;
+    /**
+    * Array with sensor axes
+    */
+    'sensors': Array<Sensor>;
+    /**
+    * Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.
+    */
+    'values': Array<Array<number>>;
+    /**
+    * New start index of the cropped sample
+    */
+    'cropStart'?: number;
+    /**
+    * New end index of the cropped sample
+    */
+    'cropEnd'?: number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/rebalanceDatasetResponse.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DatasetRatioDataRatio } from './datasetRatioDataRatio';
+export declare class RebalanceDatasetResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'ratio'?: DatasetRatioDataRatio;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/removeCollaboratorRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class RemoveCollaboratorRequest {
+    /**
+    * Username or e-mail address
+    */
+    'usernameOrEmail': string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/removeMemberRequest.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class RemoveMemberRequest {
+    'id': number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/renameDeviceRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class RenameDeviceRequest {
+    /**
+    * New name for this device
+    */
+    'name': string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/renamePortalFileRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class RenamePortalFileRequest {
+    /**
+    * S3 path (within the portal)
+    */
+    'oldPath': string;
+    /**
+    * S3 path (within the portal)
+    */
+    'newPath': string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/renameSampleRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class RenameSampleRequest {
+    /**
+    * New name for this sample
+    */
+    'name': string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/requestResetPasswordRequest.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class RequestResetPasswordRequest {
+    'email': string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/resetPasswordRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class ResetPasswordRequest {
+    'email': string;
+    'code': string;
+    'newPassword': string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/restoreProjectFromPublicRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class RestoreProjectFromPublicRequest {
+    /**
+    * Source project ID
+    */
+    'projectId': number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/restoreProjectRequest.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class RestoreProjectRequest {
+    /**
+    * Source project ID
+    */
+    'projectId': number;
+    /**
+    * Source project API key
+    */
+    'projectApiKey': string;
+    /**
+    * Source project version ID
+    */
+    'versionId': number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/runOrganizationPipelineResponse.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { OrganizationPipelineRun } from './organizationPipelineRun';
+export declare class RunOrganizationPipelineResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'pipelineRun': OrganizationPipelineRun;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/runOrganizationPipelineResponseAllOf.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { OrganizationPipelineRun } from './organizationPipelineRun';
+export declare class RunOrganizationPipelineResponseAllOf {
+    'pipelineRun': OrganizationPipelineRun;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/sample.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { BoundingBox } from './boundingBox';
+import { Sensor } from './sensor';
+export declare class Sample {
+    'id': number;
+    'filename': string;
+    /**
+    * Whether signature validation passed
+    */
+    'signatureValidate': boolean;
+    'signatureMethod'?: string;
+    /**
+    * Either the shared key or the public key that was used to validate the sample
+    */
+    'signatureKey'?: string;
+    /**
+    * Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
+    */
+    'created': Date;
+    'category': string;
+    'coldstorageFilename': string;
+    'label': string;
+    /**
+    * Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
+    */
+    'intervalMs': number;
+    /**
+    * Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
+    */
+    'frequency': number;
+    /**
+    * Interval between two windows (1000 / frequency) in the source data (before resampling).
+    */
+    'originalIntervalMs': number;
+    /**
+    * Frequency of the sample in the source data (before resampling).
+    */
+    'originalFrequency': number;
+    'deviceName'?: string;
+    'deviceType': string;
+    'sensors': Array<Sensor>;
+    /**
+    * Number of readings in this file
+    */
+    'valuesCount': number;
+    /**
+    * Total length (in ms.) of this file
+    */
+    'totalLengthMs'?: number;
+    /**
+    * Timestamp when the sample was added to the current acquisition bucket.
+    */
+    'added': Date;
+    'boundingBoxes': Array<BoundingBox>;
+    'boundingBoxesType': SampleBoundingBoxesTypeEnum;
+    'chartType': SampleChartTypeEnum;
+    'thumbnailVideo'?: string;
+    'thumbnailVideoFull'?: string;
+    /**
+    * True if the current sample is excluded from use
+    */
+    'isDisabled': boolean;
+    /**
+    * True if the current sample is still processing (e.g. for video)
+    */
+    'isProcessing': boolean;
+    /**
+    * Set when sample is processing and a job has picked up the request
+    */
+    'processingJobId'?: number;
+    /**
+    * Set when processing this sample failed
+    */
+    'processingError': boolean;
+    /**
+    * Error (only set when processing this sample failed)
+    */
+    'processingErrorString'?: string;
+    /**
+    * Sample free form associated metadata
+    */
+    'metadata'?: {
+        [key: string]: string;
+    };
+    /**
+    * Unique identifier of the project this sample belongs to
+    */
+    'projectId': number;
+    /**
+    * Name of the owner of the project this sample belongs to
+    */
+    'projectOwnerName'?: string;
+    /**
+    * Name of the project this sample belongs to
+    */
+    'projectName'?: string;
+    /**
+    * What labeling flow the project this sample belongs to uses
+    */
+    'projectLabelingMethod'?: SampleProjectLabelingMethodEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type SampleBoundingBoxesTypeEnum = 'object_detection' | 'constrained_object_detection';
+export declare const SampleBoundingBoxesTypeEnumValues: string[];
+export declare type SampleChartTypeEnum = 'chart' | 'image' | 'video';
+export declare const SampleChartTypeEnumValues: string[];
+export declare type SampleProjectLabelingMethodEnum = 'single_label' | 'object_detection';
+export declare const SampleProjectLabelingMethodEnumValues: string[];

package/build/library/sdk/model/sampleBoundingBoxesRequest.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { BoundingBox } from './boundingBox';
+export declare class SampleBoundingBoxesRequest {
+    'boundingBoxes': Array<BoundingBox>;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/sampleMetadata.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class SampleMetadata {
+    /**
+    * Sample ID
+    */
+    'id': number;
+    /**
+    * Sample free form associated metadata
+    */
+    'metadata': {
+        [key: string]: string;
+    };
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/savePretrainedModelRequest.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DeployPretrainedModelInputTimeSeries } from './deployPretrainedModelInputTimeSeries';
+import { DeployPretrainedModelInputAudio } from './deployPretrainedModelInputAudio';
+import { DeployPretrainedModelInputImage } from './deployPretrainedModelInputImage';
+import { DeployPretrainedModelInputOther } from './deployPretrainedModelInputOther';
+import { DeployPretrainedModelModelClassification } from './deployPretrainedModelModelClassification';
+import { DeployPretrainedModelModelRegression } from './deployPretrainedModelModelRegression';
+import { DeployPretrainedModelModelObjectDetection } from './deployPretrainedModelModelObjectDetection';
+export declare class SavePretrainedModelRequest {
+    'input': DeployPretrainedModelInputTimeSeries | DeployPretrainedModelInputAudio | DeployPretrainedModelInputImage | DeployPretrainedModelInputOther;
+    'model': DeployPretrainedModelModelClassification | DeployPretrainedModelModelRegression | DeployPretrainedModelModelObjectDetection;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/scoreTrialResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ScoreTrialResponseAllOfLatency } from './scoreTrialResponseAllOfLatency';
+import { ScoreTrialResponseAllOfRam } from './scoreTrialResponseAllOfRam';
+export declare class ScoreTrialResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'score': number;
+    'latency': ScoreTrialResponseAllOfLatency;
+    'ram': ScoreTrialResponseAllOfRam;
+    'rom': ScoreTrialResponseAllOfRam;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}