edge-impulse-api 1.66.34 → 1.67.0

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

@@ -59,7 +59,9 @@ import { JobLogsResponse } from '../model/jobLogsResponse';
 import { JobMetricsResponse } from '../model/jobMetricsResponse';
 import { JobParentTypeEnum } from '../model/jobParentTypeEnum';
 import { ListJobsResponse } from '../model/listJobsResponse';
+import { ListOrganizationDataResponse } from '../model/listOrganizationDataResponse';
 import { ListPortalFilesInFolderResponse } from '../model/listPortalFilesInFolderResponse';
+import { ListSamplesResponse } from '../model/listSamplesResponse';
 import { StartJobResponse } from '../model/startJobResponse';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { UserTierEnum } from '../model/userTierEnum';
@@ -135,6 +137,10 @@ type adminGetOrganizationsQueryParams = {
     offset?: number;
     search?: string;
 };
+type adminGetProjectDataSamplesQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 type adminGetProjectJobsQueryParams = {
     limit?: number;
     offset?: number;
@@ -176,6 +182,11 @@ type adminGetUsersQueryParams = {
     offset?: number;
     search?: string;
 };
+type adminListOrganizationDataQueryParams = {
+    dataset?: string;
+    limit?: number;
+    offset?: number;
+};
 type adminListTrashbinOrganizationS3FilesQueryParams = {
     prefix?: string;
     sourceBucket: 'ingestion' | 'cdn' | 'user-data';
@@ -747,6 +758,18 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminProjectInfoResponse>;
+    /**
+     * Admin-only API to get the list of all data samples for a project.  The response is paginated and returns up to 1000 samples per request. To retrieve additional pages: 1. Use the `limit` parameter to specify how many samples to return (max 1000) 2. Use the `offset` parameter to skip a number of samples 3. Make subsequent requests with increasing offset values to retrieve all samples  For example: - First request: limit=1000, offset=0 (samples 1-1000) - Second request: limit=1000, offset=1000 (samples 1001-2000) - And so on
+     * @summary Get project data samples
+     * @param projectId Project ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    adminGetProjectDataSamples(projectId: number, queryParams?: adminGetProjectDataSamplesQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListSamplesResponse>;
     /**
      * Admin-only API to get the list of all jobs for a project.
      * @summary Get project jobs
@@ -890,6 +913,19 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetUsersResponse>;
+    /**
+     * Admin-only API to list all data items from an organization. The response is paginated and returns up to 1000 samples per request. To retrieve additional pages: 1. Use the `limit` parameter to specify how many samples to return (max 1000) 2. Use the `offset` parameter to skip a number of samples 3. Make subsequent requests with increasing offset values to retrieve all samples  For example: - First request: limit=1000, offset=0 (samples 1-1000) - Second request: limit=1000, offset=1000 (samples 1001-2000) - And so on
+     * @summary List organization data
+     * @param organizationId Organization ID
+     * @param dataset Selected dataset
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    adminListOrganizationData(organizationId: number, queryParams?: adminListOrganizationDataQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationDataResponse>;
     /**
      * List files in the trashbin FSx for a given organization.
      * @summary List organization FSx files in the trash bin

package/build/library/sdk/api/adminApi.js

@@ -3930,6 +3930,88 @@ class AdminApi {
             });
         });
     }
+    /**
+     * Admin-only API to get the list of all data samples for a project.  The response is paginated and returns up to 1000 samples per request. To retrieve additional pages: 1. Use the `limit` parameter to specify how many samples to return (max 1000) 2. Use the `offset` parameter to skip a number of samples 3. Make subsequent requests with increasing offset values to retrieve all samples  For example: - First request: limit=1000, offset=0 (samples 1-1000) - Second request: limit=1000, offset=1000 (samples 1001-2000) - And so on
+     * @summary Get project data samples
+     * @param projectId Project ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    async adminGetProjectDataSamples(projectId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/admin/projects/{projectId}/data'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'projectId' is not null or undefined
+        if (projectId === null || projectId === undefined) {
+            throw new Error('Required parameter projectId was null or undefined when calling adminGetProjectDataSamples.');
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.limit) !== undefined) {
+            localVarQueryParameters['limit'] = models_1.ObjectSerializer.serialize(queryParams.limit, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.offset) !== undefined) {
+            localVarQueryParameters['offset'] = models_1.ObjectSerializer.serialize(queryParams.offset, "number");
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "ListSamplesResponse");
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Admin-only API to get the list of all jobs for a project.
      * @summary Get project jobs
@@ -4898,6 +4980,92 @@ class AdminApi {
             });
         });
     }
+    /**
+     * Admin-only API to list all data items from an organization. The response is paginated and returns up to 1000 samples per request. To retrieve additional pages: 1. Use the `limit` parameter to specify how many samples to return (max 1000) 2. Use the `offset` parameter to skip a number of samples 3. Make subsequent requests with increasing offset values to retrieve all samples  For example: - First request: limit=1000, offset=0 (samples 1-1000) - Second request: limit=1000, offset=1000 (samples 1001-2000) - And so on
+     * @summary List organization data
+     * @param organizationId Organization ID
+     * @param dataset Selected dataset
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    async adminListOrganizationData(organizationId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/admin/organizations/{organizationId}/data'
+            .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'organizationId' is not null or undefined
+        if (organizationId === null || organizationId === undefined) {
+            throw new Error('Required parameter organizationId was null or undefined when calling adminListOrganizationData.');
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.dataset) !== undefined) {
+            localVarQueryParameters['dataset'] = models_1.ObjectSerializer.serialize(queryParams.dataset, "string");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.limit) !== undefined) {
+            localVarQueryParameters['limit'] = models_1.ObjectSerializer.serialize(queryParams.limit, "number");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.offset) !== undefined) {
+            localVarQueryParameters['offset'] = models_1.ObjectSerializer.serialize(queryParams.offset, "number");
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'GET',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "ListOrganizationDataResponse");
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * List files in the trashbin FSx for a given organization.
      * @summary List organization FSx files in the trash bin