edge-impulse-linux 1.4.1 → 1.4.3

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

@@ -14,10 +14,15 @@ import { AddOrganizationBucketRequest } from '../model/addOrganizationBucketRequ
 import { GenericApiResponse } from '../model/genericApiResponse';
 import { GetOrganizationDataItemResponse } from '../model/getOrganizationDataItemResponse';
 import { GetOrganizationDatasetResponse } from '../model/getOrganizationDatasetResponse';
+import { GetOrganizationProjectsDataCountResponse } from '../model/getOrganizationProjectsDataCountResponse';
 import { ListOrganizationBucketsResponse } from '../model/listOrganizationBucketsResponse';
 import { ListOrganizationDataResponse } from '../model/listOrganizationDataResponse';
 import { ListOrganizationFilesResponse } from '../model/listOrganizationFilesResponse';
+import { ListOrganizationProjectsDataResponse } from '../model/listOrganizationProjectsDataResponse';
 import { OrganizationAddDataFolderRequest } from '../model/organizationAddDataFolderRequest';
+import { OrganizationProjectsDataBatchDisableResponse } from '../model/organizationProjectsDataBatchDisableResponse';
+import { OrganizationProjectsDataBatchEnableResponse } from '../model/organizationProjectsDataBatchEnableResponse';
+import { OrganizationProjectsDataBatchRequest } from '../model/organizationProjectsDataBatchRequest';
 import { SetOrganizationDataDatasetRequest } from '../model/setOrganizationDataDatasetRequest';
 import { StartJobResponse } from '../model/startJobResponse';
 import { UpdateOrganizationBucketRequest } from '../model/updateOrganizationBucketRequest';
@@ -33,20 +38,118 @@ export declare enum OrganizationDataApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+declare type addOrganizationDataFileFormParams = {
+    files: Array<RequestFile>;
+};
+declare type addOrganizationDataItemFormParams = {
+    name: string;
+    bucketId?: number;
+    bucketName?: string;
+    dataset: string;
+    bucketPath?: string;
+    metadata: string;
+    files: Array<RequestFile>;
+};
+declare type changeDatasetOrganizationDataItemsQueryParams = {
+    dataset?: string;
+    dataIds: string;
+    filter?: string;
+};
+declare type clearChecklistOrganizationDataItemsQueryParams = {
+    dataset?: string;
+    dataIds: string;
+    filter?: string;
+};
+declare type deleteOrganizationDataFileQueryParams = {
+    fileName: string;
+};
+declare type deleteOrganizationDataItemsQueryParams = {
+    dataset?: string;
+    dataIds: string;
+    filter?: string;
+};
+declare type deleteOrganizationProjectsDataQueryParams = {
+    projectId?: number;
+    ids?: string;
+};
+declare type downloadOrganizationDataFileQueryParams = {
+    fileName: string;
+};
+declare type downloadOrganizationDataItemQueryParams = {
+    dataset?: string;
+    dataIds: string;
+    filter?: string;
+};
+declare type downloadOrganizationProjectsDataQueryParams = {
+    projectId?: number;
+    ids?: string;
+};
+declare type downloadOrganizationSingleDataItemQueryParams = {
+    filter?: string;
+};
+declare type getOrganizationDataItemQueryParams = {
+    filter?: string;
+};
+declare type getOrganizationProjectsDataCountQueryParams = {
+    projectId?: number;
+    filter?: string;
+    ids?: string;
+};
+declare type listOrganizationDataQueryParams = {
+    dataset?: string;
+    filter?: string;
+    limit?: number;
+    offset?: number;
+};
+declare type listOrganizationFilesQueryParams = {
+    dataset?: string;
+    filter?: string;
+    limit?: number;
+    offset?: number;
+};
+declare type listOrganizationProjectsDataQueryParams = {
+    projectId?: number;
+    filter?: string;
+    ids?: string;
+    limit?: number;
+    offset?: number;
+};
+declare type organizationBulkUpdateMetadataFormParams = {
+    dataset: string;
+    csvFile: RequestFile;
+};
+declare type organizationProjectsDataBulkUpdateMetadataFormParams = {
+    projectIds?: Array<number>;
+    csvFile: RequestFile;
+};
+declare type previewOrganizationDataFileQueryParams = {
+    fileName: string;
+};
+declare type refreshOrganizationDataQueryParams = {
+    dataset?: string;
+};
+export declare type OrganizationDataApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
 export declare class OrganizationDataApi {
     protected _basePath: string;
     protected defaultHeaders: any;
     protected _useQuerystring: boolean;
+    protected _opts: OrganizationDataApiOpts;
     protected authentications: {
         default: Authentication;
         ApiKeyAuthentication: ApiKeyAuth;
         JWTAuthentication: ApiKeyAuth;
         JWTHttpHeaderAuthentication: ApiKeyAuth;
     };
-    constructor(basePath?: string);
+    constructor(basePath?: string, opts?: OrganizationDataApiOpts);
     set useQuerystring(value: boolean);
     set basePath(basePath: string);
     get basePath(): string;
+    set opts(opts: OrganizationDataApiOpts);
+    get opts(): OrganizationDataApiOpts;
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: OrganizationDataApiApiKeys, value: string | undefined): void;
     /**
@@ -61,13 +164,13 @@ export declare class OrganizationDataApi {
         };
     }): Promise<GenericApiResponse>;
     /**
-     * Add a new file to an existing data item.  Don\'t trust the code generated by the widget, there are examples of using this API in Python, cURL and Node.js under the parameters.
+     * Add a new file to an existing data item.
      * @summary Add files
      * @param organizationId Organization ID
      * @param dataId Data ID
      * @param files
      */
