@stigg/js-client-sdk 0.43.0 → 0.44.0

package/dist/api/PaywallApi.d.ts

@@ -1,8 +1,8 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
-import { GetPlansQuery } from './generated/types';
+import { GetPaywallQuery } from './generated/types';
 declare class PaywallApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);
-    getPlans(productId?: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetPlansQuery>>;
+    getPaywall(productId?: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetPaywallQuery>>;
 }
 export default PaywallApi;

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

@@ -294,6 +294,7 @@ export declare type CreateEnvironment = {
     description?: InputMaybe<Scalars['String']>;
     displayName?: InputMaybe<Scalars['String']>;
     id?: InputMaybe<Scalars['String']>;
+    provisionStatus?: InputMaybe<EnvironmentProvisionStatus>;
     slug?: InputMaybe<Scalars['String']>;
 };
 export declare type CreateEnvironmentOptions = {
@@ -640,6 +641,13 @@ export declare type EnvironmentFilter = {
     or?: InputMaybe<Array<EnvironmentFilter>>;
     slug?: InputMaybe<StringFieldComparison>;
 };
+/** EnvironmentProvisionStatus. */
+export declare enum EnvironmentProvisionStatus {
+    Done = "DONE",
+    Failed = "FAILED",
+    InProgress = "IN_PROGRESS",
+    NotProvisioned = "NOT_PROVISIONED"
+}
 export declare type EnvironmentSort = {
     direction: SortDirection;
     field: EnvironmentSortFields;
@@ -661,7 +669,6 @@ export declare enum ErrorCode {
     BillingPeriodMissingError = "BillingPeriodMissingError",
     CannotDeleteCustomerError = "CannotDeleteCustomerError",
     CannotDeleteFeatureError = "CannotDeleteFeatureError",
-    CantCreateExperiment = "CantCreateExperiment",
     CheckoutIsNotSupported = "CheckoutIsNotSupported",
     CouponNotFound = "CouponNotFound",
     CustomerHasNoPaymentMethod = "CustomerHasNoPaymentMethod",
@@ -671,6 +678,7 @@ export declare enum ErrorCode {
     DuplicatedEntityNotAllowed = "DuplicatedEntityNotAllowed",
     EditAllowedOnDraftPackageOnlyError = "EditAllowedOnDraftPackageOnlyError",
     EnvironmentMissing = "EnvironmentMissing",
+    ExperimentAlreadyRunning = "ExperimentAlreadyRunning",
     ExperimentNotFoundError = "ExperimentNotFoundError",
     ExperimentStatusError = "ExperimentStatusError",
     FailedToImportCustomer = "FailedToImportCustomer",
@@ -693,6 +701,7 @@ export declare enum ErrorCode {
     MemberNotFound = "MemberNotFound",
     MeteringNotAvailableForFeatureType = "MeteringNotAvailableForFeatureType",
     NoFeatureEntitlementInSubscription = "NoFeatureEntitlementInSubscription",
+    OperationNotAllowedDuringInProgressExperiment = "OperationNotAllowedDuringInProgressExperiment",
     PackageAlreadyPublished = "PackageAlreadyPublished",
     PackagePricingTypeNotSet = "PackagePricingTypeNotSet",
     PlanAlreadyExtended = "PlanAlreadyExtended",
@@ -802,6 +811,10 @@ export declare enum ExperimentSortFields {
     RefId = "refId",
     Status = "status"
 }
+export declare type ExperimentStatsQuery = {
+    environmentId?: InputMaybe<Scalars['String']>;
+    experimentRefId: Scalars['String'];
+};
 /** The status of the EXPERIMENT */
 export declare enum ExperimentStatus {
     Completed = "COMPLETED",
@@ -924,6 +937,9 @@ export declare type GetPackageByRefIdInput = {
     refId: Scalars['String'];
     versionNumber?: InputMaybe<Scalars['Float']>;
 };
+export declare type GetPaywallInput = {
+    productId?: InputMaybe<Scalars['String']>;
+};
 export declare type HookFilter = {
     and?: InputMaybe<Array<HookFilter>>;
     createdAt?: InputMaybe<DateFieldComparison>;
@@ -1226,6 +1242,7 @@ export declare type PackageEntitlementInput = {
     featureId: Scalars['String'];
     hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
     monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
+    order?: InputMaybe<Scalars['Float']>;
     packageId: Scalars['String'];
     resetPeriod?: InputMaybe<EntitlementResetPeriod>;
     usageLimit?: InputMaybe<Scalars['Float']>;
@@ -1247,6 +1264,7 @@ export declare type PackageEntitlementUpdateInput = {
     description?: InputMaybe<Scalars['String']>;
     hasUnlimitedUsage?: InputMaybe<Scalars['Boolean']>;
     monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
+    order?: InputMaybe<Scalars['Float']>;
     resetPeriod?: InputMaybe<EntitlementResetPeriod>;
     usageLimit?: InputMaybe<Scalars['Float']>;
     weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
@@ -1765,7 +1783,6 @@ export declare type SubscriptionAddonFilterPriceFilter = {
 };
 export declare type SubscriptionAddonInput = {
     addonId: Scalars['String'];
-    billingPeriod?: InputMaybe<BillingPeriod>;
     quantity?: InputMaybe<Scalars['Int']>;
 };
 export declare type SubscriptionAddonSort = {
@@ -1840,6 +1857,13 @@ export declare enum SubscriptionCancellationTime {
     Immediate = "IMMEDIATE",
     SpecificDate = "SPECIFIC_DATE"
 }
+/** Subscription decision strategy */
+export declare enum SubscriptionDecisionStrategy {
+    PredefinedFreePlan = "PREDEFINED_FREE_PLAN",
+    PredefinedTrialPlan = "PREDEFINED_TRIAL_PLAN",
+    RequestedPlan = "REQUESTED_PLAN",
+    SkippedSubscriptionCreation = "SKIPPED_SUBSCRIPTION_CREATION"
+}
 export declare type SubscriptionEditTrialEndDateInput = {
     environmentId: Scalars['String'];
     subscriptionRefId: Scalars['String'];
@@ -1972,13 +1996,6 @@ export declare type SubscriptionStatusFilterComparison = {
     notIn?: InputMaybe<Array<SubscriptionStatus>>;
     notLike?: InputMaybe<SubscriptionStatus>;
 };
-/** Subscription strategy decision */
-export declare enum SubscriptionStrategyDecision {
-    PredefinedFreePlan = "PREDEFINED_FREE_PLAN",
-    PredefinedTrialPlan = "PREDEFINED_TRIAL_PLAN",
-    RequestedPlan = "REQUESTED_PLAN",
-    SkippedSubscriptionCreation = "SKIPPED_SUBSCRIPTION_CREATION"
-}
 /** Status of the integration sync */
 export declare enum SyncStatus {
     Error = "ERROR",
@@ -2074,6 +2091,7 @@ export declare type UpdateEnvironment = {
     description?: InputMaybe<Scalars['String']>;
     displayName?: InputMaybe<Scalars['String']>;
     id?: InputMaybe<Scalars['String']>;
+    provisionStatus?: InputMaybe<EnvironmentProvisionStatus>;
     slug?: InputMaybe<Scalars['String']>;
 };
 export declare type UpdateExperimentInput = {
@@ -2083,7 +2101,7 @@ export declare type UpdateExperimentInput = {
     name?: InputMaybe<Scalars['String']>;
     productId?: InputMaybe<Scalars['String']>;
     productSettings?: InputMaybe<ProductSettingsInput>;
-    refId?: InputMaybe<Scalars['String']>;
+    refId: Scalars['String'];
     variantGroupName?: InputMaybe<Scalars['String']>;
     variantPercentage?: InputMaybe<Scalars['Float']>;
 };
@@ -2160,6 +2178,7 @@ export declare type UpdateOnePromotionalEntitlementInput = {
 };
 export declare type UpdateSubscriptionInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
+    addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     environmentId?: InputMaybe<Scalars['String']>;
     refId: Scalars['String'];
     unitQuantity?: InputMaybe<Scalars['Float']>;
@@ -2345,7 +2364,7 @@ export declare type SubscriptionFragment = {
         __typename?: 'experimentInfo';
         name: string;
         groupName: string;
-        groupType?: ExperimentGroupType | null | undefined;
+        groupType: ExperimentGroupType;
         id: string;
     } | null | undefined;
     prices?: Array<{
@@ -2473,7 +2492,7 @@ export declare type CustomerFragment = {
     experimentInfo?: {
         __typename?: 'experimentInfo';
         name: string;
-        groupType?: ExperimentGroupType | null | undefined;
+        groupType: ExperimentGroupType;
         groupName: string;
         id: string;
     } | null | undefined;
@@ -2633,27 +2652,18 @@ export declare type PlanFragment = {
         duration: number;
         units: TrialPeriodUnits;
     } | null | undefined;
+    compatibleAddons?: Array<{
+        __typename?: 'Addon';
+    } & AddonFragment> | null | undefined;
 };
-export declare type GetPlansQueryVariables = Exact<{
-    paging?: Maybe<CursorPaging>;
-    filter?: Maybe<PlanFilter>;
-    addonFilter?: Maybe<AddonFilter>;
-    sorting?: Maybe<Array<PlanSort> | PlanSort>;
+export declare type GetPaywallQueryVariables = Exact<{
+    input: GetPaywallInput;
 }>;
-export declare type GetPlansQuery = {
+export declare type GetPaywallQuery = {
     __typename?: 'Query';
-    plans: {
-        __typename?: 'PlanConnection';
-        edges: Array<{
-            __typename?: 'PlanEdge';
-            node: {
-                __typename?: 'Plan';
-                compatibleAddons?: Array<{
-                    __typename?: 'Addon';
-                } & AddonFragment> | null | undefined;
-            } & PlanFragment;
-        }>;
-    };
+    getPaywall: Array<{
+        __typename?: 'Plan';
+    } & PlanFragment>;
 };
 export declare type SdkConfigurationQueryVariables = Exact<{
     [key: string]: never;

package/dist/client.d.ts

@@ -23,6 +23,7 @@ export declare class Stigg implements StiggClient {
     private readonly loggerService;
     private entitlementsService;
     private readonly modelMapper;
+    private readonly eventEmitter;
     private constructor();
     /**
      * Creates an instance of Stigg client.
@@ -75,6 +76,7 @@ export declare class Stigg implements StiggClient {
     getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
     /**
      * Get a list of plans for rendering the paywall
+     * @deprecated *Optional* `productId` is now deprecated and will be changed to a *required* field soon.
      *
      * @returns {Promise<Plan[]>}
      */