@stigg/js-client-sdk 0.23.0 → 0.24.0

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/client.d.ts CHANGED
@@ -19,14 +19,14 @@ export declare class Stigg implements StiggClient {
19
19
  private readonly modelMapper;
20
20
  private constructor();
21
21
  /**
22
- * Initialize the SDK
23
- * @param {ClientConfiguration} configuration
24
- * @returns {Stigg | null}
22
+ * Creates an instance of Stigg client.
23
+ *
24
+ * @param configuration configuration settings.
25
+ * @returns The new client instance.
25
26
  */
26
27
  static initialize(configuration: ClientConfiguration): Promise<StiggClient | null>;
27
28
  /**
28
29
  * Set the customer ID, usually after the customer signs in or restores a session
29
- * @returns {Promise<void>}
30
30
  */
31
31
  setCustomerId(customerId: string): Promise<void>;
32
32
  /**
@@ -35,13 +35,11 @@ export declare class Stigg implements StiggClient {
35
35
  refresh(): Promise<void>;
36
36
  /**
37
37
  * Get boolean entitlement of feature for a customer
38
- * @param {string} featureId
39
- * @param {BooleanEntitlementOptions} options
40
- * @return {BooleanEntitlement} boolean entitlement
41
38
  */
42
39
  getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
43
40
  /**
44
41
  * Get numeric entitlement of feature for a customer
42
+ *
45
43
  * @param {string} featureId
46
44
  * @param {NumericEntitlementOptions} options
47
45
  * @return {NumericEntitlement} numeric entitlement
@@ -49,6 +47,7 @@ export declare class Stigg implements StiggClient {
49
47
  getNumericEntitlement({ featureId, options }: GetNumericEntitlement): NumericEntitlement;
50
48
  /**
51
49
  * Get metered entitlement of feature for a customer
50
+ *
52
51
  * @param {string} featureId
53
52
  * @param {MeteredEntitlementOptions} options
54
53
  * @return {MeteredEntitlement} metered entitlement
@@ -56,16 +55,19 @@ export declare class Stigg implements StiggClient {
56
55
  getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
57
56
  /**
58
57
  * Get a list of plans for rendering the paywall
58
+ *
59
59
  * @returns {Promise<Plan[]>}
60
60
  */
61
61
  getPaywall({ productId }?: GetPaywall): Promise<Plan[]>;
62
62
  /**
63
63
  * Get a customer
64
+ *
64
65
  * @returns {Promise<Customer>}
65
66
  */
66
67
  getCustomer(): Promise<Customer>;
67
68
  /**
68
69
  * Get a list of entitlements
70
+ *
69
71
  * @returns {Promise<Entitlement[]>}
70
72
  */
71
73
  getEntitlements(): Promise<Entitlement[]>;
package/dist/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export { ClientConfiguration } from './configuration';
2
2
  export { StiggClient } from './client';
3
+ export { LogLevel, LogConfiguration, Logger } from './services/loggerService';
3
4
  export * from './models';
4
5
  export { Stigg as default } from './client';