edge-impulse-api 1.22.2 → 1.32.24444

package/build/library/sdk/api/organizationRequiresWhitelabelAdminApi.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { AdminAddOrganizationUserRequest } from '../model/adminAddOrganizationUserRequest';
 import { AdminAddProjectUserRequest } from '../model/adminAddProjectUserRequest';
 import { AdminGetMetricsResponse } from '../model/adminGetMetricsResponse';
 import { AdminGetOrganizationsResponse } from '../model/adminGetOrganizationsResponse';
@@ -20,14 +21,23 @@ import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoRes
 import { AdminUpdateOrganizationRequest } from '../model/adminUpdateOrganizationRequest';
 import { AdminUpdateUserRequest } from '../model/adminUpdateUserRequest';
 import { CreateOrganizationResponse } from '../model/createOrganizationResponse';
+import { CreateProjectResponse } from '../model/createProjectResponse';
+import { DevelopmentBoardCreatedResponse } from '../model/developmentBoardCreatedResponse';
+import { DevelopmentBoardRequest } from '../model/developmentBoardRequest';
+import { DevelopmentBoardRequestUpdate } from '../model/developmentBoardRequestUpdate';
 import { GenericApiResponse } from '../model/genericApiResponse';
 import { GetWhitelabelResponse } from '../model/getWhitelabelResponse';
 import { ProjectInfoResponse } from '../model/projectInfoResponse';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { UpdateThemeColorsRequest } from '../model/updateThemeColorsRequest';
+import { UpdateWhitelabelDefaultDeploymentTargetRequest } from '../model/updateWhitelabelDefaultDeploymentTargetRequest';
+import { UpdateWhitelabelDeploymentOptionsOrderRequest } from '../model/updateWhitelabelDeploymentOptionsOrderRequest';
 import { UpdateWhitelabelDeploymentTargetsRequest } from '../model/updateWhitelabelDeploymentTargetsRequest';
+import { UpdateWhitelabelLearningBlocksRequest } from '../model/updateWhitelabelLearningBlocksRequest';
+import { UpdateWhitelabelRequest } from '../model/updateWhitelabelRequest';
 import { UploadAssetResponse } from '../model/uploadAssetResponse';
 import { WhitelabelAdminCreateOrganizationRequest } from '../model/whitelabelAdminCreateOrganizationRequest';
+import { WhitelabelAdminCreateProjectRequest } from '../model/whitelabelAdminCreateProjectRequest';
 import { Authentication } from '../model/models';
 import { ApiKeyAuth } from '../model/models';
 import { RequestFile } from './apis';
@@ -59,6 +69,12 @@ declare type whitelabelAdminGetUsersQueryParams = {
     offset?: number;
     search?: string;
 };
+declare type whitelabelAdminUpdateDevelopmentBoardImageFormParams = {
+    image?: RequestFile;
+};
+declare type whitelabelAdminUpdateThemeDeviceLogoFormParams = {
+    image?: RequestFile;
+};
 declare type whitelabelAdminUpdateThemeFaviconFormParams = {
     image: RequestFile;
 };
@@ -89,6 +105,29 @@ export declare class OrganizationRequiresWhitelabelAdminApi {
     get opts(): OrganizationRequiresWhitelabelAdminApiOpts;
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: OrganizationRequiresWhitelabelAdminApiApiKeys, value: string | undefined): void;
+    /**
+     * White label admin only API to add a development board.
+     * @summary Add a development board to a whitelabel
+     * @param organizationId Organization ID
+     * @param developmentBoardRequest
+     */
+    whitelabelAdminAddDevelopmentBoard(organizationId: number, developmentBoardRequest?: DevelopmentBoardRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<DevelopmentBoardCreatedResponse>;
+    /**
+     * 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
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param adminAddOrganizationUserRequest
+     */
+    whitelabelAdminAddUserToOrganization(organizationId: number, innerOrganizationId: number, adminAddOrganizationUserRequest?: AdminAddOrganizationUserRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): 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
@@ -112,6 +151,17 @@ export declare class OrganizationRequiresWhitelabelAdminApi {
             [name: string]: string;
         };
     }): Promise<CreateOrganizationResponse>;
