@stigg/js-client-sdk 2.18.1 → 2.19.0

package/dist/api/ApiGateway.d.ts

@@ -3,12 +3,14 @@ import SdkConfigurationApi from './SdkConfigurationApi';
 import PaywallApi from './PaywallApi';
 import CustomersApi from './CustomersApi';
 import CouponsApi from './CouponsApi';
+import SubscriptionsApi from './SubscriptionsApi';
 import SubscriptionEstimationsApi from './SubscriptionEstimationsApi';
 import MockPaywallApi from './MockPaywallApi';
 import { EdgeApiClient } from './EdgeApiClient';
 declare class ApiGateway {
     sdkConfiguration: SdkConfigurationApi;
     paywall: PaywallApi;
+    subscriptions: SubscriptionsApi;
     mockPaywall: MockPaywallApi;
     customers: CustomersApi;
     coupons: CouponsApi;

package/dist/api/SubscriptionEstimationsApi.d.ts

@@ -1,10 +1,11 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
-import { EstimateSubscription, EstimateSubscriptionUpdate } from '../models';
-import { EstimateSubscriptionMutation, EstimateSubscriptionUpdateMutation } from '@stigg/api-client-js/src/generated/sdk';
+import { PreviewSubscription, EstimateSubscription, EstimateSubscriptionUpdate } from '../models';
+import { EstimateSubscriptionMutation, EstimateSubscriptionUpdateMutation, PreviewSubscriptionMutation } from '@stigg/api-client-js/src/generated/sdk';
 declare class SubscriptionEstimationsApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);
     estimateSubscription(input: EstimateSubscription): Promise<import("@apollo/client/core").FetchResult<EstimateSubscriptionMutation, Record<string, any>, Record<string, any>>>;
     estimateSubscriptionUpdate(input: EstimateSubscriptionUpdate): Promise<import("@apollo/client/core").FetchResult<EstimateSubscriptionUpdateMutation, Record<string, any>, Record<string, any>>>;
+    previewSubscription(input: PreviewSubscription): Promise<import("@apollo/client/core").FetchResult<PreviewSubscriptionMutation, Record<string, any>, Record<string, any>>>;
 }
 export default SubscriptionEstimationsApi;

package/dist/api/SubscriptionsApi.d.ts

@@ -0,0 +1,17 @@
+import { CheckoutStateQuery, ApplySubscriptionMutation } from '@stigg/api-client-js/src/generated/sdk';
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+import { ApplySubscription, GetCheckoutState } from '../models';
+export declare type ApplySubscriptionParams = ApplySubscription & {
+    customerId: string;
+};
+export declare type GetCheckoutStateParams = GetCheckoutState & {
+    customerId: string;
+};
+declare class SubscriptionsApi {
+    private readonly client;
+    constructor(client: ApolloClient<NormalizedCacheObject>);
+    applySubscription({ customerId, planId, paymentMethodId, addons, billableFeatures, billingCountryCode, billingId, billingInformation, billingPeriod, metadata, promotionCode, resourceId, skipTrial, startDate, unitQuantity, }: ApplySubscriptionParams): Promise<import("@apollo/client/core").FetchResult<ApplySubscriptionMutation, Record<string, any>, Record<string, any>>>;
+    checkoutState({ customerId, resourceId, planId, billingCountryCode }: GetCheckoutStateParams): Promise<import("@apollo/client/core").ApolloQueryResult<CheckoutStateQuery>>;
+    private mapBillingInformation;
+}
+export default SubscriptionsApi;

package/dist/client.d.ts

@@ -1,5 +1,5 @@
-import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Subscription, WaitForCheckoutCompleted, CustomerPortal, Paywall, EstimateSubscription, SubscriptionPreview, EstimateSubscriptionUpdate, GetCustomerPortal, GetActiveSubscriptions, FetchUsageHistory, UsageHistoryPoint } from './models';
 import { ClientConfiguration } from './configuration';
+import { BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EstimateSubscription, EstimateSubscriptionUpdate, FetchUsageHistory, GetActiveSubscriptions, GetBooleanEntitlement, GetCheckoutStateResults, GetCheckoutState, GetCustomerPortal, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Paywall, Subscription, SubscriptionPreview, UsageHistoryPoint, WaitForCheckoutCompleted, ApplySubscription, ApplySubscriptionResults, PreviewSubscription } from './models';
 import { EventNames, Events } from './services/eventEmitter';
 export interface StiggClient {
     isCustomerLoaded: boolean;
@@ -15,6 +15,8 @@ export interface StiggClient {
     clearResource: () => void;
     getPaywall: (params?: GetPaywall) => Promise<Paywall>;
     getCustomer: () => Promise<Customer>;
+    getCheckoutState: (params: GetCheckoutState) => Promise<GetCheckoutStateResults>;
+    applySubscription: (params: ApplySubscription) => Promise<ApplySubscriptionResults>;
     getActiveSubscriptions: (params?: GetActiveSubscriptions) => Promise<Subscription[]>;
     getCoupons(): Promise<Coupon[]>;
     getEntitlements: (resourceId?: string) => Promise<Entitlement[]>;
@@ -26,6 +28,7 @@ export interface StiggClient {
     getCustomerPortal(params?: GetCustomerPortal): Promise<CustomerPortal>;
     estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>;
     estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>;
+    previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreview>;
 }
 export declare class Stigg implements StiggClient {
     private readonly apiGateway;
@@ -145,6 +148,18 @@ export declare class Stigg implements StiggClient {
      * @returns {Promise<CustomerPortal>}
      */
     getCustomerPortal({ resourceId, productId }?: GetCustomerPortal): Promise<CustomerPortal>;
+    /**
+     * Get customer checkout details
+     * @param {GetCheckoutState} parameters
+     * @returns {Promise<GetCheckoutStateResults>}
+     */
+    getCheckoutState({ planId, resourceId, billingCountryCode, }: GetCheckoutState): Promise<GetCheckoutStateResults>;
+    /**
+     * Get customer checkout details
+     * @param {ApplySubscription} parameters
+     * @returns {Promise<ApplySubscriptionResults>}
+     */
+    applySubscription(applySubscriptionInput: ApplySubscription): Promise<ApplySubscriptionResults>;
     /**
      * Fetch customer usage history of a feature.
      * @return {Promise<UsageHistoryPoint[]>} Array of usage history as data points.
@@ -169,6 +184,12 @@ export declare class Stigg implements StiggClient {
      * @param {EstimateSubscriptionUpdate} estimateSubscriptionUpdate
      */
     estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>;
+    /**
+     * Estimate checkout
+     * @return {Promise<SubscriptionPreview>} Preview of the subscription.
+     * @param {PreviewSubscription} previewSubscription
+     */
+    previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreview>;
     /**
      * 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.