edge-impulse-api 1.95.10 → 1.95.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/build/browser/edge-impulse-api.d.ts +22 -25
  2. package/build/browser/edge-impulse-api.js +17 -15
  3. package/build/browser/edge-impulse-api.js.map +1 -1
  4. package/build/library/sdk/api/deploymentApi.d.ts +1 -1
  5. package/build/library/sdk/api/deploymentApi.js +1 -1
  6. package/build/library/sdk/api/jobsApi.d.ts +1 -1
  7. package/build/library/sdk/api/jobsApi.js +1 -1
  8. package/build/library/sdk/api/organizationBlocksApi.d.ts +5 -4
  9. package/build/library/sdk/api/organizationBlocksApi.js +4 -4
  10. package/build/library/sdk/api/organizationBlocksApi.js.map +1 -1
  11. package/build/library/sdk/model/addOrganizationExtensionBlockRequest.d.ts +2 -6
  12. package/build/library/sdk/model/addOrganizationExtensionBlockRequest.js +0 -2
  13. package/build/library/sdk/model/addOrganizationExtensionBlockRequest.js.map +1 -1
  14. package/build/library/sdk/model/extension.d.ts +2 -3
  15. package/build/library/sdk/model/extension.js +0 -2
  16. package/build/library/sdk/model/extension.js.map +1 -1
  17. package/build/library/sdk/model/extensionNavbarLocation.d.ts +5 -0
  18. package/build/library/sdk/model/extensionNavbarLocation.js +6 -0
  19. package/build/library/sdk/model/extensionNavbarLocation.js.map +1 -0
  20. package/build/library/sdk/model/getAllImpulsesResponse.d.ts +4 -0
  21. package/build/library/sdk/model/models.d.ts +1 -0
  22. package/build/library/sdk/model/models.js +1 -0
  23. package/build/library/sdk/model/models.js.map +1 -1
  24. package/build/library/sdk/model/oAuthScope.d.ts +1 -1
  25. package/build/library/sdk/model/oAuthScope.js +1 -1
  26. package/build/library/sdk/model/oAuthScope.js.map +1 -1
  27. package/build/library/sdk/model/projectExtension.d.ts +2 -3
  28. package/build/library/sdk/model/projectExtension.js +0 -2
  29. package/build/library/sdk/model/projectExtension.js.map +1 -1
  30. package/build/library/sdk/model/updateOrganizationExtensionBlockRequest.d.ts +2 -6
  31. package/build/library/sdk/model/updateOrganizationExtensionBlockRequest.js +0 -2
  32. package/build/library/sdk/model/updateOrganizationExtensionBlockRequest.js.map +1 -1
  33. package/package.json +1 -1
