Class UsersModule

Módulo para gestión administrativa de usuarios.

Todas las respuestas normalizan el campo role extrayéndolo de app_metadata.role para acceso directo (ej: user.role === "admin").

Index

Constructors

constructor

Methods

ban create createSignupLink delete generateLink get invite list listSessions listSignupLinks revokeSession revokeSessions revokeSignupLink unban update

Constructors

constructor

new UsersModule(api: ApiClient): UsersModule
Parameters
- api: ApiClient
Returns UsersModule
- Defined in src/modules/users/UsersModule.ts:13

Methods

ban

ban(userId: string, data?: BanUserRequest): Promise<DypaiResponse<User>>
Banea a un usuario y revoca sus sesiones.
Parameters
- userId: string
- data: BanUserRequest = {}
Returns Promise<DypaiResponse<User>>
- Defined in src/modules/users/UsersModule.ts:56

create

create(data: CreateUserRequest): Promise<DypaiResponse<User>>
Crea un nuevo usuario en la aplicación.
Parameters
- data: CreateUserRequest
Returns Promise<DypaiResponse<User>>
- Defined in src/modules/users/UsersModule.ts:99

createSignupLink

createSignupLink(
data?: CreateSignupLinkRequest,
): Promise<DypaiResponse<SignupLink>>
Crea un enlace genérico de registro (email desconocido al generarlo).
Parameters
- data: CreateSignupLinkRequest = {}
Returns Promise<DypaiResponse<SignupLink>>
- Defined in src/modules/users/UsersModule.ts:135

delete

delete(userId: string): Promise<DypaiResponse<{ success: boolean }>>
Elimina un usuario.
Parameters
- userId: string
Returns Promise<DypaiResponse<{ success: boolean }>>
- Defined in src/modules/users/UsersModule.ts:121

generateLink

generateLink(
data: GenerateLinkRequest,
): Promise<DypaiResponse<GenerateLinkResponse>>
Genera un enlace de invitación o recovery sin enviar email.
Parameters
- data: GenerateLinkRequest
Returns Promise<DypaiResponse<GenerateLinkResponse>>
- Defined in src/modules/users/UsersModule.ts:128

get

get(userId: string): Promise<DypaiResponse<User>>
Obtiene un usuario por ID.
Parameters
- userId: string
Returns Promise<DypaiResponse<User>>
- Defined in src/modules/users/UsersModule.ts:38

invite

invite(data: InviteUserRequest): Promise<DypaiResponse<InviteUserResponse>>
Invita a un usuario por email (envía enlace de invitación).
Parameters
- data: InviteUserRequest
Returns Promise<DypaiResponse<InviteUserResponse>>
- Defined in src/modules/users/UsersModule.ts:49

list

list(
    params?: {
        page?: number;
        per_page?: number;
        search?: string;
        sort_by?: string;
        sort_order?: "asc" | "desc";
    },
): Promise<DypaiResponse<UserListResponse>>
Obtiene la lista de usuarios de la aplicación. Requiere permiso manage_users.
Parameters
- params: {
      page?: number;
      per_page?: number;
      search?: string;
      sort_by?: string;
      sort_order?: "asc" | "desc";
  } = {}
Returns Promise<DypaiResponse<UserListResponse>>
- Defined in src/modules/users/UsersModule.ts:21

listSessions

listSessions(userId: string): Promise<DypaiResponse<SessionsListResponse>>
Lista las sesiones activas de un usuario.
Parameters
- userId: string
Returns Promise<DypaiResponse<SessionsListResponse>>
- Defined in src/modules/users/UsersModule.ts:78

listSignupLinks

listSignupLinks(): Promise<DypaiResponse<SignupLinksListResponse>>
Returns Promise<DypaiResponse<SignupLinksListResponse>>
- Defined in src/modules/users/UsersModule.ts:139

revokeSession

revokeSession(
userId: string,
sessionId: string,
): Promise<DypaiResponse<{ success: boolean }>>
Revoca una sesión específica.
Parameters
- userId: string
- sessionId: string
Returns Promise<DypaiResponse<{ success: boolean }>>
- Defined in src/modules/users/UsersModule.ts:92

revokeSessions

revokeSessions(userId: string): Promise<DypaiResponse<{ success: boolean }>>
Revoca todas las sesiones de un usuario.
Parameters
- userId: string
Returns Promise<DypaiResponse<{ success: boolean }>>
- Defined in src/modules/users/UsersModule.ts:85

revokeSignupLink

revokeSignupLink(linkId: string): Promise<DypaiResponse<{ success: boolean }>>
Parameters
- linkId: string
Returns Promise<DypaiResponse<{ success: boolean }>>
- Defined in src/modules/users/UsersModule.ts:143

unban

unban(userId: string): Promise<DypaiResponse<User>>
Quita el ban de un usuario.
Parameters
- userId: string
Returns Promise<DypaiResponse<User>>
- Defined in src/modules/users/UsersModule.ts:67

update

update(userId: string, data: UpdateUserRequest): Promise<DypaiResponse<User>>
Actualiza un usuario existente.
Parameters
- userId: string
- data: UpdateUserRequest
Returns Promise<DypaiResponse<User>>
- Defined in src/modules/users/UsersModule.ts:110

Class UsersModule

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UsersModule

Methods

ban

Parameters

Returns Promise<DypaiResponse<User>>

create

Parameters

Returns Promise<DypaiResponse<User>>

createSignupLink

Parameters

Returns Promise<DypaiResponse<SignupLink>>

delete

Parameters

Returns Promise<DypaiResponse<{ success: boolean }>>

generateLink

Parameters

Returns Promise<DypaiResponse<GenerateLinkResponse>>

get

Parameters

Returns Promise<DypaiResponse<User>>

invite

Parameters

Returns Promise<DypaiResponse<InviteUserResponse>>

list

Parameters

Returns Promise<DypaiResponse<UserListResponse>>

listSessions

Parameters

Returns Promise<DypaiResponse<SessionsListResponse>>

listSignupLinks

Returns Promise<DypaiResponse<SignupLinksListResponse>>

revokeSession

Parameters

Returns Promise<DypaiResponse<{ success: boolean }>>

revokeSessions

Parameters

Returns Promise<DypaiResponse<{ success: boolean }>>

revokeSignupLink

Parameters

Returns Promise<DypaiResponse<{ success: boolean }>>

unban

Parameters

Returns Promise<DypaiResponse<User>>

update

Parameters

Returns Promise<DypaiResponse<User>>

Settings

On This Page