@stigg/js-client-sdk 0.34.1 → 0.36.0

package/dist/models.d.ts

@@ -1,5 +1,8 @@
 import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits } from './api/generated/types';
 export { PricingType, SubscriptionStatus, PromotionalEntitlementStatus, Currency, BillingPeriod, BillingModel, TrialPeriodUnits, } from './api/generated/types';
+interface Metadata {
+    [key: string]: string;
+}
 export declare enum AccessDeniedReason {
     InvalidFeatureType = "InvalidFeatureType",
     CustomerNotFound = "CustomerNotFound",
@@ -108,11 +111,13 @@ export declare type Plan = {
     defaultTrialConfig?: DefaultTrialConfig | null;
     compatibleAddons: Addon[];
     product: Product;
+    metadata?: Metadata | null;
 };
 export declare type Product = {
     id: string;
     displayName?: string | null;
     description?: string | null;
+    metadata?: Metadata | null;
 };
 export declare type DefaultTrialConfig = {
     duration: number;
@@ -166,6 +171,7 @@ export declare type Addon = {
     entitlements: PackageEntitlement[];
     pricePoints: Price[];
     pricingType?: PricingType | null;
+    metadata?: Metadata | null;
 };
 export declare type SubscriptionAddon = {
     quantity: number;
@@ -181,10 +187,15 @@ export declare type Subscription = {
     billingId?: string;
     crmId?: string;
     startDate: Date;
-    endDate?: Date;
     currentBillingPeriodEnd?: Date;
+    /**
+     * The calculated end date after which the subscription will be canceled, which takes trial expiration and scheduled cancellations into consideration
+     */
+    effectiveEndDate?: Date;
+    endDate?: Date;
     trialEndDate?: Date;
     cancellationDate?: Date;
+    metadata?: Metadata | null;
 };
 export declare type Customer = {
     id: string;
@@ -195,11 +206,17 @@ export declare type Customer = {
     subscriptions: Subscription[];
     promotionalEntitlements: PromotionalEntitlement[];
     hasPaymentMethod: boolean;
+    metadata?: Metadata | null;
+    trialedPlans?: TrialedPlan[] | null;
     getActiveSubscriptions(): Subscription[];
     getActivePromotionalEntitlements(): PromotionalEntitlement[];
     getActiveTrials(): Subscription[];
 };
 export declare type CustomerState = Omit<Customer, 'getActiveSubscriptions' | 'getActivePromotionalEntitlements' | 'getActiveTrials'>;
+export declare type TrialedPlan = {
+    productId?: string | null;
+    planId?: string | null;
+};
 /** @hidden */
 export declare class CustomerModel implements Customer {
     id: string;
@@ -208,6 +225,7 @@ export declare class CustomerModel implements Customer {
     subscriptions: Subscription[];
     promotionalEntitlements: PromotionalEntitlement[];
     hasPaymentMethod: boolean;
+    metadata?: Metadata | null;
     constructor(state: CustomerState);
     getActiveSubscriptions(): Subscription[];
     getActiveTrials(): Subscription[];

package/dist/utils/ModelMapper.d.ts

@@ -20,6 +20,7 @@ export declare class ModelMapper {
     private mapPackageEntitlement;
     private mapPromotionalEntitlement;
     private mapSubscription;
+    private mapDate;
     private mapAddon;
     private sortPlans;
     private mapAccessDeniedReason;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "0.34.1",
+  "version": "0.36.0",
   "description": "Stigg client-side SDK for Browser",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",