@frontegg/rest-api 2.10.89 → 3.0.2

package/src/teams/index.ts

@@ -1,224 +0,0 @@
-import {Get, Post, Put, Delete, Patch} from '../fetch';
-import {urls,} from '../constants';
-import {
-  IAddUser,
-  IChangePassword,
-  ILoadUsers,
-  IResendActivationLink,
-  ITeamUserRole,
-  ITeamStats,
-  ITeamUser,
-  IUpdateProfile,
-  IUserProfile,
-  IUpdateUser,
-  IDeleteUser,
-  ITeamUserPermission,
-  IResendInvitationLink,
-  IInviteUserLinkResponse,
-  ICreateOrUpdateInviteUserLink,
-  IInviteLinkConfiguration,
-} from './interfaces';
-import {PaginationResult} from '../interfaces';
-
-/*****************************************
- * Profile Api
- *****************************************/
-
-/**
- * change user password by providing current password and the new password.
- *
- * @throws exception if the current password incorrect or new password validation failed.
- * ``authorized user``
- */
-export async function getProfile(params?: object): Promise<IUserProfile> {
-  console.debug('getProfile()');
-  return Get(`${urls.identity.users.v2}/me`, params ?? {addRoles: true});
-}
-
-/**
- * update user profile by providing updated fields.
- * ``authorized user``
- */
-export async function updateProfile(body: Partial<IUpdateProfile>): Promise<IUserProfile> {
-  console.debug('updateProfile()', body);
-  return Put(`${urls.identity.users.v2}/me`, body);
-}
-
-/**
- * update user profile image
- * ``authorized user``
- */
-
-export async function updateProfileImage(body: FormData): Promise<string> {
-  console.debug('updateProfileImage()', body);
-  return Put(`${urls.team.profile.v1}/me/image/v1`, body, {responseType: 'plain', contentType: undefined});
-}
-
-/**
- * change user password by providing current password and the new password.
- *
- * @throws exception if the current password incorrect or new password validation failed.
- * ``authorized user``
- */
-export async function changePassword(body: IChangePassword): Promise<void> {
-  console.debug('changePassword()');
-  return Post(`${urls.identity.users.v1}/passwords/change`, body);
-}
-
-/*****************************************
- * Team Api
- *****************************************/
-/**
- * load users from team-management-service
- *
- * ``authorized user``
- */
-export async function loadUsers(params: ILoadUsers): Promise<PaginationResult<ITeamUser>> {
-  const filters = (params.filter || []).reduce((p, n) => ({...p, [n.id]: n.value}), {});
-  const sorts = params.sort?.length
-    ? {
-      sortBy: params.sort?.[0]?.id ?? 'name',
-      sortDirection: params.sort?.[0]?.desc ? 'desc' : 'asc',
-    }
-    : null;
-  return Get(urls.team.members.v1, {
-    pageOffset: params.pageOffset,
-    pageSize: params.pageSize,
-    ...filters,
-    ...sorts,
-  });
-}
-
-/**
- * add user to team, invitation link will be sent to the added user.
- *
- * ``authorized user``
- */
-export async function addUser(body: IAddUser): Promise<ITeamUser> {
-  console.debug('addUser()', body);
-  return Post(urls.identity.users.v2, {...body, provider: 'local'});
-}
-
-/**
- * delete user from team, user will be deleted.
- *
- * ``authorized user``
- */
-export async function deleteUser(body: IDeleteUser): Promise<ITeamUser> {
-  console.debug('deleteUser()', body);
-  return Delete(`${urls.team.members.v1}/${body.userId}`);
-}
-
-/**
- * edit user roles in team
- *
- * ``authorized user``
- */
-export async function updateUser(body: IUpdateUser): Promise<ITeamUser> {
-  console.debug('editUser()', body);
-  return Put(urls.team.members.v1, body);
-}
-
-/**
- * create link to invite user
- *
- * ``authorized user``
- */
- export async function createInviteUserLink(body: ICreateOrUpdateInviteUserLink): Promise<IInviteUserLinkResponse> {
-  console.debug('createInviteUserLink()');
-  return Post(urls.identity.tenants.invites.user.v1, { ...body });
-}
-
-/**
- * update link to invite user
- *
- * ``authorized user``
- */
- export async function updateInviteUserLink(body: ICreateOrUpdateInviteUserLink): Promise<IInviteUserLinkResponse> {
-  console.debug('updateInviteUserLink()', body);
-  return Patch(urls.identity.tenants.invites.user.v1, { ...body });
-}
-
-/**
- * delete link to invite user
- *
- * ``authorized user``
- */
- export async function deleteInviteUserLink(): Promise<void> {
-  console.debug('deleteInviteUserLink()');
-  return Delete(urls.identity.tenants.invites.user.v1);
-}
-
-/**
- * get link to invite user
- *
- * ``authorized user``
- */
- export async function getInviteUserLink(): Promise<IInviteUserLinkResponse> {
-  console.debug('getInviteUserLink()');
-  return Get(urls.identity.tenants.invites.user.v1);
-}
-
-/**
- * get invite link configuration
- *
- */
-export async function getInviteLinkConfiguration(): Promise<IInviteLinkConfiguration> {
-  console.debug('getInviteLinkConfiguration()');
-  return Get(urls.identity.tenants.invites.configuration.v1);
-}
-
-/**
- * load available roles that can be assigned to team users from team-management-service
- *
- * ``authorized user``
- */
-export async function loadAvailableRoles(): Promise<ITeamUserRole[]> {
-  console.debug('loadAvailableRoles()');
-  return Get(urls.team.roles.v1);
-}
-
-export async function loadAvailablePermissions(): Promise<ITeamUserPermission[]> {
-  console.debug('loadAvailablePermissions()');
-  return Get(urls.identity.permissions.v1);
-}
-
-/**
- * load users stats from team-management-service
- *
- * ``authorized user``
- */
-export async function loadStats(): Promise<ITeamStats> {
-  console.debug('loadStats()');
-  return Get(`${urls.team.stats.v1}/members`);
-}
-
-/**
- * resend activation link to specific user
- *
- * ``authorized user``
- */
-export async function resendActivationLink(body: IResendActivationLink): Promise<void> {
-  console.debug('resendActivationLink()', body);
-  return Post(`${urls.team.members.v1}/${body.userId}/resendActivationEmail`, {});
-}
-
-/**
- * resend accept join tenant invitation link to specific user
- *
- * ``authorized user``
- */
-export async function resendInvitationLink(body: IResendInvitationLink): Promise<void> {
-  console.debug('resendInvitationLink()', body);
-  return Post(urls.identity.users.v2, {...body, provider: 'local'});
-}
-
-/**
- * resend accept join all pending tenant for current hierarchy invitation link to specific user
- *
- * ``authorized user``
- */
-export async function resendInvitationLinkToAllTenants(body: IResendInvitationLink): Promise<void> {
-  console.debug('resendInvitationLinkToAllTenants()', body);
-  return Post(urls.identity.users.invitation.resendAll.v1, {...body });
-}

