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

package/lib/services/customer-user/index.js

@@ -1,9 +1,4 @@
 "use strict";
-/**
- * @packageDocumentation
- *
- * @document documents/customer-user.md
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAuthenticatedUser = getAuthenticatedUser;
 exports.createCustomerUser = createCustomerUser;
@@ -15,19 +10,27 @@ exports.sendCustomerUserActivationRequest = sendCustomerUserActivationRequest;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * 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",
@@ -43,57 +46,36 @@ async function getAuthenticatedUser() {
     return data;
 }
 /**
- * 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',
@@ -110,7 +92,7 @@ async function getAuthenticatedUser() {
  *   phone: '123-456-7890'
  * });
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "id": "user1",
@@ -143,33 +125,28 @@ async function createCustomerUser(params) {
     return data;
 }
 /**
- * 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',
@@ -178,7 +155,7 @@ async function createCustomerUser(params) {
  *   customFieldValues: {}
  * });
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "detail": "User updated successfully"
@@ -201,24 +178,27 @@ async function updateCustomerUser({ civility, firstName, lastName, phone, custom
     return data;
 }
 /**
- * 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"
@@ -237,30 +217,27 @@ async function activateCustomerUser(params) {
     });
 }
 /**
- * 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,
@@ -268,7 +245,7 @@ async function activateCustomerUser(params) {
  *   organisationIds: ['org1', 'org2']
  * });
  * ```
- * #### output
+ * #### Output
  * ```json
  * {
  *   "addresses": [
@@ -294,19 +271,23 @@ async function getCustomerUserAddresses({ shipping, billing, account, organisati
     return data;
 }
 /**
- * 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": [
@@ -330,30 +311,31 @@ async function getCustomerUserOrganisations() {
     return data;
 }
 /**
- * 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"

package/lib/services/navigation-category/index.d.ts

@@ -1,132 +1,81 @@
 import { GetNavigationCategoriesParameters, GetNavigationCategoriesResponse, GetNavigationCategoryBreadcrumbsParameters, GetNavigationCategoryBreadcrumbsResponse, GetNavigationCategoryParameters, GetNavigationCategoryResponse } from "./definitions";
 /**
- * ## Get all navigation categories
- * ### APICODE(NAVCAT-550)
- * @returns {Promise<GetNavigationCategoriesResponse>} - The response with the navigation categories
- *
- * @example
- * ### input
- * ```typescript
- * const response = await getNavigationCategories({ locale: 'string' });
+ * 📄 Gets all navigation categories.
+ *
+ * Retrieves a list of all navigation categories available for the shop.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/navigation-category/online`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `locale`              | `string`                       | ✅         | Locale of the navigation categories to fetch.                |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetNavigationCategoriesResponse>` containing a list of navigation categories.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const categories = await getNavigationCategories({
+ *   locale: 'en-US',
+ * });
+ *
+ * console.log(categories);
  * ```
- * ### output
- * Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * [
- *   {
- *      "active": true,
- *      "childrenCategories": [
- *        string
- *      ],
- *      "customFieldValues": [
- *        {
- *          "customField": {
- *            "externalId": "string",
- *            "id": "string",
- *            "name": {
- *              "additionalProp1": "string",
- *              "additionalProp2": "string",
- *              "additionalProp3": "string"
- *            },
- *            "type": "LONG_TEXT"
- *          },
- *          "value": {}
- *        }
- *      ],
- *      "externalId": "string",
- *      "id": "string",
- *      "name": "string"
- *    }
- * ]
  */
 export declare function getNavigationCategories({ locale, }: GetNavigationCategoriesParameters): Promise<GetNavigationCategoriesResponse>;
 /**
- * ## Get navigation category
- * ### APICODE(NAVCAT-501)
- * @param {GetNavigationCategoryParameters} params - The parameters for the function
- * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
- * #### idType - `string` | <strong style={{ color: 'red' }}>required</strong>
- * #### navigationCategoryId - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * @returns {Promise<GetNavigationCategoryResponse>} - The response with the navigation category
- *
- * @example
- * ### input
- * ```typescript
- * const response = await getNavigationCategory({ locale: 'string', idType: 'string', navigationCategoryId: 'string' });
+ * 📄 Gets a specific navigation category.
+ *
+ * Retrieves a specific navigation category based on its ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/navigation-category/{navigationCategoryId}`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `locale`              | `string`                       | ✅         | Locale of the navigation category.                            |
+ * | `idType`              | `string`                       | ✅         | Type of the ID used to identify the category (e.g., `id`, `slug`). |
+ * | `navigationCategoryId`| `string`                       | ✅         | ID of the navigation category to fetch.                       |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetNavigationCategoryResponse>` containing the specific navigation category.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const category = await getNavigationCategory({
+ *   locale: 'en-US',
+ *   idType: 'id',
+ *   navigationCategoryId: '123',
+ * });
+ *
+ * console.log(category);
  * ```
- * ### output
- * Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "active": true,
- *   "childrenCategories": [
- *     string
- *   ],
- *   "customFieldValues": [
- *     {
- *       "customField": {
- *         "externalId": "string",
- *         "id": "string",
- *         "name": {
- *           "additionalProp1": "string",
- *           "additionalProp2": "string",
- *           "additionalProp3": "string"
- *         },
- *         "type": "LONG_TEXT"
- *       },
- *       "value": {}
- *     }
- *   ],
- *   "externalId": "string",
- *   "id": "string",
- *   "name": "string",
- * }
  */
 export declare function getNavigationCategory({ locale, idType, navigationCategoryId, }: GetNavigationCategoryParameters): Promise<GetNavigationCategoryResponse>;
 /**
- * ## Get navigation category breadcrumbs
- * ### APICODE(NAVCAT-502)
- * @param {GetNavigationCategoryBreadcrumbsParameters} params - The parameters for the function
- * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
- * #### idType - `string` | <strong style={{ color: 'red' }}>required</strong>
- * #### navigationCategoryId - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * @returns {Promise<GetNavigationCategoryBreadcrumbsResponse>} - The response with the navigation category breadcrumbs
- *
- * @example
- * ### input
- * ```typescript
- * const response = await getNavigationCategoryBreadcrumbs({ locale: 'string', idType: 'string', navigationCategoryId: 'string' });
+ * 📄 Gets breadcrumbs for a specific navigation category.
+ *
+ * Retrieves the breadcrumb trail for a specific navigation category, showing its hierarchy.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/navigation-category/{navigationCategoryId}/breadcrumb`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `locale`              | `string`                       | ✅         | Locale of the navigation category breadcrumbs.               |
+ * | `idType`              | `string`                       | ✅         | Type of the ID used to identify the category (e.g., `id`, `slug`). |
+ * | `navigationCategoryId`| `string`                       | ✅         | ID of the navigation category to fetch breadcrumbs for.      |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetNavigationCategoryBreadcrumbsResponse>` containing the breadcrumb trail for the navigation category.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const breadcrumbs = await getNavigationCategoryBreadcrumbs({
+ *   locale: 'en-US',
+ *   idType: 'id',
+ *   navigationCategoryId: '123',
+ * });
+ *
+ * console.log(breadcrumbs);
  * ```
- * ### output
- * Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * [
- *   {
- *     "active": true,
- *     "childrenCategories": [
- *       string
- *     ],
- *     "customFieldValues": [
- *       {
- *         "customField": {
- *           "externalId": "string",
- *           "id": "string",
- *           "name": {
- *             "additionalProp1": "string",
- *             "additionalProp2": "string",
- *             "additionalProp3": "string"
- *           },
- *           "type": "LONG_TEXT"
- *         },
- *         "value": {}
- *       }
- *     ],
- *     "externalId": "string",
- *     "id": "string",
- *     "name": "string",
- *     "parent": "string"
- *   }
  */
 export declare function getNavigationCategoryBreadcrumbs({ locale, idType, navigationCategoryId, }: GetNavigationCategoryBreadcrumbsParameters): Promise<GetNavigationCategoryBreadcrumbsResponse>;