edge-impulse-linux 1.4.7 → 1.5.0

package/build/sdk/studio/sdk/api/projectsApi.d.ts

@@ -9,15 +9,16 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { AddApiKeyRequest } from '../model/addApiKeyRequest';
 import { AddCollaboratorRequest } from '../model/addCollaboratorRequest';
 import { AddHmacKeyRequest } from '../model/addHmacKeyRequest';
+import { AddProjectApiKeyRequest } from '../model/addProjectApiKeyRequest';
 import { CreateProjectRequest } from '../model/createProjectRequest';
 import { CreateProjectResponse } from '../model/createProjectResponse';
 import { DevelopmentBoardsResponse } from '../model/developmentBoardsResponse';
 import { DevelopmentKeysResponse } from '../model/developmentKeysResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
 import { GetNotesResponse } from '../model/getNotesResponse';
+import { GetTargetConstraintsResponse } from '../model/getTargetConstraintsResponse';
 import { LastModificationDateResponse } from '../model/lastModificationDateResponse';
 import { ListApiKeysResponse } from '../model/listApiKeysResponse';
 import { ListEmailResponse } from '../model/listEmailResponse';
@@ -36,6 +37,7 @@ import { RemoveCollaboratorRequest } from '../model/removeCollaboratorRequest';
 import { SetProjectComputeTimeRequest } from '../model/setProjectComputeTimeRequest';
 import { SetProjectDspFileSizeRequest } from '../model/setProjectDspFileSizeRequest';
 import { SocketTokenResponse } from '../model/socketTokenResponse';
+import { TargetConstraints } from '../model/targetConstraints';
 import { TransferOwnershipOrganizationRequest } from '../model/transferOwnershipOrganizationRequest';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { UpdateProjectTagsRequest } from '../model/updateProjectTagsRequest';
@@ -104,9 +106,9 @@ export declare class ProjectsApi {
      * Add an API key. If you set `developmentKey` to `true` this flag will be removed from the current development API key.
      * @summary Add API key
      * @param projectId Project ID
-     * @param addApiKeyRequest
+     * @param addProjectApiKeyRequest
      */
-    addProjectApiKey(projectId: number, addApiKeyRequest: AddApiKeyRequest, options?: {
+    addProjectApiKey(projectId: number, addProjectApiKeyRequest: AddProjectApiKeyRequest, options?: {
         headers: {
             [name: string]: string;
         };
@@ -237,6 +239,16 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<SocketTokenResponse>;
+    /**
+     * Retrieve target constraints for a project. The constraints object captures hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage
+     * @summary Get target constraints
+     * @param projectId Project ID
+     */
+    getTargetConstraints(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetTargetConstraintsResponse>;
     /**
      * This clears out *all data in your project*, and is irrevocable. This function is only available through a JWT token, and is not available to all users.
      * @summary Launch getting started wizard
@@ -414,6 +426,17 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Set target constraints for a project. Use the constraints object to capture hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage
+     * @summary Set target constraints
+     * @param projectId Project ID
+     * @param targetConstraints
+     */
+    setTargetConstraints(projectId: number, targetConstraints: TargetConstraints, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Transfer ownership of a project to another user.
      * @summary Transfer ownership (user)

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

@@ -157,9 +157,9 @@ class ProjectsApi {
      * Add an API key. If you set `developmentKey` to `true` this flag will be removed from the current development API key.
      * @summary Add API key
      * @param projectId Project ID
-     * @param addApiKeyRequest
+     * @param addProjectApiKeyRequest
      */
-    async addProjectApiKey(projectId, addApiKeyRequest, options = { headers: {} }) {
+    async addProjectApiKey(projectId, addProjectApiKeyRequest, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/apikeys'
             .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
         let localVarQueryParameters = {};
@@ -179,9 +179,9 @@ class ProjectsApi {
         if (projectId === null || projectId === undefined) {
             throw new Error('Required parameter projectId was null or undefined when calling addProjectApiKey.');
         }
-        // verify required parameter 'addApiKeyRequest' is not null or undefined
-        if (addApiKeyRequest === null || addApiKeyRequest === undefined) {
-            throw new Error('Required parameter addApiKeyRequest was null or undefined when calling addProjectApiKey.');
+        // verify required parameter 'addProjectApiKeyRequest' is not null or undefined
+        if (addProjectApiKeyRequest === null || addProjectApiKeyRequest === undefined) {
+            throw new Error('Required parameter addProjectApiKeyRequest was null or undefined when calling addProjectApiKey.');
         }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
@@ -194,7 +194,7 @@ class ProjectsApi {
             useQuerystring: this._useQuerystring,
             agentOptions: { keepAlive: false },
             json: true,
-            body: models_1.ObjectSerializer.serialize(addApiKeyRequest, "AddApiKeyRequest")
+            body: models_1.ObjectSerializer.serialize(addProjectApiKeyRequest, "AddProjectApiKeyRequest")
         };
         let authenticationPromise = Promise.resolve();
         authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
@@ -1136,6 +1136,79 @@ class ProjectsApi {
             });
         });
     }
+    /**
+     * Retrieve target constraints for a project. The constraints object captures hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage
+     * @summary Get target constraints
+     * @param projectId Project ID
+     */
+    async getTargetConstraints(projectId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/target-constraints'
+            .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 getTargetConstraints.');
+        }
+        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, "GetTargetConstraintsResponse");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * This clears out *all data in your project*, and is irrevocable. This function is only available through a JWT token, and is not available to all users.
      * @summary Launch getting started wizard
@@ -2407,6 +2480,85 @@ class ProjectsApi {
             });
         });
     }
+    /**
+     * Set target constraints for a project. Use the constraints object to capture hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage
+     * @summary Set target constraints
+     * @param projectId Project ID
+     * @param targetConstraints
+     */
+    async setTargetConstraints(projectId, targetConstraints, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/target-constraints'
+            .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 setTargetConstraints.');
+        }
+        // verify required parameter 'targetConstraints' is not null or undefined
+        if (targetConstraints === null || targetConstraints === undefined) {
+            throw new Error('Required parameter targetConstraints was null or undefined when calling setTargetConstraints.');
+        }
+        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(targetConstraints, "TargetConstraints")
+        };
+        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, "GenericApiResponse");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Transfer ownership of a project to another user.
      * @summary Transfer ownership (user)