@frontegg/rest-api 3.0.99 → 3.0.100

package/constants.d.ts

@@ -73,6 +73,9 @@ export declare const urls: {
                     v1: string;
                 };
             };
+            users: {
+                v1: string;
+            };
         };
         roles: {
             v1: string;

package/constants.js

@@ -72,6 +72,9 @@ export const urls = {
         configuration: {
           v1: '/identity/resources/tenants/invites/v1/configuration'
         }
+      },
+      users: {
+        v1: "/identity/resources/tenants/users/v1"
       }
     },
     roles: {

package/fetch.d.ts

@@ -1,4 +1,4 @@
-import { ContextOptions } from './interfaces';
+import { ContextOptions, UserJwtOptions } from './interfaces';
 interface RequestOptions {
     url: string;
     method: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
@@ -16,4 +16,7 @@ export declare const Patch: (url: string, body?: any, opts?: Pick<RequestOptions
 export declare const Put: (url: string, body?: any, opts?: Pick<RequestOptions, "body" | "params" | "contentType" | "responseType" | "headers" | "credentials"> | undefined) => Promise<any>;
 export declare const Delete: (url: string, body?: any, opts?: Pick<RequestOptions, "body" | "params" | "contentType" | "responseType" | "headers" | "credentials"> | undefined) => Promise<any>;
 export declare const PostDownload: (url: string, body?: any, params?: any, opts?: any) => Promise<any>;
+export declare const extractHeadersFromOptions: (options?: UserJwtOptions) => {
+    Authorization?: string;
+};
 export {};

package/fetch.js

@@ -212,4 +212,7 @@ export const PostDownload = async (url, body, params, opts) => sendRequest(_exte
   responseType: 'blob',
   body,
   params
-}, opts));
+}, opts));
+export const extractHeadersFromOptions = (options = {}) => _extends({}, options.jwt ? {
+  Authorization: options.jwt
+} : {});

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.99
+/** @license Frontegg v3.0.100
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/interfaces.d.ts

@@ -6,6 +6,12 @@ export interface PaginationResult<T> {
     totalPages: number;
     items: T[];
 }
+export interface FronteggPaginationLinks {
+    next: string;
+    prev: string;
+    first: string;
+    last: string;
+}
 export interface FronteggPaginationResult<T> {
     _metadata: {
         totalPages: number;
@@ -13,6 +19,9 @@ export interface FronteggPaginationResult<T> {
     };
     items: T[];
 }
+export interface FronteggPaginationWrapper<T> extends FronteggPaginationResult<T> {
+    _links?: FronteggPaginationLinks;
+}
 export interface KeyValuePair {
     key: string;
     value: string;
@@ -53,3 +62,6 @@ export interface RedirectOptions {
     replace?: boolean;
     preserveQueryParams?: boolean;
 }
+export interface UserJwtOptions {
+    jwt?: string;
+}

package/node/constants.js

@@ -78,6 +78,9 @@ const urls = {
         configuration: {
           v1: '/identity/resources/tenants/invites/v1/configuration'
         }
+      },
+      users: {
+        v1: "/identity/resources/tenants/users/v1"
       }
     },
     roles: {

package/node/fetch.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Put = exports.PostDownload = exports.Post = exports.Patch = exports.Get = exports.Delete = void 0;
+exports.extractHeadersFromOptions = exports.Put = exports.PostDownload = exports.Post = exports.Patch = exports.Get = exports.Delete = void 0;
 exports.getBaseUrl = getBaseUrl;
 
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
@@ -243,4 +243,10 @@ const PostDownload = async (url, body, params, opts) => sendRequest((0, _extends
   params
 }, opts));
 
-exports.PostDownload = PostDownload;
+exports.PostDownload = PostDownload;
+
+const extractHeadersFromOptions = (options = {}) => (0, _extends2.default)({}, options.jwt ? {
+  Authorization: options.jwt
+} : {});
+
+exports.extractHeadersFromOptions = extractHeadersFromOptions;

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.99
+/** @license Frontegg v3.0.100
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/sub-tenants/index.js

@@ -25,8 +25,10 @@ async function addUserToTenantAndSubTenants(body) {
   return (0, _fetch.Post)(_constants.urls.identity.subTenants.v1, body);
 }
 
-async function removeUserFromTenantAndSubTenants(body) {
-  return (0, _fetch.Delete)(_constants.urls.identity.subTenants.v1, body);
+async function removeUserFromTenantAndSubTenants(body, options) {
+  return (0, _fetch.Delete)(_constants.urls.identity.subTenants.v1, body, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }
 
 async function addUserRolesForSubTenants(userId, body) {
@@ -37,18 +39,26 @@ async function removeUserRolesFromSubTenants(userId, body) {
   return (0, _fetch.Delete)(`${_constants.urls.identity.subTenants.v1}/${userId}/roles`, body);
 }
 
-async function setUserRolesForSubTenants(userId, body) {
-  return (0, _fetch.Patch)(`${_constants.urls.identity.subTenants.v1}/${userId}/roles`, body);
+async function setUserRolesForSubTenants(userId, body, options) {
+  return (0, _fetch.Patch)(`${_constants.urls.identity.subTenants.v1}/${userId}/roles`, body, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }
 
-async function createSubTenant(body) {
-  return (0, _fetch.Post)(_constants.urls.tenants.subTenants.v1, body);
+async function createSubTenant(body, options) {
+  return (0, _fetch.Post)(_constants.urls.tenants.subTenants.v1, body, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }
 
-async function deleteSubTenant(tenantId) {
-  return (0, _fetch.Delete)(`${_constants.urls.tenants.subTenants.v1}/${tenantId}`);
+async function deleteSubTenant(tenantId, options) {
+  return (0, _fetch.Delete)(`${_constants.urls.tenants.subTenants.v1}/${tenantId}`, undefined, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }
 
-async function updateSubAccountAccess(userId, body) {
-  return (0, _fetch.Put)(`${_constants.urls.identity.subTenants.v1}/${userId}/access`, body);
+async function updateSubAccountAccess(userId, body, options) {
+  return (0, _fetch.Put)(`${_constants.urls.identity.subTenants.v1}/${userId}/access`, body, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }

package/node/tenants/index.js

@@ -7,6 +7,7 @@ exports.getParentTenants = getParentTenants;
 exports.getSubTenants = getSubTenants;
 exports.getSubTenantsAsTree = getSubTenantsAsTree;
 exports.getTenants = getTenants;
+exports.getTenantsUsersCount = getTenantsUsersCount;
 exports.switchTenant = switchTenant;
 
 var _fetch = require("../fetch");
@@ -21,14 +22,24 @@ async function getTenants() {
   return (0, _fetch.Get)(`${_constants.urls.identity.users.v2}/me/tenants`);
 }
 
-async function getSubTenants() {
-  return (0, _fetch.Get)(_constants.urls.tenants.hierarchy.v1);
+async function getSubTenants(options) {
+  return (0, _fetch.Get)(_constants.urls.tenants.hierarchy.v1, undefined, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }
 
-async function getSubTenantsAsTree() {
-  return (0, _fetch.Get)(_constants.urls.tenants.hierarchy.tree.v1);
+async function getSubTenantsAsTree(options) {
+  return (0, _fetch.Get)(_constants.urls.tenants.hierarchy.tree.v1, undefined, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }
 
-async function getParentTenants() {
-  return (0, _fetch.Get)(_constants.urls.tenants.hierarchy.parents.v1);
+async function getParentTenants(options) {
+  return (0, _fetch.Get)(_constants.urls.tenants.hierarchy.parents.v1, undefined, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
+}
+
+async function getTenantsUsersCount(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.tenants.users.v1}/count`, body);
 }

package/node/users/index.js

@@ -4,11 +4,18 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.GetUserJwt = GetUserJwt;
+exports.getUsersV3 = getUsersV3;
 
 var _fetch = require("../fetch");
 
 var _constants = require("../constants");
 
 async function GetUserJwt(body) {
-  return (0, _fetch.Post)(_constants.urls.identity.users.v3, body);
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v3}/me/token`, body);
+}
+
+async function getUsersV3(queryParams, options) {
+  return (0, _fetch.Get)(_constants.urls.identity.users.v3, queryParams, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }

package/node/users/interfaces.js

@@ -2,4 +2,26 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+exports.SortByEnum = exports.PaginationOrderEnum = void 0;
+let SortByEnum;
+exports.SortByEnum = SortByEnum;
+
+(function (SortByEnum) {
+  SortByEnum["createdAt"] = "createdAt";
+  SortByEnum["name"] = "name";
+  SortByEnum["email"] = "email";
+  SortByEnum["id"] = "id";
+  SortByEnum["verified"] = "verified";
+  SortByEnum["isLocked"] = "isLocked";
+  SortByEnum["provider"] = "provider";
+  SortByEnum["tenantId"] = "tenantId";
+})(SortByEnum || (exports.SortByEnum = SortByEnum = {}));
+
+let PaginationOrderEnum;
+exports.PaginationOrderEnum = PaginationOrderEnum;
+
+(function (PaginationOrderEnum) {
+  PaginationOrderEnum["ASC"] = "ASC";
+  PaginationOrderEnum["DESC"] = "DESC";
+})(PaginationOrderEnum || (exports.PaginationOrderEnum = PaginationOrderEnum = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/rest-api",
-  "version": "3.0.99",
+  "version": "3.0.100",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {

package/sub-tenants/index.d.ts

@@ -1,11 +1,11 @@
-import { PaginationResult } from "../interfaces";
+import { PaginationResult, UserJwtOptions } from "../interfaces";
 import { AddUserToSubTenantsRequest, CreateSubTenantRequest, CreateSubTenantResponse, ILoadAllUsers, ISubTenantUser, RemoveUserFromSubTenantsRequest, UpdateSubAccountAccessRequestDto, UpdateUserRolesForSubTenantsRequestDto } from "./interfaces";
 export declare function loadAllUsers(params: ILoadAllUsers): Promise<PaginationResult<ISubTenantUser>>;
 export declare function addUserToTenantAndSubTenants(body: AddUserToSubTenantsRequest): Promise<void>;
-export declare function removeUserFromTenantAndSubTenants(body: RemoveUserFromSubTenantsRequest): Promise<void>;
+export declare function removeUserFromTenantAndSubTenants(body: RemoveUserFromSubTenantsRequest, options?: UserJwtOptions): Promise<void>;
 export declare function addUserRolesForSubTenants(userId: string, body: UpdateUserRolesForSubTenantsRequestDto): Promise<void>;
 export declare function removeUserRolesFromSubTenants(userId: string, body: UpdateUserRolesForSubTenantsRequestDto): Promise<void>;
-export declare function setUserRolesForSubTenants(userId: string, body: UpdateUserRolesForSubTenantsRequestDto): Promise<void>;
-export declare function createSubTenant(body: CreateSubTenantRequest): Promise<CreateSubTenantResponse>;
-export declare function deleteSubTenant(tenantId: string): Promise<void>;
-export declare function updateSubAccountAccess(userId: string, body: UpdateSubAccountAccessRequestDto): Promise<void>;
+export declare function setUserRolesForSubTenants(userId: string, body: UpdateUserRolesForSubTenantsRequestDto, options?: UserJwtOptions): Promise<void>;
+export declare function createSubTenant(body: CreateSubTenantRequest, options?: UserJwtOptions): Promise<CreateSubTenantResponse>;
+export declare function deleteSubTenant(tenantId: string, options?: UserJwtOptions): Promise<void>;
+export declare function updateSubAccountAccess(userId: string, body: UpdateSubAccountAccessRequestDto, options?: UserJwtOptions): Promise<void>;

package/sub-tenants/index.js

@@ -1,4 +1,4 @@
-import { Delete, Get, Patch, Post, Put } from "../fetch";
+import { Delete, extractHeadersFromOptions, Get, Patch, Post, Put } from "../fetch";
 import { urls } from "../constants";
 export async function loadAllUsers(params) {
   return Get(urls.identity.subTenants.v1, params);
@@ -6,8 +6,10 @@ export async function loadAllUsers(params) {
 export async function addUserToTenantAndSubTenants(body) {
   return Post(urls.identity.subTenants.v1, body);
 }
-export async function removeUserFromTenantAndSubTenants(body) {
-  return Delete(urls.identity.subTenants.v1, body);
+export async function removeUserFromTenantAndSubTenants(body, options) {
+  return Delete(urls.identity.subTenants.v1, body, {
+    headers: extractHeadersFromOptions(options)
+  });
 }
 export async function addUserRolesForSubTenants(userId, body) {
   return Post(`${urls.identity.subTenants.v1}/${userId}/roles`, body);
@@ -15,15 +17,23 @@ export async function addUserRolesForSubTenants(userId, body) {
 export async function removeUserRolesFromSubTenants(userId, body) {
   return Delete(`${urls.identity.subTenants.v1}/${userId}/roles`, body);
 }
-export async function setUserRolesForSubTenants(userId, body) {
-  return Patch(`${urls.identity.subTenants.v1}/${userId}/roles`, body);
-}
-export async function createSubTenant(body) {
-  return Post(urls.tenants.subTenants.v1, body);
-}
-export async function deleteSubTenant(tenantId) {
-  return Delete(`${urls.tenants.subTenants.v1}/${tenantId}`);
-}
-export async function updateSubAccountAccess(userId, body) {
-  return Put(`${urls.identity.subTenants.v1}/${userId}/access`, body);
+export async function setUserRolesForSubTenants(userId, body, options) {
+  return Patch(`${urls.identity.subTenants.v1}/${userId}/roles`, body, {
+    headers: extractHeadersFromOptions(options)
+  });
+}
+export async function createSubTenant(body, options) {
+  return Post(urls.tenants.subTenants.v1, body, {
+    headers: extractHeadersFromOptions(options)
+  });
+}
+export async function deleteSubTenant(tenantId, options) {
+  return Delete(`${urls.tenants.subTenants.v1}/${tenantId}`, undefined, {
+    headers: extractHeadersFromOptions(options)
+  });
+}
+export async function updateSubAccountAccess(userId, body, options) {
+  return Put(`${urls.identity.subTenants.v1}/${userId}/access`, body, {
+    headers: extractHeadersFromOptions(options)
+  });
 }

package/tenants/index.d.ts

@@ -1,4 +1,5 @@
-import { IParentTenant, ISubTenant, ISubTenantTree, ISwitchTenant, ITenantsResponse } from "./interfaces";
+import { IGetTenantsUserCountRequest, IGetTenantsUserCountResponse, IParentTenant, ISubTenant, ISubTenantTree, ISwitchTenant, ITenantsResponse } from "./interfaces";
+import { UserJwtOptions } from "../interfaces";
 /**
  * switch logged in user to specific tenant by providing tenantId.
  *
@@ -17,16 +18,17 @@ export declare function getTenants(): Promise<ITenantsResponse[]>;
  *
  * ``authorized user``
  */
