edge-impulse-linux 1.4.8 → 1.5.1

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

@@ -11,9 +11,15 @@
  */
 import { AddMemberRequest } from '../model/addMemberRequest';
 import { AddOrganizationApiKeyRequest } from '../model/addOrganizationApiKeyRequest';
+import { AdminAddOrganizationApiKeyRequest } from '../model/adminAddOrganizationApiKeyRequest';
 import { AdminAddOrganizationUserRequest } from '../model/adminAddOrganizationUserRequest';
+import { AdminAddProjectApiKeyRequest } from '../model/adminAddProjectApiKeyRequest';
 import { AdminAddProjectUserRequest } from '../model/adminAddProjectUserRequest';
+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 { AdminGetUserMetricsResponse } from '../model/adminGetUserMetricsResponse';
 import { AdminGetUserResponse } from '../model/adminGetUserResponse';
@@ -33,14 +39,16 @@ import { GenericApiResponse } from '../model/genericApiResponse';
 import { GetWhitelabelResponse } from '../model/getWhitelabelResponse';
 import { InviteOrganizationMemberRequest } from '../model/inviteOrganizationMemberRequest';
 import { ListOrganizationApiKeysResponse } from '../model/listOrganizationApiKeysResponse';
-import { ListOrganizationProjectsResponse } from '../model/listOrganizationProjectsResponse';
 import { ListOrganizationsResponse } from '../model/listOrganizationsResponse';
+import { ListProjectsResponse } from '../model/listProjectsResponse';
 import { OrganizationInfoResponse } from '../model/organizationInfoResponse';
 import { OrganizationMetricsResponse } from '../model/organizationMetricsResponse';
 import { ProjectInfoResponse } from '../model/projectInfoResponse';
+import { ProjectVisibility } from '../model/projectVisibility';
 import { RemoveMemberRequest } from '../model/removeMemberRequest';
 import { SetMemberDatasetsRequest } from '../model/setMemberDatasetsRequest';
 import { SetMemberRoleRequest } from '../model/setMemberRoleRequest';
+import { StartJobResponse } from '../model/startJobResponse';
 import { UpdateOrganizationRequest } from '../model/updateOrganizationRequest';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { UpdateThemeColorsRequest } from '../model/updateThemeColorsRequest';
@@ -52,7 +60,6 @@ import { UpdateWhitelabelRequest } from '../model/updateWhitelabelRequest';
 import { UploadAssetResponse } from '../model/uploadAssetResponse';
 import { UploadReadmeImageResponse } from '../model/uploadReadmeImageResponse';
 import { WhitelabelAdminCreateOrganizationRequest } from '../model/whitelabelAdminCreateOrganizationRequest';
-import { WhitelabelAdminCreateProjectRequest } from '../model/whitelabelAdminCreateProjectRequest';
 import { Authentication } from '../model/models';
 import { ApiKeyAuth } from '../model/models';
 import { RequestFile } from './apis';
