Skip to main content

Function: userService()

userService(client): object

Defined in: service/UserService.ts:96

Factory for user-related GraphQL operations. Methods preserve the v0.9.x surface: same names, same parameter shapes, returns are now plain objects (with __typename available for discrimination, not class instances).

Parameters​

client​

GraphQLClient

Returns​

authenticate()​

authenticate(email): Promise<GCIPUser>

Get authentication information for user by email.

Parameters​

email​

string

Returns​

Promise<GCIPUser>

claimsReset()​

claimsReset(uid, email): Promise<boolean>

Resets all claims for a user by email.

Parameters​

uid​

string

email​

string

Returns​

Promise<boolean>

getUser()​

getUser(variables): Promise<ViewerResult>

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>

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

Parameters​

variables​

ViewerVariables

Returns​

Promise<ViewerResult>

login()​

login(input): Promise<Login>

Login with credentials.

Parameters​

input​

LoginInput

Returns​

Promise<Login>

logout()​

logout(): Promise<Logout>

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>

Register a new contact.

Parameters​

variables​

ContactRegisterVariables

Returns​

Promise<RegisterContactResponse>

registerCustomer()​

registerCustomer(variables): Promise<RegisterCustomerResponse>

Register a new customer.

Parameters​

variables​

CustomerRegisterVariables

Returns​

Promise<RegisterCustomerResponse>

sendPasswordResetEmail()​

sendPasswordResetEmail(input): Promise<boolean>

Send a password reset email to the specified user.

Parameters​

input​

PasswordResetInput

Returns​

Promise<boolean>

triggerContactSendWelcomeEmailEvent()​

triggerContactSendWelcomeEmailEvent(input): Promise<boolean>

Sends a welcome email to a contact.

Parameters​

input​

TriggerContactSendWelcomeEmailEventInput

Returns​

Promise<boolean>

triggerCustomerSendWelcomeEmailEvent()​

triggerCustomerSendWelcomeEmailEvent(input): Promise<boolean>

Sends a welcome email to a customer.

Parameters​

input​

TriggerCustomerSendWelcomeEmailEventInput

Returns​

Promise<boolean>