@linagora/ldap-rest-client 1.0.5 → 1.0.6

package/README.md

@@ -38,8 +38,11 @@ const client = new LdapRestClient({
   baseUrl: 'https://ldap-rest.example.com',
 });
 
-// Manage users in organization (returns baseDN)
-const { baseDN } = await client.organizations.createUser(orgId, userData);
+// Manage users in organization (returns User object)
+const user = await client.organizations.createUser(orgId, userData);
+console.log(user._id); // Access unique identifier
+console.log(user.organizationId); // Access organization ID
+
 await client.organizations.listUsers(orgId, { page: 1, limit: 20 });
 
 // Manage groups (returns Group object)
@@ -79,11 +82,12 @@ client.organizations.transferOwnership(orgId, { newOwnerUsername })
 
 ### B2B Users (within Organizations)
 ```typescript
-// Returns baseDN of created user
-const { baseDN } = await client.organizations.createUser(orgId, userData)
+// Returns full User object with _id and organizationId
+const user = await client.organizations.createUser(orgId, userData)
+console.log(user._id, user.organizationId)
 
-// Returns User object or { success: true }
-const result = await client.organizations.updateUser(orgId, userId, updates)
+// Returns updated User object or { success: true }
+const updatedUser = await client.organizations.updateUser(orgId, userId, updates)
 
 client.organizations.disableUser(orgId, userId)
 client.organizations.deleteUser(orgId, userId)

package/dist/index.d.mts

@@ -385,6 +385,8 @@ interface User {
     recoveryEmail?: string;
     /** Timestamp when password account was locked */
     pwdAccountLockedTime?: string;
+    /** Organization ID for B2B users */
+    organizationId?: string;
     /** User's role in Twake organization ('owner', 'admin', 'moderator', 'member') */
     twakeOrganizationRole?: string;
     /** Full name as a single string */
@@ -565,11 +567,9 @@ interface ListUsersResponse {
 }
 /**
  * Response from creating a B2B user in an organization
+ * Returns the full user object with all fields populated
  */
-interface CreateB2BUserResponse {
-    /** Base DN of the created user */
-    baseDN: string;
-}
+type CreateB2BUserResponse = User;
 
 /**
  * Organization domain model representing a B2B organization
@@ -1139,7 +1139,7 @@ declare class OrganizationsResource extends BaseResource {
      *
      * @param {string} organizationId - Organization identifier
      * @param {CreateUserRequest} data - User data including credentials and profile
-     * @returns {Promise<CreateB2BUserResponse>} Response with user's baseDN
+     * @returns {Promise<CreateB2BUserResponse>} The created user object with all fields populated
      * @throws {ForbiddenError} When user lacks admin privileges
      * @throws {NotFoundError} When organization is not found
      * @throws {ConflictError} When username/email/phone already exists
@@ -1147,11 +1147,12 @@ declare class OrganizationsResource extends BaseResource {
      *
      * @example
      * ```typescript
-     * const result = await client.organizations.createUser('org_abc123', {
+     * const user = await client.organizations.createUser('org_abc123', {
      *   cn: 'john.doe',
      *   uid: 'john.doe',
      *   // ... other user fields
      * });
+     * console.log(user._id); // Access the user's unique identifier
      * ```
      */
     createUser: (organizationId: string, data: CreateUserRequest) => Promise<CreateB2BUserResponse>;
@@ -1163,16 +1164,17 @@ declare class OrganizationsResource extends BaseResource {
      * @param {string} organizationId - Organization identifier
      * @param {string} userId - User identifier (username)
      * @param {UpdateUserRequest} data - Fields to update
-     * @returns {Promise<User | { success: true }>} Updated user object or success response
+     * @returns {Promise<User | { success: true }>} The updated user object with all fields populated
      * @throws {NotFoundError} When user or organization is not found
      * @throws {ForbiddenError} When user lacks admin privileges
      * @throws {ApiError} On other API errors
      *
      * @example
      * ```typescript
-     * const result = await client.organizations.updateUser('org_abc123', 'john.doe', {
+     * const user = await client.organizations.updateUser('org_abc123', 'john.doe', {
      *   mobile: '+33687654321'
      * });
+     * console.log(user); // Access the updated user object
      * ```
      */
     updateUser: (organizationId: string, userId: string, data: UpdateUserRequest) => Promise<User | {

package/dist/index.d.ts

@@ -385,6 +385,8 @@ interface User {
     recoveryEmail?: string;
     /** Timestamp when password account was locked */
     pwdAccountLockedTime?: string;
+    /** Organization ID for B2B users */
+    organizationId?: string;
     /** User's role in Twake organization ('owner', 'admin', 'moderator', 'member') */
     twakeOrganizationRole?: string;
     /** Full name as a single string */
@@ -565,11 +567,9 @@ interface ListUsersResponse {
 }
 /**
  * Response from creating a B2B user in an organization
+ * Returns the full user object with all fields populated
  */
-interface CreateB2BUserResponse {
-    /** Base DN of the created user */
-    baseDN: string;
-}
+type CreateB2BUserResponse = User;
 
 /**
  * Organization domain model representing a B2B organization
@@ -1139,7 +1139,7 @@ declare class OrganizationsResource extends BaseResource {
      *
      * @param {string} organizationId - Organization identifier
      * @param {CreateUserRequest} data - User data including credentials and profile
-     * @returns {Promise<CreateB2BUserResponse>} Response with user's baseDN
+     * @returns {Promise<CreateB2BUserResponse>} The created user object with all fields populated
      * @throws {ForbiddenError} When user lacks admin privileges
      * @throws {NotFoundError} When organization is not found
      * @throws {ConflictError} When username/email/phone already exists
@@ -1147,11 +1147,12 @@ declare class OrganizationsResource extends BaseResource {
      *
      * @example
      * ```typescript
-     * const result = await client.organizations.createUser('org_abc123', {
+     * const user = await client.organizations.createUser('org_abc123', {
      *   cn: 'john.doe',
      *   uid: 'john.doe',
      *   // ... other user fields
      * });
+     * console.log(user._id); // Access the user's unique identifier
      * ```
      */
     createUser: (organizationId: string, data: CreateUserRequest) => Promise<CreateB2BUserResponse>;
@@ -1163,16 +1164,17 @@ declare class OrganizationsResource extends BaseResource {
      * @param {string} organizationId - Organization identifier
      * @param {string} userId - User identifier (username)
      * @param {UpdateUserRequest} data - Fields to update
-     * @returns {Promise<User | { success: true }>} Updated user object or success response
+     * @returns {Promise<User | { success: true }>} The updated user object with all fields populated
      * @throws {NotFoundError} When user or organization is not found
      * @throws {ForbiddenError} When user lacks admin privileges
      * @throws {ApiError} On other API errors
      *
      * @example
      * ```typescript
-     * const result = await client.organizations.updateUser('org_abc123', 'john.doe', {
+     * const user = await client.organizations.updateUser('org_abc123', 'john.doe', {
      *   mobile: '+33687654321'
      * });
+     * console.log(user); // Access the updated user object
      * ```
      */
     updateUser: (organizationId: string, userId: string, data: UpdateUserRequest) => Promise<User | {

package/dist/index.js

@@ -878,7 +878,7 @@ var OrganizationsResource = class extends BaseResource {
    *
    * @param {string} organizationId - Organization identifier
    * @param {CreateUserRequest} data - User data including credentials and profile
-   * @returns {Promise<CreateB2BUserResponse>} Response with user's baseDN
+   * @returns {Promise<CreateB2BUserResponse>} The created user object with all fields populated
    * @throws {ForbiddenError} When user lacks admin privileges
    * @throws {NotFoundError} When organization is not found
    * @throws {ConflictError} When username/email/phone already exists
@@ -886,11 +886,12 @@ var OrganizationsResource = class extends BaseResource {
    *
    * @example
    * ```typescript
-   * const result = await client.organizations.createUser('org_abc123', {
+   * const user = await client.organizations.createUser('org_abc123', {
    *   cn: 'john.doe',
    *   uid: 'john.doe',
    *   // ... other user fields
    * });
+   * console.log(user._id); // Access the user's unique identifier
    * ```
    */
   createUser = async (organizationId, data) => {
@@ -907,16 +908,17 @@ var OrganizationsResource = class extends BaseResource {
    * @param {string} organizationId - Organization identifier
    * @param {string} userId - User identifier (username)
    * @param {UpdateUserRequest} data - Fields to update
-   * @returns {Promise<User | { success: true }>} Updated user object or success response
+   * @returns {Promise<User | { success: true }>} The updated user object with all fields populated
    * @throws {NotFoundError} When user or organization is not found
    * @throws {ForbiddenError} When user lacks admin privileges
    * @throws {ApiError} On other API errors
    *
    * @example
    * ```typescript
-   * const result = await client.organizations.updateUser('org_abc123', 'john.doe', {
+   * const user = await client.organizations.updateUser('org_abc123', 'john.doe', {
    *   mobile: '+33687654321'
    * });
+   * console.log(user); // Access the updated user object
    * ```
    */
   updateUser = async (organizationId, userId, data) => {

package/dist/index.mjs

@@ -840,7 +840,7 @@ var OrganizationsResource = class extends BaseResource {
    *
    * @param {string} organizationId - Organization identifier
    * @param {CreateUserRequest} data - User data including credentials and profile
-   * @returns {Promise<CreateB2BUserResponse>} Response with user's baseDN
+   * @returns {Promise<CreateB2BUserResponse>} The created user object with all fields populated
    * @throws {ForbiddenError} When user lacks admin privileges
    * @throws {NotFoundError} When organization is not found
    * @throws {ConflictError} When username/email/phone already exists
@@ -848,11 +848,12 @@ var OrganizationsResource = class extends BaseResource {
    *
    * @example
    * ```typescript
-   * const result = await client.organizations.createUser('org_abc123', {
+   * const user = await client.organizations.createUser('org_abc123', {
    *   cn: 'john.doe',
    *   uid: 'john.doe',
    *   // ... other user fields
    * });
+   * console.log(user._id); // Access the user's unique identifier
    * ```
    */
   createUser = async (organizationId, data) => {
@@ -869,16 +870,17 @@ var OrganizationsResource = class extends BaseResource {
    * @param {string} organizationId - Organization identifier
    * @param {string} userId - User identifier (username)
    * @param {UpdateUserRequest} data - Fields to update
-   * @returns {Promise<User | { success: true }>} Updated user object or success response
+   * @returns {Promise<User | { success: true }>} The updated user object with all fields populated
    * @throws {NotFoundError} When user or organization is not found
    * @throws {ForbiddenError} When user lacks admin privileges
    * @throws {ApiError} On other API errors
    *
    * @example
    * ```typescript
-   * const result = await client.organizations.updateUser('org_abc123', 'john.doe', {
+   * const user = await client.organizations.updateUser('org_abc123', 'john.doe', {
    *   mobile: '+33687654321'
    * });
+   * console.log(user); // Access the updated user object
    * ```
    */
   updateUser = async (organizationId, userId, data) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linagora/ldap-rest-client",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "TypeScript API client for LDAP-REST",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",