@frontegg/rest-api 2.10.89 → 3.0.2

package/src/sub-tenants/interfaces.ts

@@ -1,100 +0,0 @@
-import { QueryFilter, QuerySort } from "../interfaces";
-
-export type ILoadAllUsers = {
-  _offset: number;
-  _limit: number;
-  _filter: string;
-  _sortBy: string;
-  _order: "ASC" | "DESC";
-};
-
-export type ISubTenantUserRole = {
-  id: string;
-  vendorId: string;
-  tenantId: string;
-  key: string;
-  name: string;
-  description: string;
-  isDefault: boolean;
-  firstUserRole: boolean;
-  level: number;
-  createdAt: Date;
-  updatedAt: Date;
-  permissions: string[];
-};
-
-export type ISubTenantUserPermission = {
-  id: string;
-  key: string;
-  name: string;
-  description: string;
-  createdAt: Date;
-  updatedAt: Date;
-  roleIds: string[];
-  categoryId: string;
-  fePermission: boolean;
-};
-
-export type ISubTenantUserTenant = {
-  tenantId: string;
-  roles: ISubTenantUserRole[];
-  permissions: ISubTenantUserPermission[];
-  activated: boolean;
-  lastLogin: Date;
-};
-
-export type ISubTenantUser = {
-  id: string;
-  sub: string;
-  email: string;
-  verified: boolean;
-  mfaEnrolled: boolean;
-  mfaBypass?: boolean;
-  name?: string;
-  phoneNumber?: string;
-  profilePictureUrl?: string;
-  provider: string; // 'local' | 'saml' | 'google' | 'facebook';
-  tenantId: string;
-  tenantIds: string[];
-  isLocked?: boolean;
-  tenants: ISubTenantUserTenant[];
-  invisible?: true;
-  superUser?: true;
-  metadata: string;
-  createdAt: Date;
-};
-
-export interface AddUserToSubTenantsRequestUserDto {
-  email: string;
-  name?: string;
-}
-
-export interface AddUserToSubTenantsRequestTenantDto {
-  tenantId: string;
-  roleIds?: string[];
-}
-
-export interface AddUserToSubTenantsRequest {
-  user: AddUserToSubTenantsRequestUserDto;
-  subTenants: AddUserToSubTenantsRequestTenantDto[];
-}
-
-export interface RemoveUserFromSubTenantsRequestTenantDto {
-  tenantId: string;
-}
-
-export interface RemoveUserFromSubTenantsRequest {
-  userId: string;
-  subTenants: RemoveUserFromSubTenantsRequestTenantDto[];
-}
-
-export interface UpdateUserRolesForSubTenantRequestDto {
-  tenantId: string;
-  roleIds: string[];
-}
-
-export interface UpdateUserRolesForSubTenantsRequestDto {
-  subTenantsRoles: UpdateUserRolesForSubTenantRequestDto[];
-  ipAddress?: string;
-  userAgent?: string;
-}

package/src/subscriptions/enums.ts

@@ -1,22 +0,0 @@
-export enum ISubscriptionStatus {
-  ACTIVE = "active",
-  CANCELED = "canceled",
-  INCOMPLETE = "incomplete",
-  EXPIRED = "expired",
-  TRIALING = "trialing",
-  TRIAL_ENDED = "trialEnded",
-}
-
-
-export enum PaymentMethodType {
-  UNKNWON = "unknown",
-  CARD = "card",
-}
-
-export enum ISubscriptionCancellationPolicy {
-  AT_PERIOD_END = "atPeriodEnd",
-}
-
-export enum ProviderType {
-  Stripe = "Stripe",
-}

package/src/subscriptions/index.ts

@@ -1,10 +0,0 @@
-export * from './subscriptions';
-export * from './managedSubscriptions';
-export * from './plans';
-export * from './invoices';
-export * from './paymentMethods';
-export * from './providers';
-export * from './summaries';
-export * from './tenantConfiguration';
-export * from './paymentProviders';
-export * from './enums';

package/src/subscriptions/interfaces.ts

