edge-impulse-linux 1.4.8 → 1.5.1

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

@@ -1,471 +0,0 @@
-/**
- * Edge Impulse API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * 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';
-import { AdminGetUserMetricsResponse } from '../model/adminGetUserMetricsResponse';
-import { AdminGetUserResponse } from '../model/adminGetUserResponse';
-import { AdminGetUsersResponse } from '../model/adminGetUsersResponse';
-import { AdminListProjectsResponse } from '../model/adminListProjectsResponse';
-import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoResponse';
-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';
-export declare enum OrganizationRequiresWhitelabelAdminApiApiKeys {
-    ApiKeyAuthentication = 0,
-    JWTAuthentication = 1,
-    JWTHttpHeaderAuthentication = 2
-}
-declare type whitelabelAdminGetOrganizationsQueryParams = {
-    active?: number;
-    sort?: string;
-    limit?: number;
-    offset?: number;
-    search?: string;
-};
-declare type whitelabelAdminGetProjectsQueryParams = {
-    active?: number;
-    sort?: string;
-    limit?: number;
-    offset?: number;
-    search?: string;
-};
-declare type whitelabelAdminGetUsersQueryParams = {
-    active?: number;
-    tier?: 'free' | 'pro' | 'enterprise';
-    fields?: string;
-    sort?: string;
-    limit?: number;
-    offset?: number;
-    search?: string;
-};
-declare type whitelabelAdminUpdateDevelopmentBoardImageFormParams = {
-    image?: RequestFile;
-};
-declare type whitelabelAdminUpdateThemeDeviceLogoFormParams = {
-    image?: RequestFile;
-};
-declare type whitelabelAdminUpdateThemeFaviconFormParams = {
-    image: RequestFile;
-};
-declare type whitelabelAdminUpdateThemeLogoFormParams = {
-    image?: RequestFile;
-};
-export declare type OrganizationRequiresWhitelabelAdminApiOpts = {
-    extraHeaders?: {
-        [name: string]: string;
-    };
-};
-export declare class OrganizationRequiresWhitelabelAdminApi {
-    protected _basePath: string;
-    protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
-    protected _opts: OrganizationRequiresWhitelabelAdminApiOpts;
-    protected authentications: {
-        default: Authentication;
-        ApiKeyAuthentication: ApiKeyAuth;
-        JWTAuthentication: ApiKeyAuth;
-        JWTHttpHeaderAuthentication: ApiKeyAuth;
-    };
-    constructor(basePath?: string, opts?: OrganizationRequiresWhitelabelAdminApiOpts);
-    set useQuerystring(value: boolean);
-    set basePath(basePath: string);
-    get basePath(): string;
-    set opts(opts: OrganizationRequiresWhitelabelAdminApiOpts);
-    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
-     * @param organizationId Organization ID
-     * @param projectId Project ID
-     * @param adminAddProjectUserRequest
-     */
-    whitelabelAdminAddUserToProject(organizationId: number, projectId: number, adminAddProjectUserRequest?: AdminAddProjectUserRequest, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): 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
-     * @param organizationId Organization ID
-     * @param whitelabelAdminCreateOrganizationRequest
-     */
-    whitelabelAdminCreateOrganization(organizationId: number, whitelabelAdminCreateOrganizationRequest: WhitelabelAdminCreateOrganizationRequest, options?: {
-        headers: {
-            [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
-     * @param organizationId Organization ID
-     */
-    whitelabelAdminGetInfo(organizationId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<GetWhitelabelResponse>;
-    /**
-     * White label admin only API to get global metrics.
-     * @summary Get global white label metrics
-     * @param organizationId Organization ID
-     */
-    whitelabelAdminGetMetrics(organizationId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<AdminGetMetricsResponse>;
-    /**
-     * 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
-     */
-    whitelabelAdminGetOrganizationInfo(organizationId: number, innerOrganizationId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<AdminOrganizationInfoResponse>;
-    /**
-     * 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 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.
-     * @param search Search query
-     */
-    whitelabelAdminGetOrganizations(organizationId: number, queryParams: whitelabelAdminGetOrganizationsQueryParams, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<AdminGetOrganizationsResponse>;
-    /**
-     * White label admin only API to get project information.
-     * @summary Get a white label project
-     * @param organizationId Organization ID
-     * @param projectId Project ID
-     */
-    whitelabelAdminGetProject(organizationId: number, projectId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<ProjectInfoResponse>;
-    /**
-     * White label admin only API to get the list of all projects.
-     * @summary 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 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?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<AdminListProjectsResponse>;
-    /**
-     * White label admin only API to get information about a user.
-     * @summary Get a white label user
-     * @param organizationId Organization ID
-     * @param userId User ID
-     */
-    whitelabelAdminGetUser(organizationId: number, userId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<AdminGetUserResponse>;
-    /**
-     * White label admin only API to get marketing metrics about a user.
-     * @summary Get white label user metrics
-     * @param organizationId Organization ID
-     * @param userId User ID
-     */
-    whitelabelAdminGetUserMetrics(organizationId: number, userId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<AdminGetUserMetricsResponse>;
-    /**
-     * White label admin only API to get the list of all registered users.
-     * @summary 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)
-     * @param fields Comma separated list of fields to fetch in a query
-     * @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.
-     * @param search Search query
-     */
-    whitelabelAdminGetUsers(organizationId: number, queryParams: whitelabelAdminGetUsersQueryParams, options?: {
-        headers: {
-            [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
-     * @param organizationId Organization ID
-     * @param projectId Project ID
-     * @param userId User ID
-     */
-    whitelabelAdminRemoveUserFromProject(organizationId: number, projectId: number, userId: 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
-     * @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
-     * @param organizationId Organization ID
-     * @param updateWhitelabelDeploymentTargetsRequest
-     */
-    whitelabelAdminUpdateDeploymentTargets(organizationId: number, updateWhitelabelDeploymentTargetsRequest: UpdateWhitelabelDeploymentTargetsRequest, options?: {
-        headers: {
-            [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
-     * @param organizationId Organization ID
-     * @param innerOrganizationId Organization ID within the context of a white label
-     * @param adminUpdateOrganizationRequest
-     */
-    whitelabelAdminUpdateOrganization(organizationId: number, innerOrganizationId: number, adminUpdateOrganizationRequest: AdminUpdateOrganizationRequest, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<GenericApiResponse>;
-    /**
-     * White label admin only API to update project properties.
-     * @summary Update white label project
-     * @param organizationId Organization ID
-     * @param projectId Project ID
-     * @param updateProjectRequest
-     */
-    whitelabelAdminUpdateProject(organizationId: number, projectId: number, updateProjectRequest: UpdateProjectRequest, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<GenericApiResponse>;
-    /**
-     * White label admin only API to update some or all theme colors.
-     * @summary Update theme colors
-     * @param organizationId Organization ID
-     * @param updateThemeColorsRequest
-     */
-    whitelabelAdminUpdateThemeColors(organizationId: number, updateThemeColorsRequest: UpdateThemeColorsRequest, options?: {
-        headers: {
-            [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
-     * @param organizationId Organization ID
-     * @param image
-     */
-    whitelabelAdminUpdateThemeFavicon(organizationId: number, params: whitelabelAdminUpdateThemeFaviconFormParams, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<GenericApiResponse>;
-    /**
-     * White label admin only API to update the white label theme logo.
-     * @summary Update theme logo
-     * @param organizationId Organization ID
-     * @param image
-     */
-    whitelabelAdminUpdateThemeLogo(organizationId: number, params: whitelabelAdminUpdateThemeLogoFormParams, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<UploadAssetResponse>;
-    /**
-     * White label admin only API to update user properties.
-     * @summary Update white label user
-     * @param organizationId Organization ID
-     * @param userId User ID
-     * @param adminUpdateUserRequest
-     */
-    whitelabelAdminUpdateUser(organizationId: number, userId: number, adminUpdateUserRequest: AdminUpdateUserRequest, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<GenericApiResponse>;
-}
-export {};