import { HttpTypes } from "@medusajs/types"; import { Client } from "../client.js"; import { ClientHeaders } from "../types.js"; export declare class User { /** * @ignore */ private client; /** * @ignore */ constructor(client: Client); /** * This method updates a user. It sends a request to the * [Update User](https://docs.medusajs.com/api/admin/users/update-a-user) * API route. * * @param id - The ID of the user to update. * @param body - The details of the user to update. * @param query - Configure the fields and relations to retrieve in the tax region. * @param headers - Headers to pass in the request. * @returns The user's details. * * @example * sdk.admin.user.update("user_123", { * first_name: "John", * last_name: "Doe", * }) * .then(({ user }) => { * console.log(user) * }) */ update(id: string, body: HttpTypes.AdminUpdateUser, query?: HttpTypes.AdminUserParams, headers?: ClientHeaders): Promise; /** * This method retrieves a list of users. It sends a request to the * [List Users](https://docs.medusajs.com/api/admin/users/list-users) * API route. * * @param queryParams - Filters and pagination configurations. * @param headers - Headers to pass in the request. * @returns The list of users. * * @example * To retrieve the list of users: * * ```ts * sdk.admin.user.list() * .then(({ users, count, limit, offset }) => { * console.log(users) * }) * ``` * * To configure the pagination, pass the `limit` and `offset` query parameters. * * For example, to retrieve only 10 items and skip 10 items: * * ```ts * sdk.admin.user.list({ * limit: 10, * offset: 10 * }) * .then(({ users, count, limit, offset }) => { * console.log(users) * }) * ``` * * Using the `fields` query parameter, you can specify the fields and relations to retrieve * in each user: * * ```ts * sdk.admin.user.list({ * fields: "id,email" * }) * .then(({ users, count, limit, offset }) => { * console.log(users) * }) * ``` * * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin/select-fields-and-relations). */ list(queryParams?: HttpTypes.AdminUserListParams, headers?: ClientHeaders): Promise; /** * This method retrieves a user. It sends a request to the * [Get User](https://docs.medusajs.com/api/admin/users/get-a-user) * API route. * * @param id - The ID of the user to retrieve. * @param query - Configure the fields and relations to retrieve in the user. * @param headers - Headers to pass in the request. * @returns The user's details. * * @example * To retrieve a user by its ID: * * ```ts * sdk.admin.user.retrieve("user_123") * .then(({ user }) => { * console.log(user) * }) * ``` * * To specify the fields and relations to retrieve: * * ```ts * sdk.admin.user.retrieve("user_123", { * fields: "id,email" * }) * .then(({ user }) => { * console.log(user) * }) * ``` * * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin/select-fields-and-relations). */ retrieve(id: string, query?: HttpTypes.AdminUserParams, headers?: ClientHeaders): Promise; /** * This method retrieves the auth providers a user can authenticate with. It sends a * request to the List User Auth Providers API route. * * @param id - The user's ID. * @param headers - Headers to pass in the request. * @returns The IDs of the user's auth providers. * * @example * sdk.admin.user.listAuthProviders("user_123") * .then(({ providers }) => { * console.log(providers) * }) * * @since 2.20.0 */ listAuthProviders(id: string, headers?: ClientHeaders): Promise; /** * This method generates a reset password token for a user. It sends a request to the * Generate Reset Password Token for a User API route. * * Useful for constructing the reset password link without sending an email. * * The token is short-lived, can only be used once, and generating it invalidates * any reset password token previously issued for the user. * * @param id - The ID of the user to generate the token for. * @param headers - Headers to pass in the request. * @returns The generated reset password token. * * @example * sdk.admin.user.generateResetPasswordToken("user_123") * .then(({ token }) => { * console.log(token) * }) * * @since 2.20.0 */ generateResetPasswordToken(id: string, headers?: ClientHeaders): Promise; /** * This method retrieves a paginated list of roles assigned to a user. It sends a request to the * List User Roles API route. * * @param id - The user's ID. * @param queryParams - Filters and pagination configurations. * @param headers - Headers to pass in the request. * @returns The list of roles. * * @example * sdk.admin.user.listRoles("user_123") * .then(({ roles, count, limit, offset }) => { * console.log(roles) * }) */ listRoles(id: string, queryParams?: HttpTypes.AdminRbacRoleUserListParams, headers?: ClientHeaders): Promise; /** * This method assigns roles to a user. It sends a request to the * Assign User Roles API route. * * @param id - The user's ID. * @param body - The roles to assign. * @param headers - Headers to pass in the request. * @returns The user's roles. * * @example * sdk.admin.user.addRoles("user_123", { * roles: ["role_123"] * }) * .then(({ roles }) => { * console.log(roles) * }) */ addRoles(id: string, body: HttpTypes.AdminAssignUserRoles, headers?: ClientHeaders): Promise; /** * This method removes a role from a user. It sends a request to the * Remove User Role API route. * * @param id - The user's ID. * @param roleId - The role's ID. * @param headers - Headers to pass in the request. * @returns The removal's details. * * @example * sdk.admin.user.removeRole("user_123", "role_123") * .then(({ deleted }) => { * console.log(deleted) * }) */ removeRole(id: string, roleId: string, headers?: ClientHeaders): Promise; /** * This method removes roles from a user. It sends a request to the * Remove User Roles API route. * * @param id - The user's ID. * @param body - The roles to remove. * @param headers - Headers to pass in the request. * @returns The removal's details. * * @example * sdk.admin.user.removeRoles("user_123", { * roles: ["role_123"] * }) * .then(({ deleted }) => { * console.log(deleted) * }) */ removeRoles(id: string, body: HttpTypes.AdminRemoveUserRoles, headers?: ClientHeaders): Promise; /** * This method deletes a user. It sends a request to the * [Delete User](https://docs.medusajs.com/api/admin/users/delete-a-user) * API route. * * @param id - The ID of the user to delete. * @param headers - Headers to pass in the request. * @returns The deletion's details. * * @example * sdk.admin.user.delete("user_123") * .then(({ deleted }) => { * console.log(deleted) * }) */ delete(id: string, headers?: ClientHeaders): Promise; /** * This method retrieves the currently authenticated user. It sends a request to the * [Get Logged-In User](https://docs.medusajs.com/api/admin/users/get-logged-in-user) * API route. * * @param query - Configure the fields and relations to retrieve in the user. * @param headers - Headers to pass in the request. * @returns The user's details. * * @example * To retrieve the currently authenticated user: * * ```ts * sdk.admin.user.me() * .then(({ user }) => { * console.log(user) * }) * ``` * * To specify the fields and relations to retrieve: * * ```ts * sdk.admin.user.me({ * fields: "id,email" * }) * .then(({ user }) => { * console.log(user) * }) * ``` * * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin/select-fields-and-relations). */ me(query?: HttpTypes.AdminUserParams, headers?: ClientHeaders): Promise; } //# sourceMappingURL=user.d.ts.map