edge-impulse-linux 1.15.4 → 1.15.6

package/build/sdk/studio/sdk/api/rawDataApi.js

@@ -100,6 +100,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async batchAddMetadata(projectId, batchAddMetadataRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/add-metadata'
@@ -180,6 +183,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -252,6 +264,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async batchClearMetadata(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/clear-metadata'
@@ -328,6 +343,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -400,6 +424,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async batchClearMetadataByKey(projectId, batchClearMetadataByKeyRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/clear-metadata-by-key'
@@ -480,6 +507,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -552,6 +588,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async batchDelete(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/delete'
@@ -628,6 +667,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -699,6 +747,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async batchDisable(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/disable-samples'
@@ -775,6 +826,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -847,6 +907,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async batchEditLabels(projectId, editSampleLabelRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/edit-labels'
@@ -927,6 +990,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -999,6 +1071,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async batchEnable(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/enable-samples'
@@ -1075,6 +1150,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -1147,6 +1231,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async batchMove(projectId, moveRawDataRequest, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/batch/moveSamples'
@@ -1227,6 +1314,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -1534,6 +1630,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID >= this value
      * @param maxId Include only samples with an ID < this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \"no_metadata\": true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async countSamples(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data/count'
@@ -1604,6 +1703,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -3630,6 +3738,97 @@ class RawDataApi {
             });
         });
     }
+    /**
+     * Get a list of unique key value pairs across all samples in a project that can be applied as filters to the /api/{projectId}/raw-data endpoint
+     * @summary Get project sample metadata filter options
+     * @param projectId Project ID
+     * @param category Which of the three acquisition categories to retrieve data from
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    async getSampleMetadataFilterOptions(projectId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/metadata-filter-options'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'projectId' is not null or undefined
+        if (projectId === null || projectId === undefined) {
+            throw new Error('Required parameter projectId was null or undefined when calling getSampleMetadataFilterOptions.');
+        }
+        // verify required parameter 'category' is not null or undefined
+        if (queryParams.category === null || queryParams.category === undefined) {
+            throw new Error('Required parameter queryParams.category was null or undefined when calling getSampleMetadataFilterOptions.');
+        }
+        if (queryParams?.category !== undefined) {
+            localVarQueryParameters['category'] = models_1.ObjectSerializer.serialize(queryParams.category, "RawDataCategory");
+        }
+        if (queryParams?.limit !== undefined) {
+            localVarQueryParameters['limit'] = models_1.ObjectSerializer.serialize(queryParams.limit, "number");
+        }
+        if (queryParams?.offset !== undefined) {
+            localVarQueryParameters['offset'] = models_1.ObjectSerializer.serialize(queryParams.offset, "number");
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.OAuth2.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "GetSampleMetadataFilterOptionsResponse");
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Get a slice of a sample.
      * @summary Get sample slice
@@ -4082,6 +4281,9 @@ class RawDataApi {
      * @param dataType Include only samples with a particular data type
      * @param minId Include only samples with an ID &gt;&#x3D; this value
      * @param maxId Include only samples with an ID &lt; this value
+     * @param metadata Filter samples by metadata key-value pairs, provided as a JSON string. Each filter item in the list is combined using a logical OR. To include samples without any metadata, use: { \&quot;no_metadata\&quot;: true }.
+     * @param minDate Only include samples that where added after the date given
+     * @param maxDate Only include samples that were added before the date given
      */
     async listSamples(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/raw-data'
@@ -4170,6 +4372,15 @@ class RawDataApi {
         if (queryParams?.maxId !== undefined) {
             localVarQueryParameters['maxId'] = models_1.ObjectSerializer.serialize(queryParams.maxId, "number");
         }
+        if (queryParams?.metadata !== undefined) {
+            localVarQueryParameters['metadata'] = models_1.ObjectSerializer.serialize(queryParams.metadata, "string");
+        }
+        if (queryParams?.minDate !== undefined) {
+            localVarQueryParameters['minDate'] = models_1.ObjectSerializer.serialize(queryParams.minDate, "Date");
+        }
+        if (queryParams?.maxDate !== undefined) {
+            localVarQueryParameters['maxDate'] = models_1.ObjectSerializer.serialize(queryParams.maxDate, "Date");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;