@djust-b2b/djust-front-sdk 1.23.0 → 1.24.0

package/lib/index.d.ts

@@ -101,6 +101,9 @@ export declare const DjustSDK: {
     getCustomerUserAddresses({ shipping, billing, account, organisationIds, }: import("./interfaces").GetCustomerUserAddressesParameters): Promise<void>;
     getCustomerUserOrganisations(): Promise<import("./interfaces").GetCustomerUserOrganisationsResponse>;
     sendCustomerUserActivationRequest({ redirectUrl, token, }: import("./interfaces").SendCustomerUserActivationRequestParameters): Promise<void>;
+    updateSpecificCustomerUser({ userToUpdateId, civility, firstName, lastName, phone, groups, customFieldValues, }: import("./interfaces").UpdateSpecificCustomerUserParameters): Promise<void>;
+    removeAccountsFromCustomerUser({ userToUpdateId, idType, accountIds, }: import("./interfaces").RemoveAccountsFromCustomerUserParameters): Promise<void>;
+    addCustomerUserToAccounts({ userToUpdateId, idType, accountIds, }: import("./interfaces").AddCustomerUserToAccountsParameters): Promise<void>;
     getCustomerAccount(config?: import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").GetCustomerAccountResponse>;
     getCustomerAccountV2(pageable: import("./interfaces/models/common").PageableParameters): Promise<import("./interfaces").GetCustomerAccountResponseV2>;
     createCustomerAccount({ createAddressRequests, createCustomerUserRequest, createObjectCustomerAccountRequest, customFieldValues, customerTagList, fromFO, legalUser, ...config }: import("./interfaces").CreateCustomerAccountParameters & import("./interfaces/models/common").DjustConfig): Promise<import("./interfaces").CreateCustomerAccountResponse>;

package/lib/interfaces/models/customer-account.d.ts

@@ -4,6 +4,7 @@ import { Country } from "./common";
 import { CustomerUserWithoutAccountDto } from "./customer-user";
 import { PaymentType } from "./payment";
 export type CustomerAccountStatus = "ACTIVE" | "INACTIVE" | "WAITING_APPROBATION" | "APPROBATION_REFUSED";
+export type AccountIdType = "DJUST_ID" | "EXTERNAL_ID";
 interface CustomerTagNameableDto {
     id: string;
     name: string;

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

@@ -2,6 +2,7 @@ import { CustomFieldValueRequest } from "../../interfaces/models/custom-field";
 import { CivilityType, UserInfoDto, UserStatus } from "../../interfaces/models/customer-user";
 import { CustomerOrganisationDto } from "../../interfaces/models/customer-organisation";
 import { AddressDto } from "../../interfaces/models/address";
+import { AccountIdType } from "../../interfaces/models/customer-account";
 /**
  * Requests parameters type definitions
  */
@@ -40,6 +41,25 @@ export interface SendCustomerUserActivationRequestParameters {
     redirectUrl?: string;
     token: string;
 }
+export interface UpdateSpecificCustomerUserParameters {
+    userToUpdateId: string;
+    civility: CivilityType;
+    customFieldValues?: CustomFieldValueRequest[];
+    firstName: string;
+    lastName: string;
+    phone?: string;
+    groups?: string[];
+}
+export interface RemoveAccountsFromCustomerUserParameters {
+    userToUpdateId: string;
+    idType?: AccountIdType;
+    accountIds: string[];
+}
+export interface AddCustomerUserToAccountsParameters {
+    userToUpdateId: string;
+    idType?: AccountIdType;
+    accountIds: string[];
+}
 /**
  * Responses type definitions
  */

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

@@ -1,4 +1,4 @@
-import { ActivateCustomerUserParameters, CreateCustomerUserParameters, CreateCustomerUserResponse, GetAuthenticatedUserResponse, GetCustomerUserAddressesParameters, GetCustomerUserOrganisationsResponse, SendCustomerUserActivationRequestParameters, UpdateCustomerUserParameters, UpdateCustomerUserResponse } from "./definitions";
+import { ActivateCustomerUserParameters, AddCustomerUserToAccountsParameters, CreateCustomerUserParameters, CreateCustomerUserResponse, GetAuthenticatedUserResponse, GetCustomerUserAddressesParameters, GetCustomerUserOrganisationsResponse, RemoveAccountsFromCustomerUserParameters, SendCustomerUserActivationRequestParameters, UpdateCustomerUserParameters, UpdateCustomerUserResponse, UpdateSpecificCustomerUserParameters } from "./definitions";
 /**
  * 🚚 **Retrieve Authenticated User**
  *
@@ -89,9 +89,9 @@ export declare function createCustomerUser(params: CreateCustomerUserParameters)
  * 🚚 **Update Customer User**
  *
  * **APICODE(USER-201)**
- * Updates a customer user.
+ * Updates your customer user.
  *
- * This function sends a request to update the details of an existing customer user.
+ * This function sends a request to update the details of the current customer user.
  *
  * 🛠 **Endpoint**: `PUT /v1/shop/customer-users`
  *
@@ -262,3 +262,132 @@ export declare function getCustomerUserOrganisations(): Promise<GetCustomerUserO
  * ```
  */
 export declare function sendCustomerUserActivationRequest({ redirectUrl, token, }: SendCustomerUserActivationRequestParameters): Promise<void>;
+/**
+ * 🚚 **Update Specific Customer User**
+ *
+ * **APICODE(USER-202)**
+ * Updates a specific customer user.
+ *
+ * This function updates the details of a specific user, identified by
+ * the `userToUpdateId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/customer-users/{userToUpdateId}`
+ *
+ * | Parameter          | Type   | Required | Description                                      |
+ * |--------------------|--------|----------|--------------------------------------------------|
+ * | `userToUpdateId`   | string | ✅        | The ID of the user you want to update.           |
+ * | `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.   |
+ * | `groups`           | string[] | ❌      | The groups to which the user belongs.            |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the request is sent.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedUser = await updateCustomerUser({
+ *  "userToUpdateId": "user1"
+    "civility": "MR",
+    "customFieldValues": [
+      {
+        "customFieldId": "string",
+        "customFieldValue": "string"
+      }
+    ],
+    "firstName": "string",
+    "groups": [
+      "string"
+    ],
+    "lastName": "string",
+    "phone": "+1 6884-2243 27"
+  });
+ * ```
+ * #### Output
+ * ```json
+ * {
+ *   "detail": "User updated successfully"
+ * }
+ * ```
+ */
+export declare function updateSpecificCustomerUser({ userToUpdateId, civility, firstName, lastName, phone, groups, customFieldValues, }: UpdateSpecificCustomerUserParameters): Promise<void>;
+/**
+ * 🚚 **Remove Accounts from User**
+ *
+ * **APICODE(USER-350)**
+ * Removes accounts from a specific customer user.
+ *
+ * This function removes accounts of a specific user, identified by
+ * the `userToUpdateId`. The parameters `userToUpdateId` and `accountIds` are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `DELETE /v1/shop/customer-users/{userToUpdateId}/customer-accounts`
+ *
+ * | Parameter          | Type   | Required | Description                                      |
+ * |--------------------|--------|----------|--------------------------------------------------|
+ * | `userToUpdateId`   | string | ✅        | The ID of the user you want to update.           |
+ * | `idType`           | `AccountIdType`| ❌ | The type of account ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
+ * | `accountIds`       | string[] | ✅      | The first name of the user.                      |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the request is sent.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedUser = await updateCustomerUser({
+ *  "userToUpdateId": "user1",
+ *  "idType": "EXTERNAL_ID",
+    "accountIds": ["account1", "account2", ...],
+  });
+ * ```
+ * #### Output
+ * ```json
+ * {
+ *   "detail": "User successfully removed from accounts"
+ * }
+ * ```
+ */
+export declare function removeAccountsFromCustomerUser({ userToUpdateId, idType, accountIds, }: RemoveAccountsFromCustomerUserParameters): Promise<void>;
+/**
+ * 🚚 **Add User to Accounts**
+ *
+ * **APICODE(USER-250)**
+ * Add specific user to accounts.
+ *
+ * This function removes accounts of a specific user, identified by
+ * the `userToUpdateId`. The parameters `userToUpdateId` and `accountIds` are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PATCH /v1/shop/customer-users/{userToUpdateId}/customer-accounts`
+ *
+ * | Parameter          | Type   | Required | Description                                      |
+ * |--------------------|--------|----------|--------------------------------------------------|
+ * | `userToUpdateId`   | string | ✅        | The ID of the user you want to update.           |
+ * | `idType`           | `AccountIdType`| ❌ | The type of account ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
+ * | `accountIds`       | string[] | ✅      | The first name of the user.                      |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the request is sent.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedUser = await updateCustomerUser({
+ *  "userToUpdateId": "user1",
+ *  "idType": "EXTERNAL_ID",
+    "accountIds": ["account1", "account2", ...],
+  });
+ * ```
+ * #### Output
+ * ```json
+ * {
+ *   "detail": "User successfully added to accounts"
+ * }
+ * ```
+ */
+export declare function addCustomerUserToAccounts({ userToUpdateId, idType, accountIds, }: AddCustomerUserToAccountsParameters): Promise<void>;

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

@@ -7,6 +7,9 @@ exports.activateCustomerUser = activateCustomerUser;
 exports.getCustomerUserAddresses = getCustomerUserAddresses;
 exports.getCustomerUserOrganisations = getCustomerUserOrganisations;
 exports.sendCustomerUserActivationRequest = sendCustomerUserActivationRequest;
+exports.updateSpecificCustomerUser = updateSpecificCustomerUser;
+exports.removeAccountsFromCustomerUser = removeAccountsFromCustomerUser;
+exports.addCustomerUserToAccounts = addCustomerUserToAccounts;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
@@ -128,9 +131,9 @@ async function createCustomerUser(params) {
  * 🚚 **Update Customer User**
  *
  * **APICODE(USER-201)**
- * Updates a customer user.
+ * Updates your customer user.
  *
- * This function sends a request to update the details of an existing customer user.
+ * This function sends a request to update the details of the current customer user.
  *
  * 🛠 **Endpoint**: `PUT /v1/shop/customer-users`
  *
@@ -353,3 +356,169 @@ async function sendCustomerUserActivationRequest({ redirectUrl, token, }) {
         }),
     });
 }
