edge-impulse-linux 1.8.9 → 1.9.0

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

@@ -21,9 +21,9 @@ import { AdminGetDataMigrationsResponse } from '../model/adminGetDataMigrationsR
 import { AdminGetDisallowedEmailDomainsResponse } from '../model/adminGetDisallowedEmailDomainsResponse';
 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 { AdminGetReportResponse } from '../model/adminGetReportResponse';
+import { AdminGetReportsResponse } from '../model/adminGetReportsResponse';
 import { AdminGetSSODomainIdPsResponse } from '../model/adminGetSSODomainIdPsResponse';
 import { AdminGetSSOSettingsResponse } from '../model/adminGetSSOSettingsResponse';
 import { AdminGetTrialResponse } from '../model/adminGetTrialResponse';
@@ -35,6 +35,7 @@ import { AdminListProjectsResponse } from '../model/adminListProjectsResponse';
 import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoResponse';
 import { AdminStartEnterpriseTrialRequest } from '../model/adminStartEnterpriseTrialRequest';
 import { AdminToggleDataMigrationRequest } from '../model/adminToggleDataMigrationRequest';
+import { AdminUpdateConfigRequest } from '../model/adminUpdateConfigRequest';
 import { AdminUpdateOrganizationDataExportRequest } from '../model/adminUpdateOrganizationDataExportRequest';
 import { AdminUpdateOrganizationRequest } from '../model/adminUpdateOrganizationRequest';
 import { AdminUpdateTrialRequest } from '../model/adminUpdateTrialRequest';
@@ -50,10 +51,12 @@ import { GetEmailVerificationCodeResponse } from '../model/getEmailVerificationC
 import { GetFeatureFlagsResponse } from '../model/getFeatureFlagsResponse';
 import { GetOrganizationDataExportResponse } from '../model/getOrganizationDataExportResponse';
 import { GetOrganizationDataExportsResponse } from '../model/getOrganizationDataExportsResponse';
+import { GetStudioConfigResponse } from '../model/getStudioConfigResponse';
 import { JobDetailsResponse } from '../model/jobDetailsResponse';
 import { JobLogsResponse } from '../model/jobLogsResponse';
 import { JobMetricsResponse } from '../model/jobMetricsResponse';
 import { JobParentTypeEnum } from '../model/jobParentTypeEnum';
+import { ListJobsResponse } from '../model/listJobsResponse';
 import { ProjectInfoResponse } from '../model/projectInfoResponse';
 import { StartJobResponse } from '../model/startJobResponse';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
