edge-impulse-api 1.48.6 → 1.49.0

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

@@ -47,6 +47,8 @@ import { FindUserResponse } from '../model/findUserResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
 import { GetEmailVerificationCodeResponse } from '../model/getEmailVerificationCodeResponse';
 import { GetFeatureFlagsResponse } from '../model/getFeatureFlagsResponse';
+import { GetOrganizationDataExportResponse } from '../model/getOrganizationDataExportResponse';
+import { GetOrganizationDataExportsResponse } from '../model/getOrganizationDataExportsResponse';
 import { JobDetailsResponse } from '../model/jobDetailsResponse';
 import { JobLogsResponse } from '../model/jobLogsResponse';
 import { JobMetricsResponse } from '../model/jobMetricsResponse';
@@ -91,6 +93,10 @@ declare type adminGetOrganizationComputeTimeUsageQueryParams = {
     startDate: Date;
     endDate: Date;
 };
+declare type adminGetOrganizationDataExportsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 declare type adminGetOrganizationInfoQueryParams = {
     includeDeleted?: boolean;
 };
@@ -210,7 +216,7 @@ export declare class AdminApi {
         };
     }): Promise<CreateOrganizationResponse>;
     /**
-     * Admin-only API to create a new data export for an organization.
+     * Admin-only API to create a new data export for an organization. A job is created to process the export request and the job details are returned in the response.
      * @summary Create a new organization data export
      * @param organizationId Organization ID
      * @param adminCreateOrganizationDataExportRequest
@@ -219,7 +225,7 @@ export declare class AdminApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<EntityCreatedResponse>;
+    }): Promise<StartJobResponse>;
     /**
      * Admin-only API to create a new project for an organization.
      * @summary Create a new organization project
@@ -512,6 +518,29 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetOrganizationComputeTimeUsageResponse>;
+    /**
+     * Admin-only API to get a data export for an organization.
+     * @summary Get organization data export
+     * @param organizationId Organization ID
+     * @param exportId Export ID
+     */
+    adminGetOrganizationDataExport(organizationId: number, exportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataExportResponse>;
+    /**
+     * Admin-only API to get the list of all data exports for an organization.
+     * @summary Get all organization data exports
+     * @param organizationId Organization ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    adminGetOrganizationDataExports(organizationId: number, queryParams: adminGetOrganizationDataExportsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataExportsResponse>;
     /**
      * Admin-only API to list all information about this organization.
      * @summary Organization information

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

@@ -523,7 +523,7 @@ class AdminApi {
         });
     }
     /**
-     * Admin-only API to create a new data export for an organization.
+     * Admin-only API to create a new data export for an organization. A job is created to process the export request and the job details are returned in the response.
      * @summary Create a new organization data export
      * @param organizationId Organization ID
      * @param adminCreateOrganizationDataExportRequest
@@ -585,7 +585,7 @@ class AdminApi {
                         reject(error);
                     }
                     else {
-                        body = models_1.ObjectSerializer.deserialize(body, "EntityCreatedResponse");
+                        body = models_1.ObjectSerializer.deserialize(body, "StartJobResponse");
                         const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
                         if (typeof body.success === 'boolean' && !body.success) {
                             reject(new Error(body.error || errString));
@@ -2722,6 +2722,166 @@ class AdminApi {
             });
         });
     }
+    /**
+     * Admin-only API to get a data export for an organization.
+     * @summary Get organization data export
+     * @param organizationId Organization ID
+     * @param exportId Export ID
+     */
+    async adminGetOrganizationDataExport(organizationId, exportId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/admin/organizations/{organizationId}/exports/{exportId}'
+            .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)))
+            .replace('{' + 'exportId' + '}', encodeURIComponent(String(exportId)));
+        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 adminGetOrganizationDataExport.');
+        }
+        // verify required parameter 'exportId' is not null or undefined
+        if (exportId === null || exportId === undefined) {
+            throw new Error('Required parameter exportId was null or undefined when calling adminGetOrganizationDataExport.');
+        }
+        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, "GetOrganizationDataExportResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Admin-only API to get the list of all data exports for an organization.
+     * @summary Get all organization data exports
+     * @param organizationId Organization ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    async adminGetOrganizationDataExports(organizationId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/admin/organizations/{organizationId}/exports'
+            .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 adminGetOrganizationDataExports.');
+        }
+        if (queryParams.limit !== undefined) {
+            localVarQueryParameters['limit'] = models_1.ObjectSerializer.serialize(queryParams.limit, "number");
+        }
+        if (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, "GetOrganizationDataExportsResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Admin-only API to list all information about this organization.
      * @summary Organization information