edge-impulse-api 1.22.1 → 1.25.33

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

@@ -0,0 +1,574 @@
+/**
+ * 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 { AdminAddDisallowedEmailDomainRequest } from '../model/adminAddDisallowedEmailDomainRequest';
+import { AdminAddOrUpdateSSODomainIdPsRequest } from '../model/adminAddOrUpdateSSODomainIdPsRequest';
+import { AdminAddOrganizationUserRequest } from '../model/adminAddOrganizationUserRequest';
+import { AdminAddProjectUserRequest } from '../model/adminAddProjectUserRequest';
+import { AdminCreateOrganizationRequest } from '../model/adminCreateOrganizationRequest';
+import { AdminCreateUserTrialRequest } from '../model/adminCreateUserTrialRequest';
+import { AdminGetDataMigrationResponse } from '../model/adminGetDataMigrationResponse';
+import { AdminGetDataMigrationsResponse } from '../model/adminGetDataMigrationsResponse';
+import { AdminGetDisallowedEmailDomainsResponse } from '../model/adminGetDisallowedEmailDomainsResponse';
+import { AdminGetMetricsResponse } from '../model/adminGetMetricsResponse';
+import { AdminGetOrganizationsResponse } from '../model/adminGetOrganizationsResponse';
+import { AdminGetSSODomainIdPsResponse } from '../model/adminGetSSODomainIdPsResponse';
+import { AdminGetSSOSettingsResponse } from '../model/adminGetSSOSettingsResponse';
+import { AdminGetUserIdsResponse } from '../model/adminGetUserIdsResponse';
+import { AdminGetUserMetricsResponse } from '../model/adminGetUserMetricsResponse';
+import { AdminGetUserResponse } from '../model/adminGetUserResponse';
+import { AdminGetUserTrialResponse } from '../model/adminGetUserTrialResponse';
+import { AdminGetUsersResponse } from '../model/adminGetUsersResponse';
+import { AdminListProjectsResponse } from '../model/adminListProjectsResponse';
+import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoResponse';
+import { AdminToggleDataMigrationRequest } from '../model/adminToggleDataMigrationRequest';
+import { AdminUpdateOrganizationRequest } from '../model/adminUpdateOrganizationRequest';
+import { AdminUpdateUserPermissionsRequest } from '../model/adminUpdateUserPermissionsRequest';
+import { AdminUpdateUserRequest } from '../model/adminUpdateUserRequest';
+import { AdminUpdateUserTrialRequest } from '../model/adminUpdateUserTrialRequest';
+import { CreateOrganizationResponse } from '../model/createOrganizationResponse';
+import { EntityCreatedResponse } from '../model/entityCreatedResponse';
+import { FindUserResponse } from '../model/findUserResponse';
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { JobDetailsResponse } from '../model/jobDetailsResponse';
+import { JobLogsResponse } from '../model/jobLogsResponse';
+import { JobMetricsResponse } from '../model/jobMetricsResponse';
+import { JobParentTypeEnum } from '../model/jobParentTypeEnum';
+import { ProjectInfoResponse } from '../model/projectInfoResponse';
+import { UpdateProjectRequest } from '../model/updateProjectRequest';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+export declare enum AdminApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type adminDeleteOrganizationQueryParams = {
+    fullDeletion?: boolean;
+};
+declare type adminDeleteUserQueryParams = {
+    fullDeletion?: boolean;
+};
+declare type adminFindUserQueryParams = {
+    query: string;
+};
+declare type adminGetJobDetailsQueryParams = {
+    parentType: JobParentTypeEnum;
+    includeChildrenJobs?: boolean;
+};
+declare type adminGetJobsLogsQueryParams = {
+    parentType: JobParentTypeEnum;
+    limit: number;
+    offset: number;
+};
+declare type adminGetJobsMetricsQueryParams = {
+    parentType: JobParentTypeEnum;
+};
+declare type adminGetOrganizationsQueryParams = {
+    active?: number;
+    sort?: string;
+    limit?: number;
+    offset?: number;
+    search?: string;
+};
+declare type adminGetProjectsQueryParams = {
+    active?: number;
+    sort?: string;
+    limit?: number;
+    offset?: number;
+    search?: string;
+};
+declare type adminGetUsersQueryParams = {
+    active?: number;
+    tier?: 'free' | 'pro' | 'enterprise';
+    fields?: string;
+    sort?: string;
+    limit?: number;
+    offset?: number;
+    search?: string;
+};
+export declare type AdminApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class AdminApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: AdminApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: AdminApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: AdminApiOpts);
+    get opts(): AdminApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: AdminApiApiKeys, value: string | undefined): void;
+    /**
+     * Admin-only API to add an email domain to the list of disallowed email domains.
+     * @summary Add a disallowed email domain
+     * @param adminAddDisallowedEmailDomainRequest
+     */
+    adminAddDisallowedEmailDomain(adminAddDisallowedEmailDomainRequest: AdminAddDisallowedEmailDomainRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to set the list of identity provider for a given domain.
+     * @summary Add or update SSO settings for a domain
+     * @param domainName Email domain name
+     * @param adminAddOrUpdateSSODomainIdPsRequest
+     */
+    adminAddOrUpdateSSODomainIdPs(domainName: string, adminAddOrUpdateSSODomainIdPsRequest: AdminAddOrUpdateSSODomainIdPsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * 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 adminAddOrganizationUserRequest
+     */
+    adminAddUserToOrganization(organizationId: number, adminAddOrganizationUserRequest?: AdminAddOrganizationUserRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * 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 projectId Project ID
+     * @param adminAddProjectUserRequest
+     */
+    adminAddUserToProject(projectId: number, adminAddProjectUserRequest?: AdminAddProjectUserRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * DEPRECATED. Admin-only API to add the current user to a project.
+     * @summary Add current user to a project
+     * @param projectId Project ID
+     */
+    adminAddUserToProjectDeprecated(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to create a new organization.
+     * @summary Create a new organization
+     * @param adminCreateOrganizationRequest
+     */
+    adminCreateOrganization(adminCreateOrganizationRequest: AdminCreateOrganizationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateOrganizationResponse>;
+    /**
+     * Admin-only API to create an enterprise trial for a user.
+     * @summary Create user enterprise trial
+     * @param userId User ID
+     * @param adminCreateUserTrialRequest
+     */
+    adminCreateUserTrial(userId: number, adminCreateUserTrialRequest: AdminCreateUserTrialRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<EntityCreatedResponse>;
+    /**
+     * Admin-only API to delete an email domain from the list of disallowed email domains.
+     * @summary Delete disallowed email domain
+     * @param domainName Email domain name
+     */
+    adminDeleteDisallowedEmailDomain(domainName: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete an organization. If `fullDeletion` is set, it deletes the organization\'s identifiable information and files. Otherwise, it soft deletes the organization by setting its `delete_date` value.
+     * @summary Delete an organization
+     * @param organizationId Organization ID
+     * @param fullDeletion Set to true for full deletion
+     */
+    adminDeleteOrganization(organizationId: number, queryParams: adminDeleteOrganizationQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete a project.
+     * @summary Delete a project
+     * @param projectId Project ID
+     */
+    adminDeleteProject(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete the list of identity providers for a given domain.
+     * @summary Delete SSO settings for a domain
+     * @param domainName Email domain name
+     */
+    adminDeleteSSODomainIdPs(domainName: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete a user. If `fullDeletion` is set, it deletes the user\'s identifiable information and files. Otherwise, it soft deletes the user by setting it\'s `delete_date` value.
+     * @summary Delete a user
+     * @param userId User ID
+     * @param fullDeletion Set to true for full deletion
+     */
+    adminDeleteUser(userId: number, queryParams: adminDeleteUserQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to delete an enterprise trial for a user.
+     * @summary Delete user enterprise trial
+     * @param userId User ID
+     * @param enterpriseTrialId Enterprise trial ID
+     */
+    adminDeleteUserTrial(userId: number, enterpriseTrialId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * DEPRECATED. Admin-only API to find a user by username or email address.
+     * @summary Find a user
+     * @param query Part of e-mail address or username
+     */
+    adminFindUser(queryParams: adminFindUserQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<FindUserResponse>;
+    /**
+     * DEPRECATED. Admin-only API to get list of all users that have been active in the past 30 days.
+     * @summary Get all user IDs (active last 30 days)
+     */
+    adminGetAllActiveUserIds(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserIdsResponse>;
+    /**
+     * DEPRECATED. Admin-only API to get list of all users.
+     * @summary Get all user IDs
+     */
+    adminGetAllUserIds(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserIdsResponse>;
+    /**
+     * Admin-only API to get a data migration.
+     * @summary Get data migration
+     * @param migrationId Data migration ID
+     */
+    adminGetDataMigration(migrationId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetDataMigrationResponse>;
+    /**
+     * Admin-only API to get data migrations.
+     * @summary Get data migrations
+     */
+    adminGetDataMigrations(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetDataMigrationsResponse>;
+    /**
+     * Admin-only API to get the list of disallowed email domains.
+     * @summary Get the list of disallowed email domains
+     */
+    adminGetDisallowedEmailDomains(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetDisallowedEmailDomainsResponse>;
+    /**
+     * Get the job execution details including inner jobs
+     * @summary Get job execution details
+     * @param jobId Job ID
+     * @param parentType Job parent type (project or organization)
+     * @param includeChildrenJobs Include the details of each of the children jobs (recursively)
+     */
+    adminGetJobDetails(jobId: number, queryParams: adminGetJobDetailsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<JobDetailsResponse>;
+    /**
+     * Get the logs for a job.
+     * @summary Get job logs
+     * @param jobId Job ID
+     * @param parentType Job parent type (project or organization)
+     * @param limit Maximum number of logs
+     * @param offset Start fetching logs from this offset
+     */
+    adminGetJobsLogs(jobId: number, queryParams: adminGetJobsLogsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<JobLogsResponse>;
+    /**
+     * Get cpu/memory usage metrics, if the job is a Kubernetes job
+     * @summary Get job usage metrics
+     * @param jobId Job ID
+     * @param parentType Job parent type (project or organization)
+     */
+    adminGetJobsMetrics(jobId: number, queryParams: adminGetJobsMetricsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<JobMetricsResponse>;
+    /**
+     * Admin-only API to get global metrics.
+     * @summary Get global metrics
+     */
+    adminGetMetrics(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetMetricsResponse>;
+    /**
+     * Admin-only API to list all information about this organization.
+     * @summary Organization information
+     * @param organizationId Organization ID
+     */
+    adminGetOrganizationInfo(organizationId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminOrganizationInfoResponse>;
+    /**
+     * Admin-only API to get the list of all organizations.
+     * @summary Get all organizations
+     * @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
+     */
+    adminGetOrganizations(queryParams: adminGetOrganizationsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOrganizationsResponse>;
+    /**
+     * Admin-only API to get project information.
+     * @summary Get project
+     * @param projectId Project ID
+     */
+    adminGetProject(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProjectInfoResponse>;
+    /**
+     * Admin-only API to get the list of all projects.
+     * @summary Get all projects
+     * @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
+     */
+    adminGetProjects(queryParams: adminGetProjectsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminListProjectsResponse>;
+    /**
+     * Admin-only API to get the list of identity providers enabled for a given domain.
+     * @summary Get SSO settings for a domain
+     * @param domainName Email domain name
+     */
+    adminGetSSODomainIdPs(domainName: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetSSODomainIdPsResponse>;
+    /**
+     * Admin-only API to get the SSO settings.
+     * @summary Get SSO settings
+     */
+    adminGetSSOSettings(options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetSSOSettingsResponse>;
+    /**
+     * Admin-only API to get information about a user.
+     * @summary Get user
+     * @param userId User ID
+     */
+    adminGetUser(userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserResponse>;
+    /**
+     * Admin-only API to get marketing metrics about a user.
+     * @summary Get user metrics
+     * @param userId User ID
+     */
+    adminGetUserMetrics(userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserMetricsResponse>;
+    /**
+     * Admin-only API to get a specific enterprise trial.
+     * @summary Get user enterprise trial
+     * @param userId User ID
+     * @param enterpriseTrialId Enterprise trial ID
+     */
+    adminGetUserTrial(userId: number, enterpriseTrialId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUserTrialResponse>;
+    /**
+     * Admin-only API to get the list of all registered users.
+     * @summary Get all users
+     * @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
+     */
+    adminGetUsers(queryParams: adminGetUsersQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetUsersResponse>;
+    /**
+     * Admin-only API to remove a user from an organization.
+     * @summary Remove user from an organization
+     * @param organizationId Organization ID
+     * @param userId User ID
+     */
+    adminRemoveUserFromOrganization(organizationId: number, userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to remove a user from a project.
+     * @summary Remove user from a project
+     * @param projectId Project ID
+     * @param userId User ID
+     */
+    adminRemoveUserFromProject(projectId: number, userId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * DEPRECATED. Admin-only API to remove the current user from a project.
+     * @summary Remove current user from a project
+     * @param projectId Project ID
+     */
+    adminRemoveUserFromProjectDeprecated(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to run or pause a data migration.
+     * @summary Run or pause a data migration
+     * @param migrationId Data migration ID
+     * @param adminToggleDataMigrationRequest
+     */
+    adminToggleDataMigration(migrationId: string, adminToggleDataMigrationRequest: AdminToggleDataMigrationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update organization properties such as name and logo.
+     * @summary Update organization
+     * @param organizationId Organization ID
+     * @param adminUpdateOrganizationRequest
+     */
+    adminUpdateOrganization(organizationId: number, adminUpdateOrganizationRequest: AdminUpdateOrganizationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update project properties.
+     * @summary Update project
+     * @param projectId Project ID
+     * @param updateProjectRequest
+     */
+    adminUpdateProject(projectId: number, updateProjectRequest: UpdateProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update user properties.
+     * @summary Update user
+     * @param userId User ID
+     * @param adminUpdateUserRequest
+     */
+    adminUpdateUser(userId: number, adminUpdateUserRequest: AdminUpdateUserRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update the list of permissions for a user.
+     * @summary Update user permissions
+     * @param userId User ID
+     * @param adminUpdateUserPermissionsRequest
+     */
+    adminUpdateUserPermissions(userId: number, adminUpdateUserPermissionsRequest: AdminUpdateUserPermissionsRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Admin-only API to update an enterprise trial for a user.
+     * @summary Update user enterprise trial
+     * @param userId User ID
+     * @param enterpriseTrialId Enterprise trial ID
+     * @param adminUpdateUserTrialRequest
+     */
+    adminUpdateUserTrial(userId: number, enterpriseTrialId: number, adminUpdateUserTrialRequest: AdminUpdateUserTrialRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+}
+export {};