@frontegg/rest-api 3.1.72 → 3.1.74-alpha.9436511986

package/groups/index.js

@@ -1,50 +1,69 @@
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 import _extends from "@babel/runtime/helpers/esm/extends";
 const _excluded = ["groupId"];
-import { urls } from "../constants";
-import { Delete, Get, Patch, Post } from "../fetch";
-export async function getGroupById({
-  groupId
-}, query) {
-  return Get(`${urls.identity.groups.v1}/${groupId}`, _extends({}, query));
-}
-export async function getGroups(query) {
-  return Get(`${urls.identity.groups.v1}`, _extends({}, query));
-}
-export async function getGroupsByIds(body, params) {
-  return Post(`${urls.identity.groups.getByIds.v1}`, body, {
-    params
-  });
-}
-export async function createGroup(body) {
-  return Post(`${urls.identity.groups.v1}`, body);
-}
-export async function updateGroup(_ref) {
-  let {
-    groupId
-  } = _ref,
-      body = _objectWithoutPropertiesLoose(_ref, _excluded);
+import { urls } from '../constants';
+import { BaseApiClient } from '../BaseApiClient';
+export class GroupsApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+
+    this.getGroupById = async ({
+      groupId
+    }, query) => {
+      return this.get(`${urls.identity.groups.v1}/${groupId}`, _extends({}, query));
+    };
+
+    this.getGroups = async query => {
+      return this.get(`${urls.identity.groups.v1}`, _extends({}, query));
+    };
+
+    this.getGroupsByIds = async (body, params) => {
+      return this.post(`${urls.identity.groups.getByIds.v1}`, body, {
+        params
+      });
+    };
+
+    this.createGroup = async body => {
+      return this.post(`${urls.identity.groups.v1}`, body);
+    };
+
+    this.updateGroup = async _ref => {
+      let {
+        groupId
+      } = _ref,
+          body = _objectWithoutPropertiesLoose(_ref, _excluded);
+
+      return this.patch(`${urls.identity.groups.v1}/${groupId}`, body);
+    };
+
+    this.deleteGroup = async groupId => {
+      return this.delete(`${urls.identity.groups.v1}/${groupId}`);
+    };
+
+    this.addRolesToGroup = async (groupId, body) => {
+      return this.post(`${urls.identity.groups.v1}/${groupId}/roles`, body);
+    };
+
+    this.deleteRolesFromGroup = async (groupId, body) => {
+      return this.delete(`${urls.identity.groups.v1}/${groupId}/roles`, body);
+    };
+
+    this.addUsersToGroup = async (groupId, body) => {
+      return this.post(`${urls.identity.groups.v1}/${groupId}/users`, body);
+    };
+
+    this.deleteUsersFromGroup = async (groupId, body) => {
+      return this.delete(`${urls.identity.groups.v1}/${groupId}/users`, body);
+    };
+
+    this.getGroupConfiguration = async () => {
+      return this.get(`${urls.identity.groups.configurations.v1}`);
+    };
+
+    this.updateGroupConfiguration = async body => {
+      return this.post(`${urls.identity.groups.configurations.v1}`, body);
+    };
+  }
 
-  return Patch(`${urls.identity.groups.v1}/${groupId}`, body);
-}
-export async function deleteGroup(groupId) {
-  return Delete(`${urls.identity.groups.v1}/${groupId}`);
-}
-export async function addRolesToGroup(groupId, body) {
-  return Post(`${urls.identity.groups.v1}/${groupId}/roles`, body);
-}
-export async function deleteRolesFromGroup(groupId, body) {
-  return Delete(`${urls.identity.groups.v1}/${groupId}/roles`, body);
-}
-export async function addUsersToGroup(groupId, body) {
-  return Post(`${urls.identity.groups.v1}/${groupId}/users`, body);
-}
-export async function deleteUsersFromGroup(groupId, body) {
-  return Delete(`${urls.identity.groups.v1}/${groupId}/users`, body);
-}
-export async function getGroupConfiguration() {
-  return Get(`${urls.identity.groups.configurations.v1}`);
 }
-export async function updateGroupConfiguration(body) {
-  return Post(`${urls.identity.groups.configurations.v1}`, body);
-}
+export default new GroupsApi('default');

package/impersonate/index.d.ts

@@ -1,8 +1,17 @@
-import { IImpersonate, IImpersonateResponse } from "./interfaces";
+import { IImpersonate, IImpersonateResponse } from './interfaces';
+import { BaseApiClient } from '../BaseApiClient';
 /**
- * impersonating user should be called after creating actor token that contains information about impersonation.
- * ``impersonate`` should contain impersonated user info (userId, tenantId, and vendorId) and the actor token that was created for him to perform impersonation.
- *
- * @throws exception if impersonation failed
+ * UsersApi class provides methods for handling user and impersonation-related API requests.
  */
