@stigg/js-client-sdk 0.53.0 → 0.55.0

package/dist/api/PaywallApi.d.ts

@@ -1,5 +1,6 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
 import { GetPaywallQuery } from './generated/types';
+export declare const PAYWALL_CONFIGURATION: import("graphql/language/ast").DocumentNode;
 declare class PaywallApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);

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

@@ -450,6 +450,18 @@ export declare type CustomerInput = {
     refId?: InputMaybe<Scalars['String']>;
     shouldSyncFree?: InputMaybe<Scalars['Boolean']>;
 };
+export declare type CustomerPortalColorsPaletteInput = {
+    backgroundColor?: InputMaybe<Scalars['String']>;
+    borderColor?: InputMaybe<Scalars['String']>;
+    currentPlanBackground?: InputMaybe<Scalars['String']>;
+    iconsColor?: InputMaybe<Scalars['String']>;
+    paywallBackgroundColor?: InputMaybe<Scalars['String']>;
+    primary?: InputMaybe<Scalars['String']>;
+    textColor?: InputMaybe<Scalars['String']>;
+};
+export declare type CustomerPortalConfigurationInput = {
+    palette?: InputMaybe<CustomerPortalColorsPaletteInput>;
+};
 export declare type CustomerPortalInput = {
     customerId: Scalars['String'];
 };
@@ -981,6 +993,9 @@ export declare type GetPaywallInput = {
     environmentId?: InputMaybe<Scalars['String']>;
     productId?: InputMaybe<Scalars['String']>;
 };
