@frontegg/rest-api 3.1.74 → 3.1.76-alpha.9502349697

package/index.js

@@ -1,93 +1,124 @@
-/** @license Frontegg v3.1.74
+/** @license Frontegg v3.1.76-alpha.9502349697
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import * as auth from "./auth";
-import { AuthStrategyEnum, MachineToMachineAuthStrategy, SocialLoginProviders } from "./auth";
-import * as teams from "./teams";
-import * as metadata from "./metadata";
-import * as reports from "./reports";
-import * as notifications from "./notifications";
-import * as audits from "./audits";
-import * as fetch from "./fetch";
-import * as connectivity from "./connectivity";
-import * as tenants from "./tenants";
-import * as accountSettings from "./account-settings";
-import * as roles from "./roles";
-import * as subscriptions from "./subscriptions";
-import * as applications from "./applications";
-import { ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType } from "./subscriptions";
-import { FronteggApiError } from "./error";
-import * as vendor from "./vendor";
-import * as subTenants from "./sub-tenants";
-import * as featureFlags from "./feature-flags";
-import * as directory from "./directory";
-import * as impersonate from "./impersonate";
-import * as groups from "./groups";
-import * as users from "./users";
-import * as entitlements from "./entitlements";
-import * as securityCenter from "./security-center";
-import * as userPhoneNumbers from "./user-phone-numbers";
-import { ContextHolder, FronteggContext } from "./ContextHolder";
-export * from "./interfaces";
-export * from "./auth/interfaces";
+import { AuthStrategyEnum, MachineToMachineAuthStrategy, SocialLoginProviders } from './auth';
+import { ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType } from './subscriptions';
+import { FronteggApiError } from './error';
+import fetch, { FetchClient } from './FetchClient';
+import { ContextHolder, FronteggContext } from './ContextHolder';
+import DefaultAuthenticationApi, { AuthenticationApi } from './auth';
+import DefaultSecurityPolicyApi, { SecurityPolicyApi } from './auth/secutiry-poilicy';
+import DefaultUsersApi, { UsersApi } from './users';
+import DefaultTeamsApi, { TeamsApi } from './teams';
+import DefaultMetadataApi, { MetadataApi } from './metadata';
+import DefaultReportsApi, { ReportsApi } from './reports';
+import DefaultConnectivityApi, { ConnectivityApi } from './connectivity';
+import DefaultNotificationsApi, { NotificationsApi } from './notifications';
+import DefaultAuditsApi, { AuditsApi } from './audits';
+import DefaultTenantsApi, { TenantsApi } from './tenants';
+import DefaultAccountSettingsApi, { AccountSettingsApi } from './account-settings';
+import DefaultRolesApi, { RolesApi } from './roles';
+import DefaultSubscriptionsApi, { SubscriptionsApi } from './subscriptions';
+import DefaultVendorApi, { VendorApi } from './vendor';
+import DefaultSubTenantsApi, { SubTenantsApi } from './sub-tenants';
+import DefaultFeatureFlagsApi, { FeatureFlagsApi } from './feature-flags';
+import DefaultDirectoryApi, { DirectoryApi } from './directory';
+import DefaultImpersonateApi, { ImpersonateApi } from './impersonate';
+import DefaultGroupsApi, { GroupsApi } from './groups';
+import DefaultEntitlementsApi, { EntitlementsApi } from './entitlements';
+import DefaultSecurityCenterApi, { SecurityCenterApi } from './security-center';
+import DefaultPhoneNumbersApi, { PhoneNumbersApi } from './user-phone-numbers';
+import DefaultApplicationsApi, { ApplicationsApi } from './applications';
+export * from './interfaces';
+export * from './auth/interfaces';
 export { setTabTenantInSessionStorage, getTabTenantFromSessionStorage, removeTabTenantFromSessionStorage, getCurrentUserTenantsFunction, FRONTEGG_SEPARATE_TABS_BY_TENANT } from './auth';
-export * from "./teams/interfaces";
-export * from "./metadata/interfaces";
-export * from "./reports/interfaces";
-export * from "./connectivity/interfaces";
-export * from "./notifications/interfaces";
-export * from "./audits/interfaces";
-export * from "./tenants/interfaces";
-export * from "./account-settings/interfaces";
-export * from "./roles/interfaces";
-export * from "./subscriptions/interfaces";
-export * from "./vendor/interfaces";
-export * from "./sub-tenants/interfaces";
-export * from "./routers";
-export * from "./feature-flags/index";
-export * from "./feature-flags/interfaces";
-export * from "./directory/index";
-export * from "./directory/interfaces";
-export * from "./impersonate/interfaces";
-export * from "./groups/interfaces";
-export * from "./groups/enums";
-export * from "./users/interfaces";
-export * from "./entitlements/interfaces";
-export * from "./security-center/interfaces";
-export * from "./user-phone-numbers/interfaces";
-export * from "./applications/interfaces";
+export * from './teams/interfaces';
+export * from './metadata/interfaces';
+export * from './reports/interfaces';
+export * from './connectivity/interfaces';
+export * from './notifications/interfaces';
+export * from './audits/interfaces';
+export * from './tenants/interfaces';
+export * from './account-settings/interfaces';
+export * from './roles/interfaces';
+export * from './subscriptions/interfaces';
+export * from './vendor/interfaces';
+export * from './sub-tenants/interfaces';
+export * from './routers';
+export * from './feature-flags/index';
+export * from './feature-flags/interfaces';
+export * from './directory/index';
+export * from './directory/interfaces';
+export * from './impersonate/interfaces';
+export * from './groups/interfaces';
+export * from './groups/enums';
+export * from './users/interfaces';
+export * from './entitlements/interfaces';
+export * from './security-center/interfaces';
+export * from './user-phone-numbers/interfaces';
+export * from './applications/interfaces';
 const api = {
-  auth,
-  teams,
-  metadata,
-  reports,
-  connectivity,
-  notifications,
-  audits,
-  tenants,
-  accountSettings,
-  roles,
-  subscriptions,
-  vendor,
-  subTenants,
-  featureFlags,
-  directory,
-  impersonate,
-  groups,
-  users,
-  entitlements,
-  securityCenter,
-  userPhoneNumbers,
-  applications
+  auth: DefaultAuthenticationApi,
+  securityPolicy: DefaultSecurityPolicyApi,
+  teams: DefaultTeamsApi,
+  metadata: DefaultMetadataApi,
+  reports: DefaultReportsApi,
+  connectivity: DefaultConnectivityApi,
+  notifications: DefaultNotificationsApi,
+  audits: DefaultAuditsApi,
+  tenants: DefaultTenantsApi,
+  accountSettings: DefaultAccountSettingsApi,
+  roles: DefaultRolesApi,
+  subscriptions: DefaultSubscriptionsApi,
+  vendor: DefaultVendorApi,
+  subTenants: DefaultSubTenantsApi,
+  featureFlags: DefaultFeatureFlagsApi,
+  directory: DefaultDirectoryApi,
+  impersonate: DefaultImpersonateApi,
+  groups: DefaultGroupsApi,
+  users: DefaultUsersApi,
+  entitlements: DefaultEntitlementsApi,
+  securityCenter: DefaultSecurityCenterApi,
+  userPhoneNumbers: DefaultPhoneNumbersApi,
+  applications: DefaultApplicationsApi
 };
-export { fetch, ContextHolder, FronteggContext, api, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy };
+
+const createApiClient = appName => ({
+  auth: new AuthenticationApi(appName),
+  securityPolicy: new SecurityPolicyApi(appName),
+  teams: new TeamsApi(appName),
+  metadata: new MetadataApi(appName),
+  reports: new ReportsApi(appName),
+  connectivity: new ConnectivityApi(appName),
+  notifications: new NotificationsApi(appName),
+  audits: new AuditsApi(appName),
+  tenants: new TenantsApi(appName),
+  accountSettings: new AccountSettingsApi(appName),
+  roles: new RolesApi(appName),
+  subscriptions: new SubscriptionsApi(appName),
+  vendor: new VendorApi(appName),
+  subTenants: new SubTenantsApi(appName),
+  featureFlags: new FeatureFlagsApi(appName),
+  directory: new DirectoryApi(appName),
+  impersonate: new ImpersonateApi(appName),
+  groups: new GroupsApi(appName),
+  users: new UsersApi(appName),
+  entitlements: new EntitlementsApi(appName),
+  securityCenter: new SecurityCenterApi(appName),
+  userPhoneNumbers: new PhoneNumbersApi(appName),
+  applications: new ApplicationsApi(appName)
+});
+
+export { fetch, FetchClient, ContextHolder, FronteggContext, api, createApiClient, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy };
 export default {
   fetch,
+  FetchClient,
   ContextHolder,
   FronteggContext,
   api,
+  createApiClient,
   FronteggApiError,
   AuthStrategyEnum,
   MachineToMachineAuthStrategy,

package/interfaces.d.ts

@@ -102,3 +102,13 @@ export declare enum PaginationOrderEnum {
     ASC = "ASC",
     DESC = "DESC"
 }
+export interface RequestOptions {
+    url: string;
+    method: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
+    body?: any;
+    params?: any;
+    contentType?: string;
+    responseType?: 'json' | 'plain' | 'blob';
+    headers?: Record<string, string>;
+    credentials?: RequestCredentials;
+}

package/metadata/index.d.ts

@@ -1,8 +1,68 @@
 import { CommitChangesRequest, IAuditsMetadata, IMetadataIp, INotificationMetadata, ISamlMetadata } from './interfaces';
-export declare function getAdminBoxMetadata(): Promise<any>;
-export declare function updateAdminBoxMetadata(body: CommitChangesRequest): Promise<any>;
-export declare function getCurrentUserIpMetadata(): Promise<IMetadataIp>;
-export declare const getNotificationsMetadata: () => Promise<INotificationMetadata>;
-export declare const getSamlMetadata: () => Promise<ISamlMetadata>;
-export declare const getAuditsMetadata: () => Promise<IAuditsMetadata>;
-export declare const getIpAdressMetadata: (ip: string) => Promise<IMetadataIp>;
+import { BaseApiClient } from '../BaseApiClient';
+export declare class MetadataApi extends BaseApiClient {
+    constructor(appName: string);
+    /**
+     * Retrieves metadata based on the given criteria.
+     *
+     * @param body - Metadata request parameters.
+     * @returns Metadata matching the criteria.
+     * @throws Will throw an error if metadata is not found.
+     */
+    private getMetadata;
+    /**
+     * Retrieves admin box metadata.
+     *
+     * @returns Admin box metadata.
+     */
+    getAdminBoxMetadata: () => Promise<unknown>;
+    /**
+     * Updates admin box metadata.
+     *
+     * @param body - Request body for committing changes.
+     * @returns Response from the POST request.
+     */
+    updateAdminBoxMetadata: (body: CommitChangesRequest) => Promise<unknown>;
+    /**
+     * Retrieves IP metadata for a given IP address.
+     *
+     * @param ip - IP address to get metadata for.
+     * @returns IP metadata.
+     * @throws Will throw an error if IP metadata is not found.
+     */
+    private getIpMetadata;
+    /**
+     * Retrieves current user IP metadata.
+     *
+     * @returns Current user IP metadata.
+     * @throws Will throw an error if IP metadata is not found.
+     */
+    getCurrentUserIpMetadata: () => Promise<IMetadataIp>;
+    /**
+     * Retrieves notifications metadata.
+     *
+     * @returns Notifications metadata.
+     */
+    getNotificationsMetadata: () => Promise<INotificationMetadata>;
+    /**
+     * Retrieves SAML metadata.
+     *
+     * @returns SAML metadata.
+     */
+    getSamlMetadata: () => Promise<ISamlMetadata>;
+    /**
+     * Retrieves audits metadata.
+     *
+     * @returns Audits metadata.
+     */
+    getAuditsMetadata: () => Promise<IAuditsMetadata>;
+    /**
+     * Retrieves IP address metadata for a given IP.
+     *
+     * @param ip - IP address to get metadata for.
+     * @returns IP address metadata.
+     */
+    getIpAdressMetadata: (ip: string) => Promise<IMetadataIp>;
+}
+declare const _default: MetadataApi;
+export default _default;

