@sesamy/sesamy-js 1.30.1 → 1.31.1

package/README.md

@@ -46,7 +46,7 @@ The following methods are available on the `sesamy` object:
   - signedLinks: lists and signedLinks registered in the current session
 - fulfillments
   - 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.
+- generateLink: creates a link to a Sesamy hosted service such as account, change-payment, 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
@@ -562,20 +562,37 @@ export type Address = {
 };
 ```
 
-## `generateLink(params: GenerateAccountLink | GenerateConsumeLink)`
+## `generateLink(params: GenerateAccountLink | GenerateChangePaymentLink | GenerateConsumeLink | GenerateCheckoutLink)`
 
 Generates a link to a Sesamy-hosted service such as account or consume. If the user is authenticated, the link will be signed so that the user can access the service without logging in again.
 
 ### Parameters
 
-- params (GenerateAccountLink | GenerateConsumeLink): The parameters for generating the link.
-  - target (string): The target service, either 'account' or 'consume'.
-  - sku (string, required for 'consume' target): The SKU of the product to consume.
-  - episodeId (string, optional for 'consume' target): The ID of the episode to consume.
-  - shorten (boolean, optional): If true, the link will be shortened.
-  - ttl (number, optional): The time-to-live for the shortened link in seconds.
-  - redirectUrl (string, optional): The URL to redirect to after the link is accessed.
-  - language (string, optional): The language for the link. If not provided the language will be fetched from the HTML element's `lang` attribute.
+- params (GenerateAccountLink | GenerateConsumeLink):
+
+  - The parameters for generating the link.
+    attribute.
+    Common parameters:
+
+    - target (string, required): The target service. Valid values:
+      - 'account': Generate link to account page
+      - 'change-payment': Generate link to payment change page
+      - 'consume': Generate link to consume content
+      - 'checkout': Generate link to checkout page
+    - shorten (boolean, optional): If true, the link will be shortened
+    - ttl (number, optional): The time-to-live for the shortened link in seconds
+    - redirectUrl (string, optional): The URL to redirect to after the link is accessed
+    - language (string, optional): The language for the link. Defaults to HTML element's `lang` attribute
+
+  - Target-specific parameters:
+    For target='consume':
+
+    - sku (string, required): The SKU of the product to consume
+    - episodeId (string, optional): The ID of the episode to consume
+
+  - For target='change-payment':
+
+    - contractId (string, required): The ID of the contract to change payment for
 
 ### Returns