@stigg/js-client-sdk 3.68.0 → 3.69.0

package/dist/api/EdgeApiClient.d.ts

@@ -1,5 +1,5 @@
 import { ApolloQueryResult } from '@apollo/client/core';
-import { GetActiveSubscriptionsListQuery, GetEntitlementsQuery, GetPaywallQuery, GetSdkConfigurationQuery } from '@stigg/api-client-js/src/generated/sdk';
+import { GetActiveSubscriptionsListQuery, GetEntitlementsStateQuery, GetPaywallQuery, GetSdkConfigurationQuery } from '@stigg/api-client-js/src/generated/sdk';
 declare type EdgeApiClientConfiguration = {
     apiKey: string;
     baseEdgeUri: string;
@@ -13,7 +13,7 @@ export declare class EdgeApiClient {
         customerToken?: string | null;
     }): EdgeApiClient | null;
     getPaywall(productId?: string, billingCountryCode?: string, includeHiddenPlans?: boolean): Promise<ApolloQueryResult<GetPaywallQuery>>;
-    getEntitlements(customerId: string, resourceId: string | undefined): Promise<ApolloQueryResult<GetEntitlementsQuery>>;
+    getEntitlementsState(customerId: string, resourceId: string | undefined): Promise<ApolloQueryResult<GetEntitlementsStateQuery>>;
     getActiveSubscriptionsList(customerId: string, resourceId: string | string[] | undefined): Promise<ApolloQueryResult<GetActiveSubscriptionsListQuery>>;
     getSdkConfiguration(): Promise<ApolloQueryResult<GetSdkConfigurationQuery>>;
     private get;

package/dist/api/EntitlementsApi.d.ts

@@ -1,10 +1,10 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
 import { EdgeApiClient } from './EdgeApiClient';
-import { GetEntitlementsQuery } from '@stigg/api-client-js/src/generated/sdk';
+import { GetEntitlementsStateQuery } from '@stigg/api-client-js/src/generated/sdk';
 declare class EntitlementsApi {
     private readonly client;
     private readonly edgeApiClient;
     constructor(client: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null);
-    getEntitlements(customerId: string, skipEdge?: boolean, resourceId?: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetEntitlementsQuery>>;
+    getEntitlementsState(customerId: string, skipEdge?: boolean, resourceId?: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetEntitlementsStateQuery>>;
 }
 export default EntitlementsApi;

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 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, GetCreditUsageInput, GetCreditGrantsResult } 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, EntitlementsState } from './models';
 import { EventNames, Events } from './services/eventEmitter';
 import { LoggerService } from './services/loggerService';
 export interface StiggClient {
@@ -26,7 +26,11 @@ export interface StiggClient {
     getActiveSubscriptionsList(params?: GetActiveSubscriptions): Promise<SlimSubscriptionFragmentV2Fragment[]>;
     getSubscription(params: GetSubscription): Promise<Subscription>;
     getCoupons(): Promise<Coupon[]>;
+    /**
+     * @deprecated Use {@link getEntitlementsState} instead
+     */
     getEntitlements: (resourceId?: string) => Promise<Entitlement[]>;
+    getEntitlementsState: (resourceId?: string) => Promise<EntitlementsState>;
     refresh: () => Promise<void>;
     waitForCheckoutCompleted(params?: WaitForCheckoutCompleted): Promise<Subscription | null>;
     waitForInitialization(): Promise<StiggClient>;
@@ -194,10 +198,16 @@ export declare class Stigg implements StiggClient {
     fetchUsageHistory(fetchUsageHistory: FetchUsageHistory): Promise<UsageHistoryPoint[] | undefined>;
     /**
      * Get a list of entitlements
-     *
+     * @deprecated Use getEntitlementsState instead.
      * @returns {Promise<Entitlement[]>}
      */
     getEntitlements(resourceId?: string): Promise<Entitlement[]>;
+    /**
+     * Get a list of entitlements alongside an access denied reason if applicable.
+     *
+     * @returns {Promise<EntitlementsState>}
+     */
+    getEntitlementsState(resourceId?: string): Promise<EntitlementsState>;
     /**
      * Estimate subscription
      * @return {Promise<SubscriptionPreview>} Preview of the subscription.