-    addOrganizationDataFile(organizationId: number, dataId: number, files: Array<RequestFile>, options?: {
+    addOrganizationDataFile(organizationId: number, dataId: number, params: addOrganizationDataFileFormParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -84,7 +187,7 @@ export declare class OrganizationDataApi {
         };
     }): Promise<StartJobResponse>;
     /**
-     * Add a new data item. You can add a maximum of 10000 files directly through this API. Use `addOrganizationDataFile` to add additional files. Don\'t trust the code generated by the widget, there are examples of using this API in Python, cURL and Node.js under the parameters.
+     * Add a new data item. You can add a maximum of 10000 files directly through this API. Use `addOrganizationDataFile` to add additional files.
      * @summary Add new data
      * @param organizationId Organization ID
      * @param name
@@ -95,7 +198,7 @@ export declare class OrganizationDataApi {
      * @param bucketName Name of the bucket name (as an Edge Impulse name)
      * @param bucketPath Optional path in the bucket to create this data item (files are created under this path).
      */
-    addOrganizationDataItem(organizationId: number, name: string, dataset: string, metadata: string, files: Array<RequestFile>, bucketId?: number, bucketName?: string, bucketPath?: string, options?: {
+    addOrganizationDataItem(organizationId: number, params: addOrganizationDataItemFormParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -109,7 +212,7 @@ export declare class OrganizationDataApi {
      * @param dataset Selected dataset
      * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
      */
-    changeDatasetOrganizationDataItems(organizationId: number, dataIds: string, setOrganizationDataDatasetRequest: SetOrganizationDataDatasetRequest, dataset?: string, filter?: string, options?: {
+    changeDatasetOrganizationDataItems(organizationId: number, setOrganizationDataDatasetRequest: SetOrganizationDataDatasetRequest, queryParams: changeDatasetOrganizationDataItemsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -122,7 +225,7 @@ export declare class OrganizationDataApi {
      * @param dataset Selected dataset
      * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
      */
-    clearChecklistOrganizationDataItems(organizationId: number, dataIds: string, dataset?: string, filter?: string, options?: {
+    clearChecklistOrganizationDataItems(organizationId: number, queryParams: clearChecklistOrganizationDataItemsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -134,7 +237,7 @@ export declare class OrganizationDataApi {
      * @param dataId Data ID
      * @param fileName File name
      */
-    deleteOrganizationDataFile(organizationId: number, dataId: number, fileName: string, options?: {
+    deleteOrganizationDataFile(organizationId: number, dataId: number, queryParams: deleteOrganizationDataFileQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -158,11 +261,23 @@ export declare class OrganizationDataApi {
      * @param dataset Selected dataset
      * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
      */
-    deleteOrganizationDataItems(organizationId: number, dataIds: string, dataset?: string, filter?: string, options?: {
+    deleteOrganizationDataItems(organizationId: number, queryParams: deleteOrganizationDataItemsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<StartJobResponse>;
+    /**
+     * Delete data samples from organizational projects.
+     * @summary Delete projects data
+     * @param organizationId Organization ID
+     * @param projectId Unique identifier of the organizational project from where data samples will be fetched.
+     * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
+     */
+    deleteOrganizationProjectsData(organizationId: number, queryParams: deleteOrganizationProjectsDataQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Download a single file from a data item.
      * @summary Download file
@@ -170,7 +285,7 @@ export declare class OrganizationDataApi {
      * @param dataId Data ID
      * @param fileName File name
      */
-    downloadOrganizationDataFile(organizationId: number, dataId: number, fileName: string, options?: {
+    downloadOrganizationDataFile(organizationId: number, dataId: number, queryParams: downloadOrganizationDataFileQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -183,7 +298,19 @@ export declare class OrganizationDataApi {
      * @param dataset Selected dataset
      * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
      */
-    downloadOrganizationDataItem(organizationId: number, dataIds: string, dataset?: string, filter?: string, options?: {
+    downloadOrganizationDataItem(organizationId: number, queryParams: downloadOrganizationDataItemQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<Buffer>;
+    /**
+     * Download all selected project data items.
+     * @summary Download data
+     * @param organizationId Organization ID
+     * @param projectId Unique identifier of the organizational project from where data samples will be fetched.
+     * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
+     */
+    downloadOrganizationProjectsData(organizationId: number, queryParams: downloadOrganizationProjectsDataQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -195,7 +322,7 @@ export declare class OrganizationDataApi {
      * @param dataId Data ID
      * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
      */
-    downloadOrganizationSingleDataItem(organizationId: number, dataId: number, filter?: string, options?: {
+    downloadOrganizationSingleDataItem(organizationId: number, dataId: number, queryParams: downloadOrganizationSingleDataItemQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -207,7 +334,7 @@ export declare class OrganizationDataApi {
      * @param dataId Data ID
      * @param filter Data filter in SQL WHERE format, where you can reference \&#39;dataset\&#39;, \&#39;bucket\&#39;, \&#39;name\&#39;, \&#39;total_file_count\&#39;, \&#39;total_file_size\&#39;, \&#39;created\&#39; and any metadata label through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
      */
-    getOrganizationDataItem(organizationId: number, dataId: number, filter?: string, options?: {
+    getOrganizationDataItem(organizationId: number, dataId: number, queryParams: getOrganizationDataItemQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -223,6 +350,19 @@ export declare class OrganizationDataApi {
             [name: string]: string;
         };
     }): Promise<GetOrganizationDatasetResponse>;
+    /**
+     * Get the number of samples for all or for a specific organization project.
+     * @summary Get projects data count
+     * @param organizationId Organization ID
+     * @param projectId Unique identifier of the organizational project from where data samples will be fetched.
+     * @param filter Data filter in SQL WHERE format, where you can reference \&#39;filename\&#39;, \&#39;label\&#39;, \&#39;project_name\&#39;, \&#39;category\&#39;, \&#39;sensors\&#39;, \&#39;frequency\&#39;, and any metadata through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
+     * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
+     */
+    getOrganizationProjectsDataCount(organizationId: number, queryParams: getOrganizationProjectsDataCountQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationProjectsDataCountResponse>;
     /**
      * Hide a dataset (does not remove underlying data)
      * @summary Hide dataset
@@ -253,7 +393,7 @@ export declare class OrganizationDataApi {
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      */
-    listOrganizationData(organizationId: number, dataset?: string, filter?: string, limit?: number, offset?: number, options?: {
+    listOrganizationData(organizationId: number, queryParams: listOrganizationDataQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -267,11 +407,26 @@ export declare class OrganizationDataApi {
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      */
-    listOrganizationFiles(organizationId: number, dataset?: string, filter?: string, limit?: number, offset?: number, options?: {
+    listOrganizationFiles(organizationId: number, queryParams: listOrganizationFilesQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<ListOrganizationFilesResponse>;
+    /**
+     * Retrieve all the data samples from organizational projects.
+     * @summary Get projects data
+     * @param organizationId Organization ID
+     * @param projectId Unique identifier of the organizational project from where data samples will be fetched.
+     * @param filter Data filter in SQL WHERE format, where you can reference \&#39;filename\&#39;, \&#39;label\&#39;, \&#39;project_name\&#39;, \&#39;category\&#39;, \&#39;sensors\&#39;, \&#39;frequency\&#39;, and any metadata through \&#39;metadata-&gt;\&#39; (dots are replaced by underscore).
+     * @param ids Only include samples with an ID within the given list of IDs, given as a JSON string
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    listOrganizationProjectsData(organizationId: number, queryParams: listOrganizationProjectsDataQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationProjectsDataResponse>;
     /**
      * Bulk update the metadata of many data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named \'name\'. The other columns are used as metadata keys.
      * @summary Bulk update metadata
@@ -279,7 +434,41 @@ export declare class OrganizationDataApi {
      * @param dataset
      * @param csvFile
      */
-    organizationBulkUpdateMetadata(organizationId: number, dataset: string, csvFile: RequestFile, options?: {
+    organizationBulkUpdateMetadata(organizationId: number, params: organizationBulkUpdateMetadataFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Batch disable project data samples by dataId
+     * @summary Batch disable data
+     * @param organizationId Organization ID
+     * @param organizationProjectsDataBatchRequest
+     */
+    organizationProjectsDataBatchDisable(organizationId: number, organizationProjectsDataBatchRequest: OrganizationProjectsDataBatchRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<OrganizationProjectsDataBatchDisableResponse>;
+    /**
+     * Batch enable project data samples by dataId
+     * @summary Batch enable data
+     * @param organizationId Organization ID
+     * @param organizationProjectsDataBatchRequest
+     */
+    organizationProjectsDataBatchEnable(organizationId: number, organizationProjectsDataBatchRequest: OrganizationProjectsDataBatchRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<OrganizationProjectsDataBatchEnableResponse>;
+    /**
+     * Bulk update the metadata of many raw data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named \'name\'. The other columns are used as metadata keys.
+     * @summary Bulk update metadata
+     * @param organizationId Organization ID
+     * @param csvFile
+     * @param projectIds
+     */
+    organizationProjectsDataBulkUpdateMetadata(organizationId: number, params: organizationProjectsDataBulkUpdateMetadataFormParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -291,7 +480,7 @@ export declare class OrganizationDataApi {
      * @param dataId Data ID
      * @param fileName File name
      */
-    previewOrganizationDataFile(organizationId: number, dataId: number, fileName: string, options?: {
+    previewOrganizationDataFile(organizationId: number, dataId: number, queryParams: previewOrganizationDataFileQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -302,7 +491,7 @@ export declare class OrganizationDataApi {
      * @param organizationId Organization ID
      * @param dataset Selected dataset
      */
-    refreshOrganizationData(organizationId: number, dataset?: string, options?: {
+    refreshOrganizationData(organizationId: number, queryParams: refreshOrganizationDataQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -366,3 +555,4 @@ export declare class OrganizationDataApi {
         };
     }): Promise<VerifyOrganizationBucketResponse>;
 }
+export {};