@stigg/js-client-sdk 2.2.0 → 2.4.0

package/dist/models.d.ts

@@ -350,6 +350,18 @@ export declare type EstimateSubscriptionUpdate = {
     addons?: SubscriptionEstimationAddon[];
     promotionCode?: string;
 };
+export declare type FetchUsageHistory = {
+    customerId: string;
+    resourceId?: string;
+    featureId: string;
+    startDate: Date;
+    endDate?: Date;
+};
+export declare type UsageHistoryPoint = {
+    date: Date;
+    value: number;
+    isResetPoint: boolean;
+};
 /** @hidden */
 export declare class CustomerModel implements Customer {
     id: string;

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

@@ -1,10 +1,12 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
-import { GetCustomerPortalByRefIdQuery, GetCustomerByIdQuery, GetActiveSubscriptionsQuery } from '@stigg/api-client-js/src/generated/sdk';
+import { GetCustomerPortalByRefIdQuery, GetCustomerByIdQuery, GetActiveSubscriptionsQuery, UsageHistoryQuery } from '@stigg/api-client-js/src/generated/sdk';
+import { FetchUsageHistory } from '../models';
 declare class CustomersApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);
     getCustomer(customerId: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetCustomerByIdQuery>>;
     getActiveSubscriptions(customerId: string, resourceId?: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetActiveSubscriptionsQuery>>;
     getCustomerPortal(customerId: string, resourceId: string | undefined): Promise<import("@apollo/client/core").ApolloQueryResult<GetCustomerPortalByRefIdQuery>>;
+    fetchUsageHistory({ customerId, resourceId, endDate, startDate, featureId }: FetchUsageHistory): Promise<import("@apollo/client/core").ApolloQueryResult<UsageHistoryQuery>>;
 }
 export default CustomersApi;

package/dist/src/client.d.ts

@@ -1,4 +1,4 @@
-import { BooleanEntitlement, Coupon, Customer, Entitlement, GetBooleanEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Subscription, WaitForCheckoutCompleted, CustomerPortal, Paywall, EstimateSubscription, SubscriptionPreview, EstimateSubscriptionUpdate, GetCustomerPortal, GetActiveSubscriptions } from './models';
+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 { EventNames, Events } from './services/eventEmitter';
 export interface StiggClient {
@@ -144,6 +144,12 @@ export declare class Stigg implements StiggClient {
      * @returns {Promise<CustomerPortal>}
      */
     getCustomerPortal({ resourceId }?: GetCustomerPortal): Promise<CustomerPortal>;
+    /**
+     * Fetch customer usage history of a feature.
+     * @return {Promise<UsageHistoryPoint[]>} Array of usage history as data points.
+     * @param fetchUsageHistory
+     */
+    fetchUsageHistory(fetchUsageHistory: FetchUsageHistory): Promise<UsageHistoryPoint[] | undefined>;
     /**
      * Get a list of entitlements
      *

package/dist/src/models.d.ts

@@ -350,6 +350,18 @@ export declare type EstimateSubscriptionUpdate = {
     addons?: SubscriptionEstimationAddon[];
     promotionCode?: string;
 };
+export declare type FetchUsageHistory = {
+    customerId: string;
+    resourceId?: string;
+    featureId: string;
+    startDate: Date;
+    endDate?: Date;
+};
+export declare type UsageHistoryPoint = {
+    date: Date;
+    value: number;
+    isResetPoint: boolean;
+};
 /** @hidden */
 export declare class CustomerModel implements Customer {
     id: string;

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

@@ -1,5 +1,5 @@
-import { CustomerFragment, EntitlementFragment, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, EntitlementCheckResult, GetCouponsQuery, GetMockPaywallQuery, CustomerResourceFragment, CustomerPortalFragment } from '@stigg/api-client-js/src/generated/sdk';
-import { BooleanEntitlement, BooleanEntitlementFallback, Coupon, Customer, CustomerPortal, CustomerResource, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount } from '../models';
+import { CustomerFragment, EntitlementFragment, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, EntitlementCheckResult, GetCouponsQuery, GetMockPaywallQuery, CustomerResourceFragment, CustomerPortalFragment, UsageHistoryFragment } from '@stigg/api-client-js/src/generated/sdk';
+import { BooleanEntitlement, BooleanEntitlementFallback, Coupon, Customer, CustomerPortal, CustomerResource, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint } from '../models';
 import CachedEntitlement from '../services/cachedEntitlement';
 import { Decision } from '../services/entitlementDecisionService';
 export declare class ModelMapper {
@@ -42,4 +42,5 @@ export declare class ModelMapper {
     mapSubscriptions(activeSubscriptions: Array<{
         __typename?: 'CustomerSubscription';
     } & SubscriptionFragment>): Subscription[];
+    mapUsageHistory(usageHistory: UsageHistoryFragment): UsageHistoryPoint[];
 }

package/dist/utils/ModelMapper.d.ts

@@ -1,5 +1,5 @@
-import { CustomerFragment, EntitlementFragment, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, EntitlementCheckResult, GetCouponsQuery, GetMockPaywallQuery, CustomerResourceFragment, CustomerPortalFragment } from '@stigg/api-client-js/src/generated/sdk';
-import { BooleanEntitlement, BooleanEntitlementFallback, Coupon, Customer, CustomerPortal, CustomerResource, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount } from '../models';
+import { CustomerFragment, EntitlementFragment, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, EntitlementCheckResult, GetCouponsQuery, GetMockPaywallQuery, CustomerResourceFragment, CustomerPortalFragment, UsageHistoryFragment } from '@stigg/api-client-js/src/generated/sdk';
+import { BooleanEntitlement, BooleanEntitlementFallback, Coupon, Customer, CustomerPortal, CustomerResource, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint } from '../models';
 import CachedEntitlement from '../services/cachedEntitlement';
 import { Decision } from '../services/entitlementDecisionService';
 export declare class ModelMapper {
@@ -42,4 +42,5 @@ export declare class ModelMapper {
     mapSubscriptions(activeSubscriptions: Array<{
         __typename?: 'CustomerSubscription';
     } & SubscriptionFragment>): Subscription[];
+    mapUsageHistory(usageHistory: UsageHistoryFragment): UsageHistoryPoint[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "2.2.0",
+  "version": "2.4.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": "0.455.1",
+    "@stigg/api-client-js": "0.466.0",
     "cross-fetch": "^3.1.6",
     "fetch-retry": "^5.0.6",
     "husky": "^7.0.4",