@stigg/js-client-sdk 3.81.0 → 3.83.0

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { 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, GetCreditUsageInput, GetCreditGrantsResult, GetCreditLedgerResult, AutomaticRechargeConfiguration, GetAutomaticRechargeConfigurationInput, SaveAutomaticRechargeConfigurationInput, EntitlementsState } from './models';
+import { ApplySubscription, ApplySubscriptionResults, BooleanEntitlement, Coupon, CreditEntitlement, Customer, CustomerPortal, Entitlement, EstimateSubscription, EstimateSubscriptionUpdate, FetchUsageHistory, GetActiveSubscriptions, GetBooleanEntitlement, GetCheckoutStateResults, GetCheckoutState, GetCreditEntitlement, 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, GetCreditLedgerResult, AutomaticRechargeConfiguration, GetAutomaticRechargeConfigurationInput, SaveAutomaticRechargeConfigurationInput, EntitlementsState } from './models';
 import { EventNames, Events } from './services/eventEmitter';
 import { LoggerService } from './services/loggerService';
 export interface StiggClient {
@@ -12,6 +12,7 @@ export interface StiggClient {
     getNumericEntitlement: (params: GetNumericEntitlement) => NumericEntitlement;
     getMeteredEntitlement: (params: GetMeteredEntitlement) => MeteredEntitlement;
     getEnumEntitlement: (params: GetEnumEntitlement) => EnumEntitlement;
+    getCreditEntitlement: (params: GetCreditEntitlement) => CreditEntitlement;
     fetchUsageHistory: (params: FetchUsageHistory) => Promise<UsageHistoryPoint[] | undefined>;
     setCustomerId: (customerId: string, customerToken?: string | null, resourceId?: string | null) => Promise<void>;
     clearCustomer: () => void;
@@ -154,6 +155,15 @@ export declare class Stigg implements StiggClient {
      * @return {EnumEntitlement} enum entitlement
      */
     getEnumEntitlement({ featureId, options, resourceId }: GetEnumEntitlement): EnumEntitlement;
+    /**
+     * Get credit entitlement for a customer by currency ID
+     *
+     * @param {string} currencyId
+     * @param {string} resourceId
+     * @param {CreditEntitlementOptions} options
+     * @return {CreditEntitlement} credit entitlement
+     */
+    getCreditEntitlement({ currencyId, options, resourceId }: GetCreditEntitlement): CreditEntitlement;
     /**
      * Get paywall data for rendering the paywall
      * @deprecated *Optional* `productId` is now deprecated and will be changed to a *required* field soon.