@stigg/js-client-sdk 0.37.0 → 0.38.0

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-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 {
     getBooleanEntitlement: (params: GetBooleanEntitlement) => BooleanEntitlement;
@@ -9,6 +9,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;
@@ -78,5 +79,15 @@ export declare class Stigg implements StiggClient {
      * @returns {Promise<Entitlement[]>}
      */
     getEntitlements(): Promise<Entitlement[]>;
+    /**
+     * 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>;
     private withErrorHandling;
 }