-export declare function getSubTenants(): Promise<ISubTenant>;
+export declare function getSubTenants(options?: UserJwtOptions): Promise<ISubTenant>;
 /**
  * retrieve logged in user's available sub tenants as a tree.
  *
  * ``authorized user``
  */
-export declare function getSubTenantsAsTree(): Promise<ISubTenantTree>;
+export declare function getSubTenantsAsTree(options?: UserJwtOptions): Promise<ISubTenantTree>;
 /**
  * retrieve logged in user's available parent tenants.
  *
  * ``authorized user``
  */
-export declare function getParentTenants(): Promise<IParentTenant[]>;
+export declare function getParentTenants(options?: UserJwtOptions): Promise<IParentTenant[]>;
+export declare function getTenantsUsersCount(body: IGetTenantsUserCountRequest): Promise<IGetTenantsUserCountResponse[]>;

package/tenants/index.js

@@ -1,4 +1,4 @@
-import { Get, Put } from "../fetch";
+import { extractHeadersFromOptions, Get, Post, Put } from "../fetch";
 import { urls } from "../constants";
 export async function switchTenant(body) {
   return Put(`${urls.identity.users.v1}/tenant`, body);
@@ -6,12 +6,21 @@ export async function switchTenant(body) {
 export async function getTenants() {
   return Get(`${urls.identity.users.v2}/me/tenants`);
 }
-export async function getSubTenants() {
-  return Get(urls.tenants.hierarchy.v1);
+export async function getSubTenants(options) {
+  return Get(urls.tenants.hierarchy.v1, undefined, {
+    headers: extractHeadersFromOptions(options)
+  });
 }
-export async function getSubTenantsAsTree() {
-  return Get(urls.tenants.hierarchy.tree.v1);
+export async function getSubTenantsAsTree(options) {
+  return Get(urls.tenants.hierarchy.tree.v1, undefined, {
+    headers: extractHeadersFromOptions(options)
+  });
 }
-export async function getParentTenants() {
-  return Get(urls.tenants.hierarchy.parents.v1);
+export async function getParentTenants(options) {
+  return Get(urls.tenants.hierarchy.parents.v1, undefined, {
+    headers: extractHeadersFromOptions(options)
+  });
+}
+export async function getTenantsUsersCount(body) {
+  return Post(`${urls.identity.tenants.users.v1}/count`, body);
 }

package/tenants/interfaces.d.ts

@@ -71,3 +71,10 @@ export interface IParentTenant {
     status: string;
     createdAt: Date;
 }
+export interface IGetTenantsUserCountRequest {
+    tenantIds: string[];
+}
+export interface IGetTenantsUserCountResponse {
+    tenantId: string;
+    totalUsers: number;
+}

package/users/index.d.ts

@@ -1,2 +1,4 @@
-import { GetUserJwtRequestDto, GetUserJwtResponseDto } from "./interfaces";
+import { GetUserJwtRequestDto, GetUserJwtResponseDto, ISearchUserQueryParamsV3, IUsersV3Data } from "./interfaces";
+import { FronteggPaginationWrapper, UserJwtOptions } from "../interfaces";
 export declare function GetUserJwt(body: GetUserJwtRequestDto): Promise<GetUserJwtResponseDto>;
+export declare function getUsersV3(queryParams: ISearchUserQueryParamsV3, options?: UserJwtOptions): Promise<FronteggPaginationWrapper<IUsersV3Data>>;

package/users/index.js

@@ -1,5 +1,10 @@
-import { Post } from "../fetch";
+import { extractHeadersFromOptions, Get, Post } from "../fetch";
 import { urls } from "../constants";
 export async function GetUserJwt(body) {
-  return Post(urls.identity.users.v3, body);
+  return Post(`${urls.identity.users.v3}/me/token`, body);
+}
+export async function getUsersV3(queryParams, options) {
+  return Get(urls.identity.users.v3, queryParams, {
+    headers: extractHeadersFromOptions(options)
+  });
 }

package/users/interfaces.d.ts

@@ -1,3 +1,17 @@
+export declare enum SortByEnum {
+    createdAt = "createdAt",
+    name = "name",
+    email = "email",
+    id = "id",
+    verified = "verified",
+    isLocked = "isLocked",
+    provider = "provider",
+    tenantId = "tenantId"
+}
+export declare enum PaginationOrderEnum {
+    ASC = "ASC",
+    DESC = "DESC"
+}
 export interface GetUserJwtRequestDto {
     tenantId: string;
 }
@@ -6,3 +20,30 @@ export interface GetUserJwtResponseDto {
     expires: string;
     expiresIn: number;
 }
+export interface ISearchUserQueryParamsV3 {
+    _limit?: number;
+    _offset?: number;
+    _email?: string;
+    _tenantId?: string;
+    ids?: string;
+    _sortBy?: SortByEnum;
+    _order?: PaginationOrderEnum;
+}
+export interface IUsersV3Data {
+    sub?: string;
+    verified?: boolean;
+    mfaEnrolled?: boolean;
+    mfaBypass?: boolean;
+    phoneNumber?: string;
+    provider?: string;
+    tenantId?: string;
+    tenantIds?: string[];
+    activatedForTenant?: boolean;
+    isLocked?: boolean;
+    invisible?: boolean;
+    superUser?: boolean;
+    metadata?: string;
+    createdAt?: Date;
+    lastLogin?: Date;
+    subAccountAccessAllowed?: boolean;
+}

package/users/interfaces.js

@@ -1 +1,19 @@
-export {};
+export let SortByEnum;
+
+(function (SortByEnum) {
+  SortByEnum["createdAt"] = "createdAt";
+  SortByEnum["name"] = "name";
+  SortByEnum["email"] = "email";
+  SortByEnum["id"] = "id";
+  SortByEnum["verified"] = "verified";
+  SortByEnum["isLocked"] = "isLocked";
+  SortByEnum["provider"] = "provider";
+  SortByEnum["tenantId"] = "tenantId";
+})(SortByEnum || (SortByEnum = {}));
+
+export let PaginationOrderEnum;
+
+(function (PaginationOrderEnum) {
+  PaginationOrderEnum["ASC"] = "ASC";
+  PaginationOrderEnum["DESC"] = "DESC";
+})(PaginationOrderEnum || (PaginationOrderEnum = {}));