edge-impulse-api 1.66.22 → 1.66.24

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

@@ -86,6 +86,7 @@ type adminDeleteProjectQueryParams = {
 };
 type adminDeleteUserQueryParams = {
     fullDeletion?: boolean;
+    skipUserNotification?: boolean;
 };
 type adminFindUserQueryParams = {
     query: string;
@@ -153,6 +154,14 @@ type adminGetTrashbinQueryParams = {
     offset?: number;
     search?: string;
 };
+type adminGetTrashbinJobsQueryParams = {
+    startDate?: Date;
+    endDate?: Date;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    key?: string;
+};
 type adminGetUserJobsQueryParams = {
     limit?: number;
     offset?: number;
@@ -433,6 +442,7 @@ export declare class AdminApi {
      * @summary Delete a user
      * @param userId User ID
      * @param fullDeletion Set to true to schedule permanent deletion
+     * @param skipUserNotification If set to true, skips sending email notifications to users about their account/entity deletion. This is typically used for maintenance activities where notification is not needed or desired.
      */
     adminDeleteUser(userId: number, queryParams?: adminDeleteUserQueryParams, options?: {
         headers: {
@@ -806,6 +816,21 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetTrashBinResponse>;
+    /**
+     * Admin-only API to retrieve a paginated list of trash bin related jobs.  Jobs can be filtered by job key  The response is paginated and can be controlled using: - limit: Maximum number of jobs to return - offset: Number of jobs to skip  Results are ordered by creation date (newest first), or custom sort.  Note: This endpoint requires admin:jobs:read permission.
+     * @summary Get a list of trash bin related jobs
+     * @param startDate Start date
+     * @param endDate End date
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     * @param sort Fields and order to sort query by
+     * @param key Job key to filter on
+     */
+    adminGetTrashbinJobs(queryParams?: adminGetTrashbinJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
     /**
      * Admin-only API to get a specific enterprise trial.
      * @summary Get enterprise trial

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

@@ -1688,6 +1688,7 @@ class AdminApi {
      * @summary Delete a user
      * @param userId User ID
      * @param fullDeletion Set to true to schedule permanent deletion
+     * @param skipUserNotification If set to true, skips sending email notifications to users about their account/entity deletion. This is typically used for maintenance activities where notification is not needed or desired.
      */
     async adminDeleteUser(userId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/admin/users/{userId}'
@@ -1712,6 +1713,9 @@ class AdminApi {
         if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.fullDeletion) !== undefined) {
             localVarQueryParameters['fullDeletion'] = models_1.ObjectSerializer.serialize(queryParams.fullDeletion, "boolean");
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.skipUserNotification) !== undefined) {
+            localVarQueryParameters['skipUserNotification'] = models_1.ObjectSerializer.serialize(queryParams.skipUserNotification, "boolean");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;
@@ -4342,6 +4346,97 @@ class AdminApi {
             });
         });
     }
+    /**
+     * Admin-only API to retrieve a paginated list of trash bin related jobs.  Jobs can be filtered by job key  The response is paginated and can be controlled using: - limit: Maximum number of jobs to return - offset: Number of jobs to skip  Results are ordered by creation date (newest first), or custom sort.  Note: This endpoint requires admin:jobs:read permission.
+     * @summary Get a list of trash bin related jobs
+     * @param startDate Start date
+     * @param endDate End date
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     * @param sort Fields and order to sort query by
+     * @param key Job key to filter on
+     */
+    async adminGetTrashbinJobs(queryParams, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/admin/trashbin/jobs';
+        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 = {};
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.startDate) !== undefined) {
+            localVarQueryParameters['startDate'] = models_1.ObjectSerializer.serialize(queryParams.startDate, "Date");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.endDate) !== undefined) {
+            localVarQueryParameters['endDate'] = models_1.ObjectSerializer.serialize(queryParams.endDate, "Date");
+        }
+        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");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.sort) !== undefined) {
+            localVarQueryParameters['sort'] = models_1.ObjectSerializer.serialize(queryParams.sort, "string");
+        }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.key) !== undefined) {
+            localVarQueryParameters['key'] = models_1.ObjectSerializer.serialize(queryParams.key, "string");
+        }
+        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, "ListJobsResponse");
+                        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 a specific enterprise trial.
      * @summary Get enterprise trial