edge-impulse-linux 1.5.0 → 1.6.0

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

@@ -36,6 +36,8 @@ import { DevelopmentBoardRequest } from '../model/developmentBoardRequest';
 import { DevelopmentBoardRequestUpdate } from '../model/developmentBoardRequestUpdate';
 import { EnterpriseUpgradeOrTrialExtensionRequest } from '../model/enterpriseUpgradeOrTrialExtensionRequest';
 import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetOrganizationDataExportResponse } from '../model/getOrganizationDataExportResponse';
+import { GetOrganizationDataExportsResponse } from '../model/getOrganizationDataExportsResponse';
 import { GetWhitelabelResponse } from '../model/getWhitelabelResponse';
 import { InviteOrganizationMemberRequest } from '../model/inviteOrganizationMemberRequest';
 import { ListOrganizationApiKeysResponse } from '../model/listOrganizationApiKeysResponse';
@@ -68,6 +70,10 @@ export declare enum OrganizationsApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+declare type getOrganizationDataExportsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
 declare type getOrganizationMetricsQueryParams = {
     excludeEdgeImpulseUsers?: boolean;
     projectVisibility?: ProjectVisibility;
@@ -198,6 +204,40 @@ export declare class OrganizationsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Download a data export for an organization.
+     * @summary Download organization data export
+     * @param organizationId Organization ID
+     * @param exportId Export ID
+     */
+    downloadOrganizationDataExport(organizationId: number, exportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<any>;
+    /**
+     * Get a data export for an organization.
+     * @summary Get organization data export
+     * @param organizationId Organization ID
+     * @param exportId Export ID
+     */
+    getOrganizationDataExport(organizationId: number, exportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataExportResponse>;
+    /**
+     * Get all data exports for an organization.
+     * @summary Get all organization data exports
+     * @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.
+     */
+    getOrganizationDataExports(organizationId: number, queryParams: getOrganizationDataExportsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataExportsResponse>;
     /**
      * List all information about this organization.
      * @summary Organization information
@@ -384,7 +424,7 @@ export declare class OrganizationsApi {
     }): Promise<UploadReadmeImageResponse>;
     /**
      * White label admin only API to add a development board.
-     * @summary Add a development board to a whitelabel
+     * @summary White Label Admin - Add a development board to a whitelabel
      * @param organizationId Organization ID
      * @param developmentBoardRequest
      */
@@ -395,7 +435,7 @@ export declare class OrganizationsApi {
     }): 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
+     * @summary White Label Admin - Add organization API key
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param adminAddOrganizationApiKeyRequest
@@ -407,7 +447,7 @@ export declare class OrganizationsApi {
     }): 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
+     * @summary White Label Admin - Add Project API key
      * @param organizationId Organization ID
      * @param projectId Project ID
      * @param adminAddProjectApiKeyRequest
@@ -419,7 +459,7 @@ export declare class OrganizationsApi {
     }): 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
+     * @summary White Label Admin - Add user to an organization
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param adminAddOrganizationUserRequest
@@ -431,7 +471,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label 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
+     * @summary White Label Admin - Add user to a project
      * @param organizationId Organization ID
      * @param projectId Project ID
      * @param adminAddProjectUserRequest
@@ -443,7 +483,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * Create a new organization. This is an internal API only available to white label admins
-     * @summary Create new organization within white label context
+     * @summary White Label Admin - Create new organization within white label context
      * @param organizationId Organization ID
      * @param whitelabelAdminCreateOrganizationRequest
      */
@@ -454,7 +494,7 @@ export declare class OrganizationsApi {
     }): Promise<CreateOrganizationResponse>;
     /**
      * White label admin only API to create a new project for an organization.
-     * @summary Create a new organization project
+     * @summary White Label Admin - Create a new organization project
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param adminCreateProjectRequest
@@ -466,7 +506,7 @@ export declare class OrganizationsApi {
     }): 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
+     * @summary White Label Admin - Creates a new usage report
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param startDate Start date
@@ -479,7 +519,7 @@ export declare class OrganizationsApi {
     }): 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.
+     * @summary White Label Admin - Create a new project within white label context.
      * @param organizationId Organization ID
      * @param adminCreateProjectRequest
      */
