User

User registration, email verification, invites, and profile.

Endpoints

Endpoint	Arguments	Returns
v2.user.invite.accept	unknown	unknown
v2.user.invite.decline	unknown	unknown
v2.user.invite.list	-	any[]
v2.user.invite.register	options, InviteKey	unknown
v2.user.profile	userId	unknown
v2.user.register	options, options, unknown	object
v2.user.registerApple	options, options	object
v2.user.registerGoogle	unknown, options	object
v2.user.send_verification_email	-	unknown
v2.user.settings.global.set	options	boolean
v2.user.verify_email	unknown, unknown	unknown

v2.user.invite.accept

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (string, required): Invite key

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.invite.accept', [
  'string', // Invite key (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.invite.decline

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (string, required):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.invite.decline', [
  'string', // argument 1 (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.invite.list

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Undocumented

This endpoint declares no argument schema in the source yet.

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.invite.list', []);
console.log(result);

Returns

Array of any.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.invite.register

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, optional):

Field	Type	Required	Description
firstname	string	yes
lastname	string	yes
password	string	yes

Argument 2 (InviteKey, string, required):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.invite.register', [
  {
    firstname: 'string',
    lastname: 'string',
    password: 'string',
  },
  'string', // InviteKey (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.profile

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (userId, required): userId

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.profile', [
  '507f1f77bcf86cd799439011', // userId (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.register

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, optional):

Field	Type	Required	Description
email	string	yes
firstname	string	yes
lastname	string	yes
password	string	yes

Argument 2 (object, optional):

Field	Type	Required	Description
copyNetworkId	WorkspaceId	no	workspaceId (former networkId)
referralCode	string	no
publicChatSessionId	string	no
viewedSlides	string	no

Argument 3 (string, optional):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.register', [
  {
    email: 'string',
    firstname: 'string',
    lastname: 'string',
    password: 'string',
  },
  {
    copyNetworkId: '507f1f77bcf86cd799439011', // workspaceId (former networkId)
    referralCode: 'string',
  },
  'string', // argument 3
]);
console.log(result);

Returns

Field	Type	Required	Description
uid	ObjectId	yes
cid	ObjectId	yes

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.registerApple

Description

Register with Apple SSO.

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
token	string	yes	idToken
email	string	yes	Email
firstname	string	yes	Firstname
lastname	string	yes	Lastname

Argument 2 (object, optional):

Field	Type	Required	Description
copyNetworkId	WorkspaceId	no	workspaceId (former networkId)
referralCode	string	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.registerApple', [
  {
    token: 'string', // idToken
    email: 'string', // Email
    firstname: 'string', // Firstname
    lastname: 'string', // Lastname
  },
  {
    copyNetworkId: '507f1f77bcf86cd799439011', // workspaceId (former networkId)
    referralCode: 'string',
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
uid	ObjectId	yes
cid	ObjectId	yes

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.registerGoogle

Description

Register with Google SSO.

Parameters

Argument 1 (string, required): idToken

Argument 2 (object, optional):

Field	Type	Required	Description
copyNetworkId	WorkspaceId	no	workspaceId (former networkId)
referralCode	string	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.registerGoogle', [
  'string', // idToken (required)
  {
    copyNetworkId: '507f1f77bcf86cd799439011', // workspaceId (former networkId)
    referralCode: 'string',
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
uid	ObjectId	yes
cid	ObjectId	yes

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.send_verification_email

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Undocumented

This endpoint declares no argument schema in the source yet.

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.send_verification_email', []);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.settings.global.set

Description

Set user's global settings

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
enterToSend	boolean	no
discussionMessageEmail	boolean	no
feedPostEmail	boolean	no
theme	string	no
hiddenFeedPosts	ObjectId[]	no
feedSelectedWorkspaces	WorkspaceId[]	no
pushOnMention	boolean	no
navOnboardingSeen	boolean	no
defaultView	object	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.settings.global.set', [
  {
    enterToSend: false,
    discussionMessageEmail: false,
  },
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

v2.user.verify_email

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (string, required):

Argument 2 (string, required):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v2.user.verify_email', [
  'string', // argument 1 (required)
  'string', // argument 2 (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.