@stigg/js-client-sdk 3.21.1 → 3.22.0

package/dist/models.d.ts

@@ -1,4 +1,4 @@
-import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod } from '@stigg/api-client-js/src/generated/sdk';
+import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod, BudgetConfigurationInput } from '@stigg/api-client-js/src/generated/sdk';
 export * from '@stigg/api-client-js/src/generated/sdk';
 interface Metadata {
     [key: string]: string;
@@ -123,6 +123,9 @@ export declare type Product = {
 export declare type DefaultTrialConfig = {
     duration: number;
     units: TrialPeriodUnits;
+    budget?: {
+        limit: BudgetConfigurationInput['limit'];
+    };
 };
 export declare type GetBooleanEntitlement = {
     featureId: string;
@@ -168,6 +171,7 @@ export declare type CheckoutAddon = {
 export declare type ApplySubscription = {
     planId: string;
     paymentMethodId?: string;
+    payingCustomerId?: string;
     resourceId?: string;
     addons?: CheckoutAddon[];
     startDate?: Date;
@@ -259,6 +263,7 @@ export declare type Subscription = {
     id: string;
     status: SubscriptionStatus;
     resourceId?: string;
+    payingCustomer?: SlimCustomer | null;
     plan: Plan;
     /** @deprecated use {@link prices} instead with {@link totalPrice} */
     price: SubscriptionPrice | null;
@@ -358,6 +363,16 @@ export declare type Customer = {
     /** @deprecated use {@link StiggClient.getActiveSubscriptions} instead with filter for {@link SubscriptionStatus.InTrial} */
     getActiveTrials(): Subscription[];
 };
+export declare type SlimCustomer = {
+    id: string;
+    name?: string;
+    email?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    billingId?: string;
+    metadata?: Metadata | null;
+    awsMarketplaceCustomerId?: string | null;
+};
 export declare type CustomerState = Omit<Customer, 'getActiveSubscriptions' | 'getActivePromotionalEntitlements' | 'getActiveTrials'>;
 export declare type TrialedPlan = {
     productId?: string | null;

package/dist/src/api/SubscriptionsApi.d.ts

@@ -10,7 +10,7 @@ export declare type GetCheckoutStateParams = GetCheckoutState & {
 declare class SubscriptionsApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);
-    applySubscription({ customerId, planId, paymentMethodId, addons, billableFeatures, billingInformation, billingCountryCode, billingId, billingPeriod, metadata, promotionCode, resourceId, skipTrial, startDate, unitQuantity, scheduleStrategy, }: ApplySubscriptionParams): Promise<import("@apollo/client/core").FetchResult<ApplySubscriptionMutation, Record<string, any>, Record<string, any>>>;
+    applySubscription({ customerId, payingCustomerId, planId, paymentMethodId, addons, billableFeatures, billingInformation, billingCountryCode, billingId, billingPeriod, metadata, promotionCode, resourceId, skipTrial, startDate, unitQuantity, scheduleStrategy, }: 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<GetCheckoutStateQuery>>;
     private mapBillingInformation;
 }

package/dist/src/models.d.ts

@@ -1,4 +1,4 @@
-import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod } from '@stigg/api-client-js/src/generated/sdk';
+import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod, BudgetConfigurationInput } from '@stigg/api-client-js/src/generated/sdk';
 export * from '@stigg/api-client-js/src/generated/sdk';
 interface Metadata {
     [key: string]: string;
@@ -123,6 +123,9 @@ export declare type Product = {
 export declare type DefaultTrialConfig = {
     duration: number;
     units: TrialPeriodUnits;
+    budget?: {
+        limit: BudgetConfigurationInput['limit'];
+    };
 };
 export declare type GetBooleanEntitlement = {
     featureId: string;
@@ -168,6 +171,7 @@ export declare type CheckoutAddon = {
 export declare type ApplySubscription = {
     planId: string;
     paymentMethodId?: string;
+    payingCustomerId?: string;
     resourceId?: string;
     addons?: CheckoutAddon[];
     startDate?: Date;
@@ -259,6 +263,7 @@ export declare type Subscription = {
     id: string;
     status: SubscriptionStatus;
     resourceId?: string;
+    payingCustomer?: SlimCustomer | null;
     plan: Plan;
     /** @deprecated use {@link prices} instead with {@link totalPrice} */
     price: SubscriptionPrice | null;
@@ -358,6 +363,16 @@ export declare type Customer = {
     /** @deprecated use {@link StiggClient.getActiveSubscriptions} instead with filter for {@link SubscriptionStatus.InTrial} */
     getActiveTrials(): Subscription[];
 };
+export declare type SlimCustomer = {
+    id: string;
+    name?: string;
+    email?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    billingId?: string;
+    metadata?: Metadata | null;
+    awsMarketplaceCustomerId?: string | null;
+};
 export declare type CustomerState = Omit<Customer, 'getActiveSubscriptions' | 'getActivePromotionalEntitlements' | 'getActiveTrials'>;
 export declare type TrialedPlan = {
     productId?: string | null;

package/dist/src/utils/ModelMapper.d.ts

@@ -1,5 +1,5 @@
-import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment, SubscriptionPreviewInvoiceFragment, ImmediateSubscriptionPreviewInvoiceFragment } from '@stigg/api-client-js/src/generated/sdk';
-import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice } from '../models';
+import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment, SubscriptionPreviewInvoiceFragment, ImmediateSubscriptionPreviewInvoiceFragment, SlimCustomerFragment } from '@stigg/api-client-js/src/generated/sdk';
+import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice, SlimCustomer } from '../models';
 import CachedEntitlement from '../services/cachedEntitlement';
 import { Decision } from '../services/entitlementDecisionService';
 export declare class ModelMapper {
@@ -23,8 +23,10 @@ export declare class ModelMapper {
     private mapPrice;
     private mapPlan;
     private mapCompatibleAddons;
+    private mapDefaultTrialConfig;
     private mapPackageEntitlement;
     private mapPromotionalEntitlement;
+    mapSlimCustomer: (customer: SlimCustomerFragment) => SlimCustomer;
     mapSubscription(subscription: SubscriptionFragment): Subscription;
     private mapLatestInvoice;
     private mapDate;

package/dist/utils/ModelMapper.d.ts

@@ -1,5 +1,5 @@
-import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment, SubscriptionPreviewInvoiceFragment, ImmediateSubscriptionPreviewInvoiceFragment } from '@stigg/api-client-js/src/generated/sdk';
-import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice } from '../models';
+import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment, SubscriptionPreviewInvoiceFragment, ImmediateSubscriptionPreviewInvoiceFragment, SlimCustomerFragment } from '@stigg/api-client-js/src/generated/sdk';
+import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice, SlimCustomer } from '../models';
 import CachedEntitlement from '../services/cachedEntitlement';
 import { Decision } from '../services/entitlementDecisionService';
 export declare class ModelMapper {
@@ -23,8 +23,10 @@ export declare class ModelMapper {
     private mapPrice;
     private mapPlan;
     private mapCompatibleAddons;
+    private mapDefaultTrialConfig;
     private mapPackageEntitlement;
     private mapPromotionalEntitlement;
+    mapSlimCustomer: (customer: SlimCustomerFragment) => SlimCustomer;
     mapSubscription(subscription: SubscriptionFragment): Subscription;
     private mapLatestInvoice;
     private mapDate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "3.21.1",
+  "version": "3.22.0",
   "description": "Stigg client-side SDK for Browser",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -28,7 +28,7 @@
   "dependencies": {
     "@apollo/client": "^3.4.17",
     "@sentry/browser": "^7.11.1",
-    "@stigg/api-client-js": "2.85.7",
+    "@stigg/api-client-js": "2.100.2",
     "cross-fetch": "^3.1.6",
     "fetch-retry": "^5.0.6",
     "husky": "^7.0.4",