edge-impulse-api 1.22.1 → 1.25.33

package/build/library/sdk/api/organizationDataApi.js

@@ -438,6 +438,85 @@ class OrganizationDataApi {
             });
         });
     }
+    /**
+     * Add a new research dataset
+     * @summary Add dataset
+     * @param organizationId Organization ID
+     * @param organizationAddDatasetRequest
+     */
+    async addOrganizationDataset(organizationId, organizationAddDatasetRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/organizations/{organizationId}/dataset'
+            .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)));
+        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 'organizationId' is not null or undefined
+        if (organizationId === null || organizationId === undefined) {
+            throw new Error('Required parameter organizationId was null or undefined when calling addOrganizationDataset.');
+        }
+        // verify required parameter 'organizationAddDatasetRequest' is not null or undefined
+        if (organizationAddDatasetRequest === null || organizationAddDatasetRequest === undefined) {
+            throw new Error('Required parameter organizationAddDatasetRequest was null or undefined when calling addOrganizationDataset.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+            body: models_1.ObjectSerializer.serialize(organizationAddDatasetRequest, "OrganizationAddDatasetRequest")
+        };
+        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.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, "StartJobResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Change the dataset for selected data items.
      * @summary Change dataset
@@ -710,7 +789,7 @@ class OrganizationDataApi {
         });
     }
     /**
-     * Delete a data item. This does not remove the items from the underlying storage.
+     * Delete a data item. This will remove items the items from the underlying storage if your dataset has \"bucketPath\" set.
      * @summary Delete data
      * @param organizationId Organization ID
      * @param dataId Data ID
@@ -1381,6 +1460,93 @@ class OrganizationDataApi {
             });
         });
     }
+    /**
+     * Get all transformation jobs that ran for a data item. If limit / offset is not provided then max. 20 results are returned.
+     * @summary Get transformation jobs for data item
+     * @param organizationId Organization ID
+     * @param dataId Data ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    async getOrganizationDataItemTransformJobs(organizationId, dataId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/organizations/{organizationId}/data/{dataId}/transformation-jobs'
+            .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)))
+            .replace('{' + 'dataId' + '}', encodeURIComponent(String(dataId)));
+        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 'organizationId' is not null or undefined
+        if (organizationId === null || organizationId === undefined) {
+            throw new Error('Required parameter organizationId was null or undefined when calling getOrganizationDataItemTransformJobs.');
+        }
+        // verify required parameter 'dataId' is not null or undefined
+        if (dataId === null || dataId === undefined) {
+            throw new Error('Required parameter dataId was null or undefined when calling getOrganizationDataItemTransformJobs.');
+        }
+        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.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, "GetOrganizationDataItemTransformJobsResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Get information about a dataset
      * @summary Get dataset
@@ -2390,7 +2556,7 @@ class OrganizationDataApi {
         });
     }
     /**
-     * Update all data items. HEADs all underlying buckets to retrieve the last file information. Use this API after uploading data directly to S3.
+     * Update all data items. HEADs all underlying buckets to retrieve the last file information. Use this API after uploading data directly to S3. If your dataset has bucketId and bucketPath set then this will also remove items that have been removed from S3.
      * @summary Refresh data
      * @param organizationId Organization ID
      * @param dataset Selected dataset
@@ -2415,6 +2581,10 @@ class OrganizationDataApi {
         if (organizationId === null || organizationId === undefined) {
             throw new Error('Required parameter organizationId was null or undefined when calling refreshOrganizationData.');
         }
+        // verify required parameter 'dataset' is not null or undefined
+        if (queryParams.dataset === null || queryParams.dataset === undefined) {
+            throw new Error('Required parameter queryParams.dataset was null or undefined when calling refreshOrganizationData.');
+        }
         if (queryParams.dataset !== undefined) {
             localVarQueryParameters['dataset'] = models_1.ObjectSerializer.serialize(queryParams.dataset, "string");
         }