@sesamy/sesamy-js 1.24.1 → 1.25.0

package/README.md

@@ -18,59 +18,66 @@ The following events are tracked:
 
 The following methods are available on the `sesamy` object:
 
-- init: Initializes the sesamy-js library
+Certainly! Here’s the list with bullet points sorted alphabetically:
+
+- attributions
+  - get: get the attributions for a user
+  - set: set the attributions for a user
 - auth
   - getUser: fetches the user's profile
   - isAuthenticated: checks if the user is authenticated
   - loginWithRedirect: redirects the user to the login page
   - logout: logs the user out
   - setToken: stores a token in session storage
+- bills
+  - get: get a bill by id
+  - list: lists all the user's bills
+- clearCache: clears the cache for the sesamy-js library
+- contracts
+  - cancel: cancel a contract by id
+  - get: get a contract by id
+  - list: lists all the user's contracts
 - entitlements
+  - access: fetches the user's access URL for an entitlement
   - get: gets a single entitlement by id
   - list: lists the user's entitlements
-  - access: fetches the user's access url for an entitlement
   - signedLinks: lists and signedLinks registered in the current session
 - fulfillments
-  - list: list the users fullfillments for a sku
+  - list: list the user's fulfillments for a SKU
+- generateLink: creates a link to a Sesamy hosted service such as account, consume, or checkout. If the user is authenticated, the link will be signed so that the user can access the service without logging in again.
+- getPaymentIssues: returns a list of failed payments and cards that will expire
+- getVersion: returns the version of the sesamy-js library
+- init: Initializes the sesamy-js library
+- paywalls
+  - get: get a paywall by id
+- product
+  - autoOnboard: trigger the auto-onboarding process for a product by SKU
+  - get: get a product by SKU
 - profile
   - get: fetches the user's profile
-  - update: updates the user's profile
-  - openHostedAccountPage: opens the hosted account page
   - isSpotifyLinked: returns true if the user has linked their Spotify account
+  - openHostedAccountPage: opens the hosted account page
   - unlinkSpotify: unlinks the user's Spotify account
+  - update: updates the user's profile
+- subscriptions (deprecated, use contracts instead)
+  - list: lists all the user's subscriptions
 - tags
+  - delete: deletes a tag for the user
   - get: fetches the user's tags
   - set: sets a tag for the user
-  - delete: deletes a tag for the user
-- userMetadata
-  - get: get the user's metadata by id
-  - list: list all the user's metadata
-  - set: sets the user's metadata
-  - delete: deletes the user's metadata by id
 - tallies
+  - delete: delete a tally by id
   - get: get a tally for a user by id
   - list: list all tallies for a user
   - push: push an item to a tally
-  - delete: delete a tally by id
-- bills
-  - get: get a bill by id
-  - list: lists all the user's bills
-- contracts
-  - get: get a contract by id
-  - list: lists all the user's contracts
-  - cancel: cancel a contract by id
-- transactions:
+- transactions
   - get: get a transaction by id
   - list: lists all the user's transactions
-- subscriptions (deprecated, use contracts instead):
-  - list: lists all the user's subscriptions
-- product
-  - get: get a product by sku
-  - autoOnboard: trigger the auto-onboarding process for a product by sku
-- getVersion: returns the version of the sesamy-js library
-- getPaymentIssues: returns a list of failed payments and cards that will expire
-- generateLink: creates a link to a sesamy hosted service such as account, consume or checkout. If the user is authenticated, the link will be signed so that the user can access the service without logging in again.
-- clearCache: clears the cache for the sesamy-js library
+- userMetadata
+  - delete: deletes the user's metadata by id
+  - get: get the user's metadata by id
+  - list: list all the user's metadata
+  - set: sets the user's metadata
 
 ## Events
 
@@ -153,7 +160,7 @@ Checks if the user is currently authenticated. This function verifies the existe
 
 ### Returns
 
-- **boolean**: Returns `true` if the user is authenticated either via local storage tokens or the Auth0 client; otherwise, it returns `false`.
+- boolean: Returns `true` if the user is authenticated either via local storage tokens or the Auth0 client; otherwise, it returns `false`.
 
 ### Example
 
@@ -389,16 +396,16 @@ console.log('Signed links:', signedLinks);
 
 ### Types
 
-- **GetEntitlementsOptions**: An object containing optional parameters for fetching entitlements.
+- GetEntitlementsOptions: An object containing optional parameters for fetching entitlements.
 
   - `includeSignedLinks` (boolean, optional): Whether to include signed links. Defaults to `true`.
   - `waitForEntitlementAfter` (Date, optional): A date to filter entitlements that are available after the given date.
 
-- **Entitlement**: Represents an entitlement object.
+- Entitlement: Represents an entitlement object.
 
-- **Access**: Represents the access details for an entitlement.
+- Access: Represents the access details for an entitlement.
 
-- **SignedLink**: Represents a signed link for accessing an entitlement.
+- SignedLink: Represents a signed link for accessing an entitlement.
 
 # Services