package/src/teams/interfaces.ts

@@ -1,163 +0,0 @@
-import { QueryFilter, QuerySort } from '../interfaces';
-import { IRole, IRolePermission } from '../roles/interfaces';
-
-export type IUserProfile = {
-  id: string;
-  email: string;
-  mfaEnrolled: boolean;
-  name: string;
-  phoneNumber?: string;
-  profileImage?: string;
-  profilePictureUrl: string;
-  roles: IRole[];
-  permissions: IRolePermission[];
-  tenantId: string;
-  tenantIds: string[];
-  activatedForTenant?: boolean;
-  metadata: any;
-  roleIds?: string[]; // { addRoles: true } params
-  verified?: boolean;
-  superUser?: boolean;
-};
-
-export type ITeamUserTenant = {
-  tenantId: string;
-  roles: IRole[]
-}
-
-export type ITeamUser = {
-  // info
-  id: string;
-  email: string;
-  name: string;
-  phone?: string;
-  profileImage?: string;
-  profileImageUrl?: string;
-  // association
-  tenantId: string;
-  vendorId: string;
-  roleIds: string[];
-  roles: IRole[];
-  activatedForTenant: boolean;
-
-  // other
-  createdAt: string;
-  customData?: any;
-  lastLogin?: string;
-  mfaEnabled?: boolean;
-  tenants?:  ITeamUserTenant;
-  verified?: boolean;
-};
-
-export type ITeamUserRole = {
-  id: string;
-  description: string;
-  key: string;
-  name: string;
-  permissions?: string[];
-  permissionLevel?: number;
-};
-
-export type ITeamUserPermission = {
-  description: string;
-  fePermission: boolean;
-  id: string;
-  key: string;
-  name: string;
-  roleIds: string[];
-  createdAt: Date;
-  updatedAt: Date;
-  categoryId: string;
-};
-
-export interface ISamlRolesGroup {
-  id: string;
-  group: string;
-  roleIds: string[];
-}
-
-export type ITeamStats = {
-  totalItems: number;
-  addedThisWeek: number;
-  superAdmins: number;
-};
-
-// api actions
-
-export type IUpdateProfile = {
-  title: 'Mr' | 'Miss' | 'Mrs' | 'Ms';
-  name: string;
-  country: string;
-  phoneNumber: string;
-  // time since 1970
-  dateOfBirth: number;
-  // profile picture in base64
-  profilePicture: string;
-};
-
-export type IUpdateProfileImage = {
-  profileImage: string;
-};
-
-export type IChangePassword = {
-  password: string;
-  newPassword: string;
-};
-
-export type ILoadUsers = {
-  silentLoading?: boolean;
-  filter?: QueryFilter[];
-  sort?: QuerySort[];
-  pageOffset: number;
-  pageSize?: number;
-};
-
-export type IAddUser = {
-  name: string;
-  email: string;
-  phone?: string;
-  roleIds: string[];
-};
-
-export type IDeleteUser = {
-  userId: string;
-};
-
-export type IUpdateUser = Partial<ITeamUser>;
-
-export type IResendActivationLink = {
-  userId: string;
-};
-
-export type IResendInvitationLink = {
-  email: string;
-};
-
-export type ISendResetPasswordLink = {
-  userId: string;
-};
-
-export type ICreateOrUpdateInviteUserLink = {
-  expiresInMinutes?: number;
-  shouldSendEmail?: boolean; 
-};
-
-/**
-* invite config
-*/
-export type IInviteUserLinkResponse = {
-  id: string;
-  vendorId: string;
-  tenantId: string;
-  userId?: string;
-  token: string;
-  expires: Date;
-  shouldSendEmail?: boolean;
-}
-/**
-* vendor config
-*/
-export type IInviteLinkConfiguration = {
-  tenantInvitationsAllowed: boolean;
-  emailsEnabled: boolean;
-}