+    /**
+     * 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
+     */
+    whitelabelAdminCreateProject(organizationId: number, whitelabelAdminCreateProjectRequest: WhitelabelAdminCreateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateProjectResponse>;
     /**
      * White label admin only API to get the white label information.
      * @summary Get white label information
@@ -223,6 +273,29 @@ export declare class OrganizationRequiresWhitelabelAdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetUsersResponse>;
+    /**
+     * White label admin only API to remove a development board.
+     * @summary Remove a development board from a whitelabel
+     * @param organizationId Organization ID
+     * @param developmentBoardId Development board ID.
+     */
+    whitelabelAdminRemoveDevelopmentBoard(organizationId: number, developmentBoardId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to remove a user from an organization.
+     * @summary Remove user from an organization
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param userId User ID
+     */
+    whitelabelAdminRemoveUserFromOrganization(organizationId: number, innerOrganizationId: number, userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to remove a user from a project.
      * @summary Remove user from a project
@@ -235,6 +308,28 @@ export declare class OrganizationRequiresWhitelabelAdminApi {
             [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
+     * @param organizationId Organization ID
+     * @param updateWhitelabelDefaultDeploymentTargetRequest
+     */
+    whitelabelAdminUpdateDefaultDeploymentTarget(organizationId: number, updateWhitelabelDefaultDeploymentTargetRequest: UpdateWhitelabelDefaultDeploymentTargetRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): 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
+     * @param organizationId Organization ID
+     * @param updateWhitelabelDeploymentOptionsOrderRequest
+     */
+    whitelabelAdminUpdateDeploymentOptionsOrder(organizationId: number, updateWhitelabelDeploymentOptionsOrderRequest: UpdateWhitelabelDeploymentOptionsOrderRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): 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
@@ -246,6 +341,52 @@ export declare class OrganizationRequiresWhitelabelAdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to update a development board.
+     * @summary Update a development board in a whitelabel
+     * @param organizationId Organization ID
+     * @param developmentBoardId Development board ID.
+     * @param developmentBoardRequestUpdate
+     */
+    whitelabelAdminUpdateDevelopmentBoard(organizationId: number, developmentBoardId: number, developmentBoardRequestUpdate?: DevelopmentBoardRequestUpdate, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to update the image of a development board.
+     * @summary Update the image of a whitelabel development board
+     * @param organizationId Organization ID
+     * @param developmentBoardId Development board ID.
+     * @param image
+     */
+    whitelabelAdminUpdateDevelopmentBoardImage(organizationId: number, developmentBoardId: number, params: whitelabelAdminUpdateDevelopmentBoardImageFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<UploadAssetResponse>;
+    /**
+     * White label admin only API to update the white label information.
+     * @summary Update white label information
+     * @param organizationId Organization ID
+     * @param updateWhitelabelRequest
+     */
+    whitelabelAdminUpdateInfo(organizationId: number, updateWhitelabelRequest: UpdateWhitelabelRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): 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
+     * @param organizationId Organization ID
+     * @param updateWhitelabelLearningBlocksRequest
+     */
+    whitelabelAdminUpdateLearningBlocks(organizationId: number, updateWhitelabelLearningBlocksRequest: UpdateWhitelabelLearningBlocksRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update organization properties such as name and logo.
      * @summary Update organization
@@ -281,6 +422,17 @@ export declare class OrganizationRequiresWhitelabelAdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to update the white label theme device logo.
+     * @summary Update theme device logo
+     * @param organizationId Organization ID
+     * @param image
+     */
+    whitelabelAdminUpdateThemeDeviceLogo(organizationId: number, params: whitelabelAdminUpdateThemeDeviceLogoFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<UploadAssetResponse>;
     /**
      * White label admin only API to update the theme favicon.
      * @summary Update theme favicon
@@ -294,7 +446,7 @@ export declare class OrganizationRequiresWhitelabelAdminApi {
     }): Promise<GenericApiResponse>;
     /**
      * White label admin only API to update the white label theme logo.
-     * @summary Update theme logos
+     * @summary Update theme logo
      * @param organizationId Organization ID
      * @param image
      */