edge-impulse-linux 1.8.9 → 1.9.0

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

@@ -19,9 +19,9 @@ import { AdminCreateOrganizationDataExportRequest } from '../model/adminCreateOr
 import { AdminCreateProjectRequest } from '../model/adminCreateProjectRequest';
 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 { AdminGetUserMetricsResponse } from '../model/adminGetUserMetricsResponse';
 import { AdminGetUserResponse } from '../model/adminGetUserResponse';
 import { AdminGetUsersResponse } from '../model/adminGetUsersResponse';
@@ -42,6 +42,7 @@ import { GetOrganizationDataExportResponse } from '../model/getOrganizationDataE
 import { GetOrganizationDataExportsResponse } from '../model/getOrganizationDataExportsResponse';
 import { GetWhitelabelResponse } from '../model/getWhitelabelResponse';
 import { InviteOrganizationMemberRequest } from '../model/inviteOrganizationMemberRequest';
+import { ListJobsResponse } from '../model/listJobsResponse';
 import { ListOrganizationApiKeysResponse } from '../model/listOrganizationApiKeysResponse';
 import { ListOrganizationsResponse } from '../model/listOrganizationsResponse';
 import { ListProjectsResponse } from '../model/listProjectsResponse';
@@ -81,13 +82,13 @@ type getOrganizationMetricsQueryParams = {
     excludeEdgeImpulseUsers?: boolean;
     projectVisibility?: ProjectVisibility;
 };