@@ -65,6 +68,10 @@ export declare enum AdminApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+type adminCreateMetricsReportQueryParams = {
+    startDate: Date;
+    endDate: Date;
+};
 type adminCreateOrganizationUsageReportQueryParams = {
     startDate: Date;
     endDate: Date;
@@ -87,6 +94,10 @@ type adminGetJobsLogsQueryParams = {
 type adminGetJobsMetricsQueryParams = {
     parentType: JobParentTypeEnum;
 };
+type adminGetMetricsReportsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 type adminGetOrganizationComputeTimeUsageQueryParams = {
     startDate: Date;
     endDate: Date;
@@ -98,6 +109,10 @@ type adminGetOrganizationDataExportsQueryParams = {
 type adminGetOrganizationInfoQueryParams = {
     includeDeleted?: boolean;
 };
+type adminGetOrganizationJobsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 type adminGetOrganizationUsageReportsQueryParams = {
     limit?: number;
     offset?: number;
@@ -106,22 +121,33 @@ type adminGetOrganizationsQueryParams = {
     active?: number;
     includeDeleted?: boolean;
     sort?: string;
+    filters?: string;
     limit?: number;
     offset?: number;
     search?: string;
 };
+type adminGetProjectJobsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 type adminGetProjectsQueryParams = {
     active?: number;
     sort?: string;
+    filters?: string;
     limit?: number;
     offset?: number;
     search?: string;
 };
+type adminGetUserJobsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 type adminGetUsersQueryParams = {
     active?: number;
     tier?: UserTierEnum;
     fields?: string;
     sort?: string;
+    filters?: string;
     limit?: number;
     offset?: number;
     search?: string;
@@ -177,7 +203,7 @@ export declare class AdminApi {
      * @param organizationId Organization ID
      * @param adminAddOrganizationUserRequest
      */
-    adminAddUserToOrganization(organizationId: number, adminAddOrganizationUserRequest?: AdminAddOrganizationUserRequest, options?: {
+    adminAddUserToOrganization(organizationId: number, adminAddOrganizationUserRequest: AdminAddOrganizationUserRequest, options?: {
         headers: {
             [name: string]: string;
         };
@@ -188,7 +214,7 @@ export declare class AdminApi {
      * @param projectId Project ID
      * @param adminAddProjectUserRequest
      */
-    adminAddUserToProject(projectId: number, adminAddProjectUserRequest?: AdminAddProjectUserRequest, options?: {
+    adminAddUserToProject(projectId: number, adminAddProjectUserRequest: AdminAddProjectUserRequest, options?: {
         headers: {
             [name: string]: string;
         };
@@ -203,6 +229,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to create a new global metrics report. A job is created to process the report request and the job details are returned in the response.
+     * @summary Create a new global metrics report
+     * @param startDate Start date
+     * @param endDate End date
+     */
+    adminCreateMetricsReport(queryParams: adminCreateMetricsReportQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
     /**
      * Admin-only API to create a new organization.
      * @summary Create a new organization
@@ -277,13 +314,23 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete a global metrics report.
+     * @summary Delete global metrics report
+     * @param reportId Report ID
+     */
+    adminDeleteMetricsReport(reportId: number, 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
      * @param organizationId Organization ID
      * @param fullDeletion Set to true for full deletion
      */
-    adminDeleteOrganization(organizationId: number, queryParams: adminDeleteOrganizationQueryParams, options?: {
+    adminDeleteOrganization(organizationId: number, queryParams?: adminDeleteOrganizationQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -303,9 +350,9 @@ export declare class AdminApi {
      * Admin-only API to delete a usage report for an organization.
      * @summary Delete usage report
      * @param organizationId Organization ID
-     * @param usageReportId Usage report ID
+     * @param reportId Report ID
      */
-    adminDeleteOrganizationUsageReport(organizationId: number, usageReportId: number, options?: {
+    adminDeleteOrganizationUsageReport(organizationId: number, reportId: number, options?: {
         headers: {
             [name: string]: string;
         };
@@ -330,6 +377,16 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete a studio config item.
+     * @summary Delete a studio config item
+     * @param configKey Config Key
+     */
+    adminDeleteStudioConfig(configKey: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to delete an enterprise trial.
      * @summary Delete enterprise trial
@@ -360,13 +417,23 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to download a global metrics report.
+     * @summary Download global metrics report
+     * @param reportId Report ID
+     */
+    adminDownloadMetricsReport(reportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<any>;
     /**
      * Admin-only API to download a usage report for an organization.
      * @summary Download usage report
      * @param organizationId Organization ID
-     * @param usageReportId Usage report ID
+     * @param reportId Report ID
      */
-    adminDownloadOrganizationUsageReport(organizationId: number, usageReportId: number, options?: {
+    adminDownloadOrganizationUsageReport(organizationId: number, reportId: number, options?: {
         headers: {
             [name: string]: string;
         };
@@ -501,6 +568,27 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetMetricsResponse>;
+    /**
+     * Admin-only API to get a global metrics report.
+     * @summary Get global metrics report
+     * @param reportId Report ID
+     */
+    adminGetMetricsReport(reportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetReportResponse>;
+    /**
+     * Admin-only API to get global metrics reports.
+     * @summary Get global metrics reports
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    adminGetMetricsReports(queryParams?: adminGetMetricsReportsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetReportsResponse>;
     /**
      * Admin-only API to get compute time usage for an organization over a period of time.
      * @summary Get organization compute time usage
@@ -531,7 +619,7 @@ export declare class AdminApi {
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      */
-    adminGetOrganizationDataExports(organizationId: number, queryParams: adminGetOrganizationDataExportsQueryParams, options?: {
+    adminGetOrganizationDataExports(organizationId: number, queryParams?: adminGetOrganizationDataExportsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -542,22 +630,34 @@ export declare class AdminApi {
      * @param organizationId Organization ID
      * @param includeDeleted Whether to include deleted entities (users, projects, orgs)
      */
-    adminGetOrganizationInfo(organizationId: number, queryParams: adminGetOrganizationInfoQueryParams, options?: {
+    adminGetOrganizationInfo(organizationId: number, queryParams?: adminGetOrganizationInfoQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<AdminOrganizationInfoResponse>;
+    /**
+     * Admin-only API to get the list of all jobs for a organization.
+     * @summary Get organization jobs
+     * @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.
+     */
+    adminGetOrganizationJobs(organizationId: number, queryParams?: adminGetOrganizationJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
     /**
      * Admin-only API to get a usage report for an organization.
      * @summary Get usage report
      * @param organizationId Organization ID
-     * @param usageReportId Usage report ID
+     * @param reportId Report ID
      */
-    adminGetOrganizationUsageReport(organizationId: number, usageReportId: number, options?: {
+    adminGetOrganizationUsageReport(organizationId: number, reportId: number, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<AdminGetOrganizationUsageReportResponse>;
+    }): Promise<AdminGetReportResponse>;
     /**
      * Admin-only API to get all usage reports for an organization.
      * @summary Get all usage reports
@@ -565,22 +665,23 @@ export declare class AdminApi {
      * @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?: {
+    adminGetOrganizationUsageReports(organizationId: number, queryParams?: adminGetOrganizationUsageReportsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<AdminGetOrganizationUsageReportsResponse>;
+    }): Promise<AdminGetReportsResponse>;
     /**
      * 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 filters
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      * @param search Search query
      */
-    adminGetOrganizations(queryParams: adminGetOrganizationsQueryParams, options?: {
+    adminGetOrganizations(queryParams?: adminGetOrganizationsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -595,16 +696,29 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<ProjectInfoResponse>;
+    /**
+     * Admin-only API to get the list of all jobs for a project.
+     * @summary Get project jobs
+     * @param projectId Project ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    adminGetProjectJobs(projectId: number, queryParams?: adminGetProjectJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
     /**
      * Admin-only API to get the list of all projects.
      * @summary Get all projects
      * @param active Whether to search for entities (users, orgs) active in the last X days
      * @param sort Fields and order to sort query by
+     * @param filters
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      * @param search Search query
      */
-    adminGetProjects(queryParams: adminGetProjectsQueryParams, options?: {
+    adminGetProjects(queryParams?: adminGetProjectsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -628,6 +742,15 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetSSOSettingsResponse>;
+    /**
+     * Admin-only API to get all studio config.
+     * @summary Get all studio config
+     */
+    adminGetStudioConfig(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetStudioConfigResponse>;
     /**
      * Admin-only API to get a specific enterprise trial.
      * @summary Get enterprise trial
@@ -648,6 +771,18 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetUserResponse>;
+    /**
+     * Admin-only API to get the list of all project jobs for a user.
+     * @summary Get user jobs
+     * @param userId User ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    adminGetUserJobs(userId: number, queryParams?: adminGetUserJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
     /**
      * Admin-only API to get marketing metrics about a user.
      * @summary Get user metrics
@@ -665,11 +800,12 @@ export declare class AdminApi {
      * @param tier Whether to search for free, community plus, professional, or enterprise entities (users, projects)
      * @param fields Comma separated list of fields to fetch in a query
      * @param sort Fields and order to sort query by
+     * @param filters
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      * @param search Search query
      */
-    adminGetUsers(queryParams: adminGetUsersQueryParams, options?: {
+    adminGetUsers(queryParams?: adminGetUsersQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -716,6 +852,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update a studio config item.
+     * @summary Update studio config
+     * @param configKey Config Key
+     * @param adminUpdateConfigRequest
+     */
+    adminSetStudioConfig(configKey: string, adminUpdateConfigRequest: AdminUpdateConfigRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to run or pause a data migration.
      * @summary Run or pause a data migration