edge-impulse-linux 1.4.1 → 1.4.3

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

@@ -11,14 +11,27 @@
  */
 import { AddMemberRequest } from '../model/addMemberRequest';
 import { AddOrganizationBucketRequest } from '../model/addOrganizationBucketRequest';
+import { AdminGetMetricsResponse } from '../model/adminGetMetricsResponse';
+import { AdminGetOrganizationsResponse } from '../model/adminGetOrganizationsResponse';
+import { AdminGetUserMetricsResponse } from '../model/adminGetUserMetricsResponse';
+import { AdminGetUserResponse } from '../model/adminGetUserResponse';
+import { AdminGetUsersResponse } from '../model/adminGetUsersResponse';
+import { AdminListProjectsResponse } from '../model/adminListProjectsResponse';
+import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoResponse';
+import { AdminUpdateOrganizationRequest } from '../model/adminUpdateOrganizationRequest';
+import { AdminUpdateUserRequest } from '../model/adminUpdateUserRequest';
+import { CreateOrganizationResponse } from '../model/createOrganizationResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
 import { InviteOrganizationMemberRequest } from '../model/inviteOrganizationMemberRequest';
+import { ProjectInfoResponse } from '../model/projectInfoResponse';
 import { RemoveMemberRequest } from '../model/removeMemberRequest';
 import { SetMemberDatasetsRequest } from '../model/setMemberDatasetsRequest';
 import { SetMemberRoleRequest } from '../model/setMemberRoleRequest';
 import { UpdateOrganizationBucketRequest } from '../model/updateOrganizationBucketRequest';
 import { UpdateOrganizationRequest } from '../model/updateOrganizationRequest';
+import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { UploadAssetResponse } from '../model/uploadAssetResponse';
+import { WhitelabelAdminCreateOrganizationRequest } from '../model/whitelabelAdminCreateOrganizationRequest';
 import { Authentication } from '../model/models';
 import { ApiKeyAuth } from '../model/models';
 import { RequestFile } from './apis';
@@ -27,20 +40,57 @@ export declare enum OrganizationRequiresAdminApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+declare type uploadOrganizationHeaderFormParams = {
+    image?: RequestFile;
+};
+declare type uploadOrganizationLogoFormParams = {
+    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;
+};
+export declare type OrganizationRequiresAdminApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
 export declare class OrganizationRequiresAdminApi {
     protected _basePath: string;
     protected defaultHeaders: any;
     protected _useQuerystring: boolean;
+    protected _opts: OrganizationRequiresAdminApiOpts;
     protected authentications: {
         default: Authentication;
         ApiKeyAuthentication: ApiKeyAuth;
         JWTAuthentication: ApiKeyAuth;
         JWTHttpHeaderAuthentication: ApiKeyAuth;
     };
-    constructor(basePath?: string);
+    constructor(basePath?: string, opts?: OrganizationRequiresAdminApiOpts);
     set useQuerystring(value: boolean);
     set basePath(basePath: string);
     get basePath(): string;
+    set opts(opts: OrganizationRequiresAdminApiOpts);
+    get opts(): OrganizationRequiresAdminApiOpts;
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: OrganizationRequiresAdminApiApiKeys, value: string | undefined): void;
     /**
@@ -182,7 +232,7 @@ export declare class OrganizationRequiresAdminApi {
      * @param organizationId Organization ID
      * @param image
      */
-    uploadOrganizationHeader(organizationId: number, image?: RequestFile, options?: {
+    uploadOrganizationHeader(organizationId: number, params: uploadOrganizationHeaderFormParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -193,9 +243,158 @@ export declare class OrganizationRequiresAdminApi {
      * @param organizationId Organization ID
      * @param image
      */
-    uploadOrganizationLogo(organizationId: number, image?: RequestFile, options?: {
+    uploadOrganizationLogo(organizationId: number, params: uploadOrganizationLogoFormParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<UploadAssetResponse>;
+    /**
+     * 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 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 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 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 {};