@stigg/js-client-sdk 0.37.0 → 0.39.0

package/dist/api/ApiGateway.d.ts

@@ -1,8 +1,10 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+import SdkConfigurationApi from './SdkConfigurationApi';
 import PaywallApi from './PaywallApi';
 import CustomersApi from './CustomersApi';
 import CouponsApi from './CouponsApi';
 declare class ApiGateway {
+    sdkConfiguration: SdkConfigurationApi;
     paywall: PaywallApi;
     customers: CustomersApi;
     coupons: CouponsApi;

package/dist/api/SdkConfigurationApi.d.ts

@@ -0,0 +1,10 @@
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+declare class SdkConfigurationApi {
+    private readonly client;
+    constructor(client: ApolloClient<NormalizedCacheObject>);
+    getSdkConfiguration(): Promise<{
+        __typename?: "SdkConfiguration" | undefined;
+        sentryDsn?: string | null | undefined;
+    } | null | undefined>;
+}
+export default SdkConfigurationApi;

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

@@ -45,7 +45,7 @@ export declare type AddonCreateInput = {
     billingId?: InputMaybe<Scalars['String']>;
     description?: InputMaybe<Scalars['String']>;
     displayName: Scalars['String'];
-    environmentId: Scalars['String'];
+    environmentId?: InputMaybe<Scalars['String']>;
     productId: Scalars['String'];
     refId?: InputMaybe<Scalars['String']>;
     status?: InputMaybe<PackageStatus>;
@@ -126,7 +126,7 @@ export declare type ArchiveCouponInput = {
     refId: Scalars['String'];
 };
 export declare type ArchivePlanInput = {
-    environmentId: Scalars['String'];
+    environmentId?: InputMaybe<Scalars['String']>;
     id: Scalars['String'];
 };
 export declare type AttachCustomerPaymentMethodInput = {
@@ -280,7 +280,7 @@ export declare type CreateCouponInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     description?: InputMaybe<Scalars['String']>;
     discountValue: Scalars['Float'];
-    environmentId: Scalars['String'];
+    environmentId?: InputMaybe<Scalars['String']>;
     name: Scalars['String'];
     refId: Scalars['String'];
     type: CouponType;
@@ -354,7 +354,9 @@ export declare type CursorPaging = {
 export declare type CustomerBillingInfo = {
     billingAddress?: InputMaybe<Address>;
     currency?: InputMaybe<Currency>;
+    invoiceCustomFields?: InputMaybe<Scalars['JSON']>;
     language?: InputMaybe<Scalars['String']>;
+    paymentMethodId?: InputMaybe<Scalars['String']>;
     shippingAddress?: InputMaybe<Address>;
     taxIds?: InputMaybe<Array<TaxExempt>>;
     timezone?: InputMaybe<Scalars['String']>;
@@ -530,19 +532,19 @@ export declare type DefaultTrialConfigInputDto = {
     duration?: InputMaybe<Scalars['Float']>;
     units?: InputMaybe<TrialPeriodUnits>;
 };
-export declare type DeleteOneAddonInput = {
-    /** The id of the record to delete. */
+export declare type DeleteCustomerInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
     id: Scalars['String'];
 };
-export declare type DeleteOneCustomerInput = {
-    /** The id of the record to delete. */
+export declare type DeleteFeatureInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
     id: Scalars['String'];
 };
-export declare type DeleteOneEnvironmentInput = {
+export declare type DeleteOneAddonInput = {
     /** The id of the record to delete. */
     id: Scalars['String'];
 };
-export declare type DeleteOneFeatureInput = {
+export declare type DeleteOneEnvironmentInput = {
     /** The id of the record to delete. */
     id: Scalars['String'];
 };
@@ -638,6 +640,8 @@ export declare enum ErrorCode {
     ArchivedCouponCantBeApplied = "ArchivedCouponCantBeApplied",
     BadUserInput = "BadUserInput",
     BillingPeriodMissingError = "BillingPeriodMissingError",
+    CannotDeleteCustomerError = "CannotDeleteCustomerError",
+    CannotDeleteFeatureError = "CannotDeleteFeatureError",
     CheckoutIsNotSupported = "CheckoutIsNotSupported",
     CouponNotFound = "CouponNotFound",
     CustomerHasNoPaymentMethod = "CustomerHasNoPaymentMethod",
@@ -661,6 +665,7 @@ export declare enum ErrorCode {
     InvalidMemberDelete = "InvalidMemberDelete",
     InvalidQuantity = "InvalidQuantity",
     InvalidSubscriptionStatus = "InvalidSubscriptionStatus",
+    InvalidUpdatePriceUnitAmountError = "InvalidUpdatePriceUnitAmountError",
     InvalidUsageValueForIncrementalFeatureError = "InvalidUsageValueForIncrementalFeatureError",
     MemberInvitationError = "MemberInvitationError",
     MemberNotFound = "MemberNotFound",
@@ -698,8 +703,10 @@ export declare enum EventLogType {
     CouponArchived = "COUPON_ARCHIVED",
     CouponCreated = "COUPON_CREATED",
     CouponUpdated = "COUPON_UPDATED",
+    CreateSubscriptionFailed = "CREATE_SUBSCRIPTION_FAILED",
     CustomerCreated = "CUSTOMER_CREATED",
     CustomerDeleted = "CUSTOMER_DELETED",
+    CustomerPaymentFailed = "CUSTOMER_PAYMENT_FAILED",
     CustomerUpdated = "CUSTOMER_UPDATED",
     EntitlementsUpdated = "ENTITLEMENTS_UPDATED",
     EntitlementDenied = "ENTITLEMENT_DENIED",
@@ -728,7 +735,8 @@ export declare enum EventLogType {
     SubscriptionTrialExpired = "SUBSCRIPTION_TRIAL_EXPIRED",
     SubscriptionTrialStarted = "SUBSCRIPTION_TRIAL_STARTED",
     SubscriptionUpdated = "SUBSCRIPTION_UPDATED",
-    SubscriptionUsageUpdated = "SUBSCRIPTION_USAGE_UPDATED"
+    SubscriptionUsageUpdated = "SUBSCRIPTION_USAGE_UPDATED",
+    SyncFailed = "SYNC_FAILED"
 }
 export declare type FeatureFilter = {
     and?: InputMaybe<Array<FeatureFilter>>;
@@ -936,6 +944,7 @@ export declare type InitiateCheckoutInput = {
     environmentId?: InputMaybe<Scalars['String']>;
     planId: Scalars['String'];
     successUrl: Scalars['String'];
+    unitQuantity?: InputMaybe<Scalars['Int']>;
 };
 export declare type IntFieldComparison = {
     between?: InputMaybe<IntFieldComparisonBetween>;
@@ -1198,7 +1207,7 @@ export declare type PlanCreateInput = {
     billingId?: InputMaybe<Scalars['String']>;
     description?: InputMaybe<Scalars['String']>;
     displayName: Scalars['String'];
-    environmentId: Scalars['String'];
+    environmentId?: InputMaybe<Scalars['String']>;
     parentPlanId?: InputMaybe<Scalars['String']>;
     productId: Scalars['String'];
     refId?: InputMaybe<Scalars['String']>;
@@ -1527,6 +1536,10 @@ export declare enum SortNulls {
     NullsFirst = "NULLS_FIRST",
     NullsLast = "NULLS_LAST"
 }
+export declare enum SourceType {
+    JsClientSdk = "JS_CLIENT_SDK",
+    NodeServerSdk = "NODE_SERVER_SDK"
+}
 export declare type StringFieldComparison = {
     eq?: InputMaybe<Scalars['String']>;
     gt?: InputMaybe<Scalars['String']>;
@@ -1633,6 +1646,9 @@ export declare enum SubscriptionAddonSortFields {
     Quantity = "quantity",
     UpdatedAt = "updatedAt"
 }
+export declare type SubscriptionBillingInfo = {
+    taxRateIds?: InputMaybe<Array<Scalars['String']>>;
+};
 /** Subscription cancellation status */
 export declare enum SubscriptionCancelReason {
     CancelledByBilling = "CancelledByBilling",
@@ -1663,7 +1679,7 @@ export declare type SubscriptionCancelReasonFilterComparison = {
 };
 export declare type SubscriptionCancellationInput = {
     endDate?: InputMaybe<Scalars['DateTime']>;
-    environmentId: Scalars['String'];
+    environmentId?: InputMaybe<Scalars['String']>;
     subscriptionCancellationTime?: InputMaybe<SubscriptionCancellationTime>;
     subscriptionRefId: Scalars['String'];
 };
@@ -1686,12 +1702,13 @@ export declare type SubscriptionInput = {
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
     billingId?: InputMaybe<Scalars['String']>;
+    billingInformation?: InputMaybe<SubscriptionBillingInfo>;
     billingPeriod?: InputMaybe<BillingPeriod>;
     crmId?: InputMaybe<Scalars['String']>;
     currentBillingPeriodEnd?: InputMaybe<Scalars['DateTime']>;
     customerId: Scalars['String'];
     endDate?: InputMaybe<Scalars['DateTime']>;
-    environmentId: Scalars['String'];
+    environmentId?: InputMaybe<Scalars['String']>;
     isCustomPriceSubscription?: InputMaybe<Scalars['Boolean']>;
     isOverridingTrialConfig?: InputMaybe<Scalars['Boolean']>;
     isTrial?: InputMaybe<Scalars['Boolean']>;
@@ -1967,6 +1984,7 @@ export declare type UpdateSubscriptionInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     environmentId?: InputMaybe<Scalars['String']>;
     refId: Scalars['String'];
+    unitQuantity?: InputMaybe<Scalars['Float']>;
 };
 export declare type UsageHistoryInput = {
     customerRefId: Scalars['String'];
@@ -2440,6 +2458,16 @@ export declare type GetPlansQuery = {
         }>;
     };
 };
+export declare type SdkConfigurationQueryVariables = Exact<{
+    [key: string]: never;
+}>;
+export declare type SdkConfigurationQuery = {
+    __typename?: 'Query';
+    sdkConfiguration?: {
+        __typename?: 'SdkConfiguration';
+        sentryDsn?: string | null | undefined;
+    } | null | undefined;
+};
 export declare type PriceFragment = {
     __typename?: 'Price';
     billingModel: BillingModel;

package/dist/client.d.ts

@@ -1,6 +1,7 @@
-import { Customer, Entitlement, Plan, BooleanEntitlement, NumericEntitlement, MeteredEntitlement, GetBooleanEntitlement, GetNumericEntitlement, GetMeteredEntitlement, GetPaywall, Coupon } from './models';
+import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Plan, Subscription, WaitForCheckoutCompleted } from './models';
 import { ClientConfiguration } from './configuration';
 export interface StiggClient {
+    isCustomerLoaded: boolean;
     getBooleanEntitlement: (params: GetBooleanEntitlement) => BooleanEntitlement;
     getNumericEntitlement: (params: GetNumericEntitlement) => NumericEntitlement;
     getMeteredEntitlement: (params: GetMeteredEntitlement) => MeteredEntitlement;
@@ -9,6 +10,7 @@ export interface StiggClient {
     getCustomer: () => Promise<Customer>;
     getEntitlements: () => Promise<Entitlement[]>;
     refresh: () => Promise<void>;
+    waitForCheckoutCompleted(params?: WaitForCheckoutCompleted): Promise<Subscription | null>;
 }
 export declare class Stigg implements StiggClient {
     private readonly apiGateway;
@@ -26,6 +28,8 @@ export declare class Stigg implements StiggClient {
      * @returns The new client instance.
      */
     static initialize(configuration: ClientConfiguration): Promise<StiggClient | null>;
+    private static initializeSdk;
+    get isCustomerLoaded(): boolean;
     /**
      * Set the customer ID, usually after the customer signs in or restores a session
      */
@@ -78,5 +82,14 @@ export declare class Stigg implements StiggClient {
      * @returns {Promise<Entitlement[]>}
      */
     getEntitlements(): Promise<Entitlement[]>;
-    private withErrorHandling;
+    /**
+     * Waits for a subscription to be activated after a completed checkout.
+     * This method should be called on page load after the customer is redirected to the success URL.
+     * Returns the new subscription.
+     *
+     * @returns {Promise<Subscription | null>}
+     * @param timeoutMs
+     * @param refreshOnComplete should refresh entitlements if subscription was found
+     */
+    waitForCheckoutCompleted({ timeoutMs, refreshOnComplete, }?: WaitForCheckoutCompleted): Promise<Subscription | null>;
 }

package/dist/configuration.d.ts

@@ -1,4 +1,7 @@
+import { SourceType } from './api/generated/types';
 import { LogConfiguration, LoggerService } from './services/loggerService';
+export declare const SDK_SOURCE_TYPE = SourceType.JsClientSdk;
+export declare const SDK_NAME = "js-client-sdk";
 export declare type ClientConfiguration = {
     apiKey: string;
     baseUri?: string;