@stigg/js-client-sdk 0.35.0 → 0.38.0

package/dist/api/ApiGateway.d.ts

@@ -1,9 +1,11 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
 import PaywallApi from './PaywallApi';
 import CustomersApi from './CustomersApi';
+import CouponsApi from './CouponsApi';
 declare class ApiGateway {
     paywall: PaywallApi;
     customers: CustomersApi;
+    coupons: CouponsApi;
     constructor(client: ApolloClient<NormalizedCacheObject>);
 }
 export default ApiGateway;

package/dist/api/CouponsApi.d.ts

@@ -0,0 +1,8 @@
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+import { FetchCouponsQuery } from './generated/types';
+declare class CouponsApi {
+    private readonly client;
+    constructor(client: ApolloClient<NormalizedCacheObject>);
+    getCoupons(): Promise<import("@apollo/client/core").ApolloQueryResult<FetchCouponsQuery>>;
+}
+export default CouponsApi;

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

@@ -41,6 +41,7 @@ export declare type AddCompatibleAddonsToPlanInput = {
     relationIds: Array<Scalars['String']>;
 };
 export declare type AddonCreateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     description?: InputMaybe<Scalars['String']>;
     displayName: Scalars['String'];
@@ -120,10 +121,20 @@ export declare enum ApiKeyType {
     Client = "CLIENT",
     Server = "SERVER"
 }
+export declare type ArchiveCouponInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
+    refId: Scalars['String'];
+};
 export declare type ArchivePlanInput = {
     environmentId: Scalars['String'];
     id: Scalars['String'];
 };
+export declare type AttachCustomerPaymentMethodInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
+    paymentMethodId: Scalars['String'];
+    refId: Scalars['String'];
+    vendorIdentifier: VendorIdentifier;
+};
 /** Billing model. */
 export declare enum BillingModel {
     FlatFee = "FLAT_FEE",
@@ -176,6 +187,104 @@ export declare enum ChangeType {
     Deleted = "DELETED",
     Modified = "MODIFIED"
 }
+export declare type CouponFilter = {
+    and?: InputMaybe<Array<CouponFilter>>;
+    billingId?: InputMaybe<StringFieldComparison>;
+    createdAt?: InputMaybe<DateFieldComparison>;
+    customers?: InputMaybe<CouponFilterCustomerFilter>;
+    description?: InputMaybe<StringFieldComparison>;
+    environmentId?: InputMaybe<StringFieldComparison>;
+    id?: InputMaybe<StringFieldComparison>;
+    name?: InputMaybe<StringFieldComparison>;
+    or?: InputMaybe<Array<CouponFilter>>;
+    refId?: InputMaybe<StringFieldComparison>;
+    status?: InputMaybe<CouponStatusFilterComparison>;
+    type?: InputMaybe<CouponTypeFilterComparison>;
+    updatedAt?: InputMaybe<DateFieldComparison>;
+};
+export declare type CouponFilterCustomerFilter = {
+    and?: InputMaybe<Array<CouponFilterCustomerFilter>>;
+    billingId?: InputMaybe<StringFieldComparison>;
+    createdAt?: InputMaybe<DateFieldComparison>;
+    crmHubspotCompanyId?: InputMaybe<StringFieldComparison>;
+    crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>;
+    crmId?: InputMaybe<StringFieldComparison>;
+    email?: InputMaybe<StringFieldComparison>;
+    environmentId?: InputMaybe<StringFieldComparison>;
+    id?: InputMaybe<StringFieldComparison>;
+    name?: InputMaybe<StringFieldComparison>;
+    or?: InputMaybe<Array<CouponFilterCustomerFilter>>;
+    refId?: InputMaybe<StringFieldComparison>;
+    updatedAt?: InputMaybe<DateFieldComparison>;
+};
+export declare type CouponSort = {
+    direction: SortDirection;
+    field: CouponSortFields;
+    nulls?: InputMaybe<SortNulls>;
+};
+export declare enum CouponSortFields {
+    BillingId = "billingId",
+    CreatedAt = "createdAt",
+    Description = "description",
+    EnvironmentId = "environmentId",
+    Id = "id",
+    Name = "name",
+    RefId = "refId",
+    Status = "status",
+    Type = "type",
+    UpdatedAt = "updatedAt"
+}
+/** The status of the coupon */
+export declare enum CouponStatus {
+    Active = "ACTIVE",
+    Archived = "ARCHIVED"
+}
+export declare type CouponStatusFilterComparison = {
+    eq?: InputMaybe<CouponStatus>;
+    gt?: InputMaybe<CouponStatus>;
+    gte?: InputMaybe<CouponStatus>;
+    iLike?: InputMaybe<CouponStatus>;
+    in?: InputMaybe<Array<CouponStatus>>;
+    is?: InputMaybe<Scalars['Boolean']>;
+    isNot?: InputMaybe<Scalars['Boolean']>;
+    like?: InputMaybe<CouponStatus>;
+    lt?: InputMaybe<CouponStatus>;
+    lte?: InputMaybe<CouponStatus>;
+    neq?: InputMaybe<CouponStatus>;
+    notILike?: InputMaybe<CouponStatus>;
+    notIn?: InputMaybe<Array<CouponStatus>>;
+    notLike?: InputMaybe<CouponStatus>;
+};
+/** The type of the coupon */
+export declare enum CouponType {
+    Fixed = "FIXED",
+    Percentage = "PERCENTAGE"
+}
+export declare type CouponTypeFilterComparison = {
+    eq?: InputMaybe<CouponType>;
+    gt?: InputMaybe<CouponType>;
+    gte?: InputMaybe<CouponType>;
+    iLike?: InputMaybe<CouponType>;
+    in?: InputMaybe<Array<CouponType>>;
+    is?: InputMaybe<Scalars['Boolean']>;
+    isNot?: InputMaybe<Scalars['Boolean']>;
+    like?: InputMaybe<CouponType>;
+    lt?: InputMaybe<CouponType>;
+    lte?: InputMaybe<CouponType>;
+    neq?: InputMaybe<CouponType>;
+    notILike?: InputMaybe<CouponType>;
+    notIn?: InputMaybe<Array<CouponType>>;
+    notLike?: InputMaybe<CouponType>;
+};
+export declare type CreateCouponInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
+    description?: InputMaybe<Scalars['String']>;
+    discountValue: Scalars['Float'];
+    environmentId: Scalars['String'];
+    name: Scalars['String'];
+    refId: Scalars['String'];
+    type: CouponType;
+};
 export declare type CreateEnvironment = {
     createdAt?: InputMaybe<Scalars['DateTime']>;
     description?: InputMaybe<Scalars['String']>;
@@ -299,6 +408,7 @@ export declare type CustomerInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<CustomerBillingInfo>;
+    couponRefId?: InputMaybe<Scalars['String']>;
     crmId?: InputMaybe<Scalars['String']>;
     email?: InputMaybe<Scalars['String']>;
     environmentId?: InputMaybe<Scalars['String']>;
@@ -498,6 +608,10 @@ export declare enum EntitlementResetPeriod {
     Month = "MONTH",
     Week = "WEEK"
 }
+export declare enum EntitySelectionMode {
+    BlackList = "BLACK_LIST",
+    WhiteList = "WHITE_LIST"
+}
 export declare type EnvironmentFilter = {
     and?: InputMaybe<Array<EnvironmentFilter>>;
     createdAt?: InputMaybe<DateFieldComparison>;
@@ -519,11 +633,15 @@ export declare enum EnvironmentSortFields {
 }
 /** error codes */
 export declare enum ErrorCode {
+    AddonHasToHavePriceError = "AddonHasToHavePriceError",
     AddonNotFound = "AddonNotFound",
+    ArchivedCouponCantBeApplied = "ArchivedCouponCantBeApplied",
     BadUserInput = "BadUserInput",
     BillingPeriodMissingError = "BillingPeriodMissingError",
     CheckoutIsNotSupported = "CheckoutIsNotSupported",
+    CouponNotFound = "CouponNotFound",
     CustomerHasNoPaymentMethod = "CustomerHasNoPaymentMethod",
+    CustomerNoBillingId = "CustomerNoBillingId",
     CustomerNotFound = "CustomerNotFound",
     DraftPlanCantBeArchived = "DraftPlanCantBeArchived",
     DuplicatedEntityNotAllowed = "DuplicatedEntityNotAllowed",
@@ -532,6 +650,8 @@ export declare enum ErrorCode {
     FailedToImportCustomer = "FailedToImportCustomer",
     FeatureNotFound = "FeatureNotFound",
     IdentityForbidden = "IdentityForbidden",
+    ImportAlreadyInProgress = "ImportAlreadyInProgress",
+    InitStripePaymentMethodError = "InitStripePaymentMethodError",
     IntegrationNotFound = "IntegrationNotFound",
     IntegrityViolation = "IntegrityViolation",
     InvalidAddressError = "InvalidAddressError",
@@ -555,6 +675,8 @@ export declare enum ErrorCode {
     PriceNotFound = "PriceNotFound",
     RateLimitExceeded = "RateLimitExceeded",
     ResyncAlreadyInProgress = "ResyncAlreadyInProgress",
+    SelectedBillingModelDoesntMatchImportedItemError = "SelectedBillingModelDoesntMatchImportedItemError",
+    StripeCustomerIsDeleted = "StripeCustomerIsDeleted",
     SubscriptionAlreadyCanceledOrExpired = "SubscriptionAlreadyCanceledOrExpired",
     SubscriptionMustHaveSinglePlanError = "SubscriptionMustHaveSinglePlanError",
     SubscriptionNotFound = "SubscriptionNotFound",
@@ -573,6 +695,9 @@ export declare enum EventLogType {
     AddonCreated = "ADDON_CREATED",
     AddonDeleted = "ADDON_DELETED",
     AddonUpdated = "ADDON_UPDATED",
+    CouponArchived = "COUPON_ARCHIVED",
+    CouponCreated = "COUPON_CREATED",
+    CouponUpdated = "COUPON_UPDATED",
     CustomerCreated = "CUSTOMER_CREATED",
     CustomerDeleted = "CUSTOMER_DELETED",
     CustomerUpdated = "CUSTOMER_UPDATED",
@@ -583,6 +708,8 @@ export declare enum EventLogType {
     FeatureCreated = "FEATURE_CREATED",
     FeatureDeleted = "FEATURE_DELETED",
     FeatureUpdated = "FEATURE_UPDATED",
+    ImportIntegrationCatalogTriggered = "IMPORT_INTEGRATION_CATALOG_TRIGGERED",
+    ImportIntegrationCustomersTriggered = "IMPORT_INTEGRATION_CUSTOMERS_TRIGGERED",
     MeasurementReported = "MEASUREMENT_REPORTED",
     PackagePublished = "PACKAGE_PUBLISHED",
     PlanCreated = "PLAN_CREATED",
@@ -600,7 +727,8 @@ export declare enum EventLogType {
     SubscriptionTrialEndsSoon = "SUBSCRIPTION_TRIAL_ENDS_SOON",
     SubscriptionTrialExpired = "SUBSCRIPTION_TRIAL_EXPIRED",
     SubscriptionTrialStarted = "SUBSCRIPTION_TRIAL_STARTED",
-    SubscriptionUpdated = "SUBSCRIPTION_UPDATED"
+    SubscriptionUpdated = "SUBSCRIPTION_UPDATED",
+    SubscriptionUsageUpdated = "SUBSCRIPTION_USAGE_UPDATED"
 }
 export declare type FeatureFilter = {
     and?: InputMaybe<Array<FeatureFilter>>;
@@ -755,6 +883,51 @@ export declare type ImportCustomerInput = {
     name?: InputMaybe<Scalars['String']>;
     refId: Scalars['String'];
 };
+export declare type ImportIntegrationCatalogInput = {
+    billingModel?: InputMaybe<BillingModel>;
+    entitySelectionMode: EntitySelectionMode;
+    environmentId: Scalars['String'];
+    featureUnitName?: InputMaybe<Scalars['String']>;
+    featureUnitPluralName?: InputMaybe<Scalars['String']>;
+    plansSelectionBlacklist?: InputMaybe<Array<Scalars['String']>>;
+    plansSelectionWhitelist?: InputMaybe<Array<Scalars['String']>>;
+    productId: Scalars['String'];
+    selectedAddonBillingIds: Array<Scalars['String']>;
+    vendorIdentifier: VendorIdentifier;
+};
+export declare type ImportIntegrationCustomersInput = {
+    customersSelectionBlacklist?: InputMaybe<Array<Scalars['String']>>;
+    customersSelectionWhitelist?: InputMaybe<Array<Scalars['String']>>;
+    entitySelectionMode: EntitySelectionMode;
+    environmentId: Scalars['String'];
+    productId: Scalars['String'];
+    vendorIdentifier: VendorIdentifier;
+};
+export declare type ImportIntegrationTaskFilter = {
+    and?: InputMaybe<Array<ImportIntegrationTaskFilter>>;
+    createdAt?: InputMaybe<DateFieldComparison>;
+    environmentId?: InputMaybe<StringFieldComparison>;
+    id?: InputMaybe<StringFieldComparison>;
+    or?: InputMaybe<Array<ImportIntegrationTaskFilter>>;
+    status?: InputMaybe<TaskStatusFilterComparison>;
+    taskType?: InputMaybe<TaskTypeFilterComparison>;
+};
+export declare type ImportIntegrationTaskSort = {
+    direction: SortDirection;
+    field: ImportIntegrationTaskSortFields;
+    nulls?: InputMaybe<SortNulls>;
+};
+export declare enum ImportIntegrationTaskSortFields {
+    CreatedAt = "createdAt",
+    EnvironmentId = "environmentId",
+    Id = "id",
+    Status = "status",
+    TaskType = "taskType"
+}
+export declare type InitAddStripeCustomerPaymentMethodInput = {
+    customerRefId: Scalars['String'];
+    environmentId?: InputMaybe<Scalars['String']>;
+};
 export declare type InitiateCheckoutInput = {
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     billingPeriod: BillingPeriod;
@@ -1015,7 +1188,13 @@ export declare type PackageStatusFilterComparison = {
     notIn?: InputMaybe<Array<PackageStatus>>;
     notLike?: InputMaybe<PackageStatus>;
 };
+/** Type of a payment method */
+export declare enum PaymentMethodType {
+    Bank = "BANK",
+    Card = "CARD"
+}
 export declare type PlanCreateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     description?: InputMaybe<Scalars['String']>;
     displayName: Scalars['String'];
@@ -1172,6 +1351,7 @@ export declare type PricingTypeFilterComparison = {
     notLike?: InputMaybe<PricingType>;
 };
 export declare type ProductCreateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     description?: InputMaybe<Scalars['String']>;
     displayName?: InputMaybe<Scalars['String']>;
     environmentId: Scalars['String'];
@@ -1309,6 +1489,12 @@ export declare type RemoveCompatibleAddonsFromPlanInput = {
     /** The ids of the relations. */
     relationIds: Array<Scalars['String']>;
 };
+export declare type RemoveCouponFromCustomerInput = {
+    /** The id of the record. */
+    id: Scalars['String'];
+    /** The id of relation. */
+    relationId: Scalars['String'];
+};
 export declare type ResyncIntegrationInput = {
     environmentId: Scalars['String'];
     vendorIdentifier: VendorIdentifier;
@@ -1325,6 +1511,12 @@ export declare type SetCompatibleAddonsOnPlanInput = {
     /** The ids of the relations. */
     relationIds: Array<Scalars['String']>;
 };
+export declare type SetCouponOnCustomerInput = {
+    /** The id of the record. */
+    id: Scalars['String'];
+    /** The id of relation. */
+    relationId: Scalars['String'];
+};
 /** Sort Directions */
 export declare enum SortDirection {
     Asc = "ASC",
@@ -1356,6 +1548,20 @@ export declare type StripeCredentialsInput = {
     authorizationCode: Scalars['String'];
     isTestMode: Scalars['Boolean'];
 };
+export declare type StripeCustomerSearchInput = {
+    customerName?: InputMaybe<Scalars['String']>;
+    environmentId: Scalars['String'];
+    nextPage?: InputMaybe<Scalars['String']>;
+};
+export declare type StripeProductSearchInput = {
+    environmentId: Scalars['String'];
+    nextPage?: InputMaybe<Scalars['String']>;
+    productName?: InputMaybe<Scalars['String']>;
+};
+export declare type StripeSubscriptionSearchInput = {
+    environmentId: Scalars['String'];
+    nextPage?: InputMaybe<Scalars['String']>;
+};
 export declare type SubscriptionAddonFilter = {
     addon?: InputMaybe<SubscriptionAddonFilterAddonFilter>;
     and?: InputMaybe<Array<SubscriptionAddonFilter>>;
@@ -1478,6 +1684,7 @@ export declare enum SubscriptionEndSetup {
 export declare type SubscriptionInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
+    awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingPeriod?: InputMaybe<BillingPeriod>;
     crmId?: InputMaybe<Scalars['String']>;
@@ -1590,11 +1797,18 @@ export declare type SubscriptionStatusFilterComparison = {
     notIn?: InputMaybe<Array<SubscriptionStatus>>;
     notLike?: InputMaybe<SubscriptionStatus>;
 };
+/** Status of the integration sync */
+export declare enum SyncStatus {
+    Error = "ERROR",
+    NoSyncRequired = "NO_SYNC_REQUIRED",
+    Pending = "PENDING",
+    Success = "SUCCESS"
+}
 export declare enum TaskStatus {
     Completed = "COMPLETED",
     Failed = "FAILED",
     InProgress = "IN_PROGRESS",
-    PartiallyCompleted = "PARTIALLY_COMPLETED",
+    PartiallyFailed = "PARTIALLY_FAILED",
     Pending = "PENDING"
 }
 export declare type TaskStatusFilterComparison = {
@@ -1614,6 +1828,8 @@ export declare type TaskStatusFilterComparison = {
     notLike?: InputMaybe<TaskStatus>;
 };
 export declare enum TaskType {
+    ImportIntegrationCatalog = "IMPORT_INTEGRATION_CATALOG",
+    ImportIntegrationCustomers = "IMPORT_INTEGRATION_CUSTOMERS",
     ResyncIntegration = "RESYNC_INTEGRATION",
     SubscriptionMigration = "SUBSCRIPTION_MIGRATION"
 }
@@ -1646,10 +1862,23 @@ export declare enum TrialPeriodUnits {
     Day = "DAY",
     Month = "MONTH"
 }
+export declare type UpdateAccountInput = {
+    displayName: Scalars['String'];
+    id: Scalars['String'];
+    timezone?: InputMaybe<Scalars['String']>;
+};
+export declare type UpdateCouponInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
+    description?: InputMaybe<Scalars['String']>;
+    environmentId?: InputMaybe<Scalars['String']>;
+    name: Scalars['String'];
+    refId: Scalars['String'];
+};
 export declare type UpdateCustomerInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<CustomerBillingInfo>;
+    couponRefId?: InputMaybe<Scalars['String']>;
     crmId?: InputMaybe<Scalars['String']>;
     email?: InputMaybe<Scalars['String']>;
     environmentId?: InputMaybe<Scalars['String']>;
@@ -1844,6 +2073,60 @@ export declare type ZuoraCredentialsInput = {
     clientId: Scalars['String'];
     clientSecret: Scalars['String'];
 };
+export declare type CouponFragment = {
+    __typename?: 'Coupon';
+    id: string;
+    discountValue: number;
+    type: CouponType;
+    additionalMetaData?: any | null | undefined;
+    refId: string;
+    name: string;
+    description?: string | null | undefined;
+    createdAt: any;
+    updatedAt: any;
+    billingId?: string | null | undefined;
+    billingLinkUrl?: string | null | undefined;
+    status: CouponStatus;
+    syncStates?: Array<{
+        __typename?: 'SyncState';
+        vendorIdentifier: VendorIdentifier;
+        status: SyncStatus;
+    }> | null | undefined;
+    customers?: Array<{
+        __typename?: 'Customer';
+        id: string;
+    }> | null | undefined;
+};
+export declare type FetchCouponsQueryVariables = Exact<{
+    filter?: Maybe<CouponFilter>;
+    sorting?: Maybe<Array<CouponSort> | CouponSort>;
+    paging?: Maybe<CursorPaging>;
+}>;
+export declare type FetchCouponsQuery = {
+    __typename?: 'Query';
+    coupons: {
+        __typename?: 'CouponConnection';
+        edges: Array<{
+            __typename?: 'CouponEdge';
+            node: {
+                __typename?: 'Coupon';
+            } & CouponFragment;
+        }>;
+    };
+};
+export declare type TotalPriceFragment = {
+    __typename?: 'CustomerSubscriptionTotalPrice';
+    subTotal: {
+        __typename?: 'Money';
+        amount: number;
+        currency: Currency;
+    };
+    total: {
+        __typename?: 'Money';
+        amount: number;
+        currency: Currency;
+    };
+};
 export declare type SubscriptionFragment = {
     __typename?: 'CustomerSubscription';
     id: string;
@@ -1864,6 +2147,9 @@ export declare type SubscriptionFragment = {
             __typename?: 'Price';
         } & PriceFragment;
     }> | null | undefined;
+    totalPrice?: ({
+        __typename?: 'CustomerSubscriptionTotalPrice';
+    } & TotalPriceFragment) | null | undefined;
     plan: {
         __typename?: 'Plan';
         id: string;
@@ -1976,6 +2262,13 @@ export declare type CustomerFragment = {
     hasPaymentMethod: boolean;
     refId: string;
     additionalMetaData?: any | null | undefined;
+    trialedPlans?: Array<{
+        __typename?: 'TrialedPlan';
+        productId?: string | null | undefined;
+        productRefId?: string | null | undefined;
+        planRefId?: string | null | undefined;
+        planId?: string | null | undefined;
+    }> | null | undefined;
     promotionalEntitlements: Array<{
         __typename?: 'PromotionalEntitlement';
     } & PromotionalEntitlementFragment>;

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { Customer, Entitlement, Plan, BooleanEntitlement, NumericEntitlement, MeteredEntitlement, GetBooleanEntitlement, GetNumericEntitlement, GetMeteredEntitlement, GetPaywall } 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;
@@ -60,6 +61,12 @@ export declare class Stigg implements StiggClient {
      * @returns {Promise<Plan[]>}
      */
     getPaywall({ productId }?: GetPaywall): Promise<Plan[]>;
+    /**
+     * Get a list of coupons
+     *
+     * @returns {Promise<Coupon[]>}
+     */
+    getCoupons(): Promise<Coupon[]>;
     /**
      * Get a customer
      *
@@ -72,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;
 }