@linagora/ldap-rest-client 1.0.11 → 1.0.13

package/dist/index.d.mts

@@ -622,11 +622,16 @@ interface Organization {
  * - suspended: Organization is temporarily disabled
  */
 type OrganizationStatus = 'active' | 'suspended';
+/**
+ * Supported primitive types for metadata values
+ */
+type MetadataValue = string | number | boolean | null;
 /**
  * Optional metadata for organization customization
  *
  * Allows storing custom properties like industry, company size,
  * contact information, or any other organization-specific data.
+ * Supports strings, numbers, booleans, and null values.
  */
 interface OrganizationMetadata {
     /** Industry/sector (e.g., 'Technology', 'Healthcare') */
@@ -636,7 +641,7 @@ interface OrganizationMetadata {
     /** Primary contact information */
     contact?: string;
     /** Additional custom fields as key-value pairs */
-    [key: string]: string | undefined;
+    [key: string]: MetadataValue | undefined;
 }
 /**
  * Request parameters for creating an organization
@@ -955,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
@@ -963,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[]>;
@@ -1765,4 +1770,4 @@ declare class NetworkError extends LdapRestError {
     constructor(message: string, cause?: Error);
 }
 
-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 SearchUsersParams, 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, type MetadataValue, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SearchUsersParams, 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

@@ -622,11 +622,16 @@ interface Organization {
  * - suspended: Organization is temporarily disabled
  */
 type OrganizationStatus = 'active' | 'suspended';
+/**
+ * Supported primitive types for metadata values
+ */
+type MetadataValue = string | number | boolean | null;
 /**
  * Optional metadata for organization customization
  *
  * Allows storing custom properties like industry, company size,
  * contact information, or any other organization-specific data.
+ * Supports strings, numbers, booleans, and null values.
  */
 interface OrganizationMetadata {
     /** Industry/sector (e.g., 'Technology', 'Healthcare') */
@@ -636,7 +641,7 @@ interface OrganizationMetadata {
     /** Primary contact information */
     contact?: string;
     /** Additional custom fields as key-value pairs */
-    [key: string]: string | undefined;
+    [key: string]: MetadataValue | undefined;
 }
 /**
  * Request parameters for creating an organization
@@ -955,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
@@ -963,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[]>;
@@ -1765,4 +1770,4 @@ declare class NetworkError extends LdapRestError {
     constructor(message: string, cause?: Error);
 }
 
-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 SearchUsersParams, 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, type MetadataValue, NetworkError, NotFoundError, type Organization, type OrganizationMetadata, type OrganizationOwner, type OrganizationRole, type OrganizationSearchField, type OrganizationStatus, OrganizationsResource, type PhoneNumber, RateLimitError, type SearchUsersParams, 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

@@ -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.11",
+  "version": "1.0.13",
   "description": "TypeScript API client for LDAP-REST",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",