edge-impulse-api 1.9.9

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

@@ -0,0 +1,1097 @@
+/**
+ * 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 { AddApiKeyResponse } from '../model/addApiKeyResponse';
+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 { AdminCreateOrganizationDataExportRequest } from '../model/adminCreateOrganizationDataExportRequest';
+import { AdminCreateProjectRequest } from '../model/adminCreateProjectRequest';
+import { AdminGetMetricsResponse } from '../model/adminGetMetricsResponse';
+import { AdminGetOrganizationComputeTimeUsageResponse } from '../model/adminGetOrganizationComputeTimeUsageResponse';
+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';
+import { AdminListProjectsResponse } from '../model/adminListProjectsResponse';
+import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoResponse';
+import { AdminProjectInfoResponse } from '../model/adminProjectInfoResponse';
+import { AdminUpdateOrganizationDataExportRequest } from '../model/adminUpdateOrganizationDataExportRequest';
+import { AdminUpdateOrganizationRequest } from '../model/adminUpdateOrganizationRequest';
+import { AdminUpdateUserRequest } from '../model/adminUpdateUserRequest';
+import { CreateOrganizationRequest } from '../model/createOrganizationRequest';
+import { CreateOrganizationResponse } from '../model/createOrganizationResponse';
+import { CreateProjectResponse } from '../model/createProjectResponse';
+import { DevelopmentBoardRequest } from '../model/developmentBoardRequest';
+import { DevelopmentBoardRequestUpdate } from '../model/developmentBoardRequestUpdate';
+import { EnterpriseLimitsIncreaseRequest } from '../model/enterpriseLimitsIncreaseRequest';
+import { EnterpriseUpgradeOrTrialExtensionRequest } from '../model/enterpriseUpgradeOrTrialExtensionRequest';
+import { EntityCreatedResponse } from '../model/entityCreatedResponse';
+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 { ListJobsResponse } from '../model/listJobsResponse';
+import { ListOrganizationApiKeysResponse } from '../model/listOrganizationApiKeysResponse';
+import { ListOrganizationsResponse } from '../model/listOrganizationsResponse';
+import { ListProjectsResponse } from '../model/listProjectsResponse';
+import { OrganizationInfoResponse } from '../model/organizationInfoResponse';
+import { OrganizationMetricsResponse } from '../model/organizationMetricsResponse';
+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';
+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 { UploadReadmeImageResponse } from '../model/uploadReadmeImageResponse';
+import { UserTierEnum } from '../model/userTierEnum';
+import { WhitelabelAdminCreateOrganizationRequest } from '../model/whitelabelAdminCreateOrganizationRequest';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth, OAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum OrganizationsApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+type getOrganizationDataExportsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
+type getOrganizationMetricsQueryParams = {
+    excludeEdgeImpulseUsers?: boolean;
+    projectVisibility?: ProjectVisibility;
+};
+export type uploadOrganizationHeaderFormParams = {
+    image?: RequestFile;
+};
+export type uploadOrganizationLogoFormParams = {
+    image?: RequestFile;
+};
+export type uploadOrganizationReadmeImageFormParams = {
+    image: RequestFile;
+};
+type whitelabelAdminCreateOrganizationUsageReportQueryParams = {
+    startDate: Date;
+    endDate: Date;
+};
+type whitelabelAdminGetOrganizationComputeTimeUsageQueryParams = {
+    startDate: Date;
+    endDate: Date;
+};
+type whitelabelAdminGetOrganizationExportsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
+type whitelabelAdminGetOrganizationInfoQueryParams = {
+    includeDeleted?: boolean;
+};
+type whitelabelAdminGetOrganizationJobsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
+type whitelabelAdminGetOrganizationUsageReportsQueryParams = {
+    limit?: number;
+    offset?: number;
+};
+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;
+};
+export type whitelabelAdminUpdateDevelopmentBoardImageFormParams = {
+    image?: RequestFile;
+};
+export type whitelabelAdminUpdateThemeDeviceLogoFormParams = {
+    image?: RequestFile;
+};
+export type whitelabelAdminUpdateThemeFaviconFormParams = {
+    image: RequestFile;
+};
+export type whitelabelAdminUpdateThemeLogoFormParams = {
+    image?: RequestFile;
+};
+export type OrganizationsApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class OrganizationsApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: OrganizationsApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        OAuth2: OAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: OrganizationsApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: OrganizationsApiOpts);
+    get opts(): OrganizationsApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: OrganizationsApiApiKeys, value: string | undefined): void;
+    set accessToken(token: string);
+    /**
+     * Add an API key.
+     * @summary Add API key
+     * @param organizationId Organization ID
+     * @param addOrganizationApiKeyRequest
+     */
+    addOrganizationApiKey(organizationId: number, addOrganizationApiKeyRequest: AddOrganizationApiKeyRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AddApiKeyResponse>;
+    /**
+     * Add a member to an organization.
+     * @summary Add member
+     * @param organizationId Organization ID
+     * @param addMemberRequest
+     */
+    addOrganizationMember(organizationId: number, addMemberRequest: AddMemberRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<EntityCreatedResponse>;
+    /**
+     * Create a new organization. This is an internal API.
+     * @summary Create new organization
+     * @param createOrganizationRequest
+     */
+    createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateOrganizationResponse>;
+    /**
+     * Remove the current organization, and all data associated with it. This is irrevocable!
+     * @summary Remove organization
+     * @param organizationId Organization ID
+     */
+    deleteOrganization(organizationId: number, options?: {
+        headers: {
+            [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
+     * @param organizationId Organization ID
+     */
+    getOrganizationInfo(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<OrganizationInfoResponse>;
+    /**
+     * Get general metrics for this organization.
+     * @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: {
+            [name: string]: string;
+        };
+    }): Promise<OrganizationMetricsResponse>;
+    /**
+     * Invite a member to an organization.
+     * @summary Invite member
+     * @param organizationId Organization ID
+     * @param inviteOrganizationMemberRequest
+     */
+    inviteOrganizationMember(organizationId: number, inviteOrganizationMemberRequest: InviteOrganizationMemberRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Retrieve all API keys. This does **not** return the full API key, but only a portion (for security purposes).
+     * @summary Get API keys
+     * @param organizationId Organization ID
+     */
+    listOrganizationApiKeys(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationApiKeysResponse>;
+    /**
+     * Retrieve all projects for the organization.
+     * @summary Get projects
+     * @param organizationId Organization ID
+     */
+    listOrganizationProjects(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): 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
+     */
+    listOrganizations(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListOrganizationsResponse>;
+    /**
+     * Remove a member from an organization. Note that you cannot invoke this function if only a single member is present to the organization.
+     * @summary Remove member
+     * @param organizationId Organization ID
+     * @param removeMemberRequest
+     */
+    removeOrganizationMember(organizationId: number, removeMemberRequest: RemoveMemberRequest, options?: {
+        headers: {
+            [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 increase in the limits for this organization. Available limits are: users, projects, compute, storage.
+     * @summary Request organization limits increase
+     * @param organizationId Organization ID
+     * @param enterpriseLimitsIncreaseRequest
+     */
+    requestEnterpriseLimitsIncrease(organizationId: number, enterpriseLimitsIncreaseRequest: EnterpriseLimitsIncreaseRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Request an extension for an enterprise trial.
+     * @summary Request trial extension
+     * @param organizationId Organization ID
+     * @param enterpriseUpgradeOrTrialExtensionRequest
+     */
+    requestEnterpriseTrialExtension(organizationId: number, enterpriseUpgradeOrTrialExtensionRequest: EnterpriseUpgradeOrTrialExtensionRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Resend an invitation to a member in an organization.
+     * @summary Resend invitation
+     * @param organizationId Organization ID
+     * @param memberId Member ID
+     */
+    resendOrganizationMemberInvite(organizationId: number, memberId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Revoke an API key.
+     * @summary Revoke API key
+     * @param organizationId Organization ID
+     * @param apiKeyId API key ID
+     */
+    revokeOrganizationApiKey(organizationId: number, apiKeyId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Set the datasets a guest member has access to in an organization.
+     * @summary Set member datasets
+     * @param organizationId Organization ID
+     * @param memberId Member ID
+     * @param setMemberDatasetsRequest
+     */
+    setOrganizationMemberDatasets(organizationId: number, memberId: number, setMemberDatasetsRequest: SetMemberDatasetsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Change the role of a member in an organization.
+     * @summary Set member role
+     * @param organizationId Organization ID
+     * @param memberId Member ID
+     * @param setMemberRoleRequest
+     */
+    setOrganizationMemberRole(organizationId: number, memberId: number, setMemberRoleRequest: SetMemberRoleRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Test endpoint that can only be reached with admin rights.
+     * @summary Admin endpoint
+     * @param organizationId Organization ID
+     */
+    testOrganizationAdmin(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Update organization properties such as name and logo.
+     * @summary Update organization
+     * @param organizationId Organization ID
+     * @param updateOrganizationRequest
+     */
+    updateOrganization(organizationId: number, updateOrganizationRequest: UpdateOrganizationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Uploads and updates the organization header image
+     * @summary Upload organization header image
+     * @param organizationId Organization ID
+     * @param image
+     */
+    uploadOrganizationHeader(organizationId: number, params: uploadOrganizationHeaderFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<UploadAssetResponse>;
+    /**
+     * Uploads and updates the organization logo
+     * @summary Upload organization logo
+     * @param organizationId Organization ID
+     * @param image
+     */
+    uploadOrganizationLogo(organizationId: number, params: uploadOrganizationLogoFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<UploadAssetResponse>;
+    /**
+     * Uploads an image to the user CDN and returns the path.
+     * @summary Upload image for readme
+     * @param organizationId Organization ID
+     * @param image
+     */
+    uploadOrganizationReadmeImage(organizationId: number, params: uploadOrganizationReadmeImageFormParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<UploadReadmeImageResponse>;
+    /**
+     * White label admin only API to add a development board.
+     * @summary White Label Admin - Add a development board to a whitelabel
+     * @param organizationId Organization ID
+     * @param developmentBoardRequest
+     */
+    whitelabelAdminAddDevelopmentBoard(organizationId: number, developmentBoardRequest: DevelopmentBoardRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<EntityCreatedResponse>;
+    /**
+     * 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 White Label Admin - 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<AddApiKeyResponse>;
+    /**
+     * 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 White Label Admin - 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<AddApiKeyResponse>;
+    /**
+     * White label admin only API to add a user to an organization. If no user is provided, the current user is used.
+     * @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
+     */
+    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 White Label Admin - 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 API only available to white label admins
+     * @summary White Label Admin - 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 data export for an organization. A job is created to process the export request and the job details are returned in the response. This is an API only available to white label admins.
+     * @summary White Label Admin - Create a new organization data export
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param adminCreateOrganizationDataExportRequest
+     */
+    whitelabelAdminCreateOrganizationExport(organizationId: number, innerOrganizationId: number, adminCreateOrganizationDataExportRequest: AdminCreateOrganizationDataExportRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * White label admin only API to create a new project for an organization.
+     * @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
+     */
+    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 API only available to white label admins.
+     * @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
+     * @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 API only available to white label admins.
+     * @summary White Label Admin - Create a new project within white label context.
+     * @param organizationId Organization ID
+     * @param adminCreateProjectRequest
+     */
+    whitelabelAdminCreateProject(organizationId: number, adminCreateProjectRequest: AdminCreateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateProjectResponse>;
+    /**
+     * White label admin only API to 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
+     */
+    whitelabelAdminDeleteOrganization(organizationId: number, innerOrganizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Delete a data export for an organization. This is an API only available to white label admins.
+     * @summary White Label Admin - Delete organization data export
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param exportId Export ID
+     */
+    whitelabelAdminDeleteOrganizationExport(organizationId: number, innerOrganizationId: number, exportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Delete a usage report for an organization. This is an API only available to white label admins.
+     * @summary White Label Admin - Delete usage report
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param reportId Report ID
+     */
+    whitelabelAdminDeleteOrganizationUsageReport(organizationId: number, innerOrganizationId: number, reportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to delete a project.
+     * @summary White Label Admin - Delete a project
+     * @param organizationId Organization ID
+     * @param projectId Project ID
+     */
+    whitelabelAdminDeleteProject(organizationId: number, projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * White label admin only API to delete a user.
+     * @summary Delete a user
+     * @param organizationId Organization ID
+     * @param userId User ID
+     */
+    whitelabelAdminDeleteUser(organizationId: number, userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Download a usage report for an organization. This is an API only available to white label admins.
+     * @summary White Label Admin - Download usage report
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param reportId Report ID
+     */
+    whitelabelAdminDownloadOrganizationUsageReport(organizationId: number, innerOrganizationId: number, reportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<any>;
+    /**
+     * White label admin only API to get the white label information.
+     * @summary White Label Admin - 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 White Label Admin - Get global white label metrics
+     * @param organizationId Organization ID
+     */
+    whitelabelAdminGetMetrics(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetMetricsResponse>;
+    /**
+     * Get compute time usage for an organization over a period of time. This is an API only available to white label admins
+     * @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
+     * @param endDate End date
+     */
+    whitelabelAdminGetOrganizationComputeTimeUsage(organizationId: number, innerOrganizationId: number, queryParams: whitelabelAdminGetOrganizationComputeTimeUsageQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationComputeTimeUsageResponse>;
+    /**
+     * Get a data export for an organization. This is an API only available to white label admins.
+     * @summary White Label Admin - Get organization data export
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param exportId Export ID
+     */
+    whitelabelAdminGetOrganizationExport(organizationId: number, innerOrganizationId: number, exportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataExportResponse>;
+    /**
+     * Get all data exports for an organization. This is an API only available to white label admins.
+     * @summary White Label Admin - Get all organization data exports
+     * @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.
+     */
+    whitelabelAdminGetOrganizationExports(organizationId: number, innerOrganizationId: number, queryParams?: whitelabelAdminGetOrganizationExportsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetOrganizationDataExportsResponse>;
+    /**
+     * White label admin only API to list all information about an organization.
+     * @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)
+     */
+    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 reportId Report ID
+     */
+    whitelabelAdminGetOrganizationUsageReport(organizationId: number, innerOrganizationId: number, reportId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): 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
+     * @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<AdminGetReportsResponse>;
+    /**
+     * White label admin only API to get the list of all organizations.
+     * @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)
+     * @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?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationsResponse>;
+    /**
+     * White label admin only API to get project information.
+     * @summary White Label Admin - Get a white label project
+     * @param organizationId Organization ID
+     * @param projectId Project ID
+     */
+    whitelabelAdminGetProject(organizationId: number, projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminProjectInfoResponse>;
+    /**
+     * 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?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminListProjectsResponse>;
+    /**
+     * White label admin only API to get information about a user.
+     * @summary White Label Admin - 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 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
+     * @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 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, 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?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUsersResponse>;
+    /**
+     * White label admin only API to remove a development board.
+     * @summary White Label Admin - 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 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
+     */
+    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 White Label Admin - 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 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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>;
+    /**
+     * Update a data export for an organization. This is an API only available to white label admins.
+     * @summary White Label Admin - Update organization data export
+     * @param organizationId Organization ID
+     * @param innerOrganizationId Organization ID within the context of a white label
+     * @param exportId Export ID
+     * @param adminUpdateOrganizationDataExportRequest
+     */
+    whitelabelAdminUpdateOrganizationExport(organizationId: number, innerOrganizationId: number, exportId: number, adminUpdateOrganizationDataExportRequest: AdminUpdateOrganizationDataExportRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * White label admin only API to update project properties.
+     * @summary White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 White Label Admin - 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 {};