Class: UserService

Defined in: service/UserService.ts:203

Backwards-compatible class form. New code should call userService(client).

Constructors

Constructor

new UserService(client): UserService

Defined in: service/UserService.ts:205

Parameters

client

GraphQLClient

Returns

UserService

Methods

authenticate()

authenticate(email): Promise<GCIPUser>

Defined in: service/UserService.ts:227

Get authentication information for user by email.

Parameters

email

string

Returns

Promise<GCIPUser>

---

claimsReset()

claimsReset(uid, email): Promise<boolean>

Defined in: service/UserService.ts:251

Resets all claims for a user by email.

Parameters

uid

string

email

string

Returns

Promise<boolean>

---

getUser()

getUser(variables): Promise<ViewerResult>

Defined in: service/UserService.ts:223

Get user by id or login (mutually exclusive — provide one). Returns Contact | Customer — discriminate on result.__typename.

Parameters

variables

UserVariables

Returns

Promise<ViewerResult>

---

getViewer()

getViewer(variables): Promise<ViewerResult>

Defined in: service/UserService.ts:212

Get current viewer information (authenticated user). Returns Contact | Customer — discriminate on result.__typename.

Parameters

variables

ViewerVariables

Returns

Promise<ViewerResult>

---

login()

login(input): Promise<Login>

Defined in: service/UserService.ts:216

Login with credentials.

Parameters

input

LoginInput

Returns

Promise<Login>

---

logout()

logout(): Promise<Logout>

Defined in: service/UserService.ts:235

Logout current user.

Returns

Promise<Logout>

Deprecated

The upstream logout mutation is deprecated; a signOut mutation will be available in the future.

---

registerContact()

registerContact(variables): Promise<RegisterContactResponse>

Defined in: service/UserService.ts:239

Register a new contact.

Parameters

variables

ContactRegisterVariables

Returns

Promise<RegisterContactResponse>

---

registerCustomer()

registerCustomer(variables): Promise<RegisterCustomerResponse>

Defined in: service/UserService.ts:243

Register a new customer.

Parameters

variables

CustomerRegisterVariables

Returns

Promise<RegisterCustomerResponse>

---

sendPasswordResetEmail()

sendPasswordResetEmail(input): Promise<boolean>

Defined in: service/UserService.ts:247

Send a password reset email to the specified user.

Parameters

input

PasswordResetInput

Returns

Promise<boolean>

---

triggerContactSendWelcomeEmailEvent()

triggerContactSendWelcomeEmailEvent(input): Promise<boolean>

Defined in: service/UserService.ts:255

Sends a welcome email to a contact.

Parameters

input

TriggerContactSendWelcomeEmailEventInput

Returns

Promise<boolean>

---

triggerCustomerSendWelcomeEmailEvent()

triggerCustomerSendWelcomeEmailEvent(input): Promise<boolean>

Defined in: service/UserService.ts:261

Sends a welcome email to a customer.

Parameters

input

TriggerCustomerSendWelcomeEmailEventInput

Returns

Promise<boolean>