@linagora/ldap-rest-client 1.0.9 → 1.0.10

package/README.md

@@ -100,7 +100,9 @@ client.organizations.listUsers(orgId, { page, limit, status, search, sortBy, sor
 client.organizations.checkUserAvailability(orgId, { field, value })
 
 // User role management ('owner', 'admin', 'moderator', 'member')
-client.organizations.changeUserRole(orgId, userId, { role })
+// Returns { role, previousRole }
+const result = await client.organizations.changeUserRole(orgId, userId, { role })
+console.log(`Changed from ${result.previousRole} to ${result.role}`)
 
 // Technical/service accounts in organizations
 const techUser = await client.organizations.createUser(orgId, { ...userData, isTechnical: true })

package/dist/index.d.mts

@@ -667,6 +667,15 @@ interface ChangeUserRoleRequest {
     /** New role for the user */
     role: OrganizationRole;
 }
+/**
+ * Response from changing a user's role in an organization
+ */
+interface ChangeUserRoleResponse {
+    /** The new role assigned to the user */
+    role: OrganizationRole;
+    /** The user's previous role before the change */
+    previousRole: OrganizationRole;
+}
 /**
  * Organization owner information
  */
@@ -1312,21 +1321,20 @@ declare class OrganizationsResource extends BaseResource {
      * @param {string} organizationId - Organization identifier
      * @param {string} userId - User identifier (username)
      * @param {ChangeUserRoleRequest} data - New role
-     * @returns {Promise<{ success: true }>} Success response
+     * @returns {Promise<ChangeUserRoleResponse>} Response containing the new role and previous role
      * @throws {NotFoundError} When user or organization is not found
      * @throws {ForbiddenError} When attempting self-demotion or removing last admin
      * @throws {ApiError} On other API errors
      *
      * @example
      * ```typescript
-     * await client.organizations.changeUserRole('org_abc123', 'john.doe', {
+     * const result = await client.organizations.changeUserRole('org_abc123', 'john.doe', {
      *   role: 'moderator'
      * });
+     * console.log(`Changed role from ${result.previousRole} to ${result.role}`);
      * ```
      */
-    changeUserRole: (organizationId: string, userId: string, data: ChangeUserRoleRequest) => Promise<{
-        success: true;
-    }>;
+    changeUserRole: (organizationId: string, userId: string, data: ChangeUserRoleRequest) => Promise<ChangeUserRoleResponse>;
 }
 
 /**
@@ -1713,4 +1721,4 @@ declare class NetworkError extends LdapRestError {
     constructor(message: string, cause?: Error);
 }
 
-export { type AddGroupMembersRequest, type Address, ApiError, AuthenticationError, AuthorizationError, type ChangeUserRoleRequest, type CheckAvailabilityParams, type CheckAvailabilityResponse, type CheckOrganizationAvailabilityParams, type ClientConfig, ConflictError, type CreateAdminRequest, type CreateB2BUserResponse, type CreateGroupRequest, type CreateOrganizationRequest, type CreateOrganizationResponse, type CreateUserRequest, type EmailAddress, type ExtendedAddress, type FetchUserRequest, type GeoLocation, type GetOwnerResponse, type Group, GroupsResource, type InstantMessaging, LdapRestClient, LdapRestError, type ListGroupsParams, type ListGroupsResponse, type ListUsersParams, type ListUsersResponse, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SetOwnerRequest, type TransferOwnershipRequest, type UpdateGroupRequest, type UpdateOrganizationRequest, type UpdateUserRequest, type User, type UserCredentials, type UserKeys, type UserName, type UserSearchField, type UserStatus, UsersResource, ValidationError };
+export { type AddGroupMembersRequest, type Address, ApiError, AuthenticationError, AuthorizationError, type ChangeUserRoleRequest, type ChangeUserRoleResponse, type CheckAvailabilityParams, type CheckAvailabilityResponse, type CheckOrganizationAvailabilityParams, type ClientConfig, ConflictError, type CreateAdminRequest, type CreateB2BUserResponse, type CreateGroupRequest, type CreateOrganizationRequest, type CreateOrganizationResponse, type CreateUserRequest, type EmailAddress, type ExtendedAddress, type FetchUserRequest, type GeoLocation, type GetOwnerResponse, type Group, GroupsResource, type InstantMessaging, LdapRestClient, LdapRestError, type ListGroupsParams, type ListGroupsResponse, type ListUsersParams, type ListUsersResponse, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SetOwnerRequest, type TransferOwnershipRequest, type UpdateGroupRequest, type UpdateOrganizationRequest, type UpdateUserRequest, type User, type UserCredentials, type UserKeys, type UserName, type UserSearchField, type UserStatus, UsersResource, ValidationError };

package/dist/index.d.ts

@@ -667,6 +667,15 @@ interface ChangeUserRoleRequest {
     /** New role for the user */
     role: OrganizationRole;
 }
+/**
+ * Response from changing a user's role in an organization
+ */
+interface ChangeUserRoleResponse {
+    /** The new role assigned to the user */
+    role: OrganizationRole;
+    /** The user's previous role before the change */
+    previousRole: OrganizationRole;
+}
 /**
  * Organization owner information
  */
@@ -1312,21 +1321,20 @@ declare class OrganizationsResource extends BaseResource {
      * @param {string} organizationId - Organization identifier
      * @param {string} userId - User identifier (username)
      * @param {ChangeUserRoleRequest} data - New role
-     * @returns {Promise<{ success: true }>} Success response
+     * @returns {Promise<ChangeUserRoleResponse>} Response containing the new role and previous role
      * @throws {NotFoundError} When user or organization is not found
      * @throws {ForbiddenError} When attempting self-demotion or removing last admin
      * @throws {ApiError} On other API errors
      *
      * @example
      * ```typescript
-     * await client.organizations.changeUserRole('org_abc123', 'john.doe', {
+     * const result = await client.organizations.changeUserRole('org_abc123', 'john.doe', {
      *   role: 'moderator'
      * });
+     * console.log(`Changed role from ${result.previousRole} to ${result.role}`);
      * ```
      */
-    changeUserRole: (organizationId: string, userId: string, data: ChangeUserRoleRequest) => Promise<{
-        success: true;
-    }>;
+    changeUserRole: (organizationId: string, userId: string, data: ChangeUserRoleRequest) => Promise<ChangeUserRoleResponse>;
 }
 
 /**
@@ -1713,4 +1721,4 @@ declare class NetworkError extends LdapRestError {
     constructor(message: string, cause?: Error);
 }
 
-export { type AddGroupMembersRequest, type Address, ApiError, AuthenticationError, AuthorizationError, type ChangeUserRoleRequest, type CheckAvailabilityParams, type CheckAvailabilityResponse, type CheckOrganizationAvailabilityParams, type ClientConfig, ConflictError, type CreateAdminRequest, type CreateB2BUserResponse, type CreateGroupRequest, type CreateOrganizationRequest, type CreateOrganizationResponse, type CreateUserRequest, type EmailAddress, type ExtendedAddress, type FetchUserRequest, type GeoLocation, type GetOwnerResponse, type Group, GroupsResource, type InstantMessaging, LdapRestClient, LdapRestError, type ListGroupsParams, type ListGroupsResponse, type ListUsersParams, type ListUsersResponse, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SetOwnerRequest, type TransferOwnershipRequest, type UpdateGroupRequest, type UpdateOrganizationRequest, type UpdateUserRequest, type User, type UserCredentials, type UserKeys, type UserName, type UserSearchField, type UserStatus, UsersResource, ValidationError };
+export { type AddGroupMembersRequest, type Address, ApiError, AuthenticationError, AuthorizationError, type ChangeUserRoleRequest, type ChangeUserRoleResponse, type CheckAvailabilityParams, type CheckAvailabilityResponse, type CheckOrganizationAvailabilityParams, type ClientConfig, ConflictError, type CreateAdminRequest, type CreateB2BUserResponse, type CreateGroupRequest, type CreateOrganizationRequest, type CreateOrganizationResponse, type CreateUserRequest, type EmailAddress, type ExtendedAddress, type FetchUserRequest, type GeoLocation, type GetOwnerResponse, type Group, GroupsResource, type InstantMessaging, LdapRestClient, LdapRestError, type ListGroupsParams, type ListGroupsResponse, type ListUsersParams, type ListUsersResponse, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SetOwnerRequest, type TransferOwnershipRequest, type UpdateGroupRequest, type UpdateOrganizationRequest, type UpdateUserRequest, type User, type UserCredentials, type UserKeys, type UserName, type UserSearchField, type UserStatus, UsersResource, ValidationError };

package/dist/index.js

@@ -1072,16 +1072,17 @@ var OrganizationsResource = class extends BaseResource {
    * @param {string} organizationId - Organization identifier
    * @param {string} userId - User identifier (username)
    * @param {ChangeUserRoleRequest} data - New role
-   * @returns {Promise<{ success: true }>} Success response
+   * @returns {Promise<ChangeUserRoleResponse>} Response containing the new role and previous role
    * @throws {NotFoundError} When user or organization is not found
    * @throws {ForbiddenError} When attempting self-demotion or removing last admin
    * @throws {ApiError} On other API errors
    *
    * @example
    * ```typescript
-   * await client.organizations.changeUserRole('org_abc123', 'john.doe', {
+   * const result = await client.organizations.changeUserRole('org_abc123', 'john.doe', {
    *   role: 'moderator'
    * });
+   * console.log(`Changed role from ${result.previousRole} to ${result.role}`);
    * ```
    */
   changeUserRole = async (organizationId, userId, data) => {

package/dist/index.mjs

@@ -1034,16 +1034,17 @@ var OrganizationsResource = class extends BaseResource {
    * @param {string} organizationId - Organization identifier
    * @param {string} userId - User identifier (username)
    * @param {ChangeUserRoleRequest} data - New role
-   * @returns {Promise<{ success: true }>} Success response
+   * @returns {Promise<ChangeUserRoleResponse>} Response containing the new role and previous role
    * @throws {NotFoundError} When user or organization is not found
    * @throws {ForbiddenError} When attempting self-demotion or removing last admin
    * @throws {ApiError} On other API errors
    *
    * @example
    * ```typescript
-   * await client.organizations.changeUserRole('org_abc123', 'john.doe', {
+   * const result = await client.organizations.changeUserRole('org_abc123', 'john.doe', {
    *   role: 'moderator'
    * });
+   * console.log(`Changed role from ${result.previousRole} to ${result.role}`);
    * ```
    */
   changeUserRole = async (organizationId, userId, data) => {

package/package.json

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