@stigg/js-client-sdk 3.40.0 → 3.42.0

package/dist/models.d.ts

@@ -1,4 +1,4 @@
-import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod, BudgetConfigurationInput } 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 } from '@stigg/api-client-js/src/generated/sdk';
 export * from '@stigg/api-client-js/src/generated/sdk';
 interface Metadata {
     [key: string]: string;
@@ -155,6 +155,22 @@ export declare type GetMeteredEntitlement = {
     options?: MeteredEntitlementOptions;
     resourceId?: string;
 };
+export declare type PaginatedResult<T> = {
+    data: T[];
+    pageInfo: PageInfoFragment;
+};
+export declare type GetSubscriptionsResult = PaginatedResult<SubscriptionQueryFragment>;
+export declare type GetSubscriptionsParams = {
+    customerId?: string;
+    resourceId?: string | string[];
+    status?: SubscriptionStatus | SubscriptionStatus[];
+    productId?: string | string[];
+    pagination?: {
+        limit?: number;
+        startingAfter?: string;
+        endingBefore?: string;
+    };
+};
 export declare type GetPaywall = {
     productId?: string;
     resourceId?: string;

package/dist/offlineClient.d.ts

@@ -1,5 +1,5 @@
 import { Stigg, StiggClient } from './clients';
-import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
+import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, 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;
@@ -31,5 +31,6 @@ export declare class OfflineStigg extends Stigg {
     getPaywall(): Promise<Paywall>;
     getCustomerPortal(): Promise<CustomerPortal>;
     getActiveSubscriptions(): Promise<Subscription[]>;
+    getSubscriptions(): Promise<GetSubscriptionsResult>;
     getCustomer(): Promise<Customer>;
 }

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

@@ -1,4 +1,4 @@
-import { GetCheckoutStateQuery, ApplySubscriptionMutation } from '@stigg/api-client-js/src/generated/sdk';
+import { GetCheckoutStateQuery, ApplySubscriptionMutation, GetSubscriptionsQuery, SubscriptionStatus } from '@stigg/api-client-js/src/generated/sdk';
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
 import { ApplySubscription, GetCheckoutState } from '../models';
 export declare type ApplySubscriptionParams = ApplySubscription & {
@@ -11,6 +11,11 @@ declare class SubscriptionsApi {
     private readonly client;
     constructor(client: ApolloClient<NormalizedCacheObject>);
     applySubscription({ customerId, payingCustomerId, planId, paymentMethodId, addons, billableFeatures, billingInformation, billingCountryCode, billingId, billingPeriod, metadata, promotionCode, resourceId, skipTrial, startDate, unitQuantity, scheduleStrategy, }: ApplySubscriptionParams): Promise<import("@apollo/client/core").FetchResult<ApplySubscriptionMutation, Record<string, any>, Record<string, any>>>;
+    getSubscriptions(customerId?: string, resourceId?: string | string[], status?: SubscriptionStatus | SubscriptionStatus[], productId?: string | string[], pagination?: {
+        limit?: number;
+        startingAfter?: string;
+        endingBefore?: string;
+    }): Promise<import("@apollo/client/core").ApolloQueryResult<GetSubscriptionsQuery>>;
     checkoutState({ customerId, resourceId, planId, billingCountryCode }: GetCheckoutStateParams): Promise<import("@apollo/client/core").ApolloQueryResult<GetCheckoutStateQuery>>;
     private mapBillingInformation;
 }

package/dist/src/client.d.ts

@@ -1,6 +1,6 @@
 import { 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 } 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 } from './models';
 import { EventNames, Events } from './services/eventEmitter';
 import { LoggerService } from './services/loggerService';
 export interface StiggClient {
@@ -19,6 +19,7 @@ export interface StiggClient {
     getCustomer: () => Promise<Customer>;
     getCheckoutState: (params: GetCheckoutState) => Promise<GetCheckoutStateResults>;
     applySubscription: (params: ApplySubscription) => Promise<ApplySubscriptionResults>;
+    getSubscriptions(params: GetSubscriptionsParams): Promise<GetSubscriptionsResult>;
     getActiveSubscriptions: (params?: GetActiveSubscriptions) => Promise<Subscription[]>;
     getActiveSubscriptionsList(params?: GetActiveSubscriptions): Promise<SlimSubscriptionFragmentV2Fragment[]>;
     getSubscription(params: GetSubscription): Promise<Subscription>;
@@ -217,6 +218,7 @@ export declare class Stigg implements StiggClient {
      * @param refreshOnComplete should refresh entitlements if subscription was found
      */
     waitForCheckoutCompleted({ timeoutMs, refreshOnComplete, }?: WaitForCheckoutCompleted): Promise<Subscription | null>;
+    getSubscriptions(params?: GetSubscriptionsParams): Promise<GetSubscriptionsResult>;
     getActiveSubscriptions({ resourceId }?: GetActiveSubscriptions): Promise<Subscription[]>;
     /**
      * @description Get customer's active subscriptions, for extended subscription data use {@link getSubscription}

package/dist/src/models.d.ts

@@ -1,4 +1,4 @@
-import { BillingModel, BillingPeriod, Currency, PricingType, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits, ExperimentGroupType, CustomerPortalEntitlementFragment, CustomerPortalPromotionalEntitlementFragment, CustomerPortalSubscriptionFragment, CustomerPortalSubscriptionAddonFragment, CustomerPortalBillingInformationFragment, PaywallConfigurationFragment, CustomerPortalConfigurationFragment, WidgetType, CustomerPortalSubscriptionScheduledUpdateDataFragment, DiscountType, DiscountDurationType, PackageEntitlementFragment, PaywallCurrencyFragment, FeatureType, MeterType, EntitlementResetPeriod, AccessDeniedReason, PaywallCalculatedPricePointsFragment, SubscriptionInvoiceFragment, PaymentCollection, PlanFragment, BillingVendorIdentifier, TiersMode, SubscriptionFutureUpdateDataFragment, PriceTierFragment, TotalPriceFragment, CheckoutConfigurationFragment, TypographyConfigurationFragment, BillingAddress, ScheduleStrategy, PaymentCollectionMethod, BudgetConfigurationInput } 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 } from '@stigg/api-client-js/src/generated/sdk';
 export * from '@stigg/api-client-js/src/generated/sdk';
 interface Metadata {
     [key: string]: string;
@@ -155,6 +155,22 @@ export declare type GetMeteredEntitlement = {
     options?: MeteredEntitlementOptions;
     resourceId?: string;
 };
+export declare type PaginatedResult<T> = {
+    data: T[];
+    pageInfo: PageInfoFragment;
+};
+export declare type GetSubscriptionsResult = PaginatedResult<SubscriptionQueryFragment>;
+export declare type GetSubscriptionsParams = {
+    customerId?: string;
+    resourceId?: string | string[];
+    status?: SubscriptionStatus | SubscriptionStatus[];
+    productId?: string | string[];
+    pagination?: {
+        limit?: number;
+        startingAfter?: string;
+        endingBefore?: string;
+    };
+};
 export declare type GetPaywall = {
     productId?: string;
     resourceId?: string;

package/dist/src/offlineClient.d.ts

@@ -1,5 +1,5 @@
 import { Stigg, StiggClient } from './clients';
-import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
+import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, 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;
@@ -31,5 +31,6 @@ export declare class OfflineStigg extends Stigg {
     getPaywall(): Promise<Paywall>;
     getCustomerPortal(): Promise<CustomerPortal>;
     getActiveSubscriptions(): Promise<Subscription[]>;
+    getSubscriptions(): Promise<GetSubscriptionsResult>;
     getCustomer(): Promise<Customer>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "3.40.0",
+  "version": "3.42.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": "2.361.0",
+    "@stigg/api-client-js": "2.448.1",
     "cross-fetch": "^3.1.6",
     "dayjs": "^1.11.13",
     "fetch-retry": "^5.0.6",