edge-impulse-linux 1.4.3 → 1.4.5

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

@@ -9,9 +9,15 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { AdminAddDisallowedEmailDomainRequest } from '../model/adminAddDisallowedEmailDomainRequest';
 import { AdminAddOrUpdateSSODomainIdPsRequest } from '../model/adminAddOrUpdateSSODomainIdPsRequest';
+import { AdminAddOrganizationUserRequest } from '../model/adminAddOrganizationUserRequest';
 import { AdminAddProjectUserRequest } from '../model/adminAddProjectUserRequest';
 import { AdminCreateOrganizationRequest } from '../model/adminCreateOrganizationRequest';
+import { AdminCreateUserTrialRequest } from '../model/adminCreateUserTrialRequest';
+import { AdminGetDataMigrationResponse } from '../model/adminGetDataMigrationResponse';
+import { AdminGetDataMigrationsResponse } from '../model/adminGetDataMigrationsResponse';
+import { AdminGetDisallowedEmailDomainsResponse } from '../model/adminGetDisallowedEmailDomainsResponse';
 import { AdminGetMetricsResponse } from '../model/adminGetMetricsResponse';
 import { AdminGetOrganizationsResponse } from '../model/adminGetOrganizationsResponse';
 import { AdminGetSSODomainIdPsResponse } from '../model/adminGetSSODomainIdPsResponse';
@@ -19,14 +25,23 @@ import { AdminGetSSOSettingsResponse } from '../model/adminGetSSOSettingsRespons
 import { AdminGetUserIdsResponse } from '../model/adminGetUserIdsResponse';
 import { AdminGetUserMetricsResponse } from '../model/adminGetUserMetricsResponse';
 import { AdminGetUserResponse } from '../model/adminGetUserResponse';
+import { AdminGetUserTrialResponse } from '../model/adminGetUserTrialResponse';
 import { AdminGetUsersResponse } from '../model/adminGetUsersResponse';
 import { AdminListProjectsResponse } from '../model/adminListProjectsResponse';
 import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoResponse';
+import { AdminToggleDataMigrationRequest } from '../model/adminToggleDataMigrationRequest';
 import { AdminUpdateOrganizationRequest } from '../model/adminUpdateOrganizationRequest';
+import { AdminUpdateUserPermissionsRequest } from '../model/adminUpdateUserPermissionsRequest';
 import { AdminUpdateUserRequest } from '../model/adminUpdateUserRequest';
+import { AdminUpdateUserTrialRequest } from '../model/adminUpdateUserTrialRequest';
 import { CreateOrganizationResponse } from '../model/createOrganizationResponse';
+import { EntityCreatedResponse } from '../model/entityCreatedResponse';
 import { FindUserResponse } from '../model/findUserResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
+import { JobDetailsResponse } from '../model/jobDetailsResponse';
+import { JobLogsResponse } from '../model/jobLogsResponse';
+import { JobMetricsResponse } from '../model/jobMetricsResponse';
+import { JobParentTypeEnum } from '../model/jobParentTypeEnum';
 import { ProjectInfoResponse } from '../model/projectInfoResponse';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { Authentication } from '../model/models';
