edge-impulse-api 1.95.10 → 1.95.11

package/build/browser/edge-impulse-api.d.ts

@@ -2774,7 +2774,7 @@ export class DeploymentApi {
     setApiKey(key: DeploymentApiApiKeys, value: string | undefined): void;
     set accessToken(token: string);
     /**
-     * Create a deployment job for a _public_ project. You can only create deployments for \"wasm\" and \"wasm-browser-simd\" deployment types. If a deployment already exists, jobId is null. If a deployment did not exist, or a job is created, jobId is set to an integer, and you can get updates via `getPublicDeploymentStatus`. When this step is complete use `downloadHistoricDeployment` to download the artefacts using deploymentVersion. Updates are _NOT_ streamed over the websocket API (for security reasons); but can be obtained via `getPublicDeploymentStatus`.
+     * Create a deployment job for a _public_ project. If a deployment already exists, jobId is null. If a deployment did not exist, or a job is created, jobId is set to an integer, and you can get updates via `getPublicDeploymentStatus`. When this step is complete use `downloadHistoricDeployment` to download the artefacts using deploymentVersion. Updates are _NOT_ streamed over the websocket API (for security reasons); but can be obtained via `getPublicDeploymentStatus`.
      * @summary Build deployment (public)
      * @param projectId Project ID
      * @param buildPublicDeploymentJobRequest
@@ -4686,7 +4686,7 @@ export class JobsApi {
         }) => void;
     }): Promise<StartJobResponse>;
     /**
-     * Create a new version of the project. This stores all data and configuration offsite. If you have access to the enterprise version of Edge Impulse you can store your data in your own storage buckets (only through JWT token authentication).
+     * Create a new version of the project. This stores all data and configuration offsite. If you have access to the enterprise version of Edge Impulse you can store your data in your own storage buckets (only through JWT token authentication). OAuth requests that set makePublic to true also require the projects:versions:public:create scope.
      * @summary Version project
      * @param projectId Project ID
      * @param projectVersionRequest
@@ -5973,7 +5973,7 @@ export type addOrganizationExtensionBlockFormParams = {
     repositoryUrl?: string;
     logo?: RequestFile;
     navbarIcon?: string;
-    navbarLocation: string;
+    navbarLocation: ExtensionNavbarLocation;
     requiredApiKeyRole: ProjectApiKeyRole;
     visibility?: ExtensionVisibility;
     publicProjectTierAvailability?: PublicProjectTierAvailability;
@@ -6007,7 +6007,7 @@ export type updateOrganizationExtensionBlockFormParams = {
     repositoryUrl?: string;
     logo?: RequestFile;
     navbarIcon?: string;
-    navbarLocation?: string;
+    navbarLocation?: ExtensionNavbarLocation;
     requiredApiKeyRole?: ProjectApiKeyRole;
     visibility?: ExtensionVisibility;
     publicProjectTierAvailability?: PublicProjectTierAvailability;
@@ -6088,7 +6088,7 @@ export class OrganizationBlocksApi {
      * @param name Extension block name.
      * @param description Extension block description.
      * @param url URL loaded by the extension.
-     * @param navbarLocation Studio navigation location for the extension.
+     * @param navbarLocation
      * @param requiredApiKeyRole
      * @param onlyAvailableInProjectId Required if \\\&quot;visibility\\\&quot; is \\\&quot;project\\\&quot;. If set, this extension is scoped to this specific project.
      * @param repositoryUrl Optional source repository URL for the extension.
@@ -6550,7 +6550,7 @@ export class OrganizationBlocksApi {
      * @param repositoryUrl Optional source repository URL for the extension.
      * @param logo Optional logo image for the extension.
      * @param navbarIcon Optional Font Awesome icon class for the navigation item.
-     * @param navbarLocation Studio navigation location for the extension.
+     * @param navbarLocation
      * @param requiredApiKeyRole
      * @param visibility
      * @param publicProjectTierAvailability
@@ -14577,10 +14577,7 @@ export type AddOrganizationExtensionBlockRequest = {
     * Optional Font Awesome icon class for the navigation item.
     */
     navbarIcon?: string;
-    /**
-    * Studio navigation location for the extension.
-    */
-    navbarLocation: AddOrganizationExtensionBlockRequestNavbarLocationEnum;
+    navbarLocation: ExtensionNavbarLocation;
     requiredApiKeyRole: ProjectApiKeyRole;
     visibility?: ExtensionVisibility;
     publicProjectTierAvailability?: PublicProjectTierAvailability;
@@ -14593,8 +14590,6 @@ export type AddOrganizationExtensionBlockRequest = {
     */
     blockNoLongerAvailableReason?: string;
 };
-export type AddOrganizationExtensionBlockRequestNavbarLocationEnum = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
-export const AddOrganizationExtensionBlockRequestNavbarLocationEnumValues: string[];
 
 
 export type AddOrganizationSecretRequest = {
@@ -19832,7 +19827,7 @@ export type Extension = {
     publicProjectTierAvailability: PublicProjectTierAvailability;
     url: string;
     repositoryUrl?: string;
-    navbarLocation: ExtensionNavbarLocationEnum;
+    navbarLocation: ExtensionNavbarLocation;
     lastUpdated: Date;
     lastUpdatedByUser?: CreatedUpdatedByUser;
     /**
@@ -19848,8 +19843,13 @@ export type Extension = {
     navbarIcon?: string;
     requiredApiKeyRole: ProjectApiKeyRole;
 };
-export type ExtensionNavbarLocationEnum = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
-export const ExtensionNavbarLocationEnumValues: string[];
+
+
+/**
+* Studio navigation location for the extension.
+*/
+export type ExtensionNavbarLocation = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'upload_model' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
+export const ExtensionNavbarLocationValues: string[];
 
 
 /**
@@ -20072,6 +20072,10 @@ export type GetAllImpulsesResponse = {
     */
     error?: string;
     impulses: Impulse[];
+    /**
+    * The maximum number of impulses that you can create in this project. If unlimited, then this value is set to -1.
+    */
+    maxImpulseCount: number;
 };
 
 
@@ -24183,7 +24187,7 @@ export type NeighborsScore = {
 };
 
 
-export type OAuthScope = 'ai-actions:create' | 'ai-actions:delete' | 'ai-actions:read' | 'ai-actions:update' | 'blocks:read' | 'blocks:create' | 'blocks:update' | 'blocks:delete' | 'classify:read' | 'classify:run' | 'csv-wizard:read' | 'csv-wizard:update' | 'deployments:create' | 'deployments:read' | 'deployments:update' | 'devices:create' | 'devices:delete' | 'devices:read' | 'devices:update' | 'dsp:read' | 'dsp:run' | 'dsp:update' | 'impulse:create' | 'impulse:delete' | 'impulse:read' | 'impulse:update' | 'jobs:cancel' | 'jobs:read' | 'jobs:run' | 'jobs:update' | 'optimization:delete' | 'optimization:read' | 'optimization:run' | 'optimization:update' | 'performance-calibration:read' | 'performance-calibration:run' | 'performance-calibration:update' | 'post-processing:read' | 'post-processing:run' | 'post-processing:update' | 'learn:read' | 'learn:run' | 'learn:update' | 'organizations:read' | 'organizations:data:read' | 'organizations:data:create' | 'organizations:data:update' | 'organizations:data:delete' | 'organizations:pipelines:read' | 'organizations:pipelines:create' | 'organizations:pipelines:update' | 'organizations:pipelines:delete' | 'organizations:pipelines:run' | 'organizations:transformation-jobs:read' | 'organizations:transformation-jobs:create' | 'organizations:transformation-jobs:update' | 'organizations:transformation-jobs:delete' | 'organizations:transformation-jobs:run' | 'projects:apikeys:ingestiononly:create' | 'projects:apikeys:ingestiononly:delete' | 'projects:create' | 'projects:delete' | 'projects:monitoring:write' | 'projects:monitoring:update' | 'projects:monitoring:read' | 'projects:monitoring:delete' | 'projects:read' | 'projects:update' | 'projects:versions:create' | 'projects:versions:delete' | 'projects:versions:read' | 'projects:versions:update' | 'projects:data:delete' | 'projects:data:read' | 'projects:data:update' | 'user:read';
+export type OAuthScope = 'ai-actions:create' | 'ai-actions:delete' | 'ai-actions:read' | 'ai-actions:update' | 'blocks:read' | 'blocks:create' | 'blocks:update' | 'blocks:delete' | 'classify:read' | 'classify:run' | 'csv-wizard:read' | 'csv-wizard:update' | 'deployments:create' | 'deployments:read' | 'deployments:update' | 'devices:create' | 'devices:delete' | 'devices:read' | 'devices:update' | 'dsp:read' | 'dsp:run' | 'dsp:update' | 'impulse:create' | 'impulse:delete' | 'impulse:read' | 'impulse:update' | 'jobs:cancel' | 'jobs:read' | 'jobs:run' | 'jobs:update' | 'optimization:delete' | 'optimization:read' | 'optimization:run' | 'optimization:update' | 'performance-calibration:read' | 'performance-calibration:run' | 'performance-calibration:update' | 'post-processing:read' | 'post-processing:run' | 'post-processing:update' | 'learn:read' | 'learn:run' | 'learn:update' | 'organizations:read' | 'organizations:data:read' | 'organizations:data:create' | 'organizations:data:update' | 'organizations:data:delete' | 'organizations:pipelines:read' | 'organizations:pipelines:create' | 'organizations:pipelines:update' | 'organizations:pipelines:delete' | 'organizations:pipelines:run' | 'organizations:transformation-jobs:read' | 'organizations:transformation-jobs:create' | 'organizations:transformation-jobs:update' | 'organizations:transformation-jobs:delete' | 'organizations:transformation-jobs:run' | 'projects:apikeys:ingestiononly:create' | 'projects:apikeys:ingestiononly:delete' | 'projects:create' | 'projects:delete' | 'projects:monitoring:write' | 'projects:monitoring:update' | 'projects:monitoring:read' | 'projects:monitoring:delete' | 'projects:read' | 'projects:update' | 'projects:versions:create' | 'projects:versions:delete' | 'projects:versions:public:create' | 'projects:versions:read' | 'projects:versions:update' | 'projects:data:delete' | 'projects:data:read' | 'projects:data:update' | 'user:read';
 export const OAuthScopeValues: string[];
 
 
@@ -27295,7 +27299,7 @@ export type ProjectExtension = {
     publicProjectTierAvailability: PublicProjectTierAvailability;
     url: string;
     repositoryUrl?: string;
-    navbarLocation: ProjectExtensionNavbarLocationEnum;
+    navbarLocation: ExtensionNavbarLocation;
     lastUpdated: Date;
     lastUpdatedByUser?: CreatedUpdatedByUser;
     /**
@@ -27313,8 +27317,6 @@ export type ProjectExtension = {
     addedToProject: Date;
     addedToProjectByUser?: CreatedUpdatedByUser;
 };
-export type ProjectExtensionNavbarLocationEnum = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
-export const ProjectExtensionNavbarLocationEnumValues: string[];
 
 
 export type ProjectHmacKey = {
@@ -30157,10 +30159,7 @@ export type UpdateOrganizationExtensionBlockRequest = {
     * Optional Font Awesome icon class for the navigation item.
     */
     navbarIcon?: string;
-    /**
-    * Studio navigation location for the extension.
-    */
-    navbarLocation?: UpdateOrganizationExtensionBlockRequestNavbarLocationEnum;
+    navbarLocation?: ExtensionNavbarLocation;
     requiredApiKeyRole?: ProjectApiKeyRole;
     visibility?: ExtensionVisibility;
     publicProjectTierAvailability?: PublicProjectTierAvailability;
@@ -30173,8 +30172,6 @@ export type UpdateOrganizationExtensionBlockRequest = {
     */
     blockNoLongerAvailableReason?: string;
 };
-export type UpdateOrganizationExtensionBlockRequestNavbarLocationEnum = 'project' | 'devices' | 'data_acquisition' | 'experiments' | 'create_impulse' | 'dsp_block' | 'learn_block' | 'live_classification' | 'model_testing' | 'deployment' | 'impulse' | 'versioning';
-export const UpdateOrganizationExtensionBlockRequestNavbarLocationEnumValues: string[];
 
 
 export type UpdateOrganizationPortalResponse = {

package/build/browser/edge-impulse-api.js

@@ -12599,7 +12599,7 @@ class DeploymentApi {
         this.authentications.OAuth2.accessToken = token;
     }
     /**
-     * Create a deployment job for a _public_ project. You can only create deployments for \"wasm\" and \"wasm-browser-simd\" deployment types. If a deployment already exists, jobId is null. If a deployment did not exist, or a job is created, jobId is set to an integer, and you can get updates via `getPublicDeploymentStatus`. When this step is complete use `downloadHistoricDeployment` to download the artefacts using deploymentVersion. Updates are _NOT_ streamed over the websocket API (for security reasons); but can be obtained via `getPublicDeploymentStatus`.
+     * Create a deployment job for a _public_ project. If a deployment already exists, jobId is null. If a deployment did not exist, or a job is created, jobId is set to an integer, and you can get updates via `getPublicDeploymentStatus`. When this step is complete use `downloadHistoricDeployment` to download the artefacts using deploymentVersion. Updates are _NOT_ streamed over the websocket API (for security reasons); but can be obtained via `getPublicDeploymentStatus`.
      * @summary Build deployment (public)
      * @param projectId Project ID
      * @param buildPublicDeploymentJobRequest
@@ -21306,7 +21306,7 @@ class JobsApi {
         return resp;
     }
     /**
-     * Create a new version of the project. This stores all data and configuration offsite. If you have access to the enterprise version of Edge Impulse you can store your data in your own storage buckets (only through JWT token authentication).
+     * Create a new version of the project. This stores all data and configuration offsite. If you have access to the enterprise version of Edge Impulse you can store your data in your own storage buckets (only through JWT token authentication). OAuth requests that set makePublic to true also require the projects:versions:public:create scope.
      * @summary Version project
      * @param projectId Project ID
      * @param projectVersionRequest
@@ -27525,7 +27525,7 @@ class OrganizationBlocksApi {
      * @param name Extension block name.
      * @param description Extension block description.
      * @param url URL loaded by the extension.
-     * @param navbarLocation Studio navigation location for the extension.
+     * @param navbarLocation
      * @param requiredApiKeyRole
      * @param onlyAvailableInProjectId Required if \\\"visibility\\\" is \\\"project\\\". If set, this extension is scoped to this specific project.
      * @param repositoryUrl Optional source repository URL for the extension.
@@ -27625,7 +27625,7 @@ class OrganizationBlocksApi {
         }
         if (params.navbarLocation !== undefined) {
             if (params.navbarLocation !== null && params.navbarLocation !== undefined) {
-                localVarFormParams = (0, models_1.appendFormField)(localVarFormParams, 'navbarLocation', (0, models_1.serializeFormDataValue)(params.navbarLocation, 'string'));
+                localVarFormParams = (0, models_1.appendFormField)(localVarFormParams, 'navbarLocation', (0, models_1.serializeFormDataValue)(params.navbarLocation, 'ExtensionNavbarLocation'));
             }
         }
         if (params.requiredApiKeyRole !== undefined) {
@@ -30059,7 +30059,7 @@ class OrganizationBlocksApi {
      * @param repositoryUrl Optional source repository URL for the extension.
      * @param logo Optional logo image for the extension.
      * @param navbarIcon Optional Font Awesome icon class for the navigation item.
-     * @param navbarLocation Studio navigation location for the extension.
+     * @param navbarLocation
      * @param requiredApiKeyRole
      * @param visibility
      * @param publicProjectTierAvailability
@@ -30140,7 +30140,7 @@ class OrganizationBlocksApi {
         }
         if (params.navbarLocation !== undefined) {
             if (params.navbarLocation !== null && params.navbarLocation !== undefined) {
-                localVarFormParams = (0, models_1.appendFormField)(localVarFormParams, 'navbarLocation', (0, models_1.serializeFormDataValue)(params.navbarLocation, 'string'));
+                localVarFormParams = (0, models_1.appendFormField)(localVarFormParams, 'navbarLocation', (0, models_1.serializeFormDataValue)(params.navbarLocation, 'ExtensionNavbarLocation'));
             }
         }
         if (params.requiredApiKeyRole !== undefined) {
@@ -65089,8 +65089,6 @@ define("library/sdk/model/addOrganizationExtensionBlockRequest", ["require", "ex
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AddOrganizationExtensionBlockRequestNavbarLocationEnumValues = void 0;
-exports.AddOrganizationExtensionBlockRequestNavbarLocationEnumValues = ['project', 'devices', 'data_acquisition', 'experiments', 'create_impulse', 'dsp_block', 'learn_block', 'live_classification', 'model_testing', 'deployment', 'impulse', 'versioning'];
 });
 
 
@@ -67038,8 +67036,15 @@ define("library/sdk/model/extension", ["require", "exports"], function (require,
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtensionNavbarLocationEnumValues = void 0;
-exports.ExtensionNavbarLocationEnumValues = ['project', 'devices', 'data_acquisition', 'experiments', 'create_impulse', 'dsp_block', 'learn_block', 'live_classification', 'model_testing', 'deployment', 'impulse', 'versioning'];
+});
+
+
+define("library/sdk/model/extensionNavbarLocation", ["require", "exports"], function (require, exports) {
+"use strict";
+// Generated by studio/openapi/generate-models/convert.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionNavbarLocationValues = void 0;
+exports.ExtensionNavbarLocationValues = ['project', 'devices', 'data_acquisition', 'experiments', 'create_impulse', 'upload_model', 'dsp_block', 'learn_block', 'live_classification', 'model_testing', 'deployment', 'impulse', 'versioning'];
 });
 
 
@@ -68955,6 +68960,7 @@ __exportStar(require("./exportKerasBlockDataRequest"), exports);
 __exportStar(require("./exportOriginalDataRequest"), exports);
 __exportStar(require("./exportWavDataRequest"), exports);
 __exportStar(require("./extension"), exports);
+__exportStar(require("./extensionNavbarLocation"), exports);
 __exportStar(require("./extensionVisibility"), exports);
 __exportStar(require("./feature"), exports);
 __exportStar(require("./finalizeCustomBlockUploadRequest"), exports);
@@ -69769,7 +69775,7 @@ define("library/sdk/model/oAuthScope", ["require", "exports"], function (require
 // Generated by studio/openapi/generate-models/convert.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OAuthScopeValues = void 0;
-exports.OAuthScopeValues = ['ai-actions:create', 'ai-actions:delete', 'ai-actions:read', 'ai-actions:update', 'blocks:read', 'blocks:create', 'blocks:update', 'blocks:delete', 'classify:read', 'classify:run', 'csv-wizard:read', 'csv-wizard:update', 'deployments:create', 'deployments:read', 'deployments:update', 'devices:create', 'devices:delete', 'devices:read', 'devices:update', 'dsp:read', 'dsp:run', 'dsp:update', 'impulse:create', 'impulse:delete', 'impulse:read', 'impulse:update', 'jobs:cancel', 'jobs:read', 'jobs:run', 'jobs:update', 'optimization:delete', 'optimization:read', 'optimization:run', 'optimization:update', 'performance-calibration:read', 'performance-calibration:run', 'performance-calibration:update', 'post-processing:read', 'post-processing:run', 'post-processing:update', 'learn:read', 'learn:run', 'learn:update', 'organizations:read', 'organizations:data:read', 'organizations:data:create', 'organizations:data:update', 'organizations:data:delete', 'organizations:pipelines:read', 'organizations:pipelines:create', 'organizations:pipelines:update', 'organizations:pipelines:delete', 'organizations:pipelines:run', 'organizations:transformation-jobs:read', 'organizations:transformation-jobs:create', 'organizations:transformation-jobs:update', 'organizations:transformation-jobs:delete', 'organizations:transformation-jobs:run', 'projects:apikeys:ingestiononly:create', 'projects:apikeys:ingestiononly:delete', 'projects:create', 'projects:delete', 'projects:monitoring:write', 'projects:monitoring:update', 'projects:monitoring:read', 'projects:monitoring:delete', 'projects:read', 'projects:update', 'projects:versions:create', 'projects:versions:delete', 'projects:versions:read', 'projects:versions:update', 'projects:data:delete', 'projects:data:read', 'projects:data:update', 'user:read'];
+exports.OAuthScopeValues = ['ai-actions:create', 'ai-actions:delete', 'ai-actions:read', 'ai-actions:update', 'blocks:read', 'blocks:create', 'blocks:update', 'blocks:delete', 'classify:read', 'classify:run', 'csv-wizard:read', 'csv-wizard:update', 'deployments:create', 'deployments:read', 'deployments:update', 'devices:create', 'devices:delete', 'devices:read', 'devices:update', 'dsp:read', 'dsp:run', 'dsp:update', 'impulse:create', 'impulse:delete', 'impulse:read', 'impulse:update', 'jobs:cancel', 'jobs:read', 'jobs:run', 'jobs:update', 'optimization:delete', 'optimization:read', 'optimization:run', 'optimization:update', 'performance-calibration:read', 'performance-calibration:run', 'performance-calibration:update', 'post-processing:read', 'post-processing:run', 'post-processing:update', 'learn:read', 'learn:run', 'learn:update', 'organizations:read', 'organizations:data:read', 'organizations:data:create', 'organizations:data:update', 'organizations:data:delete', 'organizations:pipelines:read', 'organizations:pipelines:create', 'organizations:pipelines:update', 'organizations:pipelines:delete', 'organizations:pipelines:run', 'organizations:transformation-jobs:read', 'organizations:transformation-jobs:create', 'organizations:transformation-jobs:update', 'organizations:transformation-jobs:delete', 'organizations:transformation-jobs:run', 'projects:apikeys:ingestiononly:create', 'projects:apikeys:ingestiononly:delete', 'projects:create', 'projects:delete', 'projects:monitoring:write', 'projects:monitoring:update', 'projects:monitoring:read', 'projects:monitoring:delete', 'projects:read', 'projects:update', 'projects:versions:create', 'projects:versions:delete', 'projects:versions:public:create', 'projects:versions:read', 'projects:versions:update', 'projects:data:delete', 'projects:data:read', 'projects:data:update', 'user:read'];
 });
 
 
@@ -70724,8 +70730,6 @@ define("library/sdk/model/projectExtension", ["require", "exports"], function (r
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectExtensionNavbarLocationEnumValues = void 0;
-exports.ProjectExtensionNavbarLocationEnumValues = ['project', 'devices', 'data_acquisition', 'experiments', 'create_impulse', 'dsp_block', 'learn_block', 'live_classification', 'model_testing', 'deployment', 'impulse', 'versioning'];
 });
 
 
@@ -71829,8 +71833,6 @@ define("library/sdk/model/updateOrganizationExtensionBlockRequest", ["require",
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateOrganizationExtensionBlockRequestNavbarLocationEnumValues = void 0;
-exports.UpdateOrganizationExtensionBlockRequestNavbarLocationEnumValues = ['project', 'devices', 'data_acquisition', 'experiments', 'create_impulse', 'dsp_block', 'learn_block', 'live_classification', 'model_testing', 'deployment', 'impulse', 'versioning'];
 });