@djust-b2b/djust-front-sdk 1.15.0 → 1.15.1

package/lib/index.d.ts

@@ -88,13 +88,13 @@ export declare const DjustSDK: {
     getProductVariantSuppliers({ productVariantId, }: import("./interfaces").GetProductVariantSuppliersParameters): Promise<import("./interfaces").GetProductVariantSuppliersResponse>;
     getProduct({ productIdentifier, productIdType, locale, }: import("./interfaces").GetProductParameters): Promise<import("./interfaces").GetProductsListResponse>;
     getProductOffers({ productIdentifier, productIdType, locale, currency, }: import("./interfaces").GetProductOffersParameters): Promise<import("./interfaces").GetProductOffersResponse>;
-    getProductPaginatedOffers({ productIdentifier, productIdType, currency, locale, withoutPrices, pageable, }: import("./interfaces").GetProductPaginatedOffersParameters): Promise<import("./interfaces").GetProductPaginatedOffersResponse>;
-    getRelatedProducts({ productIdentifier, productIdType, locale, currency, pageable, }: import("./interfaces").GetRelatedProductsParameters): Promise<import("./interfaces").GetRelatedProductsResponse>;
+    getRelatedProducts({ productIdentifier, productIdType, locale, currency, pageable, }: import("./interfaces").GetRelatedProductsParameters): Promise<import("./interfaces").GetRelatedProductsParameters>;
     getProductReviews({ productIdentifier, productIdType, }: import("./interfaces").GetProductReviewsParameters): Promise<import("./interfaces").GetProductReviewsResponse>;
     getProductStatReviews({ productIdentifier, productIdType, }: import("./interfaces").GetProductStatReviewsParameters): Promise<import("./interfaces").GetProductStatReviewsResponse>;
     getProductVariantAttributes({ productIdentifier, productIdType, locale, }: import("./interfaces").GetProductVariantAttributesParameters): Promise<import("./interfaces").GetProductVariantAttributesResponse>;
     createProductReview({ message, productSku, rating, }: import("./interfaces").CreateProductReviewParameters): Promise<import("./interfaces").CreateProductReviewResponse>;
     updateProductReview({ productReviewId, message, rating, }: import("./interfaces").UpdateProductReviewParameters): Promise<import("./interfaces").UpdateProductReviewResponse>;
+    getProductPaginatedOffers({ productIdentifier, productIdType, currency, locale, withoutPrices, pageable, }: import("./interfaces").GetProductPaginatedOffersParameters): Promise<import("./interfaces").GetProductPaginatedOffersResponse>;
     getNavigationCategories({ locale, }: import("./interfaces").GetNavigationCategoriesParameters): Promise<import("./interfaces").GetNavigationCategoriesResponse>;
     getNavigationCategory({ locale, idType, navigationCategoryId, }: import("./interfaces").GetNavigationCategoryParameters): Promise<import("./interfaces").GetNavigationCategoryResponse>;
     getNavigationCategoryBreadcrumbs({ locale, idType, navigationCategoryId, }: import("./interfaces").GetNavigationCategoryBreadcrumbsParameters): Promise<import("./interfaces").GetNavigationCategoryBreadcrumbsResponse>;
@@ -142,11 +142,11 @@ export declare const DjustSDK: {
     deleteBuyingList({ buyingListId, }: import("./interfaces").DeleteBuyingListParameters): Promise<void>;
     deleteBuyingListItems({ buyingListId, itemIds, }: import("./interfaces").DeleteBuyingListItemsParameters): Promise<void>;
     updateBuyingListOwner({ buyingListId, newOwnerEmail, }: import("./interfaces").UpdateBuyingListOwnerParameters): Promise<void>;
-    isTokenValid({ token, }: import("./interfaces").IsTokenValidParameters): Promise<boolean>;
-    refreshToken({ refreshToken, }: import("./interfaces").RefreshTokenParameters): Promise<import("./interfaces").RefreshTokenResponse>;
-    resetPassword({ newPassword, resetPasswordToken, }: import("./interfaces").ResetPasswordParameters): Promise<void>;
-    sendResetPasswordEmail({ email, }: import("./interfaces").SendResetPasswordEmailParameters): Promise<void>;
-    login({ username, password, }: import("./interfaces").LoginParameters): Promise<import("./interfaces").LoginResponse>;
+    isTokenValid({ token, }: import("./services/auth/definitions.requests").IsTokenValidParameters): Promise<boolean>;
+    refreshToken({ refreshToken, }: import("./services/auth/definitions.requests").RefreshTokenParameters): Promise<import("./interfaces").RefreshTokenResponse>;
+    resetPassword({ newPassword, resetPasswordToken, }: import("./services/auth/definitions.requests").ResetPasswordParameters): Promise<void>;
+    sendResetPasswordEmail({ email, }: import("./services/auth/definitions.requests").SendResetPasswordEmailParameters): Promise<void>;
+    login({ username, password, }: import("./services/auth/definitions.requests").LoginParameters): Promise<import("./interfaces").LoginResponse>;
     logout(): Promise<void>;
 };
 export * from "./interfaces";

package/lib/services/auth/definitions.requests.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Request parameters type definitions
+ */
+export interface IsTokenValidParameters {
+    token: string;
+}
+export interface RefreshTokenParameters {
+    refreshToken: string;
+}
+export interface ResetPasswordParameters {
+    newPassword: string;
+    resetPasswordToken: string;
+}
+export interface SendResetPasswordEmailParameters {
+    email: string;
+    redirectUrl: string;
+}
+export interface LoginParameters {
+    username: string;
+    password: string;
+}

package/lib/services/auth/definitions.requests.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/services/auth/index.d.ts

@@ -1,11 +1,21 @@
 /**
- * @packageDocumentation
+ * # Auth Service
  *
- * @document documents/auth.md
+ * This module provides all functionalities related to user authentication and authorization.
+ *
+ * ## Features:
+ * - Validate tokens
+ * - Refresh tokens
+ * - Reset user passwords
+ * - Manage user login and logout
+ * - Send password reset emails
+ *
+ * Each function is described with its input parameters, output responses, and example usages.
  */
-import { IsTokenValidParameters, LoginParameters, LoginResponse, RefreshTokenParameters, RefreshTokenResponse, ResetPasswordParameters, SendResetPasswordEmailParameters } from "./definitions";
+import { LoginResponse, RefreshTokenResponse } from "./definitions";
+import { IsTokenValidParameters, LoginParameters, RefreshTokenParameters, ResetPasswordParameters, SendResetPasswordEmailParameters } from "./definitions.requests";
 /**
- * CART ENDPOINT
+ * AUTH ENDPOINT
  */
 /**
  * ##R eturns true if the token is valid and not expired, false otherwise

package/lib/services/auth/index.js

@@ -1,8 +1,17 @@
 "use strict";
 /**
- * @packageDocumentation
+ * # Auth Service
  *
- * @document documents/auth.md
+ * This module provides all functionalities related to user authentication and authorization.
+ *
+ * ## Features:
+ * - Validate tokens
+ * - Refresh tokens
+ * - Reset user passwords
+ * - Manage user login and logout
+ * - Send password reset emails
+ *
+ * Each function is described with its input parameters, output responses, and example usages.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isTokenValid = isTokenValid;
@@ -14,7 +23,7 @@ exports.logout = logout;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * CART ENDPOINT
+ * AUTH ENDPOINT
  */
 /**
  * ##R eturns true if the token is valid and not expired, false otherwise

package/lib/services/cart/index.d.ts

@@ -1,8 +1,3 @@
-/**
- * @packageDocumentation
- *
- * @document documents/cart.md
- */
 import { CreateCartParameters, DeleteCartsResponse, DeleteCartParameters, GetCartParameters, GetCartResponse, GetCartsParameters, GetCartsResponse, UpdateCartParameters, InitializeOrdersFromCartParameters, GetCartLinesParameters, DeleteCartLinesResponse, DeleteCartLinesParameters, GetCartLinesResponse, UpdateCartLinesResponse, UpdateCartLinesParameters, UpdateCartLinesByVariantParameters, UpdateCartLinesByVariantResponse } from "./definitions";
 /**
  * CART ENDPOINT

package/lib/services/cart/index.js

@@ -1,9 +1,4 @@
 "use strict";
-/**
- * @packageDocumentation
- *
- * @document documents/cart.md
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteCarts = deleteCarts;
 exports.getCarts = getCarts;

package/lib/services/custom-field/index.d.ts

@@ -86,23 +86,18 @@ export declare function getCustomFields(params: GetCustomFieldParameters): Promi
  * This function allows publishing a media file associated with a specific custom field.
  *
  * @param {PostMediaCustomFieldParameters} params - The parameters for publishing the media field, including:
- * #### id - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
+ * #### id - `string` | **required**
  * The identifier of the custom field to which the media is associated.
- * #### customFieldIdType - `string` | <strong style={{ color: 'red' }}>required</strong></strong>
- *
+ * #### customFieldIdType - `string` | **required**
  * The type of the custom field identifier (e.g., 'externalId').
  * #### sealedTarget - `boolean`
- *
  * Indicates whether the media should be sealed.
- * #### fileName - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
+ * #### fileName - `string` | **required**
  * The name of the media file being uploaded.
- * #### fileSize - `number` | <strong style={{ color: 'red' }}>required</strong>
- *
+ * #### fileSize - `number` | **required**
  * The size of the media file in bytes.
  *
- * @returns {Promise<string>} - A promise that resolves to the url where post the media.
+ * @returns {Promise<string>} - A promise that resolves to the URL where the media can be posted.
  *
  * @example
  * #### input

package/lib/services/custom-field/index.js

@@ -2,11 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCustomFields = getCustomFields;
 exports.postMediaCustomField = postMediaCustomField;
-/**
- * @packageDocumentation
- *
- * @document documents/custom-field.md
- */
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
  * APICODE(listPaginatedCustomFields)
@@ -102,23 +97,18 @@ async function getCustomFields(params) {
  * This function allows publishing a media file associated with a specific custom field.
  *
  * @param {PostMediaCustomFieldParameters} params - The parameters for publishing the media field, including:
- * #### id - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
+ * #### id - `string` | **required**
  * The identifier of the custom field to which the media is associated.
- * #### customFieldIdType - `string` | <strong style={{ color: 'red' }}>required</strong></strong>
- *
+ * #### customFieldIdType - `string` | **required**
  * The type of the custom field identifier (e.g., 'externalId').
  * #### sealedTarget - `boolean`
- *
  * Indicates whether the media should be sealed.
- * #### fileName - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
+ * #### fileName - `string` | **required**
  * The name of the media file being uploaded.
- * #### fileSize - `number` | <strong style={{ color: 'red' }}>required</strong>
- *
+ * #### fileSize - `number` | **required**
  * The size of the media file in bytes.
  *
- * @returns {Promise<string>} - A promise that resolves to the url where post the media.
+ * @returns {Promise<string>} - A promise that resolves to the URL where the media can be posted.
  *
  * @example
  * #### input

package/lib/services/customer-user/index.d.ts

@@ -1,23 +1,26 @@
-/**
- * @packageDocumentation
- *
- * @document documents/customer-user.md
- */
 import { ActivateCustomerUserParameters, CreateCustomerUserParameters, CreateCustomerUserResponse, GetAuthenticatedUserResponse, GetCustomerUserAddressesParameters, GetCustomerUserOrganisationsResponse, SendCustomerUserActivationRequestParameters, UpdateCustomerUserParameters, UpdateCustomerUserResponse } from "./definitions";
 /**
- * APICODE(USER-500)
+ * 🚚 **Retrieve Authenticated User**
+ *
+ * **APICODE(USER-500)**
  * Retrieves the authenticated user.
  *
  * This function sends a request to obtain the details of the currently authenticated user.
  *
- * @returns {Promise<any>} - The data of the authenticated user.
+ * 🛠 **Endpoint**: `GET /v1/authenticated-user`
+ *
+ * | Parameter | Type   | Required | Description               |
+ * |-----------|--------|----------|---------------------------|
+ * | N/A       | N/A    | N/A      | This function does not require any parameters. |
  *
- * @example
- * #### input
- * ```typescript
+ * 📤 **Returns**:
+ * A `Promise` resolving to an object containing the authenticated user's data.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
  * const user = await getAuthenticatedUser();
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "id": "user1",
@@ -27,57 +30,36 @@ import { ActivateCustomerUserParameters, CreateCustomerUserParameters, CreateCus
  */
 export declare function getAuthenticatedUser(): Promise<GetAuthenticatedUserResponse>;
 /**
- * APICODE(USER-100)
+ * 🚚 **Create Customer User**
+ *
+ * **APICODE(USER-100)**
  * Creates a customer user.
  *
  * This function sends a request to create a new customer user with the specified parameters.
  *
- * @param {CreateCustomerUserParameters} params - The parameters for creating the user, including:
- * #### email - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The email address of the user.
- * #### password - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The password of the user.
- * #### firstName - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The first name of the user.
- * #### lastName - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The last name of the user.
- * #### groups - `string[]` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The groups to which the user belongs.
- * #### activationUrl - `string`
- *
- * The URL for user activation.
- * #### civility - `string`
- *
- * The civility of the user (e.g., Mr., Ms.).
- * #### customFieldValues - `object`
- *
- * Custom fields for additional user information.
- * #### externalId - `string`
- *
- * An external identifier for the user.
- * #### status - `string`
- *
- * The status of the user (e.g., active, inactive).
- * #### mainOrganisationId - `string`
- *
- * The ID of the main organization associated with the user.
- * #### organisations - `string[]`
- *
- * The list of organizations associated with the user.
- * #### phone - `string`
- *
- * The phone number of the user.
- *
- * @returns {Promise<CreateCustomerUserResponse>} - The data of the created user.
- *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Endpoint**: `POST /v1/shop/customer-users`
+ *
+ * | Parameter          | Type   | Required | Description                                      |
+ * |--------------------|--------|----------|--------------------------------------------------|
+ * | `email`            | string | ✅        | The email address of the user.                   |
+ * | `password`         | string | ✅        | The password of the user.                        |
+ * | `firstName`        | string | ✅        | The first name of the user.                      |
+ * | `lastName`         | string | ✅        | The last name of the user.                       |
+ * | `groups`           | string[] | ✅      | The groups to which the user belongs.            |
+ * | `activationUrl`    | string | ❌        | The URL for user activation.                     |
+ * | `civility`         | string | ❌        | The civility of the user (e.g., Mr., Ms.).       |
+ * | `customFieldValues`| object | ❌        | Custom fields for additional user information.   |
+ * | `externalId`       | string | ❌        | An external identifier for the user.             |
+ * | `status`           | string | ❌        | The status of the user (e.g., active, inactive). |
+ * | `mainOrganisationId`| string | ❌      | The ID of the main organization associated with the user. |
+ * | `organisations`    | string[] | ❌      | The list of organizations associated with the user. |
+ * | `phone`            | string | ❌        | The phone number of the user.                    |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an object containing the created user's data.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
  * const newUser = await createCustomerUser({
  *   email: 'user@example.com',
  *   password: 'securePassword',
@@ -94,7 +76,7 @@ export declare function getAuthenticatedUser(): Promise<GetAuthenticatedUserResp
  *   phone: '123-456-7890'
  * });
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "id": "user1",
@@ -104,33 +86,28 @@ export declare function getAuthenticatedUser(): Promise<GetAuthenticatedUserResp
  */
 export declare function createCustomerUser(params: CreateCustomerUserParameters): Promise<CreateCustomerUserResponse>;
 /**
- * APICODE(USER-201)
+ * 🚚 **Update Customer User**
+ *
+ * **APICODE(USER-201)**
  * Updates a customer user.
  *
  * This function sends a request to update the details of an existing customer user.
  *
- * @param {UpdateCustomerUserParameters} params - The parameters for updating the user, including:
- * #### firstName - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The first name of the user.
- * #### lastName - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The last name of the user.
- * #### civility - `string`
- *
- * The civility of the user (e.g., Mr., Ms.).
- * #### phone - `string`
- *
- * The phone number of the user.
- * #### customFieldValues - `object`
+ * 🛠 **Endpoint**: `PUT /v1/shop/customer-users`
  *
- * Custom fields for additional user information.
+ * | Parameter          | Type   | Required | Description                                      |
+ * |--------------------|--------|----------|--------------------------------------------------|
+ * | `firstName`        | string | ✅        | The first name of the user.                      |
+ * | `lastName`         | string | ✅        | The last name of the user.                       |
+ * | `civility`         | string | ❌        | The civility of the user (e.g., Mr., Ms.).       |
+ * | `phone`            | string | ❌        | The phone number of the user.                    |
+ * | `customFieldValues`| object | ❌        | Custom fields for additional user information.   |
  *
- * @returns {Promise<UpdateCustomerUserResponse>} - The data of the updated user.
+ * 📤 **Returns**:
+ * A `Promise` resolving to an object containing the updated user's data.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const updatedUser = await updateCustomerUser({
  *   firstName: 'John',
  *   lastName: 'Doe',
@@ -139,7 +116,7 @@ export declare function createCustomerUser(params: CreateCustomerUserParameters)
  *   customFieldValues: {}
  * });
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "detail": "User updated successfully"
@@ -148,24 +125,27 @@ export declare function createCustomerUser(params: CreateCustomerUserParameters)
  */
 export declare function updateCustomerUser({ civility, firstName, lastName, phone, customFieldValues, }: UpdateCustomerUserParameters): Promise<UpdateCustomerUserResponse>;
 /**
- * APICODE(USER-200)
+ * 🚚 **Activate Customer User**
+ *
+ * **APICODE(USER-200)**
  * Activates a customer user.
  *
  * This function sends a request to activate a customer user with a specified token.
  *
- * @param {ActivateCustomerUserParameters} params - The parameters for activating the user, including:
- * #### token - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `POST /v1/shop/customer-users/activate`
  *
- * The activation token of the user.
+ * | Parameter | Type   | Required | Description                                      |
+ * |-----------|--------|----------|--------------------------------------------------|
+ * | `token`   | string | ✅        | The activation token of the user.                |
  *
- * @returns {Promise<void>} - A promise that resolves when the user is activated.
+ * 📤 **Returns**:
+ * A `Promise` resolving when the user is activated.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * await activateCustomerUser({ token: 'activationToken' });
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "detail": "User activated successfully"
@@ -174,30 +154,27 @@ export declare function updateCustomerUser({ civility, firstName, lastName, phon
  */
 export declare function activateCustomerUser(params: ActivateCustomerUserParameters): Promise<void>;
 /**
- * APICODE(USER-501)
+ * 🚚 **Retrieve Customer User Addresses**
+ *
+ * **APICODE(USER-501)**
  * Retrieves customer user addresses.
  *
  * This function sends a request to obtain the addresses associated with a customer user.
  *
- * @param {GetCustomerUserAddressesParameters} params - The parameters for retrieving the addresses, including:
- * #### shipping - `boolean`
- *
- * Indicates whether to retrieve shipping addresses.
- * #### billing - `boolean`
- *
- * Indicates whether to retrieve billing addresses.
- * #### account - `string`
- *
- * The ID of the account for which to retrieve addresses.
- * #### organisationIds - `string[]`
+ * 🛠 **Endpoint**: `GET /v1/shop/customer-users/addresses`
  *
- * An array of organization IDs to filter the addresses.
+ * | Parameter        | Type    | Required | Description                                   |
+ * |------------------|---------|----------|-----------------------------------------------|
+ * | `shipping`       | boolean | ✅        | Indicates whether to retrieve shipping addresses. |
+ * | `billing`        | boolean | ✅        | Indicates whether to retrieve billing addresses. |
+ * | `account`        | string  | ✅        | The ID of the account for which to retrieve addresses. |
+ * | `organisationIds`| string[]| ❌        | An array of organization IDs to filter the addresses. |
  *
- * @returns {Promise<void>} - The addresses of the customer user.
+ * 📤 **Returns**:
+ * A `Promise` resolving to the list of addresses associated with the customer user.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const addresses = await getCustomerUserAddresses({
  *   shipping: true,
  *   billing: false,
@@ -205,7 +182,7 @@ export declare function activateCustomerUser(params: ActivateCustomerUserParamet
  *   organisationIds: ['org1', 'org2']
  * });
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "addresses": [
@@ -219,19 +196,23 @@ export declare function activateCustomerUser(params: ActivateCustomerUserParamet
  */
 export declare function getCustomerUserAddresses({ shipping, billing, account, organisationIds, }: GetCustomerUserAddressesParameters): Promise<void>;
 /**
- * APICODE(USER-502)
+ * 🚚 **Retrieve Customer User Organisations**
+ *
+ * **APICODE(USER-502)**
  * Retrieves customer user organisations.
  *
  * This function sends a request to obtain the organisations associated with a customer user.
  *
- * @returns {Promise<GetCustomerUserOrganisationsResponse>} - The organisations of the customer user.
+ * 🛠 **Endpoint**: `GET /v1/shop/customer-users/organisations`
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to the list of organisations associated with the customer user.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const organisations = await getCustomerUserOrganisations();
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "organisations": [
@@ -249,30 +230,31 @@ export declare function getCustomerUserAddresses({ shipping, billing, account, o
  */
 export declare function getCustomerUserOrganisations(): Promise<GetCustomerUserOrganisationsResponse>;
 /**
- * APICODE(USER-203)
+ * 🚚 **Send Customer User Activation Request**
+ *
+ * **APICODE(USER-203)**
  * Sends a customer user activation request.
  *
  * This function sends a request to resend an activation request to a customer user.
  *
- * @param {SendCustomerUserActivationRequestParameters} params - The parameters for sending the request, including:
- * #### token - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The activation token of the user.
- * #### redirectUrl - `string`
+ * 🛠 **Endpoint**: `POST /v1/shop/customer-users/resend-activation-request`
  *
- * The URL to redirect the user after activation.
+ * | Parameter   | Type   | Required | Description                                      |
+ * |-------------|--------|----------|--------------------------------------------------|
+ * | `token`     | string | ✅        | The activation token of the user.                |
+ * | `redirectUrl`| string | ❌       | The URL to redirect the user after activation.   |
  *
- * @returns {Promise<void>} - A promise that resolves when the request is sent.
+ * 📤 **Returns**:
+ * A `Promise` resolving when the request is sent.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * await sendCustomerUserActivationRequest({
  *   token: 'activationToken',
  *   redirectUrl: 'http://example.com/redirect'
  * });
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "detail": "Activation request sent successfully"