edge-impulse-api 1.22.1 → 1.22.2

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

@@ -0,0 +1,555 @@
+/**
+ * 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 { AddMemberRequest } from '../model/addMemberRequest';
+import { AddOrganizationApiKeyRequest } from '../model/addOrganizationApiKeyRequest';
+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 { CreateOrganizationRequest } from '../model/createOrganizationRequest';
+import { CreateOrganizationResponse } from '../model/createOrganizationResponse';
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetWhitelabelResponse } from '../model/getWhitelabelResponse';
+import { InviteOrganizationMemberRequest } from '../model/inviteOrganizationMemberRequest';
+import { ListOrganizationApiKeysResponse } from '../model/listOrganizationApiKeysResponse';
+import { ListOrganizationProjectsResponse } from '../model/listOrganizationProjectsResponse';
+import { ListOrganizationsResponse } from '../model/listOrganizationsResponse';
+import { OrganizationInfoResponse } from '../model/organizationInfoResponse';
+import { OrganizationMetricsResponse } from '../model/organizationMetricsResponse';
+import { ProjectInfoResponse } from '../model/projectInfoResponse';
+import { RemoveMemberRequest } from '../model/removeMemberRequest';
+import { SetMemberDatasetsRequest } from '../model/setMemberDatasetsRequest';
+import { SetMemberRoleRequest } from '../model/setMemberRoleRequest';
+import { UpdateOrganizationRequest } from '../model/updateOrganizationRequest';
+import { UpdateProjectRequest } from '../model/updateProjectRequest';
+import { UpdateThemeColorsRequest } from '../model/updateThemeColorsRequest';
+import { UpdateWhitelabelDeploymentTargetsRequest } from '../model/updateWhitelabelDeploymentTargetsRequest';
+import { UploadAssetResponse } from '../model/uploadAssetResponse';
+import { UploadReadmeImageResponse } from '../model/uploadReadmeImageResponse';
+import { WhitelabelAdminCreateOrganizationRequest } from '../model/whitelabelAdminCreateOrganizationRequest';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+import { RequestFile } from './apis';
+export declare enum OrganizationsApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type uploadOrganizationHeaderFormParams = {
+    image?: RequestFile;
+};
+declare type uploadOrganizationLogoFormParams = {
+    image?: RequestFile;
+};
+declare type uploadOrganizationReadmeImageFormParams = {
+    image: RequestFile;
+};
+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 whitelabelAdminUpdateThemeFaviconFormParams = {
+    image: RequestFile;
+};
+declare type whitelabelAdminUpdateThemeLogoFormParams = {
+    image?: RequestFile;
+};
+export declare 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;
+        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;
+    /**
+     * 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<GenericApiResponse>;
+    /**
+     * 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<GenericApiResponse>;
+    /**
+     * 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>;
+    /**
+     * 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
+     */
+    getOrganizationMetrics(organizationId: number, 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<ListOrganizationProjectsResponse>;
+    /**
+     * 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>;
+    /**
+     * 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 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>;
+    /**
+     * 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 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 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 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 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 logos
+     * @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 {};