edge-impulse-api 1.22.1 → 1.22.2

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

@@ -0,0 +1,149 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/// <reference types="node" />
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetPerformanceCalibrationGroundTruthResponse } from '../model/getPerformanceCalibrationGroundTruthResponse';
+import { GetPerformanceCalibrationParameterSetsResponse } from '../model/getPerformanceCalibrationParameterSetsResponse';
+import { GetPerformanceCalibrationParametersResponse } from '../model/getPerformanceCalibrationParametersResponse';
+import { GetPerformanceCalibrationRawResultResponse } from '../model/getPerformanceCalibrationRawResultResponse';
+import { GetPerformanceCalibrationStatusResponse } from '../model/getPerformanceCalibrationStatusResponse';
+import { PerformanceCalibrationSaveParameterSetRequest } from '../model/performanceCalibrationSaveParameterSetRequest';
+import { PerformanceCalibrationUploadLabeledAudioResponse } from '../model/performanceCalibrationUploadLabeledAudioResponse';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum PerformanceCalibrationApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type uploadLabeledAudioFormParams = {
+    zip: RequestFile;
+};
+export declare type PerformanceCalibrationApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class PerformanceCalibrationApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: PerformanceCalibrationApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: PerformanceCalibrationApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: PerformanceCalibrationApiOpts);
+    get opts(): PerformanceCalibrationApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: PerformanceCalibrationApiApiKeys, value: string | undefined): void;
+    /**
+     * Clears the current performance calibration parameters
+     * @summary Clear performance calibration parameters
+     * @param projectId Project ID
+     */
+    deletePerformanceCalibrationSavedParameters(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Get performance calibration ground truth data
+     * @summary Get ground truth
+     * @param projectId Project ID
+     */
+    getPerformanceCalibrationGroundTruth(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetPerformanceCalibrationGroundTruthResponse>;
+    /**
+     * Get performance calibration parameter sets
+     * @summary Get parameter sets
+     * @param projectId Project ID
+     */
+    getPerformanceCalibrationParameterSets(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetPerformanceCalibrationParameterSetsResponse>;
+    /**
+     * Get performance calibration raw result
+     * @summary Get raw result
+     * @param projectId Project ID
+     */
+    getPerformanceCalibrationRawResult(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetPerformanceCalibrationRawResultResponse>;
+    /**
+     * Get performance calibration stored parameters
+     * @summary Get parameters
+     * @param projectId Project ID
+     */
+    getPerformanceCalibrationSavedParameters(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetPerformanceCalibrationParametersResponse>;
+    /**
+     * Get performance calibration status
+     * @summary Get status
+     * @param projectId Project ID
+     */
+    getPerformanceCalibrationStatus(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetPerformanceCalibrationStatusResponse>;
+    /**
+     * Get the synthetic sample as a WAV file
+     * @summary Get WAV file
+     * @param projectId Project ID
+     */
+    getWavFile(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Set the current performance calibration parameters
+     * @summary Save performance calibration parameters
+     * @param projectId Project ID
+     * @param performanceCalibrationSaveParameterSetRequest
+     */
+    setPerformanceCalibrationSavedParameters(projectId: number, performanceCalibrationSaveParameterSetRequest: PerformanceCalibrationSaveParameterSetRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Upload a zip files with a wav file and its Label metadata to run performance calibration on it.
+     * @summary Upload Performance Calibration Audio files
+     * @param projectId Project ID
+     * @param zip
+     */
+    uploadLabeledAudio(projectId: number, params: uploadLabeledAudioFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<PerformanceCalibrationUploadLabeledAudioResponse>;
+}
+export {};

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

@@ -0,0 +1,485 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * 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 { 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 { LastModificationDateResponse } from '../model/lastModificationDateResponse';
+import { ListApiKeysResponse } from '../model/listApiKeysResponse';
+import { ListEmailResponse } from '../model/listEmailResponse';
+import { ListHmacKeysResponse } from '../model/listHmacKeysResponse';
+import { ListProjectsResponse } from '../model/listProjectsResponse';
+import { ListPublicProjectsResponse } from '../model/listPublicProjectsResponse';
+import { ListPublicVersionsResponse } from '../model/listPublicVersionsResponse';
+import { ListVersionsResponse } from '../model/listVersionsResponse';
+import { ProjectDataAxesSummaryResponse } from '../model/projectDataAxesSummaryResponse';
+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 { UpdateProjectRequest } from '../model/updateProjectRequest';
+import { UpdateProjectTagsRequest } from '../model/updateProjectTagsRequest';
+import { UpdateVersionRequest } from '../model/updateVersionRequest';
+import { UploadReadmeImageResponse } from '../model/uploadReadmeImageResponse';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum ProjectsApiApiKeys {
+    ApiKeyAuthentication = 0,
+    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, 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;
+    /**
+     * Add a collaborator to a project.
+     * @summary Add collaborator
+     * @param projectId Project ID
+     * @param addCollaboratorRequest
+     */
+    addCollaborator(projectId: number, addCollaboratorRequest: AddCollaboratorRequest, 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.
+     * @summary Add API key
+     * @param projectId Project ID
+     * @param addApiKeyRequest
+     */
+    addProjectApiKey(projectId: number, addApiKeyRequest: AddApiKeyRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Add an HMAC key. If you set `developmentKey` to `true` this flag will be removed from the current development HMAC key.
+     * @summary Add HMAC key
+     * @param projectId Project ID
+     * @param addHmacKeyRequest
+     */
+    addProjectHmacKey(projectId: number, addHmacKeyRequest: AddHmacKeyRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Create a new project. This API can only be called using a JWT token.
+     * @summary Create new project
+     * @param createProjectRequest
+     */
+    createProject(createProjectRequest: CreateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateProjectResponse>;
+    /**
+     * Remove the current project, and all data associated with it. This is irrevocable!
+     * @summary Remove project
+     * @param projectId Project ID
+     */
+    deleteProject(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Delete a version. This does not delete the version from cold storage.
+     * @summary Delete versions
+     * @param projectId Project ID
+     * @param versionId Version ID
+     */
+    deleteVersion(projectId: number, versionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Get all notes in project.
+     * @summary Get notes
+     * @param projectId Project ID
+     */
+    getNotes(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetNotesResponse>;
+    /**
+     * 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, queryParams: getProjectDataAxesSummaryQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProjectDataAxesSummaryResponse>;
+    /**
+     * List all information about this project.
+     * @summary Project information
+     * @param projectId Project ID
+     */
+    getProjectInfo(projectId: number, options?: {
+        headers: {
+            [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
+     * @param projectId Project ID
+     */
+    getProjectLastModificationDate(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<LastModificationDateResponse>;
+    /**
+     * Get the interval of the training data; if multiple intervals are present, the interval of the longest data item is returned.
+     * @summary Get the interval (in ms) of the training data
+     * @param projectId Project ID
+     */
+    getProjectRecommendedDataInterval(projectId: number, options?: {
+        headers: {
+            [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
+     * @param projectId Project ID
+     */
+    getSocketToken(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<SocketTokenResponse>;
+    /**
+     * 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
+     * @param projectId Project ID
+     */
+    launchGettingStartedWizard(projectId: number, options?: {
+        headers: {
+            [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
+     * @param projectId Project ID
+     */
+    listDevkeys(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<DevelopmentKeysResponse>;
+    /**
+     * Retrieve the downloads for a project.
+     * @summary Get downloads
+     * @param projectId Project ID
+     */
+    listDownloads(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProjectDownloadsResponse>;
+    /**
+     * Get a list of all emails sent by Edge Impulse regarding this project.
+     * @summary List emails
+     * @param projectId Project ID
+     */
+    listEmails(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListEmailResponse>;
+    /**
+     * Retrieve all API keys. This does **not** return the full API key, but only a portion (for security purposes). The development key will be returned in full, as it\'ll be set in devices and is thus not private.
+     * @summary Get API keys
+     * @param projectId Project ID
+     */
+    listProjectApiKeys(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListApiKeysResponse>;
+    /**
+     * Retrieve all HMAC keys.
+     * @summary Get HMAC keys
+     * @param projectId Project ID
+     */
+    listProjectHmacKeys(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListHmacKeysResponse>;
+    /**
+     * Retrieve list of active projects. If authenticating using JWT token this lists all the projects the user has access to, if authenticating using an API key, this only lists that project.
+     * @summary List active projects
+     */
+    listProjects(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListProjectsResponse>;
+    /**
+     * Retrieve the list of all public projects. You don\'t need any authentication for this method.
+     * @summary List public projects
+     * @param limit Maximum number of results
+     * @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(queryParams: listPublicProjectsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListPublicProjectsResponse>;
+    /**
+     * Get all public versions for this project. You don\'t need any authentication for this function.
+     * @summary List public versions
+     * @param projectId Project ID
+     */
+    listPublicVersions(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListPublicVersionsResponse>;
+    /**
+     * Get all versions for this project.
+     * @summary List versions
+     * @param projectId Project ID
+     */
+    listVersions(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListVersionsResponse>;
+    /**
+     * Make a public version private.
+     * @summary Make version private
+     * @param projectId Project ID
+     * @param versionId Version ID
+     */
+    makeVersionPrivate(projectId: number, versionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Remove a collaborator to a project. Note that you cannot invoke this function if only a single collaborator is present.
+     * @summary Remove collaborator
+     * @param projectId Project ID
+     * @param removeCollaboratorRequest
+     */
+    removeCollaborator(projectId: number, removeCollaboratorRequest: RemoveCollaboratorRequest, 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
+     * @param projectId Project ID
+     * @param apiKeyId API key ID
+     */
+    revokeProjectApiKey(projectId: number, apiKeyId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Revoke an HMAC key. Note that if you revoke the development key some services (such as automatic provisioning of devices through the serial daemon) will no longer work.
+     * @summary Remove HMAC key
+     * @param projectId Project ID
+     * @param hmacId Hmac key ID
+     */
+    revokeProjectHmacKey(projectId: number, hmacId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Change the job compute time limit for the project. This function is only available through a JWT token, and is not available to all users.
+     * @summary Set compute time limit
+     * @param projectId Project ID
+     * @param setProjectComputeTimeRequest
+     */
+    setProjectComputeTimeLimit(projectId: number, setProjectComputeTimeRequest: SetProjectComputeTimeRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Change the DSP file size limit for the project. This function is only available through a JWT token, and is not available to all users.
+     * @summary Set DSP file size limit
+     * @param projectId Project ID
+     * @param setProjectDspFileSizeRequest
+     */
+    setProjectFileSizeLimit(projectId: number, setProjectDspFileSizeRequest: SetProjectDspFileSizeRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Transfer ownership of a project to another user.
+     * @summary Transfer ownership (user)
+     * @param projectId Project ID
+     * @param addCollaboratorRequest
+     */
+    transferOwnership(projectId: number, addCollaboratorRequest: AddCollaboratorRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Transfer ownership of a project to another organization.
+     * @summary Transfer ownership (organization)
+     * @param projectId Project ID
+     * @param transferOwnershipOrganizationRequest
+     */
+    transferOwnershipOrganization(projectId: number, transferOwnershipOrganizationRequest: TransferOwnershipOrganizationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Update project properties such as name and logo.
+     * @summary Update project
+     * @param projectId Project ID
+     * @param updateProjectRequest
+     */
+    updateProject(projectId: number, updateProjectRequest: UpdateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Update the list of project tags.
+     * @summary Update tags
+     * @param projectId Project ID
+     * @param updateProjectTagsRequest
+     */
+    updateProjectTags(projectId: number, updateProjectTagsRequest: UpdateProjectTagsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Updates a version, this only updates fields that were set in the body.
+     * @summary Update version
+     * @param projectId Project ID
+     * @param versionId Version ID
+     * @param updateVersionRequest
+     */
+    updateVersion(projectId: number, versionId: number, updateVersionRequest: UpdateVersionRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Uploads an image to the user CDN and returns the path.
+     * @summary Upload image for readme
+     * @param projectId Project ID
+     * @param image
+     */
+    uploadReadmeImage(projectId: number, params: uploadReadmeImageFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<UploadReadmeImageResponse>;
+}
+export {};