@stigg/js-client-sdk 0.48.0 → 0.49.0

package/dist/api/CustomersApi.d.ts

@@ -1,8 +1,9 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
-import { GetCustomerByRefIdQuery } from './generated/types';
+import { GetCustomerByRefIdQuery, GetCustomerPortalByRefIdQuery } from './generated/types';
 declare class CustomersApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);
     getCustomer(customerId: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetCustomerByRefIdQuery>>;
+    getCustomerPortal(customerId: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetCustomerPortalByRefIdQuery>>;
 }
 export default CustomersApi;

package/dist/api/EntitlementsApi.d.ts

@@ -1,5 +1,7 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
 import { GetEntitlementsQuery, EntitlementCheckResult } from './generated/types';
+export declare const RESET_PERIOD_CONFIGURATION_FRAGMENT: import("graphql/language/ast").DocumentNode;
+export declare const FEATURE_FRAGMENT: import("graphql/language/ast").DocumentNode;
 declare class EntitlementsApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);

package/dist/api/generated/types.d.ts

@@ -448,6 +448,9 @@ export declare type CustomerInput = {
     refId?: InputMaybe<Scalars['String']>;
     shouldSyncFree?: InputMaybe<Scalars['Boolean']>;
 };
+export declare type CustomerPortalInput = {
+    customerId: Scalars['String'];
+};
 export declare type CustomerSort = {
     direction: SortDirection;
     field: CustomerSortFields;
@@ -2573,6 +2576,114 @@ export declare type CustomerFragment = {
         __typename?: 'CustomerSubscription';
     } & SubscriptionFragment> | null | undefined;
 };
+export declare type CustomerPortalEntitlementFragment = {
+    __typename?: 'Entitlement';
+    isGranted: boolean;
+    usageLimit?: number | null | undefined;
+    currentUsage?: number | null | undefined;
+    hasUnlimitedUsage: boolean;
+    nextResetDate?: any | null | undefined;
+    resetPeriod?: EntitlementResetPeriod | null | undefined;
+    resetPeriodConfiguration?: ({
+        __typename?: 'MonthlyResetPeriodConfig';
+    } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_) | ({
+        __typename?: 'WeeklyResetPeriodConfig';
+    } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_) | null | undefined;
+    feature?: ({
+        __typename?: 'EntitlementFeature';
+    } & FeatureFragment) | null | undefined;
+};
+export declare type CustomerPortalPromotionalEntitlementFragment = {
+    __typename?: 'CustomerPortalPromotionalEntitlement';
+    displayName: string;
+    hasUnlimitedUsage?: boolean | null | undefined;
+    usageLimit?: number | null | undefined;
+    period: PromotionalEntitlementPeriod;
+    startDate: any;
+    endDate?: any | null | undefined;
+};
+export declare type CustomerPortalSubscriptionAddonFragment = {
+    __typename?: 'CustomerPortalAddon';
+    addonId: string;
+    description?: string | null | undefined;
+    displayName: string;
+    quantity: number;
+};
+export declare type CustomerPortalBillingInformationFragment = {
+    __typename?: 'CustomerPortalBillingInformation';
+    email?: string | null | undefined;
+    name?: string | null | undefined;
+    defaultPaymentMethodLast4Digits?: string | null | undefined;
+    defaultPaymentMethodId?: string | null | undefined;
+    defaultPaymentExpirationMonth?: number | null | undefined;
+    defaultPaymentExpirationYear?: number | null | undefined;
+};
+export declare type CustomerPortalSubscriptionFragment = {
+    __typename?: 'CustomerPortalSubscription';
+    subscriptionId: string;
+    planName: string;
+    status: SubscriptionStatus;
+    trialRemainingDays?: number | null | undefined;
+    pricing: {
+        __typename?: 'CustomerPortalSubscriptionPricing';
+        unitQuantity?: number | null | undefined;
+        billingPeriod?: BillingPeriod | null | undefined;
+        billingModel?: BillingModel | null | undefined;
+        pricingType: PricingType;
+        usageBasedEstimatedBill?: number | null | undefined;
+        price?: {
+            __typename?: 'Money';
+            amount: number;
+        } | null | undefined;
+        feature?: {
+            __typename?: 'CustomerPortalPricingFeature';
+            featureUnits?: string | null | undefined;
+            featureUnitsPlural?: string | null | undefined;
+            displayName: string;
+        } | null | undefined;
+    };
+    billingPeriodRange?: {
+        __typename?: 'DateRange';
+        start?: any | null | undefined;
+        end?: any | null | undefined;
+    } | null | undefined;
+    totalPrice?: {
+        __typename?: 'CustomerSubscriptionTotalPrice';
+        subTotal: {
+            __typename?: 'Money';
+            amount: number;
+        };
+        total: {
+            __typename?: 'Money';
+            amount: number;
+        };
+        addonsTotal: {
+            __typename?: 'Money';
+            amount: number;
+        };
+    } | null | undefined;
+    addons: Array<{
+        __typename?: 'CustomerPortalAddon';
+    } & CustomerPortalSubscriptionAddonFragment>;
+};
+export declare type CustomerPortalFragment = {
+    __typename?: 'CustomerPortal';
+    showWatermark: boolean;
+    billingPortalUrl?: string | null | undefined;
+    canUpgradeSubscription: boolean;
+    subscriptions: Array<{
+        __typename?: 'CustomerPortalSubscription';
+    } & CustomerPortalSubscriptionFragment>;
+    entitlements: Array<{
+        __typename?: 'Entitlement';
+    } & CustomerPortalEntitlementFragment>;
+    promotionalEntitlements: Array<{
+        __typename?: 'CustomerPortalPromotionalEntitlement';
+    } & CustomerPortalPromotionalEntitlementFragment>;
+    billingInformation: {
+        __typename?: 'CustomerPortalBillingInformation';
+    } & CustomerPortalBillingInformationFragment;
+};
 export declare type GetCustomerByRefIdQueryVariables = Exact<{
     filter?: Maybe<CustomerFilter>;
 }>;
