edge-impulse-api 1.39.0 → 1.40.2

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

@@ -89,12 +89,16 @@ declare type adminGetOrganizationComputeTimeUsageQueryParams = {
     startDate: Date;
     endDate: Date;
 };
+declare type adminGetOrganizationInfoQueryParams = {
+    includeDeleted?: boolean;
+};
 declare type adminGetOrganizationUsageReportsQueryParams = {
     limit?: number;
     offset?: number;
 };
 declare type adminGetOrganizationsQueryParams = {
     active?: number;
+    includeDeleted?: boolean;
     sort?: string;
     limit?: number;
     offset?: number;
@@ -488,8 +492,9 @@ export declare class AdminApi {
      * Admin-only API to list all information about this organization.
      * @summary Organization information
      * @param organizationId Organization ID
+     * @param includeDeleted Whether to include deleted entities (users, projects, orgs)
      */
-    adminGetOrganizationInfo(organizationId: number, options?: {
+    adminGetOrganizationInfo(organizationId: number, queryParams: adminGetOrganizationInfoQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -521,6 +526,7 @@ export declare class AdminApi {
      * Admin-only API to get the list of all organizations.
      * @summary Get all organizations
      * @param active Whether to search for entities (users, orgs) active in the last X days
+     * @param includeDeleted Whether to include deleted entities (users, projects, orgs)
      * @param sort Fields and order to sort query by
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
@@ -653,6 +659,16 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to restore a soft deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.
+     * @summary Restore an organization
+     * @param organizationId Organization ID
+     */
+    adminRestoreOrganization(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to run or pause a data migration.
      * @summary Run or pause a data migration

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

@@ -2568,8 +2568,9 @@ class AdminApi {
      * Admin-only API to list all information about this organization.
      * @summary Organization information
      * @param organizationId Organization ID
+     * @param includeDeleted Whether to include deleted entities (users, projects, orgs)
      */
-    async adminGetOrganizationInfo(organizationId, options = { headers: {} }) {
+    async adminGetOrganizationInfo(organizationId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/admin/organizations/{organizationId}'
             .replace('{' + 'organizationId' + '}', encodeURIComponent(String(organizationId)));
         let localVarQueryParameters = {};
@@ -2589,6 +2590,9 @@ class AdminApi {
         if (organizationId === null || organizationId === undefined) {
             throw new Error('Required parameter organizationId was null or undefined when calling adminGetOrganizationInfo.');
         }
+        if (queryParams.includeDeleted !== undefined) {
+            localVarQueryParameters['includeDeleted'] = models_1.ObjectSerializer.serialize(queryParams.includeDeleted, "boolean");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -2801,6 +2805,7 @@ class AdminApi {
      * Admin-only API to get the list of all organizations.
      * @summary Get all organizations
      * @param active Whether to search for entities (users, orgs) active in the last X days
+     * @param includeDeleted Whether to include deleted entities (users, projects, orgs)
      * @param sort Fields and order to sort query by
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
@@ -2824,6 +2829,9 @@ class AdminApi {
         if (queryParams.active !== undefined) {
             localVarQueryParameters['active'] = models_1.ObjectSerializer.serialize(queryParams.active, "number");
         }
+        if (queryParams.includeDeleted !== undefined) {
+            localVarQueryParameters['includeDeleted'] = models_1.ObjectSerializer.serialize(queryParams.includeDeleted, "boolean");
+        }
         if (queryParams.sort !== undefined) {
             localVarQueryParameters['sort'] = models_1.ObjectSerializer.serialize(queryParams.sort, "string");
         }
@@ -3735,6 +3743,79 @@ class AdminApi {
             });
         });
     }
+    /**
+     * Admin-only API to restore a soft deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.
+     * @summary Restore an organization
+     * @param organizationId Organization ID
+     */
+    async adminRestoreOrganization(organizationId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/admin/organizations/{organizationId}/restore'
+            .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 adminRestoreOrganization.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            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, "GenericApiResponse");
+                        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 run or pause a data migration.
      * @summary Run or pause a data migration