@@ -63,6 +70,7 @@ export declare enum OrganizationsApiApiKeys {
 }
 declare type getOrganizationMetricsQueryParams = {
     excludeEdgeImpulseUsers?: boolean;
+    projectVisibility?: ProjectVisibility;
 };
 declare type uploadOrganizationHeaderFormParams = {
     image?: RequestFile;
@@ -73,8 +81,24 @@ declare type uploadOrganizationLogoFormParams = {
 declare type uploadOrganizationReadmeImageFormParams = {
     image: RequestFile;
 };
+declare type whitelabelAdminCreateOrganizationUsageReportQueryParams = {
+    startDate: Date;
+    endDate: Date;
+};
+declare type whitelabelAdminGetOrganizationComputeTimeUsageQueryParams = {
+    startDate: Date;
+    endDate: Date;
+};
+declare type whitelabelAdminGetOrganizationInfoQueryParams = {
+    includeDeleted?: boolean;
+};
+declare type whitelabelAdminGetOrganizationUsageReportsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 declare type whitelabelAdminGetOrganizationsQueryParams = {
     active?: number;
+    includeDeleted?: boolean;
     sort?: string;
     limit?: number;
     offset?: number;
@@ -189,6 +213,7 @@ export declare class OrganizationsApi {
      * @summary Organization metrics
      * @param organizationId Organization ID
      * @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?: {
         headers: {
@@ -225,7 +250,7 @@ export declare class OrganizationsApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<ListOrganizationProjectsResponse>;
+    }): Promise<ListProjectsResponse>;
     /**
      * Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.
      * @summary List active organizations
@@ -368,6 +393,30 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<DevelopmentBoardCreatedResponse>;
+    /**
+     * White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.
+     * @summary Add organization API key
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param adminAddOrganizationApiKeyRequest
+     */
+    whitelabelAdminAddOrganizationApiKey(organizationId: number, innerOrganizationId: number, adminAddOrganizationApiKeyRequest: AdminAddOrganizationApiKeyRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.
+     * @summary Add Project API key
+     * @param organizationId Organization ID
+     * @param projectId Project ID
+     * @param adminAddProjectApiKeyRequest
+     */
+    whitelabelAdminAddProjectApiKey(organizationId: number, projectId: number, adminAddProjectApiKeyRequest: AdminAddProjectApiKeyRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * White label 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
@@ -403,17 +452,88 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<CreateOrganizationResponse>;
+    /**
+     * White label admin only API to create a new project for an organization.
+     * @summary Create a new organization project
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param adminCreateProjectRequest
+     */
+    whitelabelAdminCreateOrganizationProject(organizationId: number, innerOrganizationId: number, adminCreateProjectRequest: AdminCreateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateProjectResponse>;
+    /**
+     * 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. This is an internal API only available to white label admins.
+     * @summary Creates a new usage report
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param startDate Start date
+     * @param endDate End date
+     */
+    whitelabelAdminCreateOrganizationUsageReport(organizationId: number, innerOrganizationId: number, queryParams: whitelabelAdminCreateOrganizationUsageReportQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
     /**
      * Create a new free tier project. This is an internal API only available to white label admins.
      * @summary Create a new project within white label context.
      * @param organizationId Organization ID
-     * @param whitelabelAdminCreateProjectRequest
+     * @param adminCreateProjectRequest
      */
-    whitelabelAdminCreateProject(organizationId: number, whitelabelAdminCreateProjectRequest: WhitelabelAdminCreateProjectRequest, options?: {
+    whitelabelAdminCreateProject(organizationId: number, adminCreateProjectRequest: AdminCreateProjectRequest, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<CreateProjectResponse>;
+    /**
+     * White label admin only API to delete an organization.
+     * @summary Delete an organization
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     */
+    whitelabelAdminDeleteOrganization(organizationId: number, innerOrganizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Delete a usage report for an organization. This is an internal API only available to white label admins.
+     * @summary Delete usage report
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param usageReportId Usage report ID
+     */
+    whitelabelAdminDeleteOrganizationUsageReport(organizationId: number, innerOrganizationId: number, usageReportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to delete a project.
+     * @summary Delete a project
+     * @param organizationId Organization ID
+     * @param projectId Project ID
+     */
+    whitelabelAdminDeleteProject(organizationId: number, projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Download a usage report for an organization. This is an internal API only available to white label admins.
+     * @summary Download usage report
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param usageReportId Usage report ID
+     */
+    whitelabelAdminDownloadOrganizationUsageReport(organizationId: number, innerOrganizationId: number, usageReportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<any>;
     /**
      * White label admin only API to get the white label information.
      * @summary Get white label information
@@ -434,22 +554,62 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<AdminGetMetricsResponse>;
+    /**
+     * Get compute time usage for an organization over a period of time. This is an internal API only available to white label admins
+     * @summary Get organization compute time usage
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param startDate Start date
+     * @param endDate End date
+     */
+    whitelabelAdminGetOrganizationComputeTimeUsage(organizationId: number, innerOrganizationId: number, queryParams: whitelabelAdminGetOrganizationComputeTimeUsageQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationComputeTimeUsageResponse>;
     /**
      * White label admin only API to list all information about an organization.
      * @summary Get organization information
      * @param organizationId Organization ID
      * @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, options?: {
+    whitelabelAdminGetOrganizationInfo(organizationId: number, innerOrganizationId: number, queryParams: whitelabelAdminGetOrganizationInfoQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<AdminOrganizationInfoResponse>;
+    /**
+     * Get a usage report for an organization. This is an internal API only available to white label admins.
+     * @summary Get usage report
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param usageReportId Usage report ID
+     */
+    whitelabelAdminGetOrganizationUsageReport(organizationId: number, innerOrganizationId: number, usageReportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationUsageReportResponse>;
+    /**
+     * Get all usage reports for an organization. This is an internal API only available to white label admins.
+     * @summary Get all usage reports
+     * @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.
+     */
+    whitelabelAdminGetOrganizationUsageReports(organizationId: number, innerOrganizationId: number, queryParams: whitelabelAdminGetOrganizationUsageReportsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationUsageReportsResponse>;
     /**
      * White label admin only API to get the list of all organizations.
      * @summary Get all organizations within a white label
      * @param organizationId Organization ID
      * @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.
@@ -560,6 +720,17 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to restore a 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
+     * @param innerOrganizationId Organization ID within the context of a white label
+     */
+    whitelabelAdminRestoreOrganization(organizationId: number, innerOrganizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update the default deployment target for this white label.
      * @summary Update default deployment target