-export declare function impersonate(body: IImpersonate): Promise<IImpersonateResponse>;
+export declare class ImpersonateApi extends BaseApiClient {
+    constructor(appName: string);
+    /**
+     * Impersonating user should be called after creating actor token that contains information about impersonation.
+     * `impersonate` should contain impersonated user info (userId, tenantId, and vendorId) and the actor token that was created for him to perform impersonation.
+     *
+     * @throws exception if impersonation failed
+     */
+    impersonate: (body: IImpersonate) => Promise<IImpersonateResponse>;
+}
+declare const _default: ImpersonateApi;
+export default _default;

package/impersonate/index.js

@@ -1,5 +1,13 @@
-import { urls } from "../constants";
-import { Post } from "../fetch";
-export async function impersonate(body) {
-  return Post(`${urls.identity.impersonate.v1}`, body);
-}
+import { urls } from '../constants';
+import { BaseApiClient } from '../BaseApiClient';
+export class ImpersonateApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+
+    this.impersonate = async body => {
+      return this.post(`${urls.identity.impersonate.v1}`, body);
+    };
+  }
+
+}
+export default new ImpersonateApi('default');

package/index.d.ts

@@ -1,85 +1,115 @@
-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";
-export { setTabTenantInSessionStorage, getTabTenantFromSessionStorage, getCurrentUserTenantsFunction } 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";
+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, getFronteggContext } from './ContextHolder';
+import { AuthenticationApi } from './auth';
+import { UsersApi } from './users';
+import { TeamsApi } from './teams';
+import { MetadataApi } from './metadata';
+import { ReportsApi } from './reports';
+import { ConnectivityApi } from './connectivity';
+import { NotificationsApi } from './notifications';
+import { AuditsApi } from './audits';
+import { TenantsApi } from './tenants';
+import { AccountSettingsApi } from './account-settings';
+import { RolesApi } from './roles';
+import { SubscriptionsApi } from './subscriptions';
+import { VendorApi } from './vendor';
+import { SubTenantsApi } from './sub-tenants';
+import { FeatureFlagsApi } from './feature-flags';
+import { DirectoryApi } from './directory';
+import { ImpersonateApi } from './impersonate';
+import { GroupsApi } from './groups';
+import { EntitlementsApi } from './entitlements';
+import { SecurityCenterApi } from './security-center';
+import { PhoneNumbersApi } from './user-phone-numbers';
+import { 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';
+/**
+ * Frontegg API client for default app
+ *
+ * @deprecated use createApiClient instead
+ */
 declare const api: {
-    auth: typeof auth;
-    teams: typeof teams;
-    metadata: typeof metadata;
-    reports: typeof reports;
-    connectivity: typeof connectivity;
-    notifications: typeof notifications;
-    audits: typeof audits;
-    tenants: typeof tenants;
-    accountSettings: typeof accountSettings;
-    roles: typeof roles;
-    subscriptions: typeof subscriptions;
-    vendor: typeof vendor;
-    subTenants: typeof subTenants;
-    featureFlags: typeof featureFlags;
-    directory: typeof directory;
-    impersonate: typeof impersonate;
-    groups: typeof groups;
-    users: typeof users;
-    entitlements: typeof entitlements;
-    securityCenter: typeof securityCenter;
-    userPhoneNumbers: typeof userPhoneNumbers;
-    applications: typeof applications;
+    auth: AuthenticationApi;
+    teams: TeamsApi;
+    metadata: MetadataApi;
+    reports: ReportsApi;
+    connectivity: ConnectivityApi;
+    notifications: NotificationsApi;
+    audits: AuditsApi;
+    tenants: TenantsApi;
+    accountSettings: AccountSettingsApi;
+    roles: RolesApi;
+    subscriptions: SubscriptionsApi;
+    vendor: VendorApi;
+    subTenants: SubTenantsApi;
+    featureFlags: FeatureFlagsApi;
+    directory: DirectoryApi;
+    impersonate: ImpersonateApi;
+    groups: GroupsApi;
+    users: UsersApi;
+    entitlements: EntitlementsApi;
+    securityCenter: SecurityCenterApi;
+    userPhoneNumbers: PhoneNumbersApi;
+    applications: ApplicationsApi;
 };
-export { fetch, ContextHolder, FronteggContext, api, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy, };
+declare const createApiClient: (appName: string) => {
+    auth: AuthenticationApi;
+    teams: TeamsApi;
+    metadata: MetadataApi;
+    reports: ReportsApi;
+    connectivity: ConnectivityApi;
+    notifications: NotificationsApi;
+    audits: AuditsApi;
+    tenants: TenantsApi;
+    accountSettings: AccountSettingsApi;
+    roles: RolesApi;
+    subscriptions: SubscriptionsApi;
+    vendor: VendorApi;
+    subTenants: SubTenantsApi;
+    featureFlags: FeatureFlagsApi;
+    directory: DirectoryApi;
+    impersonate: ImpersonateApi;
+    groups: GroupsApi;
+    users: UsersApi;
+    entitlements: EntitlementsApi;
+    securityCenter: SecurityCenterApi;
+    userPhoneNumbers: PhoneNumbersApi;
+    applications: ApplicationsApi;
+};
+export { fetch, ContextHolder, FronteggContext, getFronteggContext, api, createApiClient, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy, };
 declare const _default: {
-    fetch: typeof fetch;
+    fetch: FetchClient;
+    FetchClient: typeof FetchClient;
     ContextHolder: typeof ContextHolder;
     FronteggContext: {
         getContext: () => import("./interfaces").ContextOptions;
@@ -88,37 +118,73 @@ declare const _default: {
         onRedirectTo: (path: string, opts: import("./interfaces").RedirectOptions) => void;
         logout: (callback?: (() => void) | undefined) => void;
     };
+    getFronteggContext: (appName?: string) => {
+        getContext: () => import("./interfaces").ContextOptions;
+        getAccessToken: () => string | null;
+        getUser: () => import("./users/interfaces").IGetUsersV2Response | null;
+        onRedirectTo: (path: string, opts?: import("./interfaces").RedirectOptions | undefined) => void;
+        logout: (callback?: (() => void) | undefined) => void;
+        getRequestSource: () => import("./interfaces").RequestSource | null;
+        setAccessToken: (accessToken: string | null) => void;
+        setUser: (user: import("./users/interfaces").IGetUsersV2Response | null) => void;
+        isSessionPerTenantEnabled: () => boolean;
+        shouldLoadEntitlements: () => boolean;
+    };
     api: {
-        auth: typeof auth;
-        teams: typeof teams;
-        metadata: typeof metadata;
-        reports: typeof reports;
-        connectivity: typeof connectivity;
-        notifications: typeof notifications;
-        audits: typeof audits;
-        tenants: typeof tenants;
-        accountSettings: typeof accountSettings;
-        roles: typeof roles;
-        subscriptions: typeof subscriptions;
-        vendor: typeof vendor;
-        subTenants: typeof subTenants;
-        featureFlags: typeof featureFlags;
-        directory: typeof directory;
-        impersonate: typeof impersonate;
-        groups: typeof groups;
-        users: typeof users;
-        entitlements: typeof entitlements;
-        securityCenter: typeof securityCenter;
-        userPhoneNumbers: typeof userPhoneNumbers;
-        applications: typeof applications;
+        auth: AuthenticationApi;
+        teams: TeamsApi;
+        metadata: MetadataApi;
+        reports: ReportsApi;
+        connectivity: ConnectivityApi;
+        notifications: NotificationsApi;
+        audits: AuditsApi;
+        tenants: TenantsApi;
+        accountSettings: AccountSettingsApi;
+        roles: RolesApi;
+        subscriptions: SubscriptionsApi;
+        vendor: VendorApi;
+        subTenants: SubTenantsApi;
+        featureFlags: FeatureFlagsApi;
+        directory: DirectoryApi;
+        impersonate: ImpersonateApi;
+        groups: GroupsApi;
+        users: UsersApi;
+        entitlements: EntitlementsApi;
+        securityCenter: SecurityCenterApi;
+        userPhoneNumbers: PhoneNumbersApi;
+        applications: ApplicationsApi;
+    };
+    createApiClient: (appName: string) => {
+        auth: AuthenticationApi;
+        teams: TeamsApi;
+        metadata: MetadataApi;
+        reports: ReportsApi;
+        connectivity: ConnectivityApi;
+        notifications: NotificationsApi;
+        audits: AuditsApi;
+        tenants: TenantsApi;
+        accountSettings: AccountSettingsApi;
+        roles: RolesApi;
+        subscriptions: SubscriptionsApi;
+        vendor: VendorApi;
+        subTenants: SubTenantsApi;
+        featureFlags: FeatureFlagsApi;
+        directory: DirectoryApi;
+        impersonate: ImpersonateApi;
+        groups: GroupsApi;
+        users: UsersApi;
+        entitlements: EntitlementsApi;
+        securityCenter: SecurityCenterApi;
+        userPhoneNumbers: PhoneNumbersApi;
+        applications: ApplicationsApi;
     };
     FronteggApiError: typeof FronteggApiError;
-    AuthStrategyEnum: typeof auth.AuthStrategyEnum;
-    MachineToMachineAuthStrategy: typeof auth.MachineToMachineAuthStrategy;
-    SocialLoginProviders: typeof auth.SocialLoginProviders;
-    ISubscriptionCancellationPolicy: typeof subscriptions.ISubscriptionCancellationPolicy;
-    ISubscriptionStatus: typeof subscriptions.ISubscriptionStatus;
-    PaymentMethodType: typeof subscriptions.PaymentMethodType;
-    ProviderType: typeof subscriptions.ProviderType;
+    AuthStrategyEnum: typeof AuthStrategyEnum;
+    MachineToMachineAuthStrategy: typeof MachineToMachineAuthStrategy;
+    SocialLoginProviders: typeof SocialLoginProviders;
+    ISubscriptionCancellationPolicy: typeof ISubscriptionCancellationPolicy;
+    ISubscriptionStatus: typeof ISubscriptionStatus;
+    PaymentMethodType: typeof PaymentMethodType;
+    ProviderType: typeof ProviderType;
 };
 export default _default;