package/metadata/index.js

@@ -1,38 +1,58 @@
-import { Get, Post } from '../fetch';
+import { BaseApiClient } from '../BaseApiClient';
+export class MetadataApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
 
-async function getMetadata(body) {
-  var _data$rows, _data$rows2;
+    this.getMetadata = async body => {
+      var _data$rows, _data$rows2;
 
-  const data = await Get('/metadata', body);
-  if (data != null && (_data$rows = data.rows) != null && _data$rows[0]) return data == null ? void 0 : (_data$rows2 = data.rows) == null ? void 0 : _data$rows2[0];
-  throw new Error(`metadata not found: ${body.entityName}`);
-}
+      const data = await this.get('/metadata', body);
+      if (data != null && (_data$rows = data.rows) != null && _data$rows[0]) return data == null ? void 0 : (_data$rows2 = data.rows) == null ? void 0 : _data$rows2[0];
+      throw new Error(`metadata not found: ${body.entityName}`);
+    };
 
-export async function getAdminBoxMetadata() {
-  return Get('/metadata/admin-box');
-}
-export async function updateAdminBoxMetadata(body) {
-  return Post('/metadata/admin-box', body);
-}
+    this.getAdminBoxMetadata = async () => {
+      return this.get('/metadata/admin-box');
+    };
 