@@ -2588,6 +2699,40 @@ export declare type GetCustomerByRefIdQuery = {
         }>;
     };
 };
+export declare type GetCustomerPortalByRefIdQueryVariables = Exact<{
+    input: CustomerPortalInput;
+}>;
+export declare type GetCustomerPortalByRefIdQuery = {
+    __typename?: 'Query';
+    customerPortal: {
+        __typename?: 'CustomerPortal';
+    } & CustomerPortalFragment;
+};
+declare type ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ = {
+    __typename: 'MonthlyResetPeriodConfig';
+} & MonthlyResetPeriodConfigFragment;
+declare type ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_ = {
+    __typename: 'WeeklyResetPeriodConfig';
+} & WeeklyResetPeriodConfigFragment;
+export declare type ResetPeriodConfigurationFragment = ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ | ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_;
+export declare type MonthlyResetPeriodConfigFragment = {
+    __typename?: 'MonthlyResetPeriodConfig';
+    monthlyAccordingTo?: MonthlyAccordingTo | null | undefined;
+};
+export declare type WeeklyResetPeriodConfigFragment = {
+    __typename?: 'WeeklyResetPeriodConfig';
+    weeklyAccordingTo?: WeeklyAccordingTo | null | undefined;
+};
+export declare type FeatureFragment = {
+    __typename?: 'EntitlementFeature';
+    featureType: FeatureType;
+    meterType?: MeterType | null | undefined;
+    featureUnits?: string | null | undefined;
+    featureUnitsPlural?: string | null | undefined;
+    description?: string | null | undefined;
+    displayName: string;
+    refId: string;
+};
 export declare type EntitlementFragment = {
     __typename?: 'Entitlement';
     isGranted: boolean;
@@ -2608,31 +2753,6 @@ export declare type EntitlementFragment = {
         __typename?: 'EntitlementFeature';
     } & FeatureFragment) | null | undefined;
 };
-declare type ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ = {
-    __typename: 'MonthlyResetPeriodConfig';
-} & MonthlyResetPeriodConfigFragment;
-declare type ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_ = {
-    __typename: 'WeeklyResetPeriodConfig';
-} & WeeklyResetPeriodConfigFragment;
-export declare type ResetPeriodConfigurationFragment = ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ | ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_;
-export declare type FeatureFragment = {
-    __typename?: 'EntitlementFeature';
-    featureType: FeatureType;
-    meterType?: MeterType | null | undefined;
-    featureUnits?: string | null | undefined;
-    featureUnitsPlural?: string | null | undefined;
-    description?: string | null | undefined;
-    displayName: string;
-    refId: string;
-};
-export declare type MonthlyResetPeriodConfigFragment = {
-    __typename?: 'MonthlyResetPeriodConfig';
-    monthlyAccordingTo?: MonthlyAccordingTo | null | undefined;
-};
-export declare type WeeklyResetPeriodConfigFragment = {
-    __typename?: 'WeeklyResetPeriodConfig';
-    weeklyAccordingTo?: WeeklyAccordingTo | null | undefined;
-};
 export declare type GetEntitlementsQueryVariables = Exact<{
     query: FetchEntitlementsQuery;
 }>;

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Plan, Subscription, WaitForCheckoutCompleted } from './models';
+import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Plan, Subscription, WaitForCheckoutCompleted, CustomerPortal } from './models';
 import { ClientConfiguration } from './configuration';
 import { EventNames, Events } from './services/eventEmitter';
 export interface StiggClient {
@@ -17,6 +17,7 @@ export interface StiggClient {
     waitForInitialization(): Promise<StiggClient>;
     addListener: <K extends EventNames>(eventName: K, callback: Events[K]) => void;
     removeListener: <K extends EventNames>(eventName: K, callback: Events[K]) => void;
+    getCustomerPortal(): Promise<CustomerPortal>;
 }
 export declare class Stigg implements StiggClient {
     private readonly apiGateway;
@@ -110,6 +111,12 @@ export declare class Stigg implements StiggClient {
      * @returns {Promise<Customer>}
      */
     getCustomer(): Promise<Customer>;
+    /**
+     * Get a customer portal
+     *
+     * @returns {Promise<CustomerPortal>}
+     */
+    getCustomerPortal(): Promise<CustomerPortal>;
     /**
      * Get a list of entitlements
      *