@@ -490,7 +530,7 @@ export declare class OrganizationsApi {
     }): Promise<CreateProjectResponse>;
     /**
      * White label admin only API to delete an organization.
-     * @summary Delete an organization
+     * @summary White Label Admin - Delete an organization
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      */
@@ -501,7 +541,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * Delete a usage report for an organization. This is an internal API only available to white label admins.
-     * @summary Delete usage report
+     * @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
@@ -513,7 +553,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to delete a project.
-     * @summary Delete a project
+     * @summary White Label Admin - Delete a project
      * @param organizationId Organization ID
      * @param projectId Project ID
      */
@@ -524,7 +564,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * Download a usage report for an organization. This is an internal API only available to white label admins.
-     * @summary Download usage report
+     * @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
@@ -536,7 +576,7 @@ export declare class OrganizationsApi {
     }): Promise<any>;
     /**
      * White label admin only API to get the white label information.
-     * @summary Get white label information
+     * @summary White Label Admin - Get white label information
      * @param organizationId Organization ID
      */
     whitelabelAdminGetInfo(organizationId: number, options?: {
@@ -546,7 +586,7 @@ export declare class OrganizationsApi {
     }): Promise<GetWhitelabelResponse>;
     /**
      * White label admin only API to get global metrics.
-     * @summary Get global white label metrics
+     * @summary White Label Admin - Get global white label metrics
      * @param organizationId Organization ID
      */
     whitelabelAdminGetMetrics(organizationId: number, options?: {
@@ -556,7 +596,7 @@ export declare class OrganizationsApi {
     }): 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
+     * @summary White Label Admin - Get organization compute time usage
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param startDate Start date
@@ -569,7 +609,7 @@ export declare class OrganizationsApi {
     }): Promise<AdminGetOrganizationComputeTimeUsageResponse>;
     /**
      * White label admin only API to list all information about an organization.
-     * @summary Get organization information
+     * @summary White Label Admin - 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)
@@ -581,7 +621,7 @@ export declare class OrganizationsApi {
     }): Promise<AdminOrganizationInfoResponse>;
     /**
      * Get a usage report for an organization. This is an internal API only available to white label admins.
-     * @summary Get usage report
+     * @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
@@ -593,7 +633,7 @@ export declare class OrganizationsApi {
     }): 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
+     * @summary White Label Admin - 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
@@ -606,7 +646,7 @@ export declare class OrganizationsApi {
     }): Promise<AdminGetOrganizationUsageReportsResponse>;
     /**
      * White label admin only API to get the list of all organizations.
-     * @summary Get all organizations within a white label
+     * @summary White Label Admin - 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)
@@ -622,7 +662,7 @@ export declare class OrganizationsApi {
     }): Promise<AdminGetOrganizationsResponse>;
     /**
      * White label admin only API to get project information.
-     * @summary Get a white label project
+     * @summary White Label Admin - Get a white label project
      * @param organizationId Organization ID
      * @param projectId Project ID
      */
@@ -633,7 +673,7 @@ export declare class OrganizationsApi {
     }): Promise<ProjectInfoResponse>;
     /**
      * White label admin only API to get the list of all projects.
-     * @summary Get all white label 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
@@ -648,7 +688,7 @@ export declare class OrganizationsApi {
     }): Promise<AdminListProjectsResponse>;
     /**
      * White label admin only API to get information about a user.
-     * @summary Get a white label user
+     * @summary White Label Admin - Get a white label user
      * @param organizationId Organization ID
      * @param userId User ID
      */
@@ -659,7 +699,7 @@ export declare class OrganizationsApi {
     }): Promise<AdminGetUserResponse>;
     /**
      * White label admin only API to get marketing metrics about a user.
-     * @summary Get white label user metrics
+     * @summary White Label Admin - Get white label user metrics
      * @param organizationId Organization ID
      * @param userId User ID
      */
@@ -670,7 +710,7 @@ export declare class OrganizationsApi {
     }): Promise<AdminGetUserMetricsResponse>;
     /**
      * White label admin only API to get the list of all registered users.
-     * @summary Get all white label users
+     * @summary White Label Admin - Get all white label users
      * @param organizationId Organization ID
      * @param active Whether to search for entities (users, orgs) active in the last X days
      * @param tier Whether to search for free, pro or enterprise entities (users, projects)
@@ -687,7 +727,7 @@ export declare class OrganizationsApi {
     }): Promise<AdminGetUsersResponse>;
     /**
      * White label admin only API to remove a development board.
-     * @summary Remove a development board from a whitelabel
+     * @summary White Label Admin - Remove a development board from a whitelabel
      * @param organizationId Organization ID
      * @param developmentBoardId Development board ID.
      */
