@stigg/js-client-sdk - npm Package Compare versions

Comparing version 2.23.1 to 2.24.0

dist/models.d.ts

@@ -382,3 +382,3 @@ 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 } from '@stigg/api-client-js/src/generated/sdk';
 };
-export declare type RecurringSubscriptionPreview = {
+export declare type SubscriptionPreviewInvoice = {
     total: Money;
@@ -392,2 +392,6 @@ subTotal: Money;
 };
+export declare type ImmediateSubscriptionPreviewInvoice = SubscriptionPreviewInvoice & {
+    proration?: SubscriptionPreviewProration;
+    credits?: SubscriptionPreviewCredits;
+};
 export declare type SubscriptionPreviewDiscount = {
@@ -425,12 +429,12 @@ type: DiscountType;
 export interface SubscriptionPreviewV2 {
-    total: Money;
-    subTotal: Money;
-    totalExcludingTax: Money;
-    tax?: Money;
-    discount?: Money;
-    taxDetails?: SubscriptionPreviewTaxDetails;
-    discountDetails?: SubscriptionPreviewDiscount;
-    proration?: SubscriptionPreviewProration;
-    credits?: SubscriptionPreviewCredits;
-    recurringSubscription?: RecurringSubscriptionPreview;
+    /**
+     * The immediate invoice prices that will be generated for the subscription
+     * for the previewed subscription \ changes
+     */
+    immediateInvoice: ImmediateSubscriptionPreviewInvoice;
+    /**
+     * The recurring invoice prices that will be generated for the subscription
+     * for the previewed subscription \ changes, starting from the next billing period
+     */
+    recurringInvoice?: SubscriptionPreviewInvoice;
     billingPeriodRange: DateRange;
@@ -437,0 +441,0 @@ isPlanDowngrade?: boolean;

dist/src/models.d.ts

@@ -382,3 +382,3 @@ 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 } from '@stigg/api-client-js/src/generated/sdk';
 };
-export declare type RecurringSubscriptionPreview = {
+export declare type SubscriptionPreviewInvoice = {
     total: Money;
@@ -392,2 +392,6 @@ subTotal: Money;
 };
+export declare type ImmediateSubscriptionPreviewInvoice = SubscriptionPreviewInvoice & {
+    proration?: SubscriptionPreviewProration;
+    credits?: SubscriptionPreviewCredits;
+};
 export declare type SubscriptionPreviewDiscount = {
@@ -425,12 +429,12 @@ type: DiscountType;
 export interface SubscriptionPreviewV2 {
-    total: Money;
-    subTotal: Money;
-    totalExcludingTax: Money;
-    tax?: Money;
-    discount?: Money;
-    taxDetails?: SubscriptionPreviewTaxDetails;
-    discountDetails?: SubscriptionPreviewDiscount;
-    proration?: SubscriptionPreviewProration;
-    credits?: SubscriptionPreviewCredits;
-    recurringSubscription?: RecurringSubscriptionPreview;
+    /**
+     * The immediate invoice prices that will be generated for the subscription
+     * for the previewed subscription \ changes
+     */
+    immediateInvoice: ImmediateSubscriptionPreviewInvoice;
+    /**
+     * The recurring invoice prices that will be generated for the subscription
+     * for the previewed subscription \ changes, starting from the next billing period
+     */
+    recurringInvoice?: SubscriptionPreviewInvoice;
     billingPeriodRange: DateRange;
@@ -437,0 +441,0 @@ isPlanDowngrade?: boolean;

dist/src/utils/ModelMapper.d.ts

@@ -1,3 +0,3 @@
-import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment } 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 } from '../models';
+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 CachedEntitlement from '../services/cachedEntitlement';
@@ -37,5 +37,6 @@ import { Decision } from '../services/entitlementDecisionService';
     mapFallbackMeteredEntitlementResult(entitlement: MeteredEntitlementFallback, decision: Decision, requestedUsage?: number): EntitlementCheckResult;
-    mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewV2Fragment | SubscriptionPreviewV2Fragment['recurringSubscription']): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
+    mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
     mapSubscriptionPreview(fragment: SubscriptionPreviewFragment): SubscriptionPreview;
     mapSubscriptionPreviewV2(fragment: SubscriptionPreviewV2Fragment): SubscriptionPreviewV2;
+    mapSubscriptionPreviewInvoice(fragment: SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): SubscriptionPreviewInvoice;
     mapDiscount(discount: NonNullable<SubscriptionPreviewFragment['discount']>): SubscriptionPreviewDiscount;
@@ -42,0 +43,0 @@ mapMoney(fragment: {

dist/utils/ModelMapper.d.ts

@@ -1,3 +0,3 @@
-import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment } 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 } from '../models';
+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 CachedEntitlement from '../services/cachedEntitlement';
@@ -37,5 +37,6 @@ import { Decision } from '../services/entitlementDecisionService';
     mapFallbackMeteredEntitlementResult(entitlement: MeteredEntitlementFallback, decision: Decision, requestedUsage?: number): EntitlementCheckResult;
-    mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewV2Fragment | SubscriptionPreviewV2Fragment['recurringSubscription']): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
+    mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
     mapSubscriptionPreview(fragment: SubscriptionPreviewFragment): SubscriptionPreview;
     mapSubscriptionPreviewV2(fragment: SubscriptionPreviewV2Fragment): SubscriptionPreviewV2;
+    mapSubscriptionPreviewInvoice(fragment: SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): SubscriptionPreviewInvoice;
     mapDiscount(discount: NonNullable<SubscriptionPreviewFragment['discount']>): SubscriptionPreviewDiscount;
@@ -42,0 +43,0 @@ mapMoney(fragment: {

package.json

 {
   "name": "@stigg/js-client-sdk",
-  "version": "2.23.1",
+  "version": "2.24.0",
   "description": "Stigg client-side SDK for Browser",
@@ -31,3 +31,3 @@ "main": "dist/index.js",
     "@sentry/browser": "^7.11.1",
-    "@stigg/api-client-js": "0.561.1",
+    "@stigg/api-client-js": "0.569.0",
     "cross-fetch": "^3.1.6",
@@ -34,0 +34,0 @@ "fetch-retry": "^5.0.6",

No alert changes

Improved metrics

Total package byte prevSize

2947479

0.08%

Lines of code

5501

0.4%

Dependency changes

• + Added

  @stigg/api-client-js@0.569.0
  (transitive)

• - Removed

  @stigg/api-client-js@0.561.1
  (transitive)

• Updated

  @stigg/api-client-js@0.569.0