edge-impulse-linux 1.4.2 → 1.4.4

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

@@ -12,10 +12,9 @@
 import { AddApiKeyRequest } from '../model/addApiKeyRequest';
 import { AddCollaboratorRequest } from '../model/addCollaboratorRequest';
 import { AddHmacKeyRequest } from '../model/addHmacKeyRequest';
-import { AddNoteRequest } from '../model/addNoteRequest';
-import { CreateNoteResponse } from '../model/createNoteResponse';
 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';
@@ -31,13 +30,13 @@ import { ProjectDataAxesSummaryResponse } from '../model/projectDataAxesSummaryR
 import { ProjectDataIntervalResponse } from '../model/projectDataIntervalResponse';
 import { ProjectDownloadsResponse } from '../model/projectDownloadsResponse';
 import { ProjectInfoResponse } from '../model/projectInfoResponse';
+import { ProjectInfoSummaryResponse } from '../model/projectInfoSummaryResponse';
+import { ProjectTrainingDataSummaryResponse } from '../model/projectTrainingDataSummaryResponse';
 import { RemoveCollaboratorRequest } from '../model/removeCollaboratorRequest';
 import { SetProjectComputeTimeRequest } from '../model/setProjectComputeTimeRequest';
 import { SetProjectDspFileSizeRequest } from '../model/setProjectDspFileSizeRequest';
 import { SocketTokenResponse } from '../model/socketTokenResponse';
 import { TransferOwnershipOrganizationRequest } from '../model/transferOwnershipOrganizationRequest';
-import { UpdateNoteRequest } from '../model/updateNoteRequest';
-import { UpdateNoteResponse } from '../model/updateNoteResponse';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { UpdateProjectTagsRequest } from '../model/updateProjectTagsRequest';
 import { UpdateVersionRequest } from '../model/updateVersionRequest';
@@ -50,20 +49,44 @@ export declare enum ProjectsApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+declare type getProjectDataAxesSummaryQueryParams = {
+    includeDisabled?: boolean;
+    includeNotProcessed?: boolean;
+};
+declare type getProjectTrainingDataSummaryQueryParams = {
+    includeDisabled?: boolean;
+    includeNotProcessed?: boolean;
+};
+declare type listPublicProjectsQueryParams = {
+    limit?: number;
+    offset?: number;
+    project?: string;
+};
+declare type uploadReadmeImageFormParams = {
+    image: RequestFile;
+};
+export declare type ProjectsApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
 export declare class ProjectsApi {
     protected _basePath: string;
     protected defaultHeaders: any;
     protected _useQuerystring: boolean;
+    protected _opts: ProjectsApiOpts;
     protected authentications: {
         default: Authentication;
         ApiKeyAuthentication: ApiKeyAuth;
         JWTAuthentication: ApiKeyAuth;
         JWTHttpHeaderAuthentication: ApiKeyAuth;
     };
-    constructor(basePath?: string);
+    constructor(basePath?: string, opts?: ProjectsApiOpts);
     set useQuerystring(value: boolean);
     set basePath(basePath: string);
     get basePath(): string;
+    set opts(opts: ProjectsApiOpts);
+    get opts(): ProjectsApiOpts;
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: ProjectsApiApiKeys, value: string | undefined): void;
     /**
@@ -77,17 +100,6 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
-    /**
-     * Add a note to a project.
-     * @summary Add note
-     * @param projectId Project ID
-     * @param addNoteRequest
-     */
-    addNote(projectId: number, addNoteRequest: AddNoteRequest, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<CreateNoteResponse>;
     /**
      * 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
@@ -155,8 +167,10 @@ export declare class ProjectsApi {
      * Get a list of axes that are present in the training data.
      * @summary Get data axes summary
      * @param projectId Project ID
+     * @param includeDisabled Whether to include disabled samples. Defaults to true
+     * @param includeNotProcessed Whether to include non-processed samples. Defaults to true
      */
-    getProjectDataAxesSummary(projectId: number, options?: {
+    getProjectDataAxesSummary(projectId: number, queryParams: getProjectDataAxesSummaryQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -171,6 +185,16 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<ProjectInfoResponse>;
+    /**
+     * List a summary about this project - available for public projects.
+     * @summary Public project information
+     * @param projectId Project ID
+     */
+    getProjectInfoSummary(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProjectInfoSummaryResponse>;
     /**
      * Get the last modification date for a project (will be upped when data is modified, or when an impulse is trained)
      * @summary Last modification
@@ -191,6 +215,18 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<ProjectDataIntervalResponse>;
+    /**
+     * Get summary of all data present in the training set. This returns the number of data items, the total length of all data, and the labels. This is similar to `dataSummary` in `ProjectInfoResponse` but allows you to exclude disabled items or items that are still processing.
+     * @summary Get data summary
+     * @param projectId Project ID
+     * @param includeDisabled Whether to include disabled samples. Defaults to true
+     * @param includeNotProcessed Whether to include non-processed samples. Defaults to true
+     */
+    getProjectTrainingDataSummary(projectId: number, queryParams: getProjectTrainingDataSummaryQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProjectTrainingDataSummaryResponse>;
     /**
      * Get a token to authenticate with the web socket interface.
      * @summary Get socket token
@@ -211,6 +247,16 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * List all development boards for a project
+     * @summary Development boards
+     * @param projectId Project ID
+     */
+    listDevelopmentBoards(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<DevelopmentBoardsResponse>;
     /**
      * Retrieve the development API and HMAC keys for a project. These keys are specifically marked to be used during development. These keys can be `undefined` if no development keys are set.
      * @summary Get development keys
@@ -277,7 +323,7 @@ export declare class ProjectsApi {
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      * @param project Only include projects that contain this string
      */
-    listPublicProjects(limit?: number, offset?: number, project?: string, options?: {
+    listPublicProjects(queryParams: listPublicProjectsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -324,17 +370,6 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
-    /**
-     * Remove a note from a project.
-     * @summary Remove note
-     * @param projectId Project ID
-     * @param noteId Note ID
-     */
-    removeNote(projectId: number, noteId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<GenericApiResponse>;
     /**
      * 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
@@ -401,18 +436,6 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
-    /**
-     * Update a note from a project.
-     * @summary Update note
-     * @param projectId Project ID
-     * @param noteId Note ID
-     * @param updateNoteRequest
-     */
-    updateNote(projectId: number, noteId: number, updateNoteRequest: UpdateNoteRequest, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<UpdateNoteResponse>;
     /**
      * Update project properties such as name and logo.
      * @summary Update project
@@ -453,9 +476,10 @@ export declare class ProjectsApi {
      * @param projectId Project ID
      * @param image
      */
-    uploadReadmeImage(projectId: number, image: RequestFile, options?: {
+    uploadReadmeImage(projectId: number, params: uploadReadmeImageFormParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<UploadReadmeImageResponse>;
 }
+export {};