edge-impulse-api 1.93.19 → 1.93.21

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

@@ -16,6 +16,7 @@ import { AddApiKeyResponse } from '../model/addApiKeyResponse';
 import { AddCollaboratorRequest } from '../model/addCollaboratorRequest';
 import { AddHmacKeyRequest } from '../model/addHmacKeyRequest';
 import { AddIngestionOnlyProjectApiKeyRequest } from '../model/addIngestionOnlyProjectApiKeyRequest';
+import { AddProjectActiveExtensionRequest } from '../model/addProjectActiveExtensionRequest';
 import { AddProjectApiKeyRequest } from '../model/addProjectApiKeyRequest';
 import { ConvertParquetToCsvResponse } from '../model/convertParquetToCsvResponse';
 import { CreateProjectRequest } from '../model/createProjectRequest';
@@ -26,8 +27,10 @@ import { EntityCreatedResponse } from '../model/entityCreatedResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
 import { GetAIActionResponse } from '../model/getAIActionResponse';
 import { GetCsvWizardUploadedFileInfo } from '../model/getCsvWizardUploadedFileInfo';
+import { GetCurrentApiKeyInfoResponse } from '../model/getCurrentApiKeyInfoResponse';
 import { GetHmacDevkeyResponse } from '../model/getHmacDevkeyResponse';
 import { GetModelVariantsResponse } from '../model/getModelVariantsResponse';
+import { GetProjectActiveExtensionsResponse } from '../model/getProjectActiveExtensionsResponse';
 import { GetSyntheticDataConfigResponse } from '../model/getSyntheticDataConfigResponse';
 import { GetTargetConstraintsResponse } from '../model/getTargetConstraintsResponse';
 import { LastModificationDateResponse } from '../model/lastModificationDateResponse';
@@ -35,6 +38,7 @@ import { ListAIActionsResponse } from '../model/listAIActionsResponse';
 import { ListApiKeysResponse } from '../model/listApiKeysResponse';
 import { ListEmailResponse } from '../model/listEmailResponse';
 import { ListHmacKeysResponse } from '../model/listHmacKeysResponse';
+import { ListProjectAvailableExtensionsResponse } from '../model/listProjectAvailableExtensionsResponse';
 import { ListProjectsResponse } from '../model/listProjectsResponse';
 import { ListPublicProjectTypesResponse } from '../model/listPublicProjectTypesResponse';
 import { ListPublicProjectsResponse } from '../model/listPublicProjectsResponse';
@@ -50,6 +54,7 @@ import { ProjectInfoResponse } from '../model/projectInfoResponse';
 import { ProjectInfoSummaryResponse } from '../model/projectInfoSummaryResponse';
 import { ProjectTrainingDataSummaryResponse } from '../model/projectTrainingDataSummaryResponse';
 import { RemoveCollaboratorRequest } from '../model/removeCollaboratorRequest';
+import { RemoveProjectActiveExtensionResponse } from '../model/removeProjectActiveExtensionResponse';
 import { SetAIActionsOrderRequest } from '../model/setAIActionsOrderRequest';
 import { SetProjectComputeTimeRequest } from '../model/setProjectComputeTimeRequest';
 import { SetProjectDspFileSizeRequest } from '../model/setProjectDspFileSizeRequest';
