@sesamy/sesamy-js 1.15.1 → 1.17.0

package/README.md

@@ -326,6 +326,143 @@ generateLink(linkParams)
   });
 ```
 
+## `checkouts.create(params: CreateCheckoutParams)`
+
+Creates a checkout session with Sesamy. This function initializes a checkout process by sending the necessary parameters to the Sesamy API.
+
+### Parameters
+
+- params (CreateCheckoutParams): The parameters for creating the checkout session.
+  - items (Array of objects): An array of items to be included in the checkout.
+    - sku (string): The SKU of the product to be purchased.
+    - purchaseOptionsId (string, optional): The ID of the purchase options for the product.
+  - language (string, optional): The language for the checkout session. If not set, it will be automatically fetched from the HTML element's `lang` attribute.
+
+### Returns
+
+Promise\<CheckoutResponse\>: A promise that resolves to the response JSON object from the Sesamy API, which contains details about the created checkout session.
+
+### CheckoutResponse Schema
+
+- id (string): The unique identifier of the checkout session.
+- checkoutUrl (string): The URL for the checkout session.
+- status (enum): The status of the checkout session, can be 'PENDING' or 'PAID'.
+- createdAt (string): The creation timestamp of the checkout session.
+- modifiedAt (string): The last modified timestamp of the checkout session.
+- type (enum): The type of checkout session, currently only 'RECURRING' is supported.
+- currency (string): The currency used for the checkout session.
+- country (string): The country associated with the checkout session.
+- language (string): The language used for the checkout session.
+- items (Array of objects): The items included in the checkout session.
+  - sku (string): The SKU of the product.
+  - purchaseOptionId (string, optional): The ID of the purchase option for the product.
+  - title (string): The title of the product.
+  - cover (string): The cover image URL of the product.
+- itemsOwned (Array of strings): The SKUs of the items already owned by the user.
+- discountCodes (Array of strings): The discount codes applied to the checkout session.
+- paymentOptions (Array of objects): The available payment options.
+  - provider (string): The payment provider.
+  - methods (Array of strings): The payment methods supported by the provider.
+
+### Example
+
+The following example demonstrates how to create a checkout session with Sesamy:
+
+```javascript
+import { createCheckout } from '@sesamy/sesamy-js';
+
+// Create a checkout session with one item
+const checkoutParams = {
+  items: [
+    {
+      sku: 'product-sku',
+      purchaseOptionsId: 'option-id', // optional
+    },
+  ],
+  language: 'en', // optional
+};
+
+createCheckout(checkoutParams)
+  .then(response => {
+    console.log('Checkout session created:', response);
+  })
+  .catch(error => {
+    console.error('Error creating checkout session:', error);
+  });
+```
+
+In this example, a checkout session is created with a single item specified by its SKU and an optional purchase options ID. The language is set to English (`'en'`), but if not provided, it will default to the language specified in the HTML `lang` attribute.
+
+### Additional Notes
+
+- The `language` parameter is optional. If it is not provided, the language will be determined using the `getLanguage` function, which fetches the language from the `lang` attribute of the HTML document element.
+- The `items` array must contain at least one item with a valid `sku`.
+
+By using the `createCheckout` function, you can easily initialize a checkout process and handle the response from the Sesamy API to complete the transaction.
+
+# Services
+
+## `checkouts.get(id: string)`
+
+Retrieves the details of a specific checkout session from Sesamy. This function fetches the checkout session information based on the provided checkout session ID.
+
+### Parameters
+
+- id (string): The unique identifier of the checkout session to retrieve.
+
+### Returns
+
+Promise\<CheckoutResponse\>: A promise that resolves to the response JSON object from the Sesamy API, which contains details about the requested checkout session.
+
+### CheckoutResponse Schema
+
+- id (string): The unique identifier of the checkout session.
+- checkoutUrl (string): The URL for the checkout session.
+- status (enum): The status of the checkout session, can be 'PENDING' or 'PAID'.
+- createdAt (string): The creation timestamp of the checkout session.
+- modifiedAt (string): The last modified timestamp of the checkout session.
+- type (enum): The type of checkout session, currently only 'RECURRING' is supported.
+- currency (string): The currency used for the checkout session.
+- country (string): The country associated with the checkout session.
+- language (string): The language used for the checkout session.
+- items (Array of objects): The items included in the checkout session.
+  - sku (string): The SKU of the product.
+  - purchaseOptionId (string, optional): The ID of the purchase option for the product.
+  - title (string): The title of the product.
+  - cover (string): The cover image URL of the product.
+- itemsOwned (Array of strings): The SKUs of the items already owned by the user.
+- discountCodes (Array of strings): The discount codes applied to the checkout session.
+- paymentOptions (Array of objects): The available payment options.
+  - provider (string): The payment provider.
+  - methods (Array of strings): The payment methods supported by the provider.
+
+### Example
+
+The following example demonstrates how to retrieve the details of a specific checkout session with Sesamy:
+
+```javascript
+import { getCheckout } from '@sesamy/sesamy-js';
+
+// Retrieve the details of a checkout session by ID
+const checkoutId = 'checkout-session-id';
+
+getCheckout(checkoutId)
+  .then(response => {
+    console.log('Checkout session details:', response);
+  })
+  .catch(error => {
+    console.error('Error retrieving checkout session:', error);
+  });
+```
+
+In this example, the details of a specific checkout session are retrieved using its unique ID. The function returns a promise that resolves to the details of the checkout session.
+
+### Additional Notes
+
+- The `id` parameter is required and must be a valid checkout session identifier.
+
+By using the `getCheckout` function, you can easily fetch the details of a specific checkout session from the Sesamy API to view or process the transaction information.
+
 ## Transform
 
 The transform module allows for dynamic content manipulation based on specified rules. This can include inserting, replacing, or removing elements on a webpage.