+export declare type GetWidgetConfigurationInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
+};
 export declare type HookFilter = {
     and?: InputMaybe<Array<HookFilter>>;
     createdAt?: InputMaybe<DateFieldComparison>;
@@ -1305,6 +1320,7 @@ export declare enum PackageEntitlementSortFields {
 }
 export declare type PackageEntitlementUpdateInput = {
     description?: InputMaybe<Scalars['String']>;
+    displayNameOverride?: InputMaybe<Scalars['String']>;
     hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
     hiddenFromWidgets?: InputMaybe<Array<WidgetType>>;
     monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
@@ -1350,6 +1366,16 @@ export declare enum PaymentMethodType {
     Bank = "BANK",
     Card = "CARD"
 }
+export declare type PaywallColorsPaletteInput = {
+    backgroundColor?: InputMaybe<Scalars['String']>;
+    borderColor?: InputMaybe<Scalars['String']>;
+    currentPlanBackground?: InputMaybe<Scalars['String']>;
+    primary?: InputMaybe<Scalars['String']>;
+    textColor?: InputMaybe<Scalars['String']>;
+};
+export declare type PaywallConfigurationInput = {
+    palette?: InputMaybe<PaywallColorsPaletteInput>;
+};
 export declare type PlanCreateInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
@@ -2374,6 +2400,11 @@ export declare enum WeeklyAccordingTo {
 export declare type WeeklyResetPeriodConfigInput = {
     accordingTo: WeeklyAccordingTo;
 };
+export declare type WidgetConfigurationUpdateInput = {
+    customerPortalConfiguration?: InputMaybe<CustomerPortalConfigurationInput>;
+    environmentId?: InputMaybe<Scalars['String']>;
+    paywallConfiguration?: InputMaybe<PaywallConfigurationInput>;
+};
 /** The widget type */
 export declare enum WidgetType {
     CustomerPortal = "CUSTOMER_PORTAL",
@@ -2696,6 +2727,19 @@ export declare type CustomerPortalSubscriptionFragment = {
         __typename?: 'CustomerPortalAddon';
     } & CustomerPortalSubscriptionAddonFragment>;
 };
+export declare type CustomerPortalConfigurationFragment = {
+    __typename?: 'CustomerPortalConfiguration';
+    palette: {
+        __typename?: 'CustomerPortalColorsPalette';
+        primary: string;
+        textColor: string;
+        backgroundColor: string;
+        borderColor: string;
+        currentPlanBackground: string;
+        iconsColor: string;
+        paywallBackgroundColor: string;
+    };
+};
 export declare type CustomerPortalFragment = {
     __typename?: 'CustomerPortal';
     showWatermark: boolean;
@@ -2713,6 +2757,9 @@ export declare type CustomerPortalFragment = {
     billingInformation: {
         __typename?: 'CustomerPortalBillingInformation';
     } & CustomerPortalBillingInformationFragment;
+    configuration: {
+        __typename?: 'CustomerPortalConfiguration';
+    } & CustomerPortalConfigurationFragment;
 };
 export declare type GetCustomerByRefIdQueryVariables = Exact<{
     filter?: Maybe<CustomerFilter>;
@@ -2805,6 +2852,7 @@ export declare type PaywallPackageEntitlementFragment = {
     hasUnlimitedUsage: boolean;
     resetPeriod?: EntitlementResetPeriod | null | undefined;
     hiddenFromWidgets?: Array<WidgetType> | null | undefined;
+    displayNameOverride?: string | null | undefined;
     feature?: {
         __typename?: 'EntitlementFeature';
         featureType: FeatureType;
@@ -2895,6 +2943,9 @@ export declare type GetMockPaywallQuery = {
         plans: Array<{
             __typename?: 'PaywallPlan';
         } & PayWallPlanFragment>;
+        configuration: {
+            __typename?: 'PaywallConfiguration';
+        } & PaywallConfigurationFragment;
     };
 };
 export declare type PackageEntitlementFragment = {
@@ -2904,6 +2955,7 @@ export declare type PackageEntitlementFragment = {
     featureId: string;
     resetPeriod?: EntitlementResetPeriod | null | undefined;
     hiddenFromWidgets?: Array<WidgetType> | null | undefined;
+    displayNameOverride?: string | null | undefined;
     feature: {
         __typename?: 'Feature';
         featureType: FeatureType;
@@ -2966,6 +3018,17 @@ export declare type PlanFragment = {
         __typename?: 'Addon';
     } & AddonFragment> | null | undefined;
 };
+export declare type PaywallConfigurationFragment = {
+    __typename?: 'PaywallConfiguration';
+    palette: {
+        __typename?: 'PaywallColorsPalette';
+        primary: string;
+        textColor: string;
+        backgroundColor: string;
+        borderColor: string;
+        currentPlanBackground: string;
+    };
+};
 export declare type GetPaywallQueryVariables = Exact<{
     input: GetPaywallInput;
 }>;
@@ -2976,6 +3039,9 @@ export declare type GetPaywallQuery = {
         plans: Array<{
             __typename?: 'Plan';
         } & PlanFragment>;
+        configuration: {
+            __typename?: 'PaywallConfiguration';
+        } & PaywallConfigurationFragment;
     };
 };
 export declare type SdkConfigurationQueryVariables = Exact<{

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Plan, Subscription, WaitForCheckoutCompleted, CustomerPortal } from './models';
+import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Subscription, WaitForCheckoutCompleted, CustomerPortal, Paywall } from './models';
 import { ClientConfiguration } from './configuration';
 import { EventNames, Events } from './services/eventEmitter';
 export interface StiggClient {
@@ -9,7 +9,7 @@ export interface StiggClient {
     getMeteredEntitlement: (params: GetMeteredEntitlement) => MeteredEntitlement;
     setCustomerId: (customerId: string) => Promise<void>;
     clearCustomer: () => void;
-    getPaywall: (params?: GetPaywall) => Promise<Plan[]>;
+    getPaywall: (params?: GetPaywall) => Promise<Paywall>;
     getCustomer: () => Promise<Customer>;
     getCoupons(): Promise<Coupon[]>;
     getEntitlements: () => Promise<Entitlement[]>;
@@ -96,12 +96,12 @@ export declare class Stigg implements StiggClient {
      */
     getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
     /**
-     * Get a list of plans for rendering the paywall
+     * Get paywall data for rendering the paywall
      * @deprecated *Optional* `productId` is now deprecated and will be changed to a *required* field soon.
      *
-     * @returns {Promise<Plan[]>}
+     * @returns {Promise<Paywall>}
      */
-    getPaywall({ productId }?: GetPaywall): Promise<Plan[]>;
+    getPaywall({ productId }?: GetPaywall): Promise<Paywall>;
     /**
      * Get a list of coupons
      *