-async function getIpMetadata(ip) {
-  const data = await Get(`/metadata/ip/${ip}`);
-  if (data) return data;
-  throw new Error(`ip metadata not found`);
-}
+    this.updateAdminBoxMetadata = async body => {
+      return this.post('/metadata/admin-box', body);
+    };
+
+    this.getIpMetadata = async ip => {
+      const data = await this.get(`/metadata/ip/${ip}`);
+      if (data) return data;
+      throw new Error(`ip metadata not found`);
+    };
+
+    this.getCurrentUserIpMetadata = async () => {
+      const data = await this.get(`/metadata/ipme`);
+      if (data) return data;
+      throw new Error(`ip metadata not found`);
+    };
+
+    this.getNotificationsMetadata = async () => {
+      return this.getMetadata({
+        entityName: 'notifications'
+      });
+    };
+
+    this.getSamlMetadata = async () => {
+      return this.getMetadata({
+        entityName: 'saml'
+      });
+    };
+
+    this.getAuditsMetadata = async () => {
+      return this.getMetadata({
+        entityName: 'audits'
+      });
+    };
+
+    this.getIpAdressMetadata = async ip => {
+      return this.getIpMetadata(ip);
+    };
+  }
 
-export async function getCurrentUserIpMetadata() {
-  const data = await Get(`/metadata/ipme`);
-  if (data) return data;
-  throw new Error(`ip metadata not found`);
 }
