@turinhub/tale-js-sdk 1.3.0

package/dist/user/index.d.ts

@@ -0,0 +1,267 @@
+import type { CreateUserRequest, AppInfo, User, Role, Privilege, UserGroup, UserLoginMethod, CreateUserResponse, CreateUserJson, CreateUserOptions, GetUserRequest, DeleteUserResponse, DeleteUserJson, CommonOptions, ListUsersRequest, UserAttributeItemDTO, UserListItem, ListUsersResponse, ListUsersJson, UpdateUserRequest, UpdateUserResponse, UpdateUserJson, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateUserPasswordJson, UploadAvatarResponse, UploadAvatarJson, AvatarPresignedUrlResponse, AvatarPresignedUrlJson, UpdateUserFrozenStatusRequest, UserFrozenStatusResponse, UpdateUserFrozenStatusJson, GetUserFrozenStatusJson } from "./types.js";
+export type { CreateUserRequest, AppInfo, User, Role, Privilege, UserGroup, UserLoginMethod, CreateUserResponse, CreateUserJson, CreateUserOptions, GetUserRequest, DeleteUserResponse, DeleteUserJson, CommonOptions, ListUsersRequest, UserAttributeItemDTO, UserListItem, ListUsersResponse, ListUsersJson, UpdateUserRequest, UpdateUserResponse, UpdateUserJson, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateUserPasswordJson, UploadAvatarResponse, UploadAvatarJson, AvatarPresignedUrlResponse, AvatarPresignedUrlJson, UpdateUserFrozenStatusRequest, UserFrozenStatusResponse, UpdateUserFrozenStatusJson, GetUserFrozenStatusJson, };
+/**
+ * Creates a new user in the Tale application.
+ *
+ * @param userData - User data to create the new user
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the created user information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { createUser } from '@tale/client';
+ *
+ * try {
+ *   const result = await createUser({
+ *     username: 'john_doe',
+ *     nickname: 'John Doe',
+ *     email: 'john@example.com'
+ *   });
+ *   console.log('User created:', result.user.user_id);
+ * } catch (error) {
+ *   console.error('Failed to create user:', error.message);
+ * }
+ * ```
+ */
+export declare function createUser(userData: CreateUserRequest, options?: CreateUserOptions): Promise<CreateUserResponse>;
+/**
+ * Retrieves user information by ID or open ID.
+ *
+ * @param userId - Optional user ID (open_id) to query. If not provided, returns current user info
+ * @param options - Optional parameters for inclusion flags and configuration
+ * @returns Promise resolving to the user information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getUserById } from '@tale/client';
+ *
+ * try {
+ *   const result = await getUserById('user_open_id_here');
+ *   console.log('User info:', result.user.username);
+ * } catch (error) {
+ *   console.error('Failed to get user:', error.message);
+ * }
+ * ```
+ */
+export declare function getUserById(userId?: string, options?: GetUserRequest & CommonOptions): Promise<CreateUserResponse>;
+/**
+ * Deletes a user by ID or open ID.
+ *
+ * @param userId - User ID (open_id) to delete
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the deletion result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { deleteUser } from '@tale/client';
+ *
+ * try {
+ *   const result = await deleteUser('user_open_id_here');
+ *   console.log('User deleted:', result.deleted);
+ * } catch (error) {
+ *   console.error('Failed to delete user:', error.message);
+ * }
+ * ```
+ */
+export declare function deleteUser(userId: string, options?: CommonOptions): Promise<DeleteUserResponse>;
+/**
+ * Lists users with pagination, filtering, and search capabilities.
+ *
+ * @param options - Optional parameters for pagination, filtering, and configuration
+ * @returns Promise resolving to paginated user list with metadata
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { listUsers } from '@tale/client';
+ *
+ * try {
+ *   const result = await listUsers({
+ *     page: 0,
+ *     size: 20,
+ *     keyword: 'john',
+ *     sort_by: 'username',
+ *     sort_direction: 'asc'
+ *   });
+ *   console.log(`Found ${result.totalElements} users`);
+ *   console.log('First user:', result.content[0].user.username);
+ * } catch (error) {
+ *   console.error('Failed to list users:', error.message);
+ * }
+ * ```
+ */
+export declare function listUsers(options?: ListUsersRequest & CommonOptions): Promise<ListUsersResponse>;
+/**
+ * Updates user information by user ID or open ID.
+ *
+ * @param userId - User ID (open_id) to update
+ * @param userData - User data to update
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the update result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateUser } from '@tale/client';
+ *
+ * try {
+ *   const result = await updateUser('user_open_id_here', {
+ *     nick_name: 'John Doe',
+ *     email: 'john@example.com'
+ *   });
+ *   console.log('User updated:', result.success);
+ * } catch (error) {
+ *   console.error('Failed to update user:', error.message);
+ * }
+ * ```
+ */
+export declare function updateUser(userId: string, userData: UpdateUserRequest, options?: CommonOptions): Promise<UpdateUserResponse>;
+/**
+ * Updates user password.
+ *
+ * @param passwordData - Password data including user_id and encrypted password
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the update result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateUserPassword } from '@tale/client';
+ *
+ * try {
+ *   const result = await updateUserPassword({
+ *     user_id: 'user_open_id_here',
+ *     password_encrypted: 'encrypted_password_here'
+ *   });
+ *   console.log('Password updated:', result.success);
+ * } catch (error) {
+ *   console.error('Failed to update password:', error.message);
+ * }
+ * ```
+ */
+export declare function updateUserPassword(passwordData: UpdateUserPasswordRequest, options?: CommonOptions): Promise<UpdateUserPasswordResponse>;
+/**
+ * Uploads user avatar image.
+ *
+ * @param file - File object to upload as avatar
+ * @param userId - User ID (open_id) of the user
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the upload result with avatar OSS key
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { uploadAvatar } from '@tale/client';
+ *
+ * try {
+ *   const fileInput = document.querySelector('input[type="file"]');
+ *   const file = fileInput.files[0];
+ *   const result = await uploadAvatar(file, 'user_open_id_here');
+ *   console.log('Avatar uploaded:', result.avatar_oss_key);
+ * } catch (error) {
+ *   console.error('Failed to upload avatar:', error.message);
+ * }
+ * ```
+ */
+export declare function uploadAvatar(file: File, userId: string, options?: CommonOptions): Promise<UploadAvatarResponse>;
+/**
+ * Gets presigned URL for avatar access.
+ *
+ * @param ossKey - OSS key of the avatar
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to presigned URL information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getAvatarPresignedUrl } from '@tale/client';
+ *
+ * try {
+ *   const result = await getAvatarPresignedUrl('avatars/user123.jpg');
+ *   console.log('Presigned URL:', result.presignedUrl);
+ *   console.log('Expires in:', result.expireTimeInSeconds, 'seconds');
+ * } catch (error) {
+ *   console.error('Failed to get presigned URL:', error.message);
+ * }
+ * ```
+ */
+export declare function getAvatarPresignedUrl(ossKey: string, options?: CommonOptions): Promise<AvatarPresignedUrlResponse>;
+/**
+ * Updates user frozen status (freeze or unfreeze a user account).
+ *
+ * @param userId - User ID (open_id) to update frozen status
+ * @param frozenData - Frozen status data including is_frozen flag and optional remark
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the updated frozen status information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateUserFrozenStatus } from '@tale/client';
+ *
+ * try {
+ *   // Freeze a user account
+ *   const result = await updateUserFrozenStatus('user_open_id_here', {
+ *     is_frozen: true,
+ *     remark: 'Violated community guidelines'
+ *   });
+ *   console.log('User frozen:', result.is_frozen);
+ *
+ *   // Unfreeze a user account
+ *   const unfrozenResult = await updateUserFrozenStatus('user_open_id_here', {
+ *     is_frozen: false,
+ *     remark: 'Account reactivated'
+ *   });
+ *   console.log('User unfrozen:', !unfrozenResult.is_frozen);
+ * } catch (error) {
+ *   console.error('Failed to update frozen status:', error.message);
+ * }
+ * ```
+ */
+export declare function updateUserFrozenStatus(userId: string, frozenData: UpdateUserFrozenStatusRequest, options?: CommonOptions): Promise<UserFrozenStatusResponse>;
+/**
+ * Gets user frozen status by user ID.
+ *
+ * @param userId - User ID (open_id) to query frozen status
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the user frozen status information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getUserFrozenStatus } from '@tale/client';
+ *
+ * try {
+ *   const status = await getUserFrozenStatus('user_open_id_here');
+ *   console.log('User is frozen:', status.is_frozen);
+ *   console.log('Remark:', status.remark);
+ *   console.log('Last updated:', status.updated_at);
+ * } catch (error) {
+ *   console.error('Failed to get frozen status:', error.message);
+ * }
+ * ```
+ */
+export declare function getUserFrozenStatus(userId: string, options?: CommonOptions): Promise<UserFrozenStatusResponse>;