+/**
+ * 🚚 **Update Specific Customer User**
+ *
+ * **APICODE(USER-202)**
+ * Updates a specific customer user.
+ *
+ * This function updates the details of a specific user, identified by
+ * the `userToUpdateId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/customer-users/{userToUpdateId}`
+ *
+ * | Parameter          | Type   | Required | Description                                      |
+ * |--------------------|--------|----------|--------------------------------------------------|
+ * | `userToUpdateId`   | string | ✅        | The ID of the user you want to update.           |
+ * | `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.   |
+ * | `groups`           | string[] | ❌      | The groups to which the user belongs.            |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the request is sent.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedUser = await updateCustomerUser({
+ *  "userToUpdateId": "user1"
+    "civility": "MR",
+    "customFieldValues": [
+      {
+        "customFieldId": "string",
+        "customFieldValue": "string"
+      }
+    ],
+    "firstName": "string",
+    "groups": [
+      "string"
+    ],
+    "lastName": "string",
+    "phone": "+1 6884-2243 27"
+  });
+ * ```
+ * #### Output
+ * ```json
+ * {
+ *   "detail": "User updated successfully"
+ * }
+ * ```
+ */
+async function updateSpecificCustomerUser({ userToUpdateId, civility, firstName, lastName, phone, groups, customFieldValues, }) {
+    (0, parameters_validation_1.required)({ userToUpdateId, civility, firstName, lastName });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v1/shop/customer-users/${userToUpdateId}`,
+        body: JSON.stringify({
+            civility,
+            firstName,
+            lastName,
+            phone,
+            groups,
+            customFieldValues,
+        }),
+    });
+    return data;
+}
+/**
+ * 🚚 **Remove Accounts from User**
+ *
+ * **APICODE(USER-350)**
+ * Removes accounts from a specific customer user.
+ *
+ * This function removes accounts of a specific user, identified by
+ * the `userToUpdateId`. The parameters `userToUpdateId` and `accountIds` are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `DELETE /v1/shop/customer-users/{userToUpdateId}/customer-accounts`
+ *
+ * | Parameter          | Type   | Required | Description                                      |
+ * |--------------------|--------|----------|--------------------------------------------------|
+ * | `userToUpdateId`   | string | ✅        | The ID of the user you want to update.           |
+ * | `idType`           | `AccountIdType`| ❌ | The type of account ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
+ * | `accountIds`       | string[] | ✅      | The first name of the user.                      |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the request is sent.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedUser = await updateCustomerUser({
+ *  "userToUpdateId": "user1",
+ *  "idType": "EXTERNAL_ID",
+    "accountIds": ["account1", "account2", ...],
+  });
+ * ```
+ * #### Output
+ * ```json
+ * {
+ *   "detail": "User successfully removed from accounts"
+ * }
+ * ```
+ */
+async function removeAccountsFromCustomerUser({ userToUpdateId, idType, accountIds, }) {
+    (0, parameters_validation_1.required)({ userToUpdateId, accountIds });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "DELETE",
+        path: `/v1/shop/customer-users/${userToUpdateId}/customer-accounts`,
+        body: JSON.stringify(accountIds),
+        params: {
+            idType,
+        },
+    });
+    return data;
+}
+/**
+ * 🚚 **Add User to Accounts**
+ *
+ * **APICODE(USER-250)**
+ * Add specific user to accounts.
+ *
+ * This function removes accounts of a specific user, identified by
+ * the `userToUpdateId`. The parameters `userToUpdateId` and `accountIds` are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PATCH /v1/shop/customer-users/{userToUpdateId}/customer-accounts`
+ *
+ * | Parameter          | Type   | Required | Description                                      |
+ * |--------------------|--------|----------|--------------------------------------------------|
+ * | `userToUpdateId`   | string | ✅        | The ID of the user you want to update.           |
+ * | `idType`           | `AccountIdType`| ❌ | The type of account ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
+ * | `accountIds`       | string[] | ✅      | The first name of the user.                      |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the request is sent.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedUser = await updateCustomerUser({
+ *  "userToUpdateId": "user1",
+ *  "idType": "EXTERNAL_ID",
+    "accountIds": ["account1", "account2", ...],
+  });
+ * ```
+ * #### Output
+ * ```json
+ * {
+ *   "detail": "User successfully added to accounts"
+ * }
+ * ```
+ */
+async function addCustomerUserToAccounts({ userToUpdateId, idType, accountIds, }) {
+    (0, parameters_validation_1.required)({ userToUpdateId, accountIds });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "PATCH",
+        path: `/v1/shop/customer-users/${userToUpdateId}/customer-accounts`,
+        body: JSON.stringify(accountIds),
+        params: {
+            idType,
+        },
+    });
+    return data;
+}

package/package.json

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