@stigg/js-client-sdk 3.64.0 → 3.65.0

package/dist/models.d.ts

@@ -1,4 +1,4 @@
-import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, SubscriptionQueryFragment, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PageInfoFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod, BudgetConfigurationInput, SubscriptionProrationBehavior, PaymentSessionInput, CreditBalanceSummaryInput, StripeCheckoutCredentialsFragment, ZuoraCheckoutCredentialsFragment, GetCreditGrantsInput as GetCreditGrantsInputGenerated, CreditLedgerInput } from '@stigg/api-client-js/src/generated/sdk';
+import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, SubscriptionQueryFragment, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PageInfoFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod, BudgetConfigurationInput, SubscriptionProrationBehavior, PaymentSessionInput, CreditBalanceSummaryInput, StripeCheckoutCredentialsFragment, ZuoraCheckoutCredentialsFragment, GetCreditGrantsInput as GetCreditGrantsInputGenerated, CreditLedgerInput, CreditUsageInput, CreditGrantFragment } from '@stigg/api-client-js/src/generated/sdk';
 export * from '@stigg/api-client-js/src/generated/sdk';
 interface Metadata {
     [key: string]: string;
@@ -171,8 +171,10 @@ export declare type GetEnumEntitlement = {
 export declare type PaginatedResult<T> = {
     data: T[];
     pageInfo: PageInfoFragment;
+    totalCount?: number;
 };
 export declare type GetSubscriptionsResult = PaginatedResult<SubscriptionQueryFragment>;
+export declare type GetCreditGrantsResult = PaginatedResult<CreditGrantFragment>;
 export declare type GetSubscriptionsParams = {
     customerId?: string;
     resourceId?: string | string[];
@@ -595,6 +597,7 @@ export declare type BillableFeature = {
     featureId: string;
     quantity: number;
 };
+export declare type GetCreditUsageInput = Omit<CreditUsageInput, 'customerId' | 'resourceId'>;
 export declare type GetCreditBalanceInput = Omit<CreditBalanceSummaryInput, 'customerId' | 'resourceId'>;
 export declare type GetCreditGrantsInput = Omit<GetCreditGrantsInputGenerated, 'customerId' | 'resourceId'>;
 export declare type GetCreditLedgerInput = Omit<CreditLedgerInput, 'customerId' | 'resourceId'>;

package/dist/offlineClient.d.ts

@@ -1,5 +1,5 @@
 import { Stigg, StiggClient } from './clients';
-import { ApplySubscriptionResults, BooleanEntitlement, Coupon, CreditGrantFragment, CreditLedgerFragment, CreditsBalanceSummaryFragment, Customer, CustomerPortal, Entitlement, EnumEntitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetEnumEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, PaymentSessionFragment, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
+import { ApplySubscriptionResults, BooleanEntitlement, Coupon, CreditLedgerFragment, CreditsBalanceSummaryFragment, CreditUsageFragment, Customer, CustomerPortal, Entitlement, EnumEntitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetCreditGrantsResult, GetEnumEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, PaymentSessionFragment, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
 export declare class OfflineStigg extends Stigg {
     getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
     getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
@@ -35,7 +35,8 @@ export declare class OfflineStigg extends Stigg {
     getSubscriptions(): Promise<GetSubscriptionsResult>;
     getCustomer(): Promise<Customer>;
     getCreditBalance(): Promise<CreditsBalanceSummaryFragment>;
-    getCreditGrants(): Promise<CreditGrantFragment[]>;
+    getCreditGrants(): Promise<GetCreditGrantsResult>;
     getCreditLedger(): Promise<CreditLedgerFragment[]>;
+    getCreditUsage(): Promise<CreditUsageFragment>;
     createPaymentSession(): Promise<PaymentSessionFragment>;
 }

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

@@ -1,10 +1,11 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
-import { CreditBalanceSummaryInput, CreditLedgerInput, GetCreditBalanceQuery, GetCreditGrantsInput, GetCreditGrantsQuery, GetCreditLedgerQuery } from '@stigg/api-client-js/src/generated/sdk';
+import { CreditBalanceSummaryInput, CreditLedgerInput, GetCreditBalanceQuery, GetCreditGrantsInput, GetCreditGrantsQuery, GetCreditUsageQuery, CreditUsageInput, GetCreditLedgerQuery } from '@stigg/api-client-js/src/generated/sdk';
 declare class CreditsApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);
     getCreditBalance(input: CreditBalanceSummaryInput): Promise<import("@apollo/client/core").ApolloQueryResult<GetCreditBalanceQuery>>;
     getCreditGrants(input: GetCreditGrantsInput): Promise<import("@apollo/client/core").ApolloQueryResult<GetCreditGrantsQuery>>;
     getCreditLedger(input: CreditLedgerInput): Promise<import("@apollo/client/core").ApolloQueryResult<GetCreditLedgerQuery>>;
+    getCreditUsage(input: CreditUsageInput): Promise<import("@apollo/client/core").ApolloQueryResult<GetCreditUsageQuery>>;
 }
 export default CreditsApi;

package/dist/src/client.d.ts

@@ -1,6 +1,6 @@
-import { CreditGrantFragment, CreditLedgerFragment, CreditsBalanceSummaryFragment, PaymentSessionFragment, SlimSubscriptionFragmentV2Fragment, SubscriptionInvoicePreviewFragment, UsageHistoryV2Fragment, UsageHistoryV2Input } from '@stigg/api-client-js/src/generated/sdk';
+import { CreditLedgerFragment, CreditsBalanceSummaryFragment, CreditUsageFragment, PaymentSessionFragment, SlimSubscriptionFragmentV2Fragment, SubscriptionInvoicePreviewFragment, UsageHistoryV2Fragment, UsageHistoryV2Input } from '@stigg/api-client-js/src/generated/sdk';
 import { ClientConfiguration } from './configuration';
-import { ApplySubscription, ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EstimateSubscription, EstimateSubscriptionUpdate, FetchUsageHistory, GetActiveSubscriptions, GetBooleanEntitlement, GetCheckoutStateResults, GetCheckoutState, GetCustomerPortal, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, GetSubscription, MeteredEntitlement, NumericEntitlement, Paywall, PreviewSubscription, Subscription, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, WaitForCheckoutCompleted, PreviewNextInvoice, GetSubscriptionsParams, GetSubscriptionsResult, EnumEntitlement, GetEnumEntitlement, CreatePaymentSessionInput, GetCreditBalanceInput, GetCreditGrantsInput, GetCreditLedgerInput } from './models';
+import { ApplySubscription, ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EstimateSubscription, EstimateSubscriptionUpdate, FetchUsageHistory, GetActiveSubscriptions, GetBooleanEntitlement, GetCheckoutStateResults, GetCheckoutState, GetCustomerPortal, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, GetSubscription, MeteredEntitlement, NumericEntitlement, Paywall, PreviewSubscription, Subscription, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, WaitForCheckoutCompleted, PreviewNextInvoice, GetSubscriptionsParams, GetSubscriptionsResult, EnumEntitlement, GetEnumEntitlement, CreatePaymentSessionInput, GetCreditBalanceInput, GetCreditGrantsInput, GetCreditLedgerInput, GetCreditUsageInput, GetCreditGrantsResult } from './models';
 import { EventNames, Events } from './services/eventEmitter';
 import { LoggerService } from './services/loggerService';
 export interface StiggClient {
@@ -38,8 +38,9 @@ export interface StiggClient {
     previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>;
     getUsageHistoryV2(input: UsageHistoryV2Input): Promise<UsageHistoryV2Fragment>;
     getCreditBalance(input?: GetCreditBalanceInput): Promise<CreditsBalanceSummaryFragment>;
-    getCreditGrants(input: GetCreditGrantsInput): Promise<CreditGrantFragment[]>;
+    getCreditGrants(input: GetCreditGrantsInput): Promise<GetCreditGrantsResult>;
     getCreditLedger(input?: GetCreditLedgerInput): Promise<CreditLedgerFragment[]>;
+    getCreditUsage(input: GetCreditUsageInput): Promise<CreditUsageFragment>;
     createPaymentSession(input: CreatePaymentSessionInput): Promise<PaymentSessionFragment>;
 }
 export declare class Stigg implements StiggClient {
@@ -245,6 +246,7 @@ export declare class Stigg implements StiggClient {
      * @param subscriptionId - subscription id
      */
     getSubscription({ subscriptionId }: GetSubscription): Promise<Subscription>;
+    getCreditUsage(input: GetCreditUsageInput): Promise<CreditUsageFragment>;
     /**
      * Get credit balance
      * @return {Promise<CreditsBalanceSummaryFragment>} the credit balance data
@@ -253,10 +255,10 @@ export declare class Stigg implements StiggClient {
     getCreditBalance(input?: GetCreditBalanceInput): Promise<CreditsBalanceSummaryFragment>;
     /**
      * Get credit grants
-     * @return {Promise<CreditGrantFragment[]>} the credit grants data
+     * @return {Promise<GetCreditGrantsResult>} paginated result of the credit grants data
      * @param input - the input for the credit grants
      */
-    getCreditGrants(input: GetCreditGrantsInput): Promise<CreditGrantFragment[]>;
+    getCreditGrants(input: GetCreditGrantsInput): Promise<GetCreditGrantsResult>;
     /**
      * Get credit ledger
      * @return {Promise<CreditLedgerFragment[]>} the credit ledger data

package/dist/src/models.d.ts

@@ -1,4 +1,4 @@
-import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, SubscriptionQueryFragment, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PageInfoFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod, BudgetConfigurationInput, SubscriptionProrationBehavior, PaymentSessionInput, CreditBalanceSummaryInput, StripeCheckoutCredentialsFragment, ZuoraCheckoutCredentialsFragment, GetCreditGrantsInput as GetCreditGrantsInputGenerated, CreditLedgerInput } from '@stigg/api-client-js/src/generated/sdk';
+import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, SubscriptionQueryFragment, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PageInfoFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod, BudgetConfigurationInput, SubscriptionProrationBehavior, PaymentSessionInput, CreditBalanceSummaryInput, StripeCheckoutCredentialsFragment, ZuoraCheckoutCredentialsFragment, GetCreditGrantsInput as GetCreditGrantsInputGenerated, CreditLedgerInput, CreditUsageInput, CreditGrantFragment } from '@stigg/api-client-js/src/generated/sdk';
 export * from '@stigg/api-client-js/src/generated/sdk';
 interface Metadata {
     [key: string]: string;
@@ -171,8 +171,10 @@ export declare type GetEnumEntitlement = {
 export declare type PaginatedResult<T> = {
     data: T[];
     pageInfo: PageInfoFragment;
+    totalCount?: number;
 };
 export declare type GetSubscriptionsResult = PaginatedResult<SubscriptionQueryFragment>;
+export declare type GetCreditGrantsResult = PaginatedResult<CreditGrantFragment>;
 export declare type GetSubscriptionsParams = {
     customerId?: string;
     resourceId?: string | string[];
@@ -595,6 +597,7 @@ export declare type BillableFeature = {
     featureId: string;
     quantity: number;
 };
+export declare type GetCreditUsageInput = Omit<CreditUsageInput, 'customerId' | 'resourceId'>;
 export declare type GetCreditBalanceInput = Omit<CreditBalanceSummaryInput, 'customerId' | 'resourceId'>;
 export declare type GetCreditGrantsInput = Omit<GetCreditGrantsInputGenerated, 'customerId' | 'resourceId'>;
 export declare type GetCreditLedgerInput = Omit<CreditLedgerInput, 'customerId' | 'resourceId'>;

package/dist/src/offlineClient.d.ts

@@ -1,5 +1,5 @@
 import { Stigg, StiggClient } from './clients';
-import { ApplySubscriptionResults, BooleanEntitlement, Coupon, CreditGrantFragment, CreditLedgerFragment, CreditsBalanceSummaryFragment, Customer, CustomerPortal, Entitlement, EnumEntitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetEnumEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, PaymentSessionFragment, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
+import { ApplySubscriptionResults, BooleanEntitlement, Coupon, CreditLedgerFragment, CreditsBalanceSummaryFragment, CreditUsageFragment, Customer, CustomerPortal, Entitlement, EnumEntitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetCreditGrantsResult, GetEnumEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, PaymentSessionFragment, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
 export declare class OfflineStigg extends Stigg {
     getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
     getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
@@ -35,7 +35,8 @@ export declare class OfflineStigg extends Stigg {
     getSubscriptions(): Promise<GetSubscriptionsResult>;
     getCustomer(): Promise<Customer>;
     getCreditBalance(): Promise<CreditsBalanceSummaryFragment>;
-    getCreditGrants(): Promise<CreditGrantFragment[]>;
+    getCreditGrants(): Promise<GetCreditGrantsResult>;
     getCreditLedger(): Promise<CreditLedgerFragment[]>;
+    getCreditUsage(): Promise<CreditUsageFragment>;
     createPaymentSession(): Promise<PaymentSessionFragment>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "3.64.0",
+  "version": "3.65.0",
   "description": "Stigg client-side SDK for Browser",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -36,7 +36,7 @@
   "dependencies": {
     "@apollo/client": "^3.4.17",
     "@sentry/browser": "^7.11.1",
-    "@stigg/api-client-js": "3.88.0",
+    "@stigg/api-client-js": "3.96.0",
     "cross-fetch": "^3.1.6",
     "dayjs": "^1.11.13",
     "fetch-retry": "^5.0.6",