Appearance
Calendar
Calendars and events: listing, access, membership, and permissions.
Endpoints
| Endpoint | Arguments | Returns |
|---|---|---|
v2.calendar.access | ObjectId | object |
v2.calendar.list | - | object |
v2.calendar.member.add | ObjectId, unknown | boolean |
v2.calendar.member.list | ObjectId | object[] |
v2.calendar.member.remove | ObjectId, unknown | boolean |
v2.calendar.permissions.deny | ObjectId, unknown, unknown | boolean |
v2.calendar.permissions.grant | ObjectId, unknown, unknown | boolean |
v2.events.list | options | any[] |
v2.calendar.access
Description
Returns possible items for adding to
Parameters
Argument 1 (ObjectId, required): Calendar Id
Example
javascript
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.calendar.access', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
| Field | Type | Required | Description |
|---|---|---|---|
users | ObjectId[] | no | |
teams | object[] | no |
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.calendar.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
javascript
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.calendar.list', []);
console.log(result);Returns
Record<string, any[]>
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.calendar.member.add
Description
Add member to calendar.
Parameters
Argument 1 (ObjectId, required): Calendar Id
Argument 2 (string, required): User / Team
Example
javascript
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.calendar.member.add', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'string', // User / Team (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.calendar.member.list
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (ObjectId, required): Calendar Id
Example
javascript
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.calendar.member.list', [
'507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);Returns
Array of objects:
| Field | Type | Required | Description |
|---|---|---|---|
id | string | no | network_<networkId>, team_<teamId>, user_<userId>, group_<groupId> |
info | object | no | |
permissions | admin | own | ownteam | any | edit[] | no |
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.calendar.member.remove
Description
Remove member of calendar.
Parameters
Argument 1 (ObjectId, required): Calendar Id
Argument 2 (string, required): User / Team
Example
javascript
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.calendar.member.remove', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'string', // User / Team (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.calendar.permissions.deny
Description
Deny permission to Calendar for User / Team.
Parameters
Argument 1 (ObjectId, required): Calendar Id
Argument 2 (string, required): User / Team
Argument 3 (admin, required): Permission
Example
javascript
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.calendar.permissions.deny', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'string', // User / Team (required)
'admin', // Permission (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.calendar.permissions.grant
Description
Grant permission to Calendar for User / Team.
Parameters
Argument 1 (ObjectId, required): Calendar Id
Argument 2 (string, required): User / Team
Argument 3 (admin, required): Permission
Example
javascript
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.calendar.permissions.grant', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'string', // User / Team (required)
'admin', // Permission (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.
v2.events.list
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (object, required):
| Field | Type | Required | Description |
|---|---|---|---|
start | timestamp | yes | start date for events |
end | timestamp | yes | end date for events |
calendars | ObjectId[] | no | list of calendars to load from |
Example
javascript
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.events.list', [
{
start: Date.now(), // start date for events
end: Date.now(), // end date for events
},
]);
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? }.