edge-impulse-api 1.40.11 → 1.46.6

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

@@ -36,6 +36,8 @@ import { DevelopmentBoardRequest } from '../model/developmentBoardRequest';
 import { DevelopmentBoardRequestUpdate } from '../model/developmentBoardRequestUpdate';
 import { EnterpriseUpgradeOrTrialExtensionRequest } from '../model/enterpriseUpgradeOrTrialExtensionRequest';
 import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetOrganizationDataExportResponse } from '../model/getOrganizationDataExportResponse';
+import { GetOrganizationDataExportsResponse } from '../model/getOrganizationDataExportsResponse';
 import { GetWhitelabelResponse } from '../model/getWhitelabelResponse';
 import { InviteOrganizationMemberRequest } from '../model/inviteOrganizationMemberRequest';
 import { ListOrganizationApiKeysResponse } from '../model/listOrganizationApiKeysResponse';
@@ -68,6 +70,10 @@ export declare enum OrganizationsApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+declare type getOrganizationDataExportsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 declare type getOrganizationMetricsQueryParams = {
     excludeEdgeImpulseUsers?: boolean;
     projectVisibility?: ProjectVisibility;
@@ -198,6 +204,40 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Download a data export for an organization.
+     * @summary Download organization data export
+     * @param organizationId Organization ID
+     * @param exportId Export ID
+     */
+    downloadOrganizationDataExport(organizationId: number, exportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<any>;
+    /**
+     * Get a data export for an organization.
+     * @summary Get organization data export
+     * @param organizationId Organization ID
+     * @param exportId Export ID
+     */
+    getOrganizationDataExport(organizationId: number, exportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataExportResponse>;
+    /**
+     * Get 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.
+     */
+    getOrganizationDataExports(organizationId: number, queryParams: getOrganizationDataExportsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataExportsResponse>;
     /**
      * List all information about this organization.
      * @summary Organization information
@@ -442,7 +482,7 @@ export declare class OrganizationsApi {
         };
     }): Promise<GenericApiResponse>;
     /**
-     * Create a new organization. This is an internal API only available to white label admins
+     * Create a new organization. This is an API only available to white label admins
      * @summary White Label Admin - Create new organization within white label context
      * @param organizationId Organization ID
      * @param whitelabelAdminCreateOrganizationRequest
@@ -465,7 +505,7 @@ export declare class OrganizationsApi {
         };
     }): Promise<CreateProjectResponse>;
     /**
-     * Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an internal API only available to white label admins.
+     * Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.
      * @summary White Label Admin - Creates a new usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -478,7 +518,7 @@ export declare class OrganizationsApi {
         };
     }): Promise<StartJobResponse>;
     /**
-     * Create a new free tier project. This is an internal API only available to white label admins.
+     * Create a new free tier project. This is an API only available to white label admins.
      * @summary White Label Admin - Create a new project within white label context.
      * @param organizationId Organization ID
      * @param adminCreateProjectRequest
@@ -500,7 +540,7 @@ export declare class OrganizationsApi {
         };
     }): Promise<GenericApiResponse>;
     /**
-     * Delete a usage report for an organization. This is an internal API only available to white label admins.
+     * Delete a usage report for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Delete usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -523,7 +563,7 @@ export declare class OrganizationsApi {
         };
     }): Promise<GenericApiResponse>;
     /**
-     * Download a usage report for an organization. This is an internal API only available to white label admins.
+     * Download a usage report for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Download usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -555,7 +595,7 @@ export declare class OrganizationsApi {
         };
     }): Promise<AdminGetMetricsResponse>;
     /**
-     * Get compute time usage for an organization over a period of time. This is an internal API only available to white label admins
+     * Get compute time usage for an organization over a period of time. This is an API only available to white label admins
      * @summary White Label Admin - Get organization compute time usage
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -580,7 +620,7 @@ export declare class OrganizationsApi {
         };
     }): Promise<AdminOrganizationInfoResponse>;
     /**
-     * Get a usage report for an organization. This is an internal API only available to white label admins.
+     * Get a usage report for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Get usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -592,7 +632,7 @@ export declare class OrganizationsApi {
         };
     }): Promise<AdminGetOrganizationUsageReportResponse>;
     /**
-     * Get all usage reports for an organization. This is an internal API only available to white label admins.
+     * Get all usage reports for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Get all usage reports
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label

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

@@ -378,6 +378,236 @@ class OrganizationsApi {
             });
         });
     }
+    /**
+     * Download a data export for an organization.
+     * @summary Download organization data export
+     * @param organizationId Organization ID
+     * @param exportId Export ID
+     */
+    async downloadOrganizationDataExport(organizationId, exportId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/organizations/{organizationId}/exports/{exportId}/download'
+            .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)))
+            .replace('{' + 'exportId' + '}', encodeURIComponent(String(exportId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        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 downloadOrganizationDataExport.');
+        }
+        // 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 downloadOrganizationDataExport.');
+        }
+        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 {
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Get a data export for an organization.
+     * @summary Get organization data export
+     * @param organizationId Organization ID
+     * @param exportId Export ID
+     */
+    async getOrganizationDataExport(organizationId, exportId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/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 getOrganizationDataExport.');
+        }
+        // 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 getOrganizationDataExport.');
+        }
+        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Get 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 getOrganizationDataExports(organizationId, queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/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 getOrganizationDataExports.');
+        }
+        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * List all information about this organization.
      * @summary Organization information
@@ -2108,7 +2338,7 @@ class OrganizationsApi {
         });
     }
     /**
-     * Create a new organization. This is an internal API only available to white label admins
+     * Create a new organization. This is an API only available to white label admins
      * @summary White Label Admin - Create new organization within white label context
      * @param organizationId Organization ID
      * @param whitelabelAdminCreateOrganizationRequest
@@ -2272,7 +2502,7 @@ class OrganizationsApi {
         });
     }
     /**
-     * Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an internal API only available to white label admins.
+     * Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.
      * @summary White Label Admin - Creates a new usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -2367,7 +2597,7 @@ class OrganizationsApi {
         });
     }
     /**
-     * Create a new free tier project. This is an internal API only available to white label admins.
+     * Create a new free tier project. This is an API only available to white label admins.
      * @summary White Label Admin - Create a new project within white label context.
      * @param organizationId Organization ID
      * @param adminCreateProjectRequest
@@ -2525,7 +2755,7 @@ class OrganizationsApi {
         });
     }
     /**
-     * Delete a usage report for an organization. This is an internal API only available to white label admins.
+     * Delete a usage report for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Delete usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -2689,7 +2919,7 @@ class OrganizationsApi {
         });
     }
     /**
-     * Download a usage report for an organization. This is an internal API only available to white label admins.
+     * Download a usage report for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Download usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -2911,7 +3141,7 @@ class OrganizationsApi {
         });
     }
     /**
-     * Get compute time usage for an organization over a period of time. This is an internal API only available to white label admins
+     * Get compute time usage for an organization over a period of time. This is an API only available to white label admins
      * @summary White Label Admin - Get organization compute time usage
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -3089,7 +3319,7 @@ class OrganizationsApi {
         });
     }
     /**
-     * Get a usage report for an organization. This is an internal API only available to white label admins.
+     * Get a usage report for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Get usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
@@ -3174,7 +3404,7 @@ class OrganizationsApi {
         });
     }
     /**
-     * Get all usage reports for an organization. This is an internal API only available to white label admins.
+     * Get all usage reports for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Get all usage reports
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label