@stigg/js-client-sdk 3.39.0 → 3.39.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/models.d.ts CHANGED
@@ -515,6 +515,9 @@ export declare type EstimateSubscriptionUpdate = {
515
515
  addons?: SubscriptionEstimationAddon[];
516
516
  promotionCode?: string;
517
517
  };
518
+ export declare type PreviewNextInvoice = {
519
+ subscriptionId: string;
520
+ };
518
521
  export declare type PreviewSubscription = {
519
522
  customerId: string;
520
523
  payingCustomerId?: string;
@@ -1,5 +1,5 @@
1
1
  import { Stigg, StiggClient } from './clients';
2
- import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
2
+ import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
3
3
  export declare class OfflineStigg extends Stigg {
4
4
  getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
5
5
  getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
@@ -20,6 +20,7 @@ export declare class OfflineStigg extends Stigg {
20
20
  getCheckoutState(): Promise<GetCheckoutStateResults>;
21
21
  applySubscription(): Promise<ApplySubscriptionResults>;
22
22
  estimateSubscription(): Promise<SubscriptionPreview>;
23
+ previewNextInvoice(): Promise<SubscriptionInvoicePreviewFragment>;
23
24
  previewSubscription(): Promise<SubscriptionPreviewV2>;
24
25
  estimateSubscriptionUpdate(): Promise<SubscriptionPreview>;
25
26
  waitForCheckoutCompleted(): Promise<Subscription | null>;
@@ -1,11 +1,12 @@
1
1
  import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
2
- import { PreviewSubscription, EstimateSubscription, EstimateSubscriptionUpdate } from '../models';
3
- import { EstimateSubscriptionMutation, EstimateSubscriptionUpdateMutation, PreviewSubscriptionMutation } from '@stigg/api-client-js/src/generated/sdk';
2
+ import { PreviewSubscription, EstimateSubscription, EstimateSubscriptionUpdate, PreviewNextInvoice } from '../models';
3
+ import { EstimateSubscriptionMutation, EstimateSubscriptionUpdateMutation, PreviewSubscriptionMutation, PreviewNextInvoiceMutation } from '@stigg/api-client-js/src/generated/sdk';
4
4
  declare class SubscriptionEstimationsApi {
5
5
  private readonly client;
6
6
  constructor(client: ApolloClient<NormalizedCacheObject>);
7
7
  estimateSubscription(input: EstimateSubscription): Promise<import("@apollo/client/core").FetchResult<EstimateSubscriptionMutation, Record<string, any>, Record<string, any>>>;
8
8
  estimateSubscriptionUpdate(input: EstimateSubscriptionUpdate): Promise<import("@apollo/client/core").FetchResult<EstimateSubscriptionUpdateMutation, Record<string, any>, Record<string, any>>>;
9
+ previewNextInvoice(input: PreviewNextInvoice): Promise<import("@apollo/client/core").FetchResult<PreviewNextInvoiceMutation, Record<string, any>, Record<string, any>>>;
9
10
  previewSubscription(input: PreviewSubscription): Promise<import("@apollo/client/core").FetchResult<PreviewSubscriptionMutation, Record<string, any>, Record<string, any>>>;
10
11
  }
11
12
  export default SubscriptionEstimationsApi;
@@ -1,6 +1,6 @@
1
- import { SlimSubscriptionFragmentV2Fragment, UsageHistoryV2Fragment, UsageHistoryV2Input } from '@stigg/api-client-js/src/generated/sdk';
1
+ import { SlimSubscriptionFragmentV2Fragment, SubscriptionInvoicePreviewFragment, UsageHistoryV2Fragment, UsageHistoryV2Input } from '@stigg/api-client-js/src/generated/sdk';
2
2
  import { ClientConfiguration } from './configuration';
3
- 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 } from './models';
3
+ 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';
4
4
  import { EventNames, Events } from './services/eventEmitter';
5
5
  import { LoggerService } from './services/loggerService';
6
6
  export interface StiggClient {
@@ -32,6 +32,7 @@ export interface StiggClient {
32
32
  getCustomerPortal(params?: GetCustomerPortal): Promise<CustomerPortal>;
33
33
  estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>;
34
34
  estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>;
35
+ previewNextInvoice(previewNextInvoice: PreviewNextInvoice): Promise<SubscriptionInvoicePreviewFragment>;
35
36
  previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>;
36
37
  getUsageHistoryV2(input: UsageHistoryV2Input): Promise<UsageHistoryV2Fragment>;
37
38
  }
@@ -190,6 +191,12 @@ export declare class Stigg implements StiggClient {
190
191
  * @param {EstimateSubscriptionUpdate} estimateSubscriptionUpdate
191
192
  */
192
193
  estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>;
194
+ /**
195
+ * Preview the subscription next invoice
196
+ * @return {Promise<SubscriptionInvoicePreviewFragment>} Preview of the next invoice.
197
+ * @param {PreviewNextInvoice} previewNextInvoice
198
+ */
199
+ previewNextInvoice(previewNextInvoice: PreviewNextInvoice): Promise<SubscriptionInvoicePreviewFragment>;
193
200
  /**
194
201
  * Preview subscription provisioning\updates
195
202
  * @return {Promise<SubscriptionPreviewV2>} Preview of the subscription.
@@ -515,6 +515,9 @@ export declare type EstimateSubscriptionUpdate = {
515
515
  addons?: SubscriptionEstimationAddon[];
516
516
  promotionCode?: string;
517
517
  };
518
+ export declare type PreviewNextInvoice = {
519
+ subscriptionId: string;
520
+ };
518
521
  export declare type PreviewSubscription = {
519
522
  customerId: string;
520
523
  payingCustomerId?: string;
@@ -1,5 +1,5 @@
1
1
  import { Stigg, StiggClient } from './clients';
2
- import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
2
+ import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
3
3
  export declare class OfflineStigg extends Stigg {
4
4
  getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
5
5
  getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
@@ -20,6 +20,7 @@ export declare class OfflineStigg extends Stigg {
20
20
  getCheckoutState(): Promise<GetCheckoutStateResults>;
21
21
  applySubscription(): Promise<ApplySubscriptionResults>;
22
22
  estimateSubscription(): Promise<SubscriptionPreview>;
23
+ previewNextInvoice(): Promise<SubscriptionInvoicePreviewFragment>;
23
24
  previewSubscription(): Promise<SubscriptionPreviewV2>;
24
25
  estimateSubscriptionUpdate(): Promise<SubscriptionPreview>;
25
26
  waitForCheckoutCompleted(): Promise<Subscription | null>;
@@ -1,5 +1,5 @@
1
1
  import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment, SubscriptionPreviewInvoiceFragment, ImmediateSubscriptionPreviewInvoiceFragment, SlimCustomerFragment } from '@stigg/api-client-js/src/generated/sdk';
2
- import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice, SlimCustomer } from '../models';
2
+ import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice, SlimCustomer, SubscriptionPreviewCredits } from '../models';
3
3
  import CachedEntitlement from '../services/cachedEntitlement';
4
4
  import { Decision } from '../services/entitlementDecisionService';
5
5
  export declare class ModelMapper {
@@ -38,6 +38,7 @@ export declare class ModelMapper {
38
38
  mapFallbackMeteredEntitlementResult(entitlement: MeteredEntitlementFallback, decision: Decision, requestedUsage?: number): EntitlementCheckResult;
39
39
  mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
40
40
  mapSubscriptionPreview(fragment: SubscriptionPreviewFragment): SubscriptionPreview;
41
+ mapCredits(fragment: NonNullable<SubscriptionPreviewFragment['credits']>): SubscriptionPreviewCredits;
41
42
  mapSubscriptionPreviewV2(fragment: SubscriptionPreviewV2Fragment): SubscriptionPreviewV2;
42
43
  mapSubscriptionPreviewInvoice(fragment: SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): SubscriptionPreviewInvoice;
43
44
  mapDiscount(discount: NonNullable<SubscriptionPreviewFragment['discount']>): SubscriptionPreviewDiscount;
@@ -1,5 +1,5 @@
1
1
  import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment, SubscriptionPreviewInvoiceFragment, ImmediateSubscriptionPreviewInvoiceFragment, SlimCustomerFragment } from '@stigg/api-client-js/src/generated/sdk';
2
- import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice, SlimCustomer } from '../models';
2
+ import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice, SlimCustomer, SubscriptionPreviewCredits } from '../models';
3
3
  import CachedEntitlement from '../services/cachedEntitlement';
4
4
  import { Decision } from '../services/entitlementDecisionService';
5
5
  export declare class ModelMapper {
@@ -38,6 +38,7 @@ export declare class ModelMapper {
38
38
  mapFallbackMeteredEntitlementResult(entitlement: MeteredEntitlementFallback, decision: Decision, requestedUsage?: number): EntitlementCheckResult;
39
39
  mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
40
40
  mapSubscriptionPreview(fragment: SubscriptionPreviewFragment): SubscriptionPreview;
41
+ mapCredits(fragment: NonNullable<SubscriptionPreviewFragment['credits']>): SubscriptionPreviewCredits;
41
42
  mapSubscriptionPreviewV2(fragment: SubscriptionPreviewV2Fragment): SubscriptionPreviewV2;
42
43
  mapSubscriptionPreviewInvoice(fragment: SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): SubscriptionPreviewInvoice;
43
44
  mapDiscount(discount: NonNullable<SubscriptionPreviewFragment['discount']>): SubscriptionPreviewDiscount;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stigg/js-client-sdk",
3
- "version": "3.39.0",
3
+ "version": "3.39.1",
4
4
  "description": "Stigg client-side SDK for Browser",
5
5
  "main": "dist/index.js",
6
6
  "typings": "dist/index.d.ts",