ce-storefront 0.4.6 → 0.4.8

package/docs/sdks/coupons/README.md

@@ -1,79 +0,0 @@
-# Coupons
-(*offers.coupons*)
-
-## Overview
-
-### Available Operations
-
-* [list](#list) - Retrieve all coupons
-
-## list
-
-Retrieve active coupons
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.offers.coupons.list();
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { offersCouponsList } from "ce-storefront/funcs/offersCouponsList.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await offersCouponsList(ceStorefront);
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.GetCouponsResponseBody](../../models/operations/getcouponsresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |

package/docs/sdks/juspay/README.md

@@ -1,242 +0,0 @@
-# Juspay
-(*juspay*)
-
-## Overview
-
-Juspay Payments
-
-### Available Operations
-
-* [postPaymentsJuspayCreateOrder](#postpaymentsjuspaycreateorder) - Create order in juspay
-* [postPaymentsJuspayCreateCustomer](#postpaymentsjuspaycreatecustomer) - Create customer in juspay
-* [getPaymentsJuspayCustomer](#getpaymentsjuspaycustomer) - Retrieve customer from juspay
-
-## postPaymentsJuspayCreateOrder
-
-Creates an order in the Juspay system and fetches the corresponding client_auth_token.
-To be used for Express Checkout integration.
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.juspay.postPaymentsJuspayCreateOrder({});
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { juspayPostPaymentsJuspayCreateOrder } from "ce-storefront/funcs/juspayPostPaymentsJuspayCreateOrder.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await juspayPostPaymentsJuspayCreateOrder(ceStorefront, {});
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.JuspayCreateOrderPayload](../../models/components/juspaycreateorderpayload.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.PostPaymentsJuspayCreateOrderResponseBody](../../models/operations/postpaymentsjuspaycreateorderresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.BadRequest   | 400                 | application/json    |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## postPaymentsJuspayCreateCustomer
-
-Create customer in juspay.
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.juspay.postPaymentsJuspayCreateCustomer({});
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { juspayPostPaymentsJuspayCreateCustomer } from "ce-storefront/funcs/juspayPostPaymentsJuspayCreateCustomer.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await juspayPostPaymentsJuspayCreateCustomer(ceStorefront, {});
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.JuspayCreateCustomerPayload](../../models/components/juspaycreatecustomerpayload.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.PostPaymentsJuspayCreateCustomerResponseBody](../../models/operations/postpaymentsjuspaycreatecustomerresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.BadRequest   | 400                 | application/json    |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## getPaymentsJuspayCustomer
-
-Retrieve customer from juspay.
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.juspay.getPaymentsJuspayCustomer({
-    userId: "<id>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { juspayGetPaymentsJuspayCustomer } from "ce-storefront/funcs/juspayGetPaymentsJuspayCustomer.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await juspayGetPaymentsJuspayCustomer(ceStorefront, {
-    userId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetPaymentsJuspayCustomerRequest](../../models/operations/getpaymentsjuspaycustomerrequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.GetPaymentsJuspayCustomerResponseBody](../../models/operations/getpaymentsjuspaycustomerresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.BadRequest   | 400                 | application/json    |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/docs/sdks/loyalty/README.md

@@ -1,167 +0,0 @@
-# Loyalty
-(*customers.loyalty*)
-
-## Overview
-
-### Available Operations
-
-* [get](#get) - Retrieve loyalty details
-* [listActivities](#listactivities) - List all loyalty points activity
-
-## get
-
-Retrieve loyalty details
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.customers.loyalty.get({
-    userId: "<id>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersLoyaltyGet } from "ce-storefront/funcs/customersLoyaltyGet.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await customersLoyaltyGet(ceStorefront, {
-    userId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetLoyaltyPointRequest](../../models/operations/getloyaltypointrequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.GetLoyaltyPointResponseBody](../../models/operations/getloyaltypointresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## listActivities
-
-List all loyalty points activity
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.customers.loyalty.listActivities({
-    userId: "<id>",
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersLoyaltyListActivities } from "ce-storefront/funcs/customersLoyaltyListActivities.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await customersLoyaltyListActivities(ceStorefront, {
-    userId: "<id>",
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetLoyaltyPointActivityRequest](../../models/operations/getloyaltypointactivityrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.GetLoyaltyPointActivityResponseBody](../../models/operations/getloyaltypointactivityresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/docs/sdks/newsletter/README.md

@@ -1,84 +0,0 @@
-# Newsletter
-(*campaigns.newsletter*)
-
-## Overview
-
-### Available Operations
-
-* [subscribe](#subscribe) - Subscribe to newsletter
-
-## subscribe
-
-Subscribe to newsletter
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.campaigns.newsletter.subscribe({
-    email: "Else.Grady38@gmail.com",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { campaignsNewsletterSubscribe } from "ce-storefront/funcs/campaignsNewsletterSubscribe.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await campaignsNewsletterSubscribe(ceStorefront, {
-    email: "Else.Grady38@gmail.com",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PostCustomersNewsletterSubscriptionRequestBody](../../models/operations/postcustomersnewslettersubscriptionrequestbody.md)                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.PostCustomersNewsletterSubscriptionResponseBody](../../models/operations/postcustomersnewslettersubscriptionresponsebody.md)\>**
-
-### Errors
-
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |