@frontegg/rest-api 3.0.114 → 3.0.115

package/constants.d.ts

@@ -12,6 +12,9 @@ export declare const urls: {
             v1: string;
             v2: string;
             v3: string;
+            roles: {
+                v3: string;
+            };
             apiTokens: {
                 v1: string;
             };
@@ -128,6 +131,9 @@ export declare const urls: {
                 v1: string;
             };
             v2: string;
+            metadata: {
+                v2: string;
+            };
         };
         subTenants: {
             v1: string;

package/constants.js

@@ -12,6 +12,9 @@ export const urls = {
       v1: '/identity/resources/users/v1',
       v2: '/identity/resources/users/v2',
       v3: '/identity/resources/users/v3',
+      roles: {
+        v3: '/identity/resources/users/v3/roles'
+      },
       apiTokens: {
         v1: '/identity/resources/users/api-tokens/v1'
       },
@@ -127,7 +130,10 @@ export const urls = {
       parents: {
         v1: '/tenants/resources/hierarchy/v1/parents'
       },
-      v2: '/tenants/resources/hierarchy/v2'
+      v2: '/tenants/resources/hierarchy/v2',
+      metadata: {
+        v2: '/tenants/resources/hierarchy/v2/metadata'
+      }
     },
     subTenants: {
       v1: '/tenants/resources/sub-tenants/v1'

package/index.js

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

package/node/constants.js

@@ -18,6 +18,9 @@ const urls = {
       v1: '/identity/resources/users/v1',
       v2: '/identity/resources/users/v2',
       v3: '/identity/resources/users/v3',
+      roles: {
+        v3: '/identity/resources/users/v3/roles'
+      },
       apiTokens: {
         v1: '/identity/resources/users/api-tokens/v1'
       },
@@ -133,7 +136,10 @@ const urls = {
       parents: {
         v1: '/tenants/resources/hierarchy/v1/parents'
       },
-      v2: '/tenants/resources/hierarchy/v2'
+      v2: '/tenants/resources/hierarchy/v2',
+      metadata: {
+        v2: '/tenants/resources/hierarchy/v2/metadata'
+      }
     },
     subTenants: {
       v1: '/tenants/resources/sub-tenants/v1'

package/node/index.js

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

package/node/tenants/index.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.getHierarchyMetadata = getHierarchyMetadata;
 exports.getParentTenants = getParentTenants;
 exports.getSubTenants = getSubTenants;
 exports.getSubTenantsAsTree = getSubTenantsAsTree;
@@ -51,4 +52,10 @@ async function searchSubTenants(params, options) {
   return (0, _fetch.Get)(_constants.urls.tenants.hierarchy.v2, params, {
     headers: (0, _fetch.extractHeadersFromOptions)(options)
   });
+}
+
+async function getHierarchyMetadata(params, options) {
+  return (0, _fetch.Get)(_constants.urls.tenants.hierarchy.metadata.v2, params, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }

package/node/users/index.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.GetUserJwt = GetUserJwt;
+exports.getUsersRoles = getUsersRoles;
 exports.getUsersV3 = getUsersV3;
 
 var _fetch = require("../fetch");
@@ -18,4 +19,10 @@ async function getUsersV3(queryParams, options) {
   return (0, _fetch.Get)(_constants.urls.identity.users.v3, queryParams, {
     headers: (0, _fetch.extractHeadersFromOptions)(options)
   });
+}
+
+async function getUsersRoles(queryParams, options) {
+  return (0, _fetch.Get)(_constants.urls.identity.users.roles.v3, queryParams, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
 }

package/package.json

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

package/tenants/index.d.ts

@@ -1,4 +1,4 @@
-import { IGetTenantsUserCountRequest, IGetTenantsUserCountResponse, IParentTenant, ISubTenant, ISubTenantTree, ISwitchTenant, ITenantsResponse, SearchSubTenantsParams, SearchSubTenantsResponse } from "./interfaces";
+import { GetHierarchyMetadataParams, GetHierarchyMetadataResponse, IGetTenantsUserCountRequest, IGetTenantsUserCountResponse, IParentTenant, ISubTenant, ISubTenantTree, ISwitchTenant, ITenantsResponse, SearchSubTenantsParams, SearchSubTenantsResponse } from "./interfaces";
 import { FronteggPaginationWrapper, UserJwtOptions } from "../interfaces";
 /**
  * switch logged in user to specific tenant by providing tenantId.
@@ -33,3 +33,4 @@ export declare function getSubTenantsAsTree(options?: UserJwtOptions): Promise<I
 export declare function getParentTenants(options?: UserJwtOptions): Promise<IParentTenant[]>;
 export declare function getTenantsUsersCount(body: IGetTenantsUserCountRequest, options?: UserJwtOptions): Promise<IGetTenantsUserCountResponse[]>;
 export declare function searchSubTenants(params: SearchSubTenantsParams, options?: UserJwtOptions): Promise<FronteggPaginationWrapper<SearchSubTenantsResponse>>;
+export declare function getHierarchyMetadata(params: GetHierarchyMetadataParams, options?: UserJwtOptions): Promise<GetHierarchyMetadataResponse[]>;

package/tenants/index.js

@@ -30,4 +30,9 @@ export async function searchSubTenants(params, options) {
   return Get(urls.tenants.hierarchy.v2, params, {
     headers: extractHeadersFromOptions(options)
   });
+}
+export async function getHierarchyMetadata(params, options) {
+  return Get(urls.tenants.hierarchy.metadata.v2, params, {
+    headers: extractHeadersFromOptions(options)
+  });
 }

package/tenants/interfaces.d.ts

@@ -93,8 +93,20 @@ export interface SearchSubTenantsParams {
     _sortBy?: TenantSortByEnum;
     _order?: PaginationOrderEnum;
 }
+export interface SearchSubTenantMetadata {
+    isParent?: boolean;
+}
 export interface SearchSubTenantsResponse {
     tenantId: string;
     name: string;
     createdAt: Date;
+    metadata: SearchSubTenantMetadata;
+}
+export interface GetHierarchyMetadataParams {
+    _tenantIds: string[];
+}
+export interface GetHierarchyMetadataResponse {
+    tenantId: string;
+    totalSubTenants: number;
+    isParent: boolean;
 }

package/users/index.d.ts

@@ -1,4 +1,5 @@
-import { GetUserJwtRequestDto, GetUserJwtResponseDto, ISearchUserQueryParamsV3, IUsersV3Data } from "./interfaces";
+import { GetUserJwtRequestDto, GetUserJwtResponseDto, GetUserRolesResponse, GetUsersRolesParams, 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>>;
+export declare function getUsersRoles(queryParams: GetUsersRolesParams, options?: UserJwtOptions): Promise<GetUserRolesResponse[]>;

package/users/index.js

@@ -7,4 +7,9 @@ export async function getUsersV3(queryParams, options) {
   return Get(urls.identity.users.v3, queryParams, {
     headers: extractHeadersFromOptions(options)
   });
+}
+export async function getUsersRoles(queryParams, options) {
+  return Get(urls.identity.users.roles.v3, queryParams, {
+    headers: extractHeadersFromOptions(options)
+  });
 }

package/users/interfaces.d.ts

@@ -45,3 +45,12 @@ export interface IUsersV3Data {
     lastLogin?: Date;
     subAccountAccessAllowed?: boolean;
 }
+export interface GetUsersRolesParams {
+    ids: string[];
+}
+export interface GetUserRolesResponse {
+    vendorId: string;
+    tenantId: string;
+    userId: string;
+    roleIds: string[];
+}