@@ -698,7 +738,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to remove a user from an organization.
-     * @summary Remove user from an organization
+     * @summary White Label Admin - Remove user from an organization
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param userId User ID
@@ -710,7 +750,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to remove a user from a project.
-     * @summary Remove user from a project
+     * @summary White Label Admin - Remove user from a project
      * @param organizationId Organization ID
      * @param projectId Project ID
      * @param userId User ID
@@ -722,7 +762,7 @@ export declare class OrganizationsApi {
     }): 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
+     * @summary White Label Admin - Restore an organization
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      */
@@ -733,7 +773,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update the default deployment target for this white label.
-     * @summary Update default deployment target
+     * @summary White Label Admin - Update default deployment target
      * @param organizationId Organization ID
      * @param updateWhitelabelDefaultDeploymentTargetRequest
      */
@@ -744,7 +784,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to customize the order of deployment options in the deployment view for this white label.
-     * @summary Update the order of deployment options in the deployment view
+     * @summary White Label Admin - Update the order of deployment options in the deployment view
      * @param organizationId Organization ID
      * @param updateWhitelabelDeploymentOptionsOrderRequest
      */
@@ -755,7 +795,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update some or all of the deployment targets enabled for this white label.
-     * @summary Update deployment targets
+     * @summary White Label Admin - Update deployment targets
      * @param organizationId Organization ID
      * @param updateWhitelabelDeploymentTargetsRequest
      */
@@ -766,7 +806,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update a development board.
-     * @summary Update a development board in a whitelabel
+     * @summary White Label Admin - Update a development board in a whitelabel
      * @param organizationId Organization ID
      * @param developmentBoardId Development board ID.
      * @param developmentBoardRequestUpdate
@@ -778,7 +818,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update the image of a development board.
-     * @summary Update the image of a whitelabel development board
+     * @summary White Label Admin - Update the image of a whitelabel development board
      * @param organizationId Organization ID
      * @param developmentBoardId Development board ID.
      * @param image
@@ -790,7 +830,7 @@ export declare class OrganizationsApi {
     }): Promise<UploadAssetResponse>;
     /**
      * White label admin only API to update the white label information.
-     * @summary Update white label information
+     * @summary White Label Admin - Update white label information
      * @param organizationId Organization ID
      * @param updateWhitelabelRequest
      */
@@ -801,7 +841,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update some or all of the learning blocks enabled for this white label.
-     * @summary Update learning blocks
+     * @summary White Label Admin - Update learning blocks
      * @param organizationId Organization ID
      * @param updateWhitelabelLearningBlocksRequest
      */
@@ -812,7 +852,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update organization properties such as name and logo.
-     * @summary Update organization
+     * @summary White Label Admin - Update organization
      * @param organizationId Organization ID
      * @param innerOrganizationId Organization ID within the context of a white label
      * @param adminUpdateOrganizationRequest
@@ -824,7 +864,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update project properties.
-     * @summary Update white label project
+     * @summary White Label Admin - Update white label project
      * @param organizationId Organization ID
      * @param projectId Project ID
      * @param updateProjectRequest
@@ -836,7 +876,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update some or all theme colors.
-     * @summary Update theme colors
+     * @summary White Label Admin - Update theme colors
      * @param organizationId Organization ID
      * @param updateThemeColorsRequest
      */
@@ -847,7 +887,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update the white label theme device logo.
-     * @summary Update theme device logo
+     * @summary White Label Admin - Update theme device logo
      * @param organizationId Organization ID
      * @param image
      */
@@ -858,7 +898,7 @@ export declare class OrganizationsApi {
     }): Promise<UploadAssetResponse>;
     /**
      * White label admin only API to update the theme favicon.
-     * @summary Update theme favicon
+     * @summary White Label Admin - Update theme favicon
      * @param organizationId Organization ID
      * @param image
      */
@@ -869,7 +909,7 @@ export declare class OrganizationsApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update the white label theme logo.
-     * @summary Update theme logo
+     * @summary White Label Admin - Update theme logo
      * @param organizationId Organization ID
      * @param image
      */
@@ -880,7 +920,7 @@ export declare class OrganizationsApi {
     }): Promise<UploadAssetResponse>;
     /**
      * White label admin only API to update user properties.
-     * @summary Update white label user
+     * @summary White Label Admin - Update white label user
      * @param organizationId Organization ID
      * @param userId User ID
      * @param adminUpdateUserRequest