@linagora/ldap-rest-client 1.0.12 → 1.0.13

package/dist/index.d.mts

@@ -960,7 +960,7 @@ declare class UsersResource extends BaseResource {
      * Returns organizations where the user is an admin or owner.
      * Optionally filter by specific role.
      *
-     * @param {string} userId - User identifier (username)
+     * @param {string} userId - User identifier (email address - unique identifier, not username)
      * @param {string} [role] - Optional role filter ('owner', 'admin', 'moderator', 'member')
      * @returns {Promise<Organization[]>} Array of organizations
      * @throws {ApiError} On API errors
@@ -968,10 +968,10 @@ declare class UsersResource extends BaseResource {
      * @example
      * ```typescript
      * // Get all organizations where user has any role
-     * const orgs = await client.users.getUserOrganizations('johndoe');
+     * const orgs = await client.users.getUserOrganizations('user@example.com');
      *
      * // Get only organizations where user is owner
-     * const ownedOrgs = await client.users.getUserOrganizations('johndoe', 'owner');
+     * const ownedOrgs = await client.users.getUserOrganizations('user@example.com', 'owner');
      * ```
      */
     getUserOrganizations: (userId: string, role?: string) => Promise<Organization[]>;

package/dist/index.d.ts

@@ -960,7 +960,7 @@ declare class UsersResource extends BaseResource {
      * Returns organizations where the user is an admin or owner.
      * Optionally filter by specific role.
      *
-     * @param {string} userId - User identifier (username)
+     * @param {string} userId - User identifier (email address - unique identifier, not username)
      * @param {string} [role] - Optional role filter ('owner', 'admin', 'moderator', 'member')
      * @returns {Promise<Organization[]>} Array of organizations
      * @throws {ApiError} On API errors
@@ -968,10 +968,10 @@ declare class UsersResource extends BaseResource {
      * @example
      * ```typescript
      * // Get all organizations where user has any role
-     * const orgs = await client.users.getUserOrganizations('johndoe');
+     * const orgs = await client.users.getUserOrganizations('user@example.com');
      *
      * // Get only organizations where user is owner
-     * const ownedOrgs = await client.users.getUserOrganizations('johndoe', 'owner');
+     * const ownedOrgs = await client.users.getUserOrganizations('user@example.com', 'owner');
      * ```
      */
     getUserOrganizations: (userId: string, role?: string) => Promise<Organization[]>;

package/dist/index.js

@@ -669,7 +669,7 @@ var UsersResource = class extends BaseResource {
    * Returns organizations where the user is an admin or owner.
    * Optionally filter by specific role.
    *
-   * @param {string} userId - User identifier (username)
+   * @param {string} userId - User identifier (email address - unique identifier, not username)
    * @param {string} [role] - Optional role filter ('owner', 'admin', 'moderator', 'member')
    * @returns {Promise<Organization[]>} Array of organizations
    * @throws {ApiError} On API errors
@@ -677,10 +677,10 @@ var UsersResource = class extends BaseResource {
    * @example
    * ```typescript
    * // Get all organizations where user has any role
-   * const orgs = await client.users.getUserOrganizations('johndoe');
+   * const orgs = await client.users.getUserOrganizations('user@example.com');
    *
    * // Get only organizations where user is owner
-   * const ownedOrgs = await client.users.getUserOrganizations('johndoe', 'owner');
+   * const ownedOrgs = await client.users.getUserOrganizations('user@example.com', 'owner');
    * ```
    */
   getUserOrganizations = async (userId, role) => {

package/dist/index.mjs

@@ -631,7 +631,7 @@ var UsersResource = class extends BaseResource {
    * Returns organizations where the user is an admin or owner.
    * Optionally filter by specific role.
    *
-   * @param {string} userId - User identifier (username)
+   * @param {string} userId - User identifier (email address - unique identifier, not username)
    * @param {string} [role] - Optional role filter ('owner', 'admin', 'moderator', 'member')
    * @returns {Promise<Organization[]>} Array of organizations
    * @throws {ApiError} On API errors
@@ -639,10 +639,10 @@ var UsersResource = class extends BaseResource {
    * @example
    * ```typescript
    * // Get all organizations where user has any role
-   * const orgs = await client.users.getUserOrganizations('johndoe');
+   * const orgs = await client.users.getUserOrganizations('user@example.com');
    *
    * // Get only organizations where user is owner
-   * const ownedOrgs = await client.users.getUserOrganizations('johndoe', 'owner');
+   * const ownedOrgs = await client.users.getUserOrganizations('user@example.com', 'owner');
    * ```
    */
   getUserOrganizations = async (userId, role) => {

package/package.json

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