package/src/tenants/index.ts

@@ -1,46 +0,0 @@
-import { ISubTenant, ISubTenantTree, ISwitchTenant, ITenantsResponse } from './interfaces';
-import { Get, Put } from '../fetch';
-import { urls } from '../constants';
-
-/**
- * switch logged in user to specific tenant by providing tenantId.
- *
- * @throws exception if invalid tenantId.
- * ``authorized user``
- */
-export async function switchTenant(body: ISwitchTenant): Promise<void> {
-  console.debug('switchTenant()', body);
-  return Put(`${urls.identity.users.v1}/tenant`, body);
-}
-
-/**
- * retrieve logged in user's available tenants.
- *
- * ``authorized user``
- */
-export async function getTenants(): Promise<ITenantsResponse[]> {
-  console.debug('getTenants()');
-  return Get(`${urls.identity.users.v2}/me/tenants`);
-}
-
-
-/**
- * retrieve logged in user's available sub tenants.
- *
- * ``authorized user``
- */
-export async function getSubTenants(): Promise<ISubTenant> {
-  console.debug('getSubTenants()');
-  return Get(urls.tenants.hierarchy.v1);
-}
-
-/**
- * retrieve logged in user's available sub tenants as a tree.
- *
- * ``authorized user``
- */
-export async function getSubTenantsAsTree(): Promise<ISubTenantTree> {
-  console.debug('getSubTenantsAsTree()');
-  return Get(urls.tenants.hierarchy.tree.v1);
-}
-

package/src/tenants/interfaces.ts

@@ -1,33 +0,0 @@
-export interface ISwitchTenant {
-  tenantId: string;
-}
-
-export interface ITenantsResponse {
-  id: string;
-  name: string;
-  deletedAt: null;
-  metadata: any;
-  tenantId: string;
-  vendorId: string;
-  isReseller: boolean;
-  createdAt: Date;
-  updatedAt: Date;
-  address?: string;
-  timezone?: string;
-  dateFormat?: string;
-  timeFormat?: string;
-  currency?: string;
-  logo?: string;
-}
-
-export interface ISubTenant {
-  tenantId: string;
-  tenantName?: string;
-  level: number;
-}
-
-export interface ISubTenantTree {
-  tenantId: string;
-  tenantName?: string;
-  children: ISubTenantTree[];
-}

package/src/vendor/index.ts

@@ -1,12 +0,0 @@
-import {Get} from '../fetch';
-import {urls} from '../constants';
-import {IVendorPublicInfoResponse} from "./interfaces";
-
-/**
- * provide vendor public info by providing the vendor context.
- * @return IVendorPublicInfoResponse
- */
-export async function getVendorPublicInfo(): Promise<IVendorPublicInfoResponse> {
-    console.debug('getVendorPublicInfo()');
-    return Get(`${urls.vendor}/public`);
-};

package/src/vendor/interfaces.ts

@@ -1,6 +0,0 @@
-export interface IVendorPublicInfoResponse {
-    name: string;
-    logo: string;
-    icon: string;
-    whiteLabelMode: boolean;
-}