@@ -136,6 +141,17 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<EntityCreatedResponse>;
+    /**
+     * Adds an extension to a project. This API is only available through JWT token authentication.
+     * @summary Add extension to project
+     * @param projectId Project ID
+     * @param addProjectActiveExtensionRequest
+     */
+    addProjectActiveExtension(projectId: number, addProjectActiveExtensionRequest: AddProjectActiveExtensionRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Add an API key. If you set `developmentKey` to `true` this flag will be removed from the current development API key. For OAuth-based third-party integrations, prefer `/api/{projectId}/apikeys/ingestiononly`.
      * @summary Add API key
@@ -294,6 +310,15 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GetCsvWizardUploadedFileInfo>;
+    /**
+     * Only available when authenticating with a project API key. Returns the current role and project ID that you\'re authenticated with.
+     * @summary Get info about current API key
+     */
+    getCurrentApiKeyInfo(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetCurrentApiKeyInfoResponse>;
     /**
      * Retrieve the HMAC development key for a project. This key are specifically marked to be used during development. This key can be `undefined` if no development keys are set.
      * @summary Get HMAC development key
@@ -325,6 +350,16 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GetAIActionResponse>;
+    /**
+     * Lists all extensions that are active for this project.
+     * @summary List active extensions
+     * @param projectId Project ID
+     */
+    getProjectActiveExtensions(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetProjectActiveExtensionsResponse>;
     /**
      * Get a list of axes that are present in the training data.
      * @summary Get data axes summary
@@ -491,6 +526,16 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<ListApiKeysResponse>;
+    /**
+     * Lists all available extensions that can be added to this project.
+     * @summary List available extensions
+     * @param projectId Project ID
+     */
+    listProjectAvailableExtensions(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListProjectAvailableExtensionsResponse>;
     /**
      * Retrieve all HMAC keys.
      * @summary Get HMAC keys
@@ -598,6 +643,17 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Removes an existing extension from a project.
+     * @summary Remove extension from project
+     * @param projectId Project ID
+     * @param extensionId Extension ID
+     */
+    removeProjectActiveExtension(projectId: number, extensionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<RemoveProjectActiveExtensionResponse>;
     /**
      * Revoke an API key. Note that if you revoke the development API key some services (such as automatic provisioning of devices through the serial daemon) will no longer work.
      * @summary Revoke API key

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

@@ -166,6 +166,74 @@ class ProjectsApi {
         const response = await fetch(url, requestOptions);
         return this.handleResponse(response, 'EntityCreatedResponse');
     }
+    /**
+     * Adds an extension to a project. This API is only available through JWT token authentication.
+     * @summary Add extension to project
+     * @param projectId Project ID
+     * @param addProjectActiveExtensionRequest
+     */
+    async addProjectActiveExtension(projectId, addProjectActiveExtensionRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/extensions/active/add'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            'User-Agent': 'edgeimpulse-api nodejs',
+            'Content-Type': 'application/json',
+            ...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 addProjectActiveExtension.');
+        }
+        // verify required parameter 'addProjectActiveExtensionRequest' is not null or undefined
+        if (addProjectActiveExtensionRequest === null || addProjectActiveExtensionRequest === undefined) {
+            throw new Error('Required parameter addProjectActiveExtensionRequest was null or undefined when calling addProjectActiveExtension.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'POST',
+            headers: { ...localVarHeaderParams },
+        };
+        localVarRequestOptions.body = JSON.stringify(addProjectActiveExtensionRequest);
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        return this.handleResponse(response, 'GenericApiResponse');
+    }
     /**
      * Add an API key. If you set `developmentKey` to `true` this flag will be removed from the current development API key. For OAuth-based third-party integrations, prefer `/api/{projectId}/apikeys/ingestiononly`.
      * @summary Add API key
@@ -1153,6 +1221,62 @@ class ProjectsApi {
         const response = await fetch(url, requestOptions);
         return this.handleResponse(response, 'GetCsvWizardUploadedFileInfo');
     }
+    /**
+     * Only available when authenticating with a project API key. Returns the current role and project ID that you\'re authenticated with.
+     * @summary Get info about current API key
+     */
+    async getCurrentApiKeyInfo(options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/projects/api-key-info';
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            'User-Agent': 'edgeimpulse-api nodejs',
+            'Content-Type': 'application/json',
+            ...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;
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'GET',
+            headers: { ...localVarHeaderParams },
+        };
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        return this.handleResponse(response, 'GetCurrentApiKeyInfoResponse');
+    }
     /**
      * Retrieve the HMAC development key for a project. This key are specifically marked to be used during development. This key can be `undefined` if no development keys are set.
      * @summary Get HMAC development key
@@ -1343,6 +1467,68 @@ class ProjectsApi {
         const response = await fetch(url, requestOptions);
         return this.handleResponse(response, 'GetAIActionResponse');
     }
+    /**
+     * Lists all extensions that are active for this project.
+     * @summary List active extensions
+     * @param projectId Project ID
+     */
+    async getProjectActiveExtensions(projectId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/extensions/active'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            'User-Agent': 'edgeimpulse-api nodejs',
+            'Content-Type': 'application/json',
+            ...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 getProjectActiveExtensions.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'GET',
+            headers: { ...localVarHeaderParams },
+        };
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        return this.handleResponse(response, 'GetProjectActiveExtensionsResponse');
+    }
     /**
      * Get a list of axes that are present in the training data.
      * @summary Get data axes summary
@@ -2359,6 +2545,68 @@ class ProjectsApi {
         const response = await fetch(url, requestOptions);
         return this.handleResponse(response, 'ListApiKeysResponse');
     }
+    /**
+     * Lists all available extensions that can be added to this project.
+     * @summary List available extensions
+     * @param projectId Project ID
+     */
+    async listProjectAvailableExtensions(projectId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/extensions/available'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            'User-Agent': 'edgeimpulse-api nodejs',
+            'Content-Type': 'application/json',
+            ...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 listProjectAvailableExtensions.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'GET',
+            headers: { ...localVarHeaderParams },
+        };
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        return this.handleResponse(response, 'ListProjectAvailableExtensionsResponse');
+    }
     /**
      * Retrieve all HMAC keys.
      * @summary Get HMAC keys
@@ -2975,6 +3223,74 @@ class ProjectsApi {
         const response = await fetch(url, requestOptions);
         return this.handleResponse(response, 'GenericApiResponse');
     }
+    /**
+     * Removes an existing extension from a project.
+     * @summary Remove extension from project
+     * @param projectId Project ID
+     * @param extensionId Extension ID
+     */
+    async removeProjectActiveExtension(projectId, extensionId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/extensions/active/{extensionId}'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'extensionId' + '}', encodeURIComponent(String(extensionId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            'User-Agent': 'edgeimpulse-api nodejs',
+            'Content-Type': 'application/json',
+            ...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 removeProjectActiveExtension.');
+        }
+        // verify required parameter 'extensionId' is not null or undefined
+        if (extensionId === null || extensionId === undefined) {
+            throw new Error('Required parameter extensionId was null or undefined when calling removeProjectActiveExtension.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'DELETE',
+            headers: { ...localVarHeaderParams },
+        };
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        return this.handleResponse(response, 'RemoveProjectActiveExtensionResponse');
+    }
     /**
      * Revoke an API key. Note that if you revoke the development API key some services (such as automatic provisioning of devices through the serial daemon) will no longer work.
      * @summary Revoke API key