-type uploadOrganizationHeaderFormParams = {
+export type uploadOrganizationHeaderFormParams = {
     image?: RequestFile;
 };
-type uploadOrganizationLogoFormParams = {
+export type uploadOrganizationLogoFormParams = {
     image?: RequestFile;
 };
-type uploadOrganizationReadmeImageFormParams = {
+export type uploadOrganizationReadmeImageFormParams = {
     image: RequestFile;
 };
 type whitelabelAdminCreateOrganizationUsageReportQueryParams = {
@@ -105,6 +106,10 @@ type whitelabelAdminGetOrganizationExportsQueryParams = {
 type whitelabelAdminGetOrganizationInfoQueryParams = {
     includeDeleted?: boolean;
 };
+type whitelabelAdminGetOrganizationJobsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 type whitelabelAdminGetOrganizationUsageReportsQueryParams = {
     limit?: number;
     offset?: number;
@@ -113,36 +118,47 @@ type whitelabelAdminGetOrganizationsQueryParams = {
     active?: number;
     includeDeleted?: boolean;
     sort?: string;
+    filters?: string;
     limit?: number;
     offset?: number;
     search?: string;
 };
+type whitelabelAdminGetProjectJobsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 type whitelabelAdminGetProjectsQueryParams = {
     active?: number;
     sort?: string;
+    filters?: string;
     limit?: number;
     offset?: number;
     search?: string;
 };
+type whitelabelAdminGetUserJobsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 type whitelabelAdminGetUsersQueryParams = {
     active?: number;
     tier?: UserTierEnum;
     fields?: string;
     sort?: string;
+    filters?: string;
     limit?: number;
     offset?: number;
     search?: string;
 };
-type whitelabelAdminUpdateDevelopmentBoardImageFormParams = {
+export type whitelabelAdminUpdateDevelopmentBoardImageFormParams = {
     image?: RequestFile;
 };
-type whitelabelAdminUpdateThemeDeviceLogoFormParams = {
+export type whitelabelAdminUpdateThemeDeviceLogoFormParams = {
     image?: RequestFile;
 };
-type whitelabelAdminUpdateThemeFaviconFormParams = {
+export type whitelabelAdminUpdateThemeFaviconFormParams = {
     image: RequestFile;
 };
-type whitelabelAdminUpdateThemeLogoFormParams = {
+export type whitelabelAdminUpdateThemeLogoFormParams = {
     image?: RequestFile;
 };
 export type OrganizationsApiOpts = {
@@ -240,7 +256,7 @@ export declare class OrganizationsApi {
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      */
-    getOrganizationDataExports(organizationId: number, queryParams: getOrganizationDataExportsQueryParams, options?: {
+    getOrganizationDataExports(organizationId: number, queryParams?: getOrganizationDataExportsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -262,7 +278,7 @@ export declare class OrganizationsApi {
      * @param excludeEdgeImpulseUsers Whether to exclude Edge Impulse users when counting enterprise entitlements usage
      * @param projectVisibility What project visibility type to include when counting enterprise entitlements usage
      */
-    getOrganizationMetrics(organizationId: number, queryParams: getOrganizationMetricsQueryParams, options?: {
+    getOrganizationMetrics(organizationId: number, queryParams?: getOrganizationMetricsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -318,6 +334,16 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Request a license required for the deployment of an impulse containing the Edge Impulse HR block.
+     * @summary Request HR block license
+     * @param organizationId Organization ID
+     */
+    requestEnterpriseHrBlockLicense(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Request an extension for an enterprise trial.
      * @summary Request trial extension
@@ -435,7 +461,7 @@ export declare class OrganizationsApi {
      * @param organizationId Organization ID
      * @param developmentBoardRequest
      */
-    whitelabelAdminAddDevelopmentBoard(organizationId: number, developmentBoardRequest?: DevelopmentBoardRequest, options?: {
+    whitelabelAdminAddDevelopmentBoard(organizationId: number, developmentBoardRequest: DevelopmentBoardRequest, options?: {
         headers: {
             [name: string]: string;
         };
@@ -471,7 +497,7 @@ export declare class OrganizationsApi {
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param adminAddOrganizationUserRequest
      */
-    whitelabelAdminAddUserToOrganization(organizationId: number, innerOrganizationId: number, adminAddOrganizationUserRequest?: AdminAddOrganizationUserRequest, options?: {
+    whitelabelAdminAddUserToOrganization(organizationId: number, innerOrganizationId: number, adminAddOrganizationUserRequest: AdminAddOrganizationUserRequest, options?: {
         headers: {
             [name: string]: string;
         };
@@ -483,7 +509,7 @@ export declare class OrganizationsApi {
      * @param projectId Project ID
      * @param adminAddProjectUserRequest
      */
-    whitelabelAdminAddUserToProject(organizationId: number, projectId: number, adminAddProjectUserRequest?: AdminAddProjectUserRequest, options?: {
+    whitelabelAdminAddUserToProject(organizationId: number, projectId: number, adminAddProjectUserRequest: AdminAddProjectUserRequest, options?: {
         headers: {
             [name: string]: string;
         };
@@ -575,9 +601,9 @@ export declare class OrganizationsApi {
      * @summary White Label Admin - Delete usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
-     * @param usageReportId Usage report ID
+     * @param reportId Report ID
      */
-    whitelabelAdminDeleteOrganizationUsageReport(organizationId: number, innerOrganizationId: number, usageReportId: number, options?: {
+    whitelabelAdminDeleteOrganizationUsageReport(organizationId: number, innerOrganizationId: number, reportId: number, options?: {
         headers: {
             [name: string]: string;
         };
@@ -609,9 +635,9 @@ export declare class OrganizationsApi {
      * @summary White Label Admin - Download usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
-     * @param usageReportId Usage report ID
+     * @param reportId Report ID
      */
-    whitelabelAdminDownloadOrganizationUsageReport(organizationId: number, innerOrganizationId: number, usageReportId: number, options?: {
+    whitelabelAdminDownloadOrganizationUsageReport(organizationId: number, innerOrganizationId: number, reportId: number, options?: {
         headers: {
             [name: string]: string;
         };
@@ -669,7 +695,7 @@ export declare class OrganizationsApi {
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      */
-    whitelabelAdminGetOrganizationExports(organizationId: number, innerOrganizationId: number, queryParams: whitelabelAdminGetOrganizationExportsQueryParams, options?: {
+    whitelabelAdminGetOrganizationExports(organizationId: number, innerOrganizationId: number, queryParams?: whitelabelAdminGetOrganizationExportsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -681,23 +707,36 @@ export declare class OrganizationsApi {
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param includeDeleted Whether to include deleted entities (users, projects, orgs)
      */
-    whitelabelAdminGetOrganizationInfo(organizationId: number, innerOrganizationId: number, queryParams: whitelabelAdminGetOrganizationInfoQueryParams, options?: {
+    whitelabelAdminGetOrganizationInfo(organizationId: number, innerOrganizationId: number, queryParams?: whitelabelAdminGetOrganizationInfoQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<AdminOrganizationInfoResponse>;
+    /**
+     * White label admin only API to get the list of all jobs for a organization.
+     * @summary White Label Admin - Get organization jobs
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    whitelabelAdminGetOrganizationJobs(organizationId: number, innerOrganizationId: number, queryParams?: whitelabelAdminGetOrganizationJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
     /**
      * Get a usage report for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Get usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
-     * @param usageReportId Usage report ID
+     * @param reportId Report ID
      */
-    whitelabelAdminGetOrganizationUsageReport(organizationId: number, innerOrganizationId: number, usageReportId: number, options?: {
+    whitelabelAdminGetOrganizationUsageReport(organizationId: number, innerOrganizationId: number, reportId: number, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<AdminGetOrganizationUsageReportResponse>;
+    }): Promise<AdminGetReportResponse>;
     /**
      * Get all usage reports for an organization. This is an API only available to white label admins.
      * @summary White Label Admin - Get all usage reports
@@ -706,11 +745,11 @@ export declare class OrganizationsApi {
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      */
-    whitelabelAdminGetOrganizationUsageReports(organizationId: number, innerOrganizationId: number, queryParams: whitelabelAdminGetOrganizationUsageReportsQueryParams, options?: {
+    whitelabelAdminGetOrganizationUsageReports(organizationId: number, innerOrganizationId: number, queryParams?: whitelabelAdminGetOrganizationUsageReportsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<AdminGetOrganizationUsageReportsResponse>;
+    }): Promise<AdminGetReportsResponse>;
     /**
      * White label admin only API to get the list of all organizations.
      * @summary White Label Admin - Get all organizations within a white label
@@ -718,11 +757,12 @@ export declare class OrganizationsApi {
      * @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
      */
-    whitelabelAdminGetOrganizations(organizationId: number, queryParams: whitelabelAdminGetOrganizationsQueryParams, options?: {
+    whitelabelAdminGetOrganizations(organizationId: number, queryParams?: whitelabelAdminGetOrganizationsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -738,17 +778,31 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<ProjectInfoResponse>;
+    /**
+     * White label admin only API to get the list of all jobs for a project.
+     * @summary White Label Admin - Get project jobs
+     * @param organizationId Organization ID
+     * @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.
+     */
+    whitelabelAdminGetProjectJobs(organizationId: number, projectId: number, queryParams?: whitelabelAdminGetProjectJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
     /**
      * White label admin only API to get the list of all projects.
      * @summary White Label Admin - Get all white label projects
      * @param organizationId Organization ID
      * @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
      */
-    whitelabelAdminGetProjects(organizationId: number, queryParams: whitelabelAdminGetProjectsQueryParams, options?: {
+    whitelabelAdminGetProjects(organizationId: number, queryParams?: whitelabelAdminGetProjectsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -764,6 +818,19 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<AdminGetUserResponse>;
+    /**
+     * White label admin only  API to get the list of all project jobs for a user.
+     * @summary White Label Admin - Get user jobs
+     * @param organizationId Organization ID
+     * @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.
+     */
+    whitelabelAdminGetUserJobs(organizationId: number, userId: number, queryParams?: whitelabelAdminGetUserJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
     /**
      * White label admin only API to get marketing metrics about a user.
      * @summary White Label Admin - Get white label user metrics
@@ -783,11 +850,12 @@ export declare class OrganizationsApi {
      * @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
      */
-    whitelabelAdminGetUsers(organizationId: number, queryParams: whitelabelAdminGetUsersQueryParams, options?: {
+    whitelabelAdminGetUsers(organizationId: number, queryParams?: whitelabelAdminGetUsersQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -878,7 +946,7 @@ export declare class OrganizationsApi {
      * @param developmentBoardId Development board ID.
      * @param developmentBoardRequestUpdate
      */
-    whitelabelAdminUpdateDevelopmentBoard(organizationId: number, developmentBoardId: number, developmentBoardRequestUpdate?: DevelopmentBoardRequestUpdate, options?: {
+    whitelabelAdminUpdateDevelopmentBoard(organizationId: number, developmentBoardId: number, developmentBoardRequestUpdate: DevelopmentBoardRequestUpdate, options?: {
         headers: {
             [name: string]: string;
         };