edge-impulse-linux 1.4.7 → 1.5.0

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

@@ -14,11 +14,14 @@ import { AdminAddOrUpdateSSODomainIdPsRequest } from '../model/adminAddOrUpdateS
 import { AdminAddOrganizationUserRequest } from '../model/adminAddOrganizationUserRequest';
 import { AdminAddProjectUserRequest } from '../model/adminAddProjectUserRequest';
 import { AdminCreateOrganizationRequest } from '../model/adminCreateOrganizationRequest';
+import { AdminCreateProjectRequest } from '../model/adminCreateProjectRequest';
 import { AdminGetDataMigrationResponse } from '../model/adminGetDataMigrationResponse';
 import { AdminGetDataMigrationsResponse } from '../model/adminGetDataMigrationsResponse';
 import { AdminGetDisallowedEmailDomainsResponse } from '../model/adminGetDisallowedEmailDomainsResponse';
-import { AdminGetFeatureFlagsResponse } from '../model/adminGetFeatureFlagsResponse';
 import { AdminGetMetricsResponse } from '../model/adminGetMetricsResponse';
+import { AdminGetOrganizationComputeTimeUsageResponse } from '../model/adminGetOrganizationComputeTimeUsageResponse';
+import { AdminGetOrganizationUsageReportResponse } from '../model/adminGetOrganizationUsageReportResponse';
+import { AdminGetOrganizationUsageReportsResponse } from '../model/adminGetOrganizationUsageReportsResponse';
 import { AdminGetOrganizationsResponse } from '../model/adminGetOrganizationsResponse';
 import { AdminGetSSODomainIdPsResponse } from '../model/adminGetSSODomainIdPsResponse';
 import { AdminGetSSOSettingsResponse } from '../model/adminGetSSOSettingsResponse';
@@ -35,16 +38,20 @@ import { AdminUpdateUserPermissionsRequest } from '../model/adminUpdateUserPermi
 import { AdminUpdateUserRequest } from '../model/adminUpdateUserRequest';
 import { AdminUpdateUserTrialRequest } from '../model/adminUpdateUserTrialRequest';
 import { CreateOrganizationResponse } from '../model/createOrganizationResponse';
+import { CreateProjectResponse } from '../model/createProjectResponse';
 import { EntityCreatedResponse } from '../model/entityCreatedResponse';
 import { Feature } from '../model/feature';
 import { FindUserResponse } from '../model/findUserResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetEmailVerificationCodeResponse } from '../model/getEmailVerificationCodeResponse';
+import { GetFeatureFlagsResponse } from '../model/getFeatureFlagsResponse';
 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 { StartEnterpriseTrialRequest } from '../model/startEnterpriseTrialRequest';
+import { StartJobResponse } from '../model/startJobResponse';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { Authentication } from '../model/models';
 import { ApiKeyAuth } from '../model/models';
@@ -53,6 +60,10 @@ export declare enum AdminApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+declare type adminCreateOrganizationUsageReportQueryParams = {
+    startDate: Date;
+    endDate: Date;
+};
 declare type adminDeleteOrganizationQueryParams = {
     fullDeletion?: boolean;
 };