@@ -45,6 +60,18 @@ declare type adminDeleteUserQueryParams = {
 declare type adminFindUserQueryParams = {
     query: string;
 };
+declare type adminGetJobDetailsQueryParams = {
+    parentType: JobParentTypeEnum;
+    includeChildrenJobs?: boolean;
+};
+declare type adminGetJobsLogsQueryParams = {
+    parentType: JobParentTypeEnum;
+    limit: number;
+    offset: number;
+};
+declare type adminGetJobsMetricsQueryParams = {
+    parentType: JobParentTypeEnum;
+};
 declare type adminGetOrganizationsQueryParams = {
     active?: number;
     sort?: string;
@@ -92,6 +119,16 @@ export declare class AdminApi {
     get opts(): AdminApiOpts;
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: AdminApiApiKeys, value: string | undefined): void;
+    /**
+     * Admin-only API to add an email domain to the list of disallowed email domains.
+     * @summary Add a disallowed email domain
+     * @param adminAddDisallowedEmailDomainRequest
+     */
+    adminAddDisallowedEmailDomain(adminAddDisallowedEmailDomainRequest: AdminAddDisallowedEmailDomainRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to set the list of identity provider for a given domain.
      * @summary Add or update SSO settings for a domain
@@ -103,6 +140,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to add a user to an organization. If no user is provided, the current user is used.
+     * @summary Add user to an organization
+     * @param organizationId Organization ID
+     * @param adminAddOrganizationUserRequest
+     */
+    adminAddUserToOrganization(organizationId: number, adminAddOrganizationUserRequest?: AdminAddOrganizationUserRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to add a user to a project. If no user is provided, the current user is used.
      * @summary Add user to a project
@@ -134,6 +182,27 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<CreateOrganizationResponse>;
+    /**
+     * Admin-only API to create an enterprise trial for a user.
+     * @summary Create user enterprise trial
+     * @param userId User ID
+     * @param adminCreateUserTrialRequest
+     */
+    adminCreateUserTrial(userId: number, adminCreateUserTrialRequest: AdminCreateUserTrialRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<EntityCreatedResponse>;
+    /**
+     * Admin-only API to delete an email domain from the list of disallowed email domains.
+     * @summary Delete disallowed email domain
+     * @param domainName Email domain name
+     */
+    adminDeleteDisallowedEmailDomain(domainName: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to delete an organization. If `fullDeletion` is set, it deletes the organization\'s identifiable information and files. Otherwise, it soft deletes the organization by setting its `delete_date` value.
      * @summary Delete an organization
@@ -176,6 +245,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete an enterprise trial for a user.
+     * @summary Delete user enterprise trial
+     * @param userId User ID
+     * @param enterpriseTrialId Enterprise trial ID
+     */
+    adminDeleteUserTrial(userId: number, enterpriseTrialId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * DEPRECATED. Admin-only API to find a user by username or email address.
      * @summary Find a user
@@ -204,6 +284,70 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetUserIdsResponse>;
+    /**
+     * Admin-only API to get a data migration.
+     * @summary Get data migration
+     * @param migrationId Data migration ID
+     */
+    adminGetDataMigration(migrationId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetDataMigrationResponse>;
+    /**
+     * Admin-only API to get data migrations.
+     * @summary Get data migrations
+     */
+    adminGetDataMigrations(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetDataMigrationsResponse>;
+    /**
+     * Admin-only API to get the list of disallowed email domains.
+     * @summary Get the list of disallowed email domains
+     */
+    adminGetDisallowedEmailDomains(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetDisallowedEmailDomainsResponse>;
+    /**
+     * Get the job execution details including inner jobs
+     * @summary Get job execution details
+     * @param jobId Job ID
+     * @param parentType Job parent type (project or organization)
+     * @param includeChildrenJobs Include the details of each of the children jobs (recursively)
+     */
+    adminGetJobDetails(jobId: number, queryParams: adminGetJobDetailsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<JobDetailsResponse>;
+    /**
+     * Get the logs for a job.
+     * @summary Get job logs
+     * @param jobId Job ID
+     * @param parentType Job parent type (project or organization)
+     * @param limit Maximum number of logs
+     * @param offset Start fetching logs from this offset
+     */
+    adminGetJobsLogs(jobId: number, queryParams: adminGetJobsLogsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<JobLogsResponse>;
+    /**
+     * Get cpu/memory usage metrics, if the job is a Kubernetes job
+     * @summary Get job usage metrics
+     * @param jobId Job ID
+     * @param parentType Job parent type (project or organization)
+     */
+    adminGetJobsMetrics(jobId: number, queryParams: adminGetJobsMetricsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<JobMetricsResponse>;
     /**
      * Admin-only API to get global metrics.
      * @summary Get global metrics
@@ -300,6 +444,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetUserMetricsResponse>;
+    /**
+     * Admin-only API to get a specific enterprise trial.
+     * @summary Get user enterprise trial
+     * @param userId User ID
+     * @param enterpriseTrialId Enterprise trial ID
+     */
+    adminGetUserTrial(userId: number, enterpriseTrialId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserTrialResponse>;
     /**
      * Admin-only API to get the list of all registered users.
      * @summary Get all users
@@ -316,6 +471,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetUsersResponse>;
+    /**
+     * Admin-only API to remove a user from an organization.
+     * @summary Remove user from an organization
+     * @param organizationId Organization ID
+     * @param userId User ID
+     */
+    adminRemoveUserFromOrganization(organizationId: number, userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to remove a user from a project.
      * @summary Remove user from a project
@@ -337,6 +503,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to run or pause a data migration.
+     * @summary Run or pause a data migration
+     * @param migrationId Data migration ID
+     * @param adminToggleDataMigrationRequest
+     */
+    adminToggleDataMigration(migrationId: string, adminToggleDataMigrationRequest: AdminToggleDataMigrationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to update organization properties such as name and logo.
      * @summary Update organization
@@ -370,5 +547,28 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update the list of permissions for a user.
+     * @summary Update user permissions
+     * @param userId User ID
+     * @param adminUpdateUserPermissionsRequest
+     */
+    adminUpdateUserPermissions(userId: number, adminUpdateUserPermissionsRequest: AdminUpdateUserPermissionsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update an enterprise trial for a user.
+     * @summary Update user enterprise trial
+     * @param userId User ID
+     * @param enterpriseTrialId Enterprise trial ID
+     * @param adminUpdateUserTrialRequest
+     */
+    adminUpdateUserTrial(userId: number, enterpriseTrialId: number, adminUpdateUserTrialRequest: AdminUpdateUserTrialRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
 }
 export {};