-export const getNotificationsMetadata = async () => getMetadata({
-  entityName: 'notifications'
-});
-export const getSamlMetadata = async () => getMetadata({
-  entityName: 'saml'
-});
-export const getAuditsMetadata = async () => getMetadata({
-  entityName: 'audits'
-});
-export const getIpAdressMetadata = async ip => getIpMetadata(ip);
+export default new MetadataApi('default');

package/node/BaseApiClient.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BaseApiClient = void 0;
+
+var _FetchClient = require("./FetchClient");
+
+class BaseApiClient {
+  constructor(appName) {
+    this.appName = void 0;
+    this.fetchClient = void 0;
+
+    this.get = async (url, params, opts) => {
+      return this.fetchClient.get(url, params, opts);
+    };
+
+    this.post = async (url, body, opts) => {
+      return this.fetchClient.post(url, body, opts);
+    };
+
+    this.patch = async (url, body, opts) => {
+      return this.fetchClient.patch(url, body, opts);
+    };
+
+    this.put = async (url, body, opts) => {
+      return this.fetchClient.put(url, body, opts);
+    };
+
+    this.delete = async (url, body, opts) => {
+      return this.fetchClient.delete(url, body, opts);
+    };
+
+    this.postDownload = async (url, body, params, opts) => {
+      return this.fetchClient.postDownload(url, body, params, opts);
+    };
+
+    this.extractHeadersFromOptions = (options = {}) => {
+      return this.fetchClient.extractHeadersFromOptions(options);
+    };
+
+    this.appName = appName;
+    this.fetchClient = new _FetchClient.FetchClient(appName);
+  }
+
+}
+
+exports.BaseApiClient = BaseApiClient;