import Users from '@pageproof/sdk/src/api/Users.js'

public class | source

Users

Extends:

API → Users

Method Summary

Public Methods
public	byEmail(email: string): Promise<User> Searches for an existing user by email address.
public	byId(userId: string): Promise<User> Retrieves a user's details by their user id.
public	invite(email: string): Promise<User> Invites a user to PageProof by their email.

Inherited Summary

From class API
public	client: PageProof

Public Methods

public byEmail(email: string): Promise<User> source

Searches for an existing user by email address.

Params:

Name	Type	Attribute	Description
email	string		The email address of the user to retieve

Return:

Promise<User>

public byId(userId: string): Promise<User> source

Retrieves a user's details by their user id.

Params:

Name	Type	Attribute	Description
userId	string		The user's unique identifier

Return:

Promise<User>

public invite(email: string): Promise<User> source

Invites a user to PageProof by their email.

PageProof handles sending the user an invitation email whenever they are added to a proof. You can invite a user to PageProof using this method when creating a workflow template, however they won't recieve an email immediately unless they're added to a proof as an owner, or to an active workflow.

Params:

Name	Type	Attribute	Description
email	string		The email address of the user to invite

Return:

Promise<User>