@@ -74,8 +85,20 @@ declare type adminGetJobsLogsQueryParams = {
 declare type adminGetJobsMetricsQueryParams = {
     parentType: JobParentTypeEnum;
 };
+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;
@@ -184,6 +207,39 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<CreateOrganizationResponse>;
+    /**
+     * Admin-only API to create a new project for an organization.
+     * @summary Create a new organization project
+     * @param organizationId Organization ID
+     * @param adminCreateProjectRequest
+     */
+    adminCreateOrganizationProject(organizationId: number, adminCreateProjectRequest: AdminCreateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateProjectResponse>;
+    /**
+     * Admin-only API to 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.
+     * @summary Creates a new usage report
+     * @param organizationId Organization ID
+     * @param startDate Start date
+     * @param endDate End date
+     */
+    adminCreateOrganizationUsageReport(organizationId: number, queryParams: adminCreateOrganizationUsageReportQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Admin-only API to create a new free tier project.
+     * @summary Create a new project
+     * @param adminCreateProjectRequest
+     */
+    adminCreateProject(adminCreateProjectRequest: AdminCreateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateProjectResponse>;
     /**
      * Admin-only API to create an enterprise trial for a user.
      * @summary Create user enterprise trial
@@ -216,6 +272,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete a usage report for an organization.
+     * @summary Delete usage report
+     * @param organizationId Organization ID
+     * @param usageReportId Usage report ID
+     */
+    adminDeleteOrganizationUsageReport(organizationId: number, usageReportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to delete a project.
      * @summary Delete a project
@@ -246,7 +313,7 @@ export declare class AdminApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GenericApiResponse>;
+    }): Promise<StartJobResponse>;
     /**
      * Admin-only API to delete an enterprise trial for a user.
      * @summary Delete user enterprise trial
@@ -268,6 +335,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to download a usage report for an organization.
+     * @summary Download usage report
+     * @param organizationId Organization ID
+     * @param usageReportId Usage report ID
+     */
+    adminDownloadOrganizationUsageReport(organizationId: number, usageReportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<any>;
     /**
      * Admin-only API to set a feature flag ON. Setting a feature flag ON essentially enables the feature for all users.
      * @summary Set a feature flag ON
@@ -334,6 +412,16 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetDisallowedEmailDomainsResponse>;
+    /**
+     * Get the enterprise trial verification code of the specified email.
+     * @summary Get enterprise trial email verification code
+     * @param email Email address
+     */
+    adminGetEmailVerificationCode(email: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetEmailVerificationCodeResponse>;
     /**
      * Admin-only API to get all feature flags.
      * @summary Get all feature flags
@@ -342,12 +430,12 @@ export declare class AdminApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<AdminGetFeatureFlagsResponse>;
+    }): Promise<GetFeatureFlagsResponse>;
     /**
      * 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 parentType Job parent type (project, organization, or standalone)
      * @param includeChildrenJobs Include the details of each of the children jobs (recursively)
      */
     adminGetJobDetails(jobId: number, queryParams: adminGetJobDetailsQueryParams, options?: {
@@ -359,7 +447,7 @@ export declare class AdminApi {
      * Get the logs for a job.
      * @summary Get job logs
      * @param jobId Job ID
-     * @param parentType Job parent type (project or organization)
+     * @param parentType Job parent type (project, organization, or standalone)
      * @param limit Maximum number of logs
      * @param offset Start fetching logs from this offset
      */
@@ -372,7 +460,7 @@ export declare class AdminApi {
      * 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)
+     * @param parentType Job parent type (project, organization, or standalone)
      */
     adminGetJobsMetrics(jobId: number, queryParams: adminGetJobsMetricsQueryParams, options?: {
         headers: {
@@ -388,20 +476,57 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetMetricsResponse>;
+    /**
+     * Admin-only API to get compute time usage for an organization over a period of time.
+     * @summary Get organization compute time usage
+     * @param organizationId Organization ID
+     * @param startDate Start date
+     * @param endDate End date
+     */
+    adminGetOrganizationComputeTimeUsage(organizationId: number, queryParams: adminGetOrganizationComputeTimeUsageQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationComputeTimeUsageResponse>;
     /**
      * 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;
         };
     }): Promise<AdminOrganizationInfoResponse>;
+    /**
+     * Admin-only API to get a usage report for an organization.
+     * @summary Get usage report
+     * @param organizationId Organization ID
+     * @param usageReportId Usage report ID
+     */
+    adminGetOrganizationUsageReport(organizationId: number, usageReportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationUsageReportResponse>;
+    /**
+     * Admin-only API to get all usage reports for an organization.
+     * @summary Get all usage reports
+     * @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.
+     */
+    adminGetOrganizationUsageReports(organizationId: number, queryParams: adminGetOrganizationUsageReportsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationUsageReportsResponse>;
     /**
      * 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.
@@ -534,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
@@ -601,5 +736,16 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to upgrade a specific enterprise trial for a user to a full enterprise account.
+     * @summary Upgrade user enterprise trial to a full enterprise account
+     * @param userId User ID
+     * @param enterpriseTrialId Enterprise trial ID
+     */
+    adminUpgradeUserTrial(userId: number, enterpriseTrialId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
 }
 export {};