@@ -116,7 +116,7 @@ export declare class DeploymentApi {
116
116
  setApiKey(key: DeploymentApiApiKeys, value: string | undefined): void;
117
117
  set accessToken(token: string);
118
118
  /**
119
- * 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`.
119
+ * 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`.
120
120
  * @summary Build deployment (public)
121
121
  * @param projectId Project ID
122
122
  * @param buildPublicDeploymentJobRequest
@@ -99,7 +99,7 @@ class DeploymentApi {
99
99
  this.authentications.OAuth2.accessToken = token;
100
100
  }
101
101
  /**
102
- * 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`.
102
+ * 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`.
103
103
  * @summary Build deployment (public)
104
104
  * @param projectId Project ID
105
105
  * @param buildPublicDeploymentJobRequest
@@ -727,7 +727,7 @@ export declare class JobsApi {
727
727
  }) => void;
728
728
  }): Promise<StartJobResponse>;
729
729
  /**
730
- * 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).
730
+ * 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.
731
731
  * @summary Version project
732
732
  * @param projectId Project ID
733
733
  * @param projectVersionRequest
@@ -3231,7 +3231,7 @@ class JobsApi {
3231
3231
  return resp;
3232
3232
  }
3233
3233
  /**
3234
- * 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).
3234
+ * 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.
3235
3235
  * @summary Version project
3236
3236
  * @param projectId Project ID
3237
3237
  * @param projectVersionRequest
@@ -16,6 +16,7 @@ import { AddOrganizationTransferLearningBlockRequest } from '../model/addOrganiz
16
16
  import { AddOrganizationTransformationBlockRequest } from '../model/addOrganizationTransformationBlockRequest';
17
17
  import { EntityCreatedResponse } from '../model/entityCreatedResponse';
18
18
  import { ExportBlockResponse } from '../model/exportBlockResponse';
19
+ import { ExtensionNavbarLocation } from '../model/extensionNavbarLocation';
19
20
  import { ExtensionVisibility } from '../model/extensionVisibility';
20
21
  import { GenericApiResponse } from '../model/genericApiResponse';
21
22
  import { GetOrganizationDeployBlockResponse } from '../model/getOrganizationDeployBlockResponse';
@@ -71,7 +72,7 @@ export type addOrganizationExtensionBlockFormParams = {
71
72
  repositoryUrl?: string;
72
73
  logo?: RequestFile;
73
74
  navbarIcon?: string;
74
- navbarLocation: string;
75
+ navbarLocation: ExtensionNavbarLocation;
75
76
  requiredApiKeyRole: ProjectApiKeyRole;
76
77
  visibility?: ExtensionVisibility;
77
78
  publicProjectTierAvailability?: PublicProjectTierAvailability;
@@ -105,7 +106,7 @@ export type updateOrganizationExtensionBlockFormParams = {
105
106
  repositoryUrl?: string;
106
107
  logo?: RequestFile;
107
108
  navbarIcon?: string;
108
- navbarLocation?: string;
109
+ navbarLocation?: ExtensionNavbarLocation;
109
110
  requiredApiKeyRole?: ProjectApiKeyRole;
110
111
  visibility?: ExtensionVisibility;
111
112
  publicProjectTierAvailability?: PublicProjectTierAvailability;
@@ -186,7 +187,7 @@ export declare class OrganizationBlocksApi {
186
187
  * @param name Extension block name.
187
188
  * @param description Extension block description.
188
189
  * @param url URL loaded by the extension.
189
- * @param navbarLocation Studio navigation location for the extension.
190
+ * @param navbarLocation
190
191
  * @param requiredApiKeyRole
191
192
  * @param onlyAvailableInProjectId Required if \\\&quot;visibility\\\&quot; is \\\&quot;project\\\&quot;. If set, this extension is scoped to this specific project.
192
193
  * @param repositoryUrl Optional source repository URL for the extension.
@@ -648,7 +649,7 @@ export declare class OrganizationBlocksApi {
648
649
  * @param repositoryUrl Optional source repository URL for the extension.
649
650
  * @param logo Optional logo image for the extension.
650
651
  * @param navbarIcon Optional Font Awesome icon class for the navigation item.
651
- * @param navbarLocation Studio navigation location for the extension.
652
+ * @param navbarLocation
652
653
  * @param requiredApiKeyRole
653
654
  * @param visibility
654
655
  * @param publicProjectTierAvailability
@@ -379,7 +379,7 @@ class OrganizationBlocksApi {
379
379
  * @param name Extension block name.
380
380
  * @param description Extension block description.
381
381
  * @param url URL loaded by the extension.
382
- * @param navbarLocation Studio navigation location for the extension.
382
+ * @param navbarLocation
383
383
  * @param requiredApiKeyRole
384
384
  * @param onlyAvailableInProjectId Required if \\\&quot;visibility\\\&quot; is \\\&quot;project\\\&quot;. If set, this extension is scoped to this specific project.
385
385
  * @param repositoryUrl Optional source repository URL for the extension.
@@ -479,7 +479,7 @@ class OrganizationBlocksApi {
479
479
  }
480
480
  if (params.navbarLocation !== undefined) {
481
481
  if (params.navbarLocation !== null && params.navbarLocation !== undefined) {
482
- localVarFormParams = (0, models_1.appendFormField)(localVarFormParams, 'navbarLocation', (0, models_1.serializeFormDataValue)(params.navbarLocation, 'string'));
482
+ localVarFormParams = (0, models_1.appendFormField)(localVarFormParams, 'navbarLocation', (0, models_1.serializeFormDataValue)(params.navbarLocation, 'ExtensionNavbarLocation'));
483
483
  }
484
484
  }
485
485
  if (params.requiredApiKeyRole !== undefined) {
@@ -2913,7 +2913,7 @@ class OrganizationBlocksApi {
2913
2913
  * @param repositoryUrl Optional source repository URL for the extension.
2914
2914
  * @param logo Optional logo image for the extension.
2915
2915
  * @param navbarIcon Optional Font Awesome icon class for the navigation item.
2916
- * @param navbarLocation Studio navigation location for the extension.
2916
+ * @param navbarLocation
2917
2917
  * @param requiredApiKeyRole
2918
2918
  * @param visibility
2919
2919
  * @param publicProjectTierAvailability
@@ -2994,7 +2994,7 @@ class OrganizationBlocksApi {
2994
2994
  }
2995
2995
  if (params.navbarLocation !== undefined) {
2996
2996
  if (params.navbarLocation !== null && params.navbarLocation !== undefined) {
2997
- localVarFormParams = (0, models_1.appendFormField)(localVarFormParams, 'navbarLocation', (0, models_1.serializeFormDataValue)(params.navbarLocation, 'string'));
2997
+ localVarFormParams = (0, models_1.appendFormField)(localVarFormParams, 'navbarLocation', (0, models_1.serializeFormDataValue)(params.navbarLocation, 'ExtensionNavbarLocation'));
2998
2998
  }
2999
2999
  }
3000
3000
  if (params.requiredApiKeyRole !== undefined) {