@djust-b2b/djust-front-sdk 2.15.3 → 2.16.1

package/lib/services/customer-account/definitions.d.ts

@@ -53,9 +53,9 @@ export interface GetCustomerAccountOrdersParameters {
     nbPreviewLines?: number;
     logisticOrderStatuses?: string[];
     /**
-     * @deprecated
+     * @deprecated Use logisticOrderStatuses instead
      */
-    orderLogisticStatusType: string;
+    orderLogisticStatusType?: string;
 }
 export interface GetCustomerAccountUsersParameters {
     pageable: PageableParameters;

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

@@ -20,6 +20,7 @@ export declare function getCustomerAccount(config?: DjustConfig): Promise<GetCus
 /**
  * 📋 Get customer accounts.
  *
+ * This function retrieves a paginated list of customer accounts.
  *
  * 🛠 **Endpoint**: `GET /v2/shop/customer-accounts`
  *
@@ -28,18 +29,17 @@ export declare function getCustomerAccount(config?: DjustConfig): Promise<GetCus
  * | `pageable`           | `object`   | ❌          | The pagination parameters to retrieve paginated results.                 |
  *
  * 📤 **Returns**:
- * A `Promise<GetCustomerAccountResponseV2>`.
+ * A `Promise<GetCustomerAccountResponseV2>` containing the paginated list of customer accounts.
  *
- * 🛠 **Example Usage**:
+ * 🛠 **Example usage**:
  * ```typescript
- * const orders = await getCustomerAccountV2({
- *   pageable: { page: 1, size: 10 },
+ * const accounts = await getCustomerAccountV2({
+ *   pageable: { page: 0, size: 20 },
  * });
+ * console.log(accounts);
  * ```
  *
- * @param {GetCustomerAccountParametersV2} params - The parameters for fetching customer accounts:
- *   - `pageable` - Pagination parameters.
- *
+ * @param {PageableParameters} pageable - The pagination parameters.
  * @returns {Promise<GetCustomerAccountResponseV2>} - The response containing the customer accounts.
  */
 export declare function getCustomerAccountV2(pageable: PageableParameters): Promise<GetCustomerAccountResponseV2>;
@@ -123,6 +123,13 @@ export declare function createCustomerAccount({ createAddressRequests, createCus
  * 📤 **Returns**:
  * A `Promise<UpdateCustomerAccountResponse>` containing the updated customer account details.
  *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await updateCustomerAccount({
+ *   name: "Updated Company Name",
+ *   accountManager: "John Doe",
+ *   vatNumber: "FR12345678901",
+ * });
  * console.log(response);
  * ```
  */
@@ -300,12 +307,9 @@ export declare function getCustomerAccountCustomFields({ customFieldIds, idType,
  * |----------------------|------------|--------------|---------------------------------------------------------------------------|
  * | `pageable`           | `object`   | ✅           | The pagination parameters to retrieve paginated results.                 |
  * | `locale`             | `string`   | ✅           | The locale to be used for the response.                                  |
- * | `nbPreviewLines`     | `number`   | ❌           | The number of order lines to retrieve by orders.                         |
+ * | `nbPreviewLines`     | `number`   | ❌           | The number of order lines to retrieve by orders (default: 100).          |
  * | `logisticOrderStatuses`| `string[]`| ❌          | The statuses of the orders to retrieve.                                  |
- * | `orderLogisticStatusType`| `string`| ❌          | The statuses of the orders to retrieve (deprecated).                                  |
- * | `includeInactive`    | `boolean`  | ❌           | Whether to include inactive orders in the response.                      |
- * | `limit`              | `number`   | ❌           | The maximum number of orders to return.                                  |
- * | `offset`             | `number`   | ❌           | The number of orders to skip before starting to collect results.         |
+ * | `orderLogisticStatusType`| `string`| ❌          | The status of the orders to retrieve (deprecated, use logisticOrderStatuses instead). |
  *
  * 📤 **Returns**:
  * A `Promise<GetCustomerAccountOrdersResponse>` containing the retrieved customer account orders.
@@ -313,50 +317,48 @@ export declare function getCustomerAccountCustomFields({ customFieldIds, idType,
  * 🛠 **Example Usage**:
  * ```typescript
  * const orders = await getCustomerAccountOrders({
- *   pageable: { page: 1, size: 10 },
+ *   pageable: { page: 0, size: 20, sort: ['createdAt,DESC'] },
  *   locale: 'en',
- *   nbPreviewLines: 10,
+ *   nbPreviewLines: 100,
  *   logisticOrderStatuses: ["ORDER_CREATED", "WAITING_CUSTOMER_APPROVAL"],
  * });
  * ```
  *
  * @param {GetCustomerAccountOrdersParameters} params - The parameters for fetching customer account orders:
- *   - `pageable` - Pagination parameters.
+ *   - `pageable` - Pagination parameters (page, size, sort).
  *   - `locale` - The locale for the response.
- *   - `nbPreviewLines` (optional) - Number of order lines to put in the response.
- *   - `logisticOrderStatuses` (optional) - Statuses of the orders to retrieve.
- *   - `orderLogisticStatusType` (deprecated) - Statuses of the orders to retrieve.
- *   - `includeInactive` (optional) - Whether to include inactive orders.
- *   - `limit` (optional) - The maximum number of orders to return.
- *   - `offset` (optional) - The number of orders to skip before collecting results.
+ *   - `nbPreviewLines` (optional) - Number of order lines to put in the response (default: 100).
+ *   - `logisticOrderStatuses` (optional) - Array of statuses of the orders to retrieve.
+ *   - `orderLogisticStatusType` (optional, deprecated) - Single status of the orders to retrieve. Use logisticOrderStatuses instead.
  *
  * @returns {Promise<GetCustomerAccountOrdersResponse>} - The response containing the customer account orders.
  */
 export declare function getCustomerAccountOrders(params: GetCustomerAccountOrdersParameters & DjustConfig): Promise<GetCustomerAccountOrdersResponse>;
 /**
- * ## Retrieve Customer Account Users
+ * 📋 Retrieve Customer Account Users
  *
  * This function retrieves the list of users associated with a specific customer account.
  *
- * ### API Code: ACCOUNT-502
- *
- * ### **Endpoint**: `GET /v1/shop/customer-accounts/users`
+ * 🛠 **Endpoint**: `GET /v1/shop/customer-accounts/users` [ACCOUNT-502]
  *
  * | **Parameter**     | **Type**   | **Required** | **Description**                                             |
  * |-------------------|------------|--------------|-------------------------------------------------------------|
  * | `pageable`        | `object`   | ✅           | Object containing pagination details: `page`, `size`, etc. |
  * | `forAllAccounts`  | `boolean`  | ❌           | Specifies if we want to retrieve users of all my users' accounts  |
+ * | `query`           | `string`   | ❌           | Search query to filter users.                                |
  * | `locale`          | `string`   | ❌           | The locale in which data should be retrieved.               |
  *
- * ### **Returns**:
+ * 📤 **Returns**:
  * A `Promise<GetCustomerAccountUsersResponse>` containing the list of users and pagination metadata.
  *
- * ### **Example Usage**:
+ * 🛠 **Example usage**:
  * ```typescript
  * const response = await getCustomerAccountUsers({
- *   pageable: { page: 1, size: 10 },
- *   locale: "en-US",
+ *   pageable: { page: 0, size: 20 },
+ *   locale: "fr-FR",
+ *   query: "john",
  * });
+ * console.log(response);
  * ```
  */
 export declare function getCustomerAccountUsers(params: GetCustomerAccountUsersParameters & DjustConfig): Promise<GetCustomerAccountUsersResponse>;

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

@@ -49,6 +49,7 @@ async function getCustomerAccount(config) {
 /**
  * 📋 Get customer accounts.
  *
+ * This function retrieves a paginated list of customer accounts.
  *
  * 🛠 **Endpoint**: `GET /v2/shop/customer-accounts`
  *
@@ -57,18 +58,17 @@ async function getCustomerAccount(config) {
  * | `pageable`           | `object`   | ❌          | The pagination parameters to retrieve paginated results.                 |
  *
  * 📤 **Returns**:
- * A `Promise<GetCustomerAccountResponseV2>`.
+ * A `Promise<GetCustomerAccountResponseV2>` containing the paginated list of customer accounts.
  *
- * 🛠 **Example Usage**:
+ * 🛠 **Example usage**:
  * ```typescript
- * const orders = await getCustomerAccountV2({
- *   pageable: { page: 1, size: 10 },
+ * const accounts = await getCustomerAccountV2({
+ *   pageable: { page: 0, size: 20 },
  * });
+ * console.log(accounts);
  * ```
  *
- * @param {GetCustomerAccountParametersV2} params - The parameters for fetching customer accounts:
- *   - `pageable` - Pagination parameters.
- *
+ * @param {PageableParameters} pageable - The pagination parameters.
  * @returns {Promise<GetCustomerAccountResponseV2>} - The response containing the customer accounts.
  */
 async function getCustomerAccountV2(pageable) {
@@ -188,6 +188,13 @@ async function createCustomerAccount({ createAddressRequests, createCustomerUser
  * 📤 **Returns**:
  * A `Promise<UpdateCustomerAccountResponse>` containing the updated customer account details.
  *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await updateCustomerAccount({
+ *   name: "Updated Company Name",
+ *   accountManager: "John Doe",
+ *   vatNumber: "FR12345678901",
+ * });
  * console.log(response);
  * ```
  */
@@ -441,12 +448,9 @@ async function getCustomerAccountCustomFields({ customFieldIds, idType, pageable
  * |----------------------|------------|--------------|---------------------------------------------------------------------------|
  * | `pageable`           | `object`   | ✅           | The pagination parameters to retrieve paginated results.                 |
  * | `locale`             | `string`   | ✅           | The locale to be used for the response.                                  |
- * | `nbPreviewLines`     | `number`   | ❌           | The number of order lines to retrieve by orders.                         |
+ * | `nbPreviewLines`     | `number`   | ❌           | The number of order lines to retrieve by orders (default: 100).          |
  * | `logisticOrderStatuses`| `string[]`| ❌          | The statuses of the orders to retrieve.                                  |
- * | `orderLogisticStatusType`| `string`| ❌          | The statuses of the orders to retrieve (deprecated).                                  |
- * | `includeInactive`    | `boolean`  | ❌           | Whether to include inactive orders in the response.                      |
- * | `limit`              | `number`   | ❌           | The maximum number of orders to return.                                  |
- * | `offset`             | `number`   | ❌           | The number of orders to skip before starting to collect results.         |
+ * | `orderLogisticStatusType`| `string`| ❌          | The status of the orders to retrieve (deprecated, use logisticOrderStatuses instead). |
  *
  * 📤 **Returns**:
  * A `Promise<GetCustomerAccountOrdersResponse>` containing the retrieved customer account orders.
@@ -454,22 +458,19 @@ async function getCustomerAccountCustomFields({ customFieldIds, idType, pageable
  * 🛠 **Example Usage**:
  * ```typescript
  * const orders = await getCustomerAccountOrders({
- *   pageable: { page: 1, size: 10 },
+ *   pageable: { page: 0, size: 20, sort: ['createdAt,DESC'] },
  *   locale: 'en',
- *   nbPreviewLines: 10,
+ *   nbPreviewLines: 100,
  *   logisticOrderStatuses: ["ORDER_CREATED", "WAITING_CUSTOMER_APPROVAL"],
  * });
  * ```
  *
  * @param {GetCustomerAccountOrdersParameters} params - The parameters for fetching customer account orders:
- *   - `pageable` - Pagination parameters.
+ *   - `pageable` - Pagination parameters (page, size, sort).
  *   - `locale` - The locale for the response.
- *   - `nbPreviewLines` (optional) - Number of order lines to put in the response.
- *   - `logisticOrderStatuses` (optional) - Statuses of the orders to retrieve.
- *   - `orderLogisticStatusType` (deprecated) - Statuses of the orders to retrieve.
- *   - `includeInactive` (optional) - Whether to include inactive orders.
- *   - `limit` (optional) - The maximum number of orders to return.
- *   - `offset` (optional) - The number of orders to skip before collecting results.
+ *   - `nbPreviewLines` (optional) - Number of order lines to put in the response (default: 100).
+ *   - `logisticOrderStatuses` (optional) - Array of statuses of the orders to retrieve.
+ *   - `orderLogisticStatusType` (optional, deprecated) - Single status of the orders to retrieve. Use logisticOrderStatuses instead.
  *
  * @returns {Promise<GetCustomerAccountOrdersResponse>} - The response containing the customer account orders.
  */
@@ -485,34 +486,36 @@ async function getCustomerAccountOrders(params) {
             locale: params.locale,
             nbPreviewLines: params.nbPreviewLines,
             logisticOrderStatuses: params.logisticOrderStatuses,
+            orderLogisticStatusType: params.orderLogisticStatusType,
         },
     });
     return data;
 }
 /**
- * ## Retrieve Customer Account Users
+ * 📋 Retrieve Customer Account Users
  *
  * This function retrieves the list of users associated with a specific customer account.
  *
- * ### API Code: ACCOUNT-502
- *
- * ### **Endpoint**: `GET /v1/shop/customer-accounts/users`
+ * 🛠 **Endpoint**: `GET /v1/shop/customer-accounts/users` [ACCOUNT-502]
  *
  * | **Parameter**     | **Type**   | **Required** | **Description**                                             |
  * |-------------------|------------|--------------|-------------------------------------------------------------|
  * | `pageable`        | `object`   | ✅           | Object containing pagination details: `page`, `size`, etc. |
  * | `forAllAccounts`  | `boolean`  | ❌           | Specifies if we want to retrieve users of all my users' accounts  |
+ * | `query`           | `string`   | ❌           | Search query to filter users.                                |
  * | `locale`          | `string`   | ❌           | The locale in which data should be retrieved.               |
  *
- * ### **Returns**:
+ * 📤 **Returns**:
  * A `Promise<GetCustomerAccountUsersResponse>` containing the list of users and pagination metadata.
  *
- * ### **Example Usage**:
+ * 🛠 **Example usage**:
  * ```typescript
  * const response = await getCustomerAccountUsers({
- *   pageable: { page: 1, size: 10 },
- *   locale: "en-US",
+ *   pageable: { page: 0, size: 20 },
+ *   locale: "fr-FR",
+ *   query: "john",
  * });
+ * console.log(response);
  * ```
  */
 async function getCustomerAccountUsers(params) {

package/lib/settings/fetch-instance.js

@@ -97,13 +97,17 @@ const isClientInitialized = (config) => "apiKey" in config && "clientId" in conf
 const serializeParams = (params, useRepeat) => {
     if (useRepeat) {
         return Object.keys(params)
+            .filter((key) => params[key] !== undefined && params[key] !== null)
             .map((key) => Array.isArray(params[key])
             ? params[key]
+                .filter((val) => val !== undefined && val !== null)
                 .map((val) => `${encodeURIComponent(key)}=${encodeURIComponent(val)}`)
                 .join("&")
             : `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`)
+            .filter(Boolean)
             .join("&");
     }
+    // Use "bracket" format for arrays by default (e.g., logisticStatus[]=VALUE1&logisticStatus[]=VALUE2)
     return qs.stringify(params, { arrayFormat: "bracket", skipNull: true });
 };
 const isTokenValid = (token) => {
@@ -153,7 +157,8 @@ const enhancedFetch = async ({ path, method, params = {}, body, }) => {
         headers.forEach((value, key) => requestHeaders.append(key, value));
     }
     let fullPath = `${clientConfig.baseUrl}${path}`;
-    const useRepeatFormat = path.includes("search");
+    // Use repeat format for search endpoints and customer-accounts/orders endpoint
+    const useRepeatFormat = path.includes("search") || path.includes("/customer-accounts/orders");
     if (params) {
         const urlParams = serializeParams(params, useRepeatFormat);
         fullPath += `?${urlParams}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djust-b2b/djust-front-sdk",
-  "version": "2.15.3",
+  "version": "2.16.1",
   "description": "DJUST Front SDK is a versatile JavaScript Software Development Kit (SDK)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",