@stigg/js-client-sdk 1.13.2 → 1.14.0

package/dist/api/ApiGateway.d.ts

@@ -3,6 +3,7 @@ import SdkConfigurationApi from './SdkConfigurationApi';
 import PaywallApi from './PaywallApi';
 import CustomersApi from './CustomersApi';
 import CouponsApi from './CouponsApi';
+import SubscriptionEstimationsApi from './SubscriptionEstimationsApi';
 import MockPaywallApi from './MockPaywallApi';
 import { EdgeApiClient } from './EdgeApiClient';
 declare class ApiGateway {
@@ -11,6 +12,7 @@ declare class ApiGateway {
     mockPaywall: MockPaywallApi;
     customers: CustomersApi;
     coupons: CouponsApi;
+    subscriptionEstimations: SubscriptionEstimationsApi;
     constructor(client: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null);
 }
 export default ApiGateway;

package/dist/api/PaywallApi.d.ts

@@ -1,7 +1,7 @@
+import { GetPaywallQuery } from '@stigg/api-client-js/src/generated/sdk';
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
 import { WidgetType } from './generated/types';
 import { EdgeApiClient } from './EdgeApiClient';
-import { GetPaywallQuery } from '@stigg/api-client-js/src/generated/sdk';
 export declare const TYPOGRAPHY_CONFIGURATION: import("graphql/language/ast").DocumentNode;
 export declare const PAYWALL_CONFIGURATION: import("graphql/language/ast").DocumentNode;
 export declare type GetPaywallProps = {

package/dist/api/SubscriptionEstimationsApi.d.ts

@@ -0,0 +1,10 @@
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+import { EstimateSubscription, EstimateSubscriptionUpdate } from '../models';
+import { EstimateSubscriptionMutation, EstimateSubscriptionUpdateMutation } 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>>>;
+}
+export default SubscriptionEstimationsApi;

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

@@ -770,6 +770,17 @@ export declare type DiscardPackageDraftInput = {
     environmentId: Scalars['String'];
     refId: Scalars['String'];
 };
+/** The type of the discount duration */
+export declare enum DiscountDurationType {
+    Forever = "FOREVER",
+    Once = "ONCE",
+    Repeating = "REPEATING"
+}
+/** The type of the discount */
+export declare enum DiscountType {
+    Fixed = "FIXED",
+    Percentage = "PERCENTAGE"
+}
 export declare type EntitlementCheckRequested = {
     customerId: Scalars['String'];
     entitlementCheckResult: EntitlementCheckResult;
@@ -1279,6 +1290,7 @@ export declare type InitiateCheckoutInput = {
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     allowPromoCodes?: InputMaybe<Scalars['Boolean']>;
     allowTaxIdCollection?: InputMaybe<Scalars['Boolean']>;
+    billingCountryCode?: InputMaybe<Scalars['String']>;
     billingPeriod: BillingPeriod;
     cancelUrl: Scalars['String'];
     collectBillingAddress?: InputMaybe<Scalars['Boolean']>;
@@ -1882,12 +1894,14 @@ export declare type ProvisionCustomerSubscriptionInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
+    billingCountryCode?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<SubscriptionBillingInfo>;
     billingPeriod?: InputMaybe<BillingPeriod>;
     planId: Scalars['String'];
     priceUnitAmount?: InputMaybe<Scalars['Float']>;
     promotionCode?: InputMaybe<Scalars['String']>;
     refId?: InputMaybe<Scalars['String']>;
+    resourceId?: InputMaybe<Scalars['String']>;
     startDate?: InputMaybe<Scalars['DateTime']>;
     subscriptionId?: InputMaybe<Scalars['String']>;
 };
@@ -1895,6 +1909,7 @@ export declare type ProvisionSubscription = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
+    billingCountryCode?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<SubscriptionBillingInfo>;
     billingPeriod?: InputMaybe<BillingPeriod>;
     checkoutOptions?: InputMaybe<CheckoutOptions>;
@@ -1903,6 +1918,7 @@ export declare type ProvisionSubscription = {
     priceUnitAmount?: InputMaybe<Scalars['Float']>;
     promotionCode?: InputMaybe<Scalars['String']>;
     refId?: InputMaybe<Scalars['String']>;
+    resourceId?: InputMaybe<Scalars['String']>;
     skipTrial?: InputMaybe<Scalars['Boolean']>;
     startDate?: InputMaybe<Scalars['DateTime']>;
     subscriptionId?: InputMaybe<Scalars['String']>;
@@ -1911,6 +1927,7 @@ export declare type ProvisionSubscriptionInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
+    billingCountryCode?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<SubscriptionBillingInfo>;
     billingPeriod?: InputMaybe<BillingPeriod>;
     checkoutOptions?: InputMaybe<CheckoutOptions>;
@@ -1919,6 +1936,7 @@ export declare type ProvisionSubscriptionInput = {
     priceUnitAmount?: InputMaybe<Scalars['Float']>;
     promotionCode?: InputMaybe<Scalars['String']>;
     refId?: InputMaybe<Scalars['String']>;
+    resourceId?: InputMaybe<Scalars['String']>;
     skipTrial?: InputMaybe<Scalars['Boolean']>;
     startDate?: InputMaybe<Scalars['DateTime']>;
     subscriptionId?: InputMaybe<Scalars['String']>;
@@ -2263,6 +2281,7 @@ export declare type SubscriptionInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
+    billingCountryCode?: InputMaybe<Scalars['String']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<SubscriptionBillingInfo>;
     billingPeriod?: InputMaybe<BillingPeriod>;
@@ -2277,6 +2296,7 @@ export declare type SubscriptionInput = {
     priceUnitAmount?: InputMaybe<Scalars['Float']>;
     promotionCode?: InputMaybe<Scalars['String']>;
     refId?: InputMaybe<Scalars['String']>;
+    resourceId?: InputMaybe<Scalars['String']>;
     startDate?: InputMaybe<Scalars['DateTime']>;
     subscriptionEntitlements?: InputMaybe<Array<SubscriptionEntitlementInput>>;
     subscriptionId?: InputMaybe<Scalars['String']>;
@@ -2649,6 +2669,7 @@ export declare type UsageMeasurementCreateInput = {
     customerId: Scalars['String'];
     environmentId?: InputMaybe<Scalars['String']>;
     featureId: Scalars['String'];
+    resourceId?: InputMaybe<Scalars['String']>;
     value: Scalars['Float'];
 };
 export declare type UsageMeasurementFilter = {
@@ -3153,4 +3174,79 @@ export declare type SdkConfigurationQuery = {
         isWidgetWatermarkEnabled?: boolean | null | undefined;
     } | null | undefined;
 };
+export declare type SubscriptionPreviewFragment = {
+    __typename?: 'SubscriptionPreview';
+    subTotal: {
+        __typename?: 'Money';
+        amount: number;
+        currency: Currency;
+    };
+    total: {
+        __typename?: 'Money';
+        amount: number;
+        currency: Currency;
+    };
+    billingPeriodRange: {
+        __typename?: 'DateRange';
+        start?: any | null | undefined;
+        end?: any | null | undefined;
+    };
+    discount?: {
+        __typename?: 'SubscriptionPreviewDiscountDTO';
+        type: DiscountType;
+        value: number;
+        durationType: DiscountDurationType;
+        durationInMonths?: number | null | undefined;
+    } | null | undefined;
+    subscription?: {
+        __typename?: 'SubscriptionPricePreviewDTO';
+        subTotal: {
+            __typename?: 'Money';
+            amount: number;
+            currency: Currency;
+        };
+        total: {
+            __typename?: 'Money';
+            amount: number;
+            currency: Currency;
+        };
+    } | null | undefined;
+    proration?: {
+        __typename?: 'SubscriptionPreviewProrations';
+        prorationDate: any;
+        credit: {
+            __typename?: 'Money';
+            amount: number;
+            currency: Currency;
+        };
+        debit: {
+            __typename?: 'Money';
+            amount: number;
+            currency: Currency;
+        };
+        netAmount: {
+            __typename?: 'Money';
+            amount: number;
+            currency: Currency;
+        };
+    } | null | undefined;
+};
+export declare type EstimateSubscriptionMutationVariables = Exact<{
+    input: EstimateSubscriptionInput;
+}>;
+export declare type EstimateSubscriptionMutation = {
+    __typename?: 'Mutation';
+    estimateSubscription: {
+        __typename?: 'SubscriptionPreview';
+    } & SubscriptionPreviewFragment;
+};
+export declare type EstimateSubscriptionUpdateMutationVariables = Exact<{
+    input: EstimateSubscriptionUpdateInput;
+}>;
+export declare type EstimateSubscriptionUpdateMutation = {
+    __typename?: 'Mutation';
+    estimateSubscriptionUpdate: {
+        __typename?: 'SubscriptionPreview';
+    } & SubscriptionPreviewFragment;
+};
 export {};

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Subscription, WaitForCheckoutCompleted, CustomerPortal, Paywall } from './models';
+import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Subscription, WaitForCheckoutCompleted, CustomerPortal, Paywall, EstimateSubscription, SubscriptionPreview, EstimateSubscriptionUpdate } from './models';
 import { ClientConfiguration } from './configuration';
 import { EventNames, Events } from './services/eventEmitter';
 export interface StiggClient {
@@ -19,6 +19,8 @@ export interface StiggClient {
     addListener: <K extends EventNames>(eventName: K, callback: Events[K]) => void;
     removeListener: <K extends EventNames>(eventName: K, callback: Events[K]) => void;
     getCustomerPortal(): Promise<CustomerPortal>;
+    estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>;
+    estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>;
 }
 export declare class Stigg implements StiggClient {
     private readonly apiGateway;
@@ -127,6 +129,18 @@ export declare class Stigg implements StiggClient {
      * @returns {Promise<Entitlement[]>}
      */
     getEntitlements(): Promise<Entitlement[]>;
+    /**
+     * Estimate subscription
+     * @return {Promise<SubscriptionPreview>} Preview of the subscription.
+     * @param {EstimateSubscription} estimateSubscription
+     */
+    estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>;
+    /**
+     * Estimate subscription update
+     * @return {Promise<SubscriptionPreview>} Preview of the subscription.
+     * @param {EstimateSubscriptionUpdate} estimateSubscriptionUpdate
+     */
+    estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): 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.