@@ -1,144 +0,0 @@
-import {
-  ISubscriptionCancellationPolicy,
-  ISubscriptionStatus,
-  PaymentMethodType,
-  ProviderType,
-} from "./enums";
-
-export * from "./providers/stripe/interfaces";
-
-export interface IPlanResponse {
-  id: string;
-  externalId: string;
-  name: string;
-  description: string;
-  price: IPlanResponsePriceResponse;
-  slug: string;
-}
-
-export interface IPlanResponsePriceResponse {
-  id: string;
-  externalId: string;
-  currency: string;
-  amount: number;
-}
-
-export interface ISubscriptionResponse {
-  id: string;
-  externalId: string;
-  externallyManaged: boolean;
-  startDate: string;
-  currentPeriodStart: string;
-  currentPeriodEnd: string;
-  status: ISubscriptionStatus;
-  cancellation: ISubscriptionCancellationResponse | null;
-  trialEnd?: string;
-  plan: ISubscriptionPlanResponse;
-}
-
-export interface ISubscriptionPlanResponse {
-  slug: string;
-}
-
-export interface ISubscriptionCancellationResponse {
-  policy: ISubscriptionCancellationPolicy;
-}
-
-export interface ISubscriptionInvoiceResponse {
-  id: string;
-  externalId: string;
-  subscriptionId: string;
-  paymentDate: string;
-  totalAmount: number;
-  currency: string;
-  paid: boolean;
-  receiptNumber: string;
-}
-
-export type ISubscriptionPaymentMethodResponse =
-  | ISubscriptionPaymentMethodDefaultResponse
-  | ISubscriptionPaymentMethodCardResponse;
-
-export interface ISubscriptionPaymentMethodDefaultResponse {
-  id: string;
-  externalId: string;
-  type: PaymentMethodType.UNKNWON;
-  isDefault: boolean;
-}
-
-export interface ISubscriptionPaymentMethodCardResponse {
-  id: string;
-  externalId: string;
-  type: PaymentMethodType.CARD;
-  isDefault: boolean;
-  last4: string;
-  expMonth: number;
-  expYear: number;
-  brand: string;
-  billingDetails: BillingDetailsResponse;
-}
-
-export interface ISubscriptionSummariesResponse {
-  tenantConfigurationId: string;
-  providerType: ProviderType;
-  subscriptionId: string;
-  externallyManaged: boolean;
-  currentPlanId: string;
-  paymentMethodId: string;
-  defaultPlanId: string;
-}
-
-export interface BillingDetailsResponse {
-  name: string;
-  email?: string;
-  address?: BillingDetailsAddress;
-}
-
-export interface BillingDetailsAddress {
-  addressLine1?: string;
-  addressLine2?: string;
-  city?: string;
-  state?: string;
-  postalCode?: string;
-  country?: string;
-}
-
-export interface ISubscriptionUpdatePaymentMethodBillingDetails {
-  email?: string;
-  address?: BillingDetailsAddress;
-}
-
-export interface ITenantConfigurationResponse {
-  id: string;
-  vendorId: string;
-  tenantId: string;
-  externallyManaged: string;
-  paymentProviderType: ProviderType;
-  mappingId: string;
-}
-
-export interface ICreateTenantConfigurationRequest {
-  tenantId: string;
-  externallyManaged?: string;
-  providerType: ProviderType;
-}
-
-export interface ICreateTenantConfigurationResponse {
-  id: string;
-}
-
-export interface IPaymentProviderResponse {
-  providerType: ProviderType;
-  name: string;
-  status: string;
-}
-
-export interface IUpdateSubscriptionRequest {
-  paymentMethodId: string;
-  planId: string;
-}
-
-export interface IUpdateManagedSubscriptionRequest {
-  paymentMethodId: string;
-  planId: string;
-}

package/src/subscriptions/invoices.ts

@@ -1,42 +0,0 @@
-import { ISubscriptionInvoiceResponse } from "./interfaces";
-import { Get } from "../fetch";
-import { urls } from "../constants";
-
-/**
- * Get subscription invoices
- */
-export async function getSubscriptionInvoices(): Promise<
-  ISubscriptionInvoiceResponse[]
-> {
-  console.debug("getSubscriptionInvoices()");
-  return Get(urls.subscriptions.billing.invoices.v1);
-}
-
-/**
- * Get subscription invoice
- */
-export async function getSubscriptionInvoice(
-  invoiceId: string
-): Promise<ISubscriptionInvoiceResponse> {
-  console.debug("getSubscriptionInvoice()", { invoiceId });
-  return Get(`${urls.subscriptions.billing.invoices.v1}/${invoiceId}`);
-}
-
-/**
- * Get subscription invoice pdf file
- */
-export async function getSubscriptionInvoicePdf(
-  invoiceId: string,
-  outputFileName?: string
-): Promise<void> {
-  console.debug("getSubscriptionInvoicePdf()", { invoiceId });
-  return Get(
-    `${urls.subscriptions.billing.invoices.v1}/${invoiceId}/pdf`,
-    {
-      outputFileName,
-    },
-    {
-      responseType: "blob",
-    }
-  );
-}

package/src/subscriptions/managedSubscriptions.ts

@@ -1,53 +0,0 @@
-import { ISubscriptionResponse, IUpdateManagedSubscriptionRequest } from "./interfaces";
-import { Get, Put } from "../fetch";
-import { urls } from "../constants";
-
-export async function getManagedSubscription(subscriptionId: string): Promise<ISubscriptionResponse> {
-    console.debug('getManagedSubscription()', {subscriptionId});
-    return Get(`${urls.subscriptions.managedSubscriptions.v1}/${subscriptionId}`)
-}
-
-export async function getManagedSubscriptions(): Promise<ISubscriptionResponse[]> {
-    console.debug('getManagedSubscriptions()');
-    return Get(`${urls.subscriptions.managedSubscriptions.v1}`)
-}
-
-/**
- * Cancel tenant subscription
- */
-export async function cancelManagedSubscription(
-  subscriptionId: string
-): Promise<void> {
-    console.debug("cancelManagedSubscription()", { subscriptionId });
-    return Put(
-      `${urls.subscriptions.managedSubscriptions.v1}/${subscriptionId}/cancellations/`,
-      {}
-    );
-}
-
-/**
- * Renew tenant subscription
- */
-export async function renewManagedSubscription(
-  subscriptionId: string
-): Promise<void> {
-    console.debug("renewManagedSubscription()", { subscriptionId });
-    return Put(
-      `${urls.subscriptions.managedSubscriptions.v1}/${subscriptionId}/renewals/`,
-      {}
-    );
-}
-
-/**
- * Upgrade/Downgrade tenant subscription plan
- */
-export async function updateManagedSubscription(
-  subscriptionId: string,
-  { paymentMethodId, planId }: IUpdateManagedSubscriptionRequest
-): Promise<void> {
-    console.debug("updateManagedSubscription()", { subscriptionId });
-    return Put(
-      `${urls.subscriptions.managedSubscriptions.v1}/${subscriptionId}`,
-      { paymentMethodId, planId }
-    );
-}

package/src/subscriptions/paymentMethods.ts

@@ -1,47 +0,0 @@
-import {
-  BillingDetailsAddress,
-  ISubscriptionPaymentMethodResponse,
-  ISubscriptionUpdatePaymentMethodBillingDetails,
-} from "./interfaces";
-import { Get, Patch } from "../fetch";
-import { urls } from "../constants";
-
-/**
- * Get payment methods
- */
-export async function getPaymentMethods(): Promise<
-  ISubscriptionPaymentMethodResponse[]
-> {
-  console.debug("getPaymentMethods()");
-  return Get(urls.subscriptions.billing.paymentMethods.v1);
-}
-
-/**
- * Get payment method
- */
-export async function getPaymentMethod(
-  paymentMethodId: string
-): Promise<ISubscriptionPaymentMethodResponse> {
-  console.debug("getPaymentMethod()", { paymentMethodId });
-  return Get(
-    `${urls.subscriptions.billing.paymentMethods.v1}/${paymentMethodId}`
-  );
-}
-
-/**
- * Update payment method billing details
- */
-export async function updatePaymentMethodBillingDetails(
-  paymentMethodId: string,
-  { email, ...address }: ISubscriptionUpdatePaymentMethodBillingDetails
-): Promise<ISubscriptionUpdatePaymentMethodBillingDetails> {
-  console.debug("updatePaymentMethodBillingDetails()", {
-    paymentMethodId,
-    email,
-    address,
-  });
-  return Patch(
-    `${urls.subscriptions.billing.paymentMethods.v1}/${paymentMethodId}/billing-details`,
-    { email, address }
-  );
-}

package/src/subscriptions/paymentProviders.ts

@@ -1,13 +0,0 @@
-import { IPaymentProviderResponse } from "./interfaces";
-import { Get } from "../fetch";
-import { urls } from "../constants";
-
-/**
- * Gets payment providers for vendor
- */
-export async function getPaymentProviders(): Promise<
-  IPaymentProviderResponse[]
-> {
-  console.debug("getPaymentProviders()");
-  return Get(urls.subscriptions.paymentProviders.v1);
-}

package/src/subscriptions/plans.ts

@@ -1,19 +0,0 @@
-import {IPlanResponse} from './interfaces';
-import {Get} from '../fetch';
-import {urls} from '../constants';
-
-/**
- * Gets subscription plans
- */
-export async function getSubscriptionPlans(): Promise<IPlanResponse[]> {
-  console.debug('getSubscriptionPlans()');
-  return Get(urls.subscriptions.billing.plans.v1);
-}
-
-/**
- * Gets subscription plan singular
- */
-export async function getSubscriptionPlan(planId: string): Promise<IPlanResponse[]> {
-  console.debug('getSubscriptionPlan()');
-  return Get(`${urls.subscriptions.billing.plans.v1}/${planId}`);
-}

package/src/subscriptions/providers/index.ts

@@ -1 +0,0 @@
-export * from './stripe';

package/src/subscriptions/providers/stripe/index.ts

@@ -1,56 +0,0 @@
-import {
-  ICreateStripeCustomerRequest, ICreateStripeCustomerResponse,
-  ICreateStripeSubscriptionRequest,
-  ICreateSubscriptionResponse,
-  IStripeCustomerResponse, IStripePaymentProviderConfigurationResponse, ICreateStripePaymentMethodSetupRequest, ICreateStripePaymentMethodSetupResponse
-} from "./interfaces";
-import {Get, Post} from "../../../fetch";
-import {urls} from "../../../constants";
-
-/**
- * Creates new stripe subscription
- * @param request
- */
-export async function createSubscription(
-  request: ICreateStripeSubscriptionRequest
-): Promise<ICreateSubscriptionResponse> {
-  console.debug('createSubscription()');
-  return Post(urls.subscriptions.billing.paymentProviders.stripe.subscriptions.v1, request);
-}
-
-
-/**
- * Fetch tenant mapping external stripe customer object
- */
-export async function getStripeCustomer(tenantId: string): Promise<IStripeCustomerResponse> {
-  console.debug('getStripeCustomer()');
-  return Get(`${urls.subscriptions.billing.paymentProviders.stripe.customers.v1}/${tenantId}`);
-}
-
-/**
- * Create tenant mapping external stripe customer object
- * @param request
- */
-export async function createStripeCustomer(
-  request: ICreateStripeCustomerRequest
-): Promise<ICreateStripeCustomerResponse> {
-  console.debug('createStripeCustomer()');
-  return Post(`${urls.subscriptions.billing.paymentProviders.stripe.customers.v1}`, request);
-}
-
-
-export async function getStripePaymentProviderConfiguration(): Promise<IStripePaymentProviderConfigurationResponse> {
-  console.debug('getStripePaymentProviderConfiguration()');
-  return Get(`${urls.subscriptions.billing.paymentProviders.stripe.publicConfigurations.v1}`);
-}
-
-/**
- * Create payment method intent secret
- * @param request
- */
-export async function createStripePaymentMethodSetupIntentSecret(
-  request: ICreateStripePaymentMethodSetupRequest
-): Promise<ICreateStripePaymentMethodSetupResponse> {
-  console.debug('createStripePaymentMethodSetupIntentSecret()');
-  return Post(`${urls.subscriptions.billing.paymentProviders.stripe.setupIntents.v1}`, request);
-}

package/src/subscriptions/providers/stripe/interfaces.ts

@@ -1,39 +0,0 @@
-export interface ICreateStripePaymentMethodSetupResponse {
-	id: string
-	paymentMethodId: string
-	setupIntentSecret: string
-}
-
-export interface ICreateStripePaymentMethodSetupRequest {
-	paymentMethodId?: string
-}
-
-export interface IStripePaymentProviderConfigurationResponse {
-  id: string;
-  name: string;
-  active: boolean;
-  publishableKey: string;
-}
-
-export interface IStripeCustomerResponse {
-  stripeCustomerId: string;
-}
-
-export interface ICreateStripeCustomerRequest {
-  name: string;
-  email: string;
-  tenantName?: string;
-}
-
-export interface ICreateStripeCustomerResponse {
-  stripeCustomerId: string;
-}
-
-export interface ICreateStripeSubscriptionRequest {
-  stripePlanId: string;
-}
-
-export interface ICreateSubscriptionResponse {
-  subscriptionId: string;
-  subscriptionSecret: string;
-}

package/src/subscriptions/subscriptions.ts

@@ -1,63 +0,0 @@
-import { ISubscriptionResponse, IUpdateSubscriptionRequest } from "./interfaces";
-import { Get, Put } from "../fetch";
-import { urls } from "../constants";
-
-/**
- * Get tenant subscriptions
- */
-export async function getSubscriptions(): Promise<ISubscriptionResponse[]> {
-  console.debug("getSubscriptions()");
-  return Get(urls.subscriptions.billing.subscriptions.v1);
-}
-
-/**
- * Get tenant subscription
- */
-export async function getSubscription(
-  subscriptionId: string
-): Promise<ISubscriptionResponse> {
-  console.debug("getSubscription()", { subscriptionId });
-  return Get(
-    `${urls.subscriptions.billing.subscriptions.v1}/${subscriptionId}`
-  );
-}
-
-/**
- * Cancel tenant subscription
- */
-export async function cancelSubscription(
-  subscriptionId: string
-): Promise<void> {
-  console.debug("cancelSubscription()", { subscriptionId });
-  return Put(
-    `${urls.subscriptions.billing.subscriptions.v1}/${subscriptionId}/cancellations/`,
-    {}
-  );
-}
-
-/**
- * Renew tenant subscription
- */
-export async function renewSubscription(
-  subscriptionId: string
-): Promise<void> {
-  console.debug("renewSubscription()", { subscriptionId });
-  return Put(
-    `${urls.subscriptions.billing.subscriptions.v1}/${subscriptionId}/renewals/`,
-    {}
-  );
-}
-
-/**
- * Upgrade/Downgrade tenant subscription plan
- */
-export async function updateSubscription(
-  subscriptionId: string,
-  { paymentMethodId, planId }: IUpdateSubscriptionRequest
-): Promise<void> {
-  console.debug("updateSubscription()", { subscriptionId });
-  return Put(
-    `${urls.subscriptions.billing.subscriptions.v1}/${subscriptionId}`,
-    { paymentMethodId, planId }
-  );
-}

package/src/subscriptions/summaries.ts

@@ -1,11 +0,0 @@
-import { ISubscriptionSummariesResponse } from './interfaces';
-import { Get } from '../fetch';
-import { urls } from '../constants';
-
-/**
- * Gets subscription summaries
- */
-export async function getSubscriptionSummaries(tenantId: string): Promise<ISubscriptionSummariesResponse> {
-  console.debug('getSubscriptionSummaries()');
-  return Get(`${urls.subscriptions.billing.summaries.v1}/${tenantId}`);
-}

package/src/subscriptions/tenantConfiguration.ts

@@ -1,23 +0,0 @@
-import {
-  ICreateTenantConfigurationRequest,
-  ICreateTenantConfigurationResponse,
-  ITenantConfigurationResponse,
-} from "./interfaces";
-import { Get, Post } from "../fetch";
-import { urls } from "../constants";
-
-export async function getTenantConfiguration(
-  tenantId: string
-): Promise<ITenantConfigurationResponse> {
-  console.debug("getTenantConfiguration()");
-  return Get(
-    `${urls.subscriptions.billing.tenantConfiguration.v1}/${tenantId}`
-  );
-}
-
-export async function createTenantConfiguration(
-  request: ICreateTenantConfigurationRequest
-): Promise<ICreateTenantConfigurationResponse> {
-  console.debug("createTenantConfiguration()");
-  return Post(`${urls.subscriptions.billing.tenantConfiguration.v1}`, request);
-}