tale-js-sdk 0.1.2 → 0.1.3

package/dist/user-group/index.d.ts

@@ -0,0 +1,230 @@
+import type { UserGroupInfo, UserGroupMember, CreateUserGroupRequest, UpdateUserGroupRequest, UserGroupMemberRequest, UserGroupOptions, ListUserGroupsRequest, ListUserGroupMembersRequest, UserGroupPaginatedResponse } from "./types.js";
+export type { UserGroupInfo, UserGroupMember, CreateUserGroupRequest, UpdateUserGroupRequest, UserGroupMemberRequest, UserGroupOptions, ListUserGroupsRequest, ListUserGroupMembersRequest, UserGroupPaginatedResponse, } from "./types.js";
+/**
+ * Gets a user group by ID.
+ *
+ * @param groupId - User group ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to user group information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getUserGroup } from '@tale/client';
+ *
+ * try {
+ *   const group = await getUserGroup('group_id_here');
+ *   console.log('Group name:', group.name);
+ * } catch (error) {
+ *   console.error('Failed to get user group:', error.message);
+ * }
+ * ```
+ */
+export declare function getUserGroup(groupId: string, options?: UserGroupOptions): Promise<UserGroupInfo>;
+/**
+ * Lists user groups with pagination and optional keyword filtering.
+ *
+ * @param options - Optional parameters for pagination and filtering
+ * @returns Promise resolving to paginated user group list
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { listUserGroups } from '@tale/client';
+ *
+ * try {
+ *   const result = await listUserGroups({
+ *     page: 0,
+ *     size: 20,
+ *     keyword: 'admin'
+ *   });
+ *   console.log(`Found ${result.totalElements} user groups`);
+ * } catch (error) {
+ *   console.error('Failed to list user groups:', error.message);
+ * }
+ * ```
+ */
+export declare function listUserGroups(options?: ListUserGroupsRequest & UserGroupOptions): Promise<UserGroupPaginatedResponse<UserGroupInfo>>;
+/**
+ * Creates a new user group.
+ *
+ * @param request - User group creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created user group
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { createUserGroup } from '@tale/client';
+ *
+ * try {
+ *   const group = await createUserGroup({
+ *     name: 'Administrators',
+ *     description: 'Admin users',
+ *     type: 'system'
+ *   });
+ *   console.log('Group created:', group.group_id);
+ * } catch (error) {
+ *   console.error('Failed to create user group:', error.message);
+ * }
+ * ```
+ */
+export declare function createUserGroup(request: CreateUserGroupRequest, options?: UserGroupOptions): Promise<UserGroupInfo>;
+/**
+ * Updates an existing user group.
+ *
+ * @param groupId - User group ID to update
+ * @param request - Update request with fields to modify
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated user group
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateUserGroup } from '@tale/client';
+ *
+ * try {
+ *   const group = await updateUserGroup('group_id_here', {
+ *     name: 'Updated Name',
+ *     description: 'Updated description'
+ *   });
+ *   console.log('Group updated:', group.name);
+ * } catch (error) {
+ *   console.error('Failed to update user group:', error.message);
+ * }
+ * ```
+ */
+export declare function updateUserGroup(groupId: string, request: UpdateUserGroupRequest, options?: UserGroupOptions): Promise<UserGroupInfo>;
+/**
+ * Deletes a user group.
+ *
+ * @param groupId - User group ID to delete
+ * @param options - Optional configuration
+ * @returns Promise that resolves when deletion is successful
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { deleteUserGroup } from '@tale/client';
+ *
+ * try {
+ *   await deleteUserGroup('group_id_here');
+ *   console.log('Group deleted successfully');
+ * } catch (error) {
+ *   console.error('Failed to delete user group:', error.message);
+ * }
+ * ```
+ */
+export declare function deleteUserGroup(groupId: string, options?: UserGroupOptions): Promise<void>;
+/**
+ * Gets members of a user group with pagination.
+ *
+ * @param groupId - User group ID
+ * @param options - Optional parameters for pagination
+ * @returns Promise resolving to paginated member list
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { listUserGroupMembers } from '@tale/client';
+ *
+ * try {
+ *   const result = await listUserGroupMembers('group_id_here', {
+ *     page: 0,
+ *     size: 20
+ *   });
+ *   console.log(`Found ${result.totalElements} members`);
+ * } catch (error) {
+ *   console.error('Failed to list user group members:', error.message);
+ * }
+ * ```
+ */
+export declare function listUserGroupMembers(groupId: string, options?: ListUserGroupMembersRequest & UserGroupOptions): Promise<UserGroupPaginatedResponse<UserGroupMember>>;
+/**
+ * Adds members to a user group.
+ *
+ * @param groupId - User group ID
+ * @param request - Request containing user IDs to add
+ * @param options - Optional configuration
+ * @returns Promise that resolves when members are added
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { addUserGroupMembers } from '@tale/client';
+ *
+ * try {
+ *   await addUserGroupMembers('group_id_here', {
+ *     user_ids: ['user1', 'user2', 'user3']
+ *   });
+ *   console.log('Members added successfully');
+ * } catch (error) {
+ *   console.error('Failed to add members:', error.message);
+ * }
+ * ```
+ */
+export declare function addUserGroupMembers(groupId: string, request: UserGroupMemberRequest, options?: UserGroupOptions): Promise<void>;
+/**
+ * Removes members from a user group.
+ *
+ * @param groupId - User group ID
+ * @param request - Request containing user IDs to remove
+ * @param options - Optional configuration
+ * @returns Promise that resolves when members are removed
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { removeUserGroupMembers } from '@tale/client';
+ *
+ * try {
+ *   await removeUserGroupMembers('group_id_here', {
+ *     user_ids: ['user1', 'user2']
+ *   });
+ *   console.log('Members removed successfully');
+ * } catch (error) {
+ *   console.error('Failed to remove members:', error.message);
+ * }
+ * ```
+ */
+export declare function removeUserGroupMembers(groupId: string, request: UserGroupMemberRequest, options?: UserGroupOptions): Promise<void>;
+/**
+ * Gets all user groups that a user belongs to.
+ *
+ * @param userId - User ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to list of user groups
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getUserGroups } from '@tale/client';
+ *
+ * try {
+ *   const groups = await getUserGroups('user_id_here');
+ *   console.log(`User belongs to ${groups.length} groups`);
+ *   groups.forEach(group => console.log('-', group.name));
+ * } catch (error) {
+ *   console.error('Failed to get user groups:', error.message);
+ * }
+ * ```
+ */
+export declare function getUserGroups(userId: string, options?: UserGroupOptions): Promise<UserGroupInfo[]>;