UsersModule
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UsersModule(
client):UsersModule
Parameters
Section titled “Parameters”client
Section titled “client”Returns
Section titled “Returns”UsersModule
Methods
Section titled “Methods”create()
Section titled “create()”create(
data):Promise<{data?:User;error?:string;success:boolean; }>
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”Promise<{ data?: User; error?: string; success: boolean; }>
getPermissions()
Section titled “getPermissions()”getPermissions(
id):Promise<{data:string[]; }>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<{ data: string[]; }>
list()
Section titled “list()”list(
params?):Promise<{data:User[];meta:any; }>
Parameters
Section titled “Parameters”params?
Section titled “params?”limit?
Section titled “limit?”number
number
search?
Section titled “search?”string
Returns
Section titled “Returns”Promise<{ data: User[]; meta: any; }>
resetPassword()
Section titled “resetPassword()”resetPassword(
id,data):Promise<{error?:string;success:boolean; }>
Parameters
Section titled “Parameters”string
password?
Section titled “password?”string
sendEmail?
Section titled “sendEmail?”boolean
Returns
Section titled “Returns”Promise<{ error?: string; success: boolean; }>
update()
Section titled “update()”update(
id,data):Promise<{error?:string;success:boolean; }>
Parameters
Section titled “Parameters”string
any
Returns
Section titled “Returns”Promise<{ error?: string; success: boolean; }>
updateStatus()
Section titled “updateStatus()”updateStatus(
id,status):Promise<{error?:string;success:boolean; }>
Parameters
Section titled “Parameters”string
status
Section titled “status”string
Returns
Section titled “Returns”Promise<{ error?: string; success: boolean; }>