Calendar

Calendars and events: create, update and load calendars and events, invites, repeat series, and iCal links.

Endpoints

Endpoint	Arguments	Returns
`calendar.calendar_permission`	`options`	object
`calendar.create_calendar`	`options`	unknown
`calendar.create_event`	`options`	any[]
`calendar.create_own_ical`	-	object
`calendar.generate_ical_link`	`ObjectId`	object
`calendar.invite_respond`	`Event` `, ObjectId`	object[]
`calendar.list_all`	`options`	object
`calendar.list_ical_links`	-	object
`calendar.load_calendars`	-	any[]
`calendar.load_event`	`unknown`	any \| any[]
`calendar.load_events`	`options`	any[]
`calendar.load_repeat_series`	`ObjectId`	object
`calendar.remove_calendar`	`ObjectId`	boolean
`calendar.remove_event`	`ObjectId, options`	HailerResult
`calendar.remove_ical_link`	`ObjectId, unknown`	boolean
`calendar.remove_invite`	`ObjectId, userId`	boolean
`calendar.remove_own_ical`	-	boolean
`calendar.save_selected_calendars`	`unknown`	boolean
`calendar.upcoming_events`	`unknown`	any[]
`calendar.update_calendar`	`options`	unknown
`calendar.update_event`	`options, options`	any \| Record<string, boolean>

`calendar.calendar_permission`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
`calendar_id`	ObjectId	yes	calendarId
`cid`	WorkspaceId	yes	workspaceId (former networkId)

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('calendar.calendar_permission', [
  {
    calendar_id: '507f1f77bcf86cd799439011', // calendarId
    cid: '507f1f77bcf86cd799439011', // workspaceId (former networkId)
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
`users`	Record<string, boolean>	yes
`teams`	Record<string, object>	yes	```javascript
{ teams: {

[teamId: string]: {
  name: string,
  users: { [userId: string]: true } } }

| `public` | boolean | yes |  |

**Auth:** requires an authenticated session.

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

## `calendar.create_calendar`

**Description**

::: warning Undocumented
This endpoint has no description in the source yet.
:::

**Parameters**

**Argument 1 (object, required):**

| Field | Type | Required | Description |
|---|---|---|---|
| `color` | string | yes |  |
| `desc` | string | no |  |
| `name` | string | yes |  |
| `timezone` | `Africa/Abidjan` \| `Africa/Accra` \| `Africa/Addis_Ababa` \| `Africa/Algiers` \| `Africa/Asmara` \| `Africa/Asmera` \| `Africa/Bamako` \| `Africa/Bangui` \| `Africa/Banjul` \| `Africa/Bissau` \| `Africa/Blantyre` \| `Africa/Brazzaville` \| `Africa/Bujumbura` \| `Africa/Cairo` \| `Africa/Casablanca` \| `Africa/Ceuta` \| `Africa/Conakry` \| `Africa/Dakar` \| `Africa/Dar_es_Salaam` \| `Africa/Djibouti` \| `Africa/Douala` \| `Africa/El_Aaiun` \| `Africa/Freetown` \| `Africa/Gaborone` \| `Africa/Harare` \| `Africa/Johannesburg` \| `Africa/Juba` \| `Africa/Kampala` \| `Africa/Khartoum` \| `Africa/Kigali` \| `Africa/Kinshasa` \| `Africa/Lagos` \| `Africa/Libreville` \| `Africa/Lome` \| `Africa/Luanda` \| `Africa/Lubumbashi` \| `Africa/Lusaka` \| `Africa/Malabo` \| `Africa/Maputo` \| `Africa/Maseru` \| `Africa/Mbabane` \| `Africa/Mogadishu` \| `Africa/Monrovia` \| `Africa/Nairobi` \| `Africa/Ndjamena` \| `Africa/Niamey` \| `Africa/Nouakchott` \| `Africa/Ouagadougou` \| `Africa/Porto-Novo` \| `Africa/Sao_Tome` \| `Africa/Timbuktu` \| `Africa/Tripoli` \| `Africa/Tunis` \| `Africa/Windhoek` \| `America/Adak` \| `America/Anchorage` \| `America/Anguilla` \| `America/Antigua` \| `America/Araguaina` \| `America/Argentina/Buenos_Aires` \| `America/Argentina/Catamarca` \| `America/Argentina/ComodRivadavia` \| `America/Argentina/Cordoba` \| `America/Argentina/Jujuy` \| `America/Argentina/La_Rioja` \| `America/Argentina/Mendoza` \| `America/Argentina/Rio_Gallegos` \| `America/Argentina/Salta` \| `America/Argentina/San_Juan` \| `America/Argentina/San_Luis` \| `America/Argentina/Tucuman` \| `America/Argentina/Ushuaia` \| `America/Aruba` \| `America/Asuncion` \| `America/Atikokan` \| `America/Atka` \| `America/Bahia` \| `America/Bahia_Banderas` \| `America/Barbados` \| `America/Belem` \| `America/Belize` \| `America/Blanc-Sablon` \| `America/Boa_Vista` \| `America/Bogota` \| `America/Boise` \| `America/Buenos_Aires` \| `America/Cambridge_Bay` \| `America/Campo_Grande` \| `America/Cancun` \| `America/Caracas` \| `America/Catamarca` \| `America/Cayenne` \| `America/Cayman` \| `America/Chicago` \| `America/Chihuahua` \| `America/Ciudad_Juarez` \| `America/Coral_Harbour` \| `America/Cordoba` \| `America/Costa_Rica` \| `America/Coyhaique` \| `America/Creston` \| `America/Cuiaba` \| `America/Curacao` \| `America/Danmarkshavn` \| `America/Dawson` \| `America/Dawson_Creek` \| `America/Denver` \| `America/Detroit` \| `America/Dominica` \| `America/Edmonton` \| `America/Eirunepe` \| `America/El_Salvador` \| `America/Ensenada` \| `America/Fort_Nelson` \| `America/Fort_Wayne` \| `America/Fortaleza` \| `America/Glace_Bay` \| `America/Godthab` \| `America/Goose_Bay` \| `America/Grand_Turk` \| `America/Grenada` \| `America/Guadeloupe` \| `America/Guatemala` \| `America/Guayaquil` \| `America/Guyana` \| `America/Halifax` \| `America/Havana` \| `America/Hermosillo` \| `America/Indiana/Indianapolis` \| `America/Indiana/Knox` \| `America/Indiana/Marengo` \| `America/Indiana/Petersburg` \| `America/Indiana/Tell_City` \| `America/Indiana/Vevay` \| `America/Indiana/Vincennes` \| `America/Indiana/Winamac` \| `America/Indianapolis` \| `America/Inuvik` \| `America/Iqaluit` \| `America/Jamaica` \| `America/Jujuy` \| `America/Juneau` \| `America/Kentucky/Louisville` \| `America/Kentucky/Monticello` \| `America/Knox_IN` \| `America/Kralendijk` \| `America/La_Paz` \| `America/Lima` \| `America/Los_Angeles` \| `America/Louisville` \| `America/Lower_Princes` \| `America/Maceio` \| `America/Managua` \| `America/Manaus` \| `America/Marigot` \| `America/Martinique` \| `America/Matamoros` \| `America/Mazatlan` \| `America/Mendoza` \| `America/Menominee` \| `America/Merida` \| `America/Metlakatla` \| `America/Mexico_City` \| `America/Miquelon` \| `America/Moncton` \| `America/Monterrey` \| `America/Montevideo` \| `America/Montreal` \| `America/Montserrat` \| `America/Nassau` \| `America/New_York` \| `America/Nipigon` \| `America/Nome` \| `America/Noronha` \| `America/North_Dakota/Beulah` \| `America/North_Dakota/Center` \| `America/North_Dakota/New_Salem` \| `America/Nuuk` \| `America/Ojinaga` \| `America/Panama` \| `America/Pangnirtung` \| `America/Paramaribo` \| `America/Phoenix` \| `America/Port-au-Prince` \| `America/Port_of_Spain` \| `America/Porto_Acre` \| `America/Porto_Velho` \| `America/Puerto_Rico` \| `America/Punta_Arenas` \| `America/Rainy_River` \| `America/Rankin_Inlet` \| `America/Recife` \| `America/Regina` \| `America/Resolute` \| `America/Rio_Branco` \| `America/Rosario` \| `America/Santa_Isabel` \| `America/Santarem` \| `America/Santiago` \| `America/Santo_Domingo` \| `America/Sao_Paulo` \| `America/Scoresbysund` \| `America/Shiprock` \| `America/Sitka` \| `America/St_Barthelemy` \| `America/St_Johns` \| `America/St_Kitts` \| `America/St_Lucia` \| `America/St_Thomas` \| `America/St_Vincent` \| `America/Swift_Current` \| `America/Tegucigalpa` \| `America/Thule` \| `America/Thunder_Bay` \| `America/Tijuana` \| `America/Toronto` \| `America/Tortola` \| `America/Vancouver` \| `America/Virgin` \| `America/Whitehorse` \| `America/Winnipeg` \| `America/Yakutat` \| `America/Yellowknife` \| `Antarctica/Casey` \| `Antarctica/Davis` \| `Antarctica/DumontDUrville` \| `Antarctica/Macquarie` \| `Antarctica/Mawson` \| `Antarctica/McMurdo` \| `Antarctica/Palmer` \| `Antarctica/Rothera` \| `Antarctica/South_Pole` \| `Antarctica/Syowa` \| `Antarctica/Troll` \| `Antarctica/Vostok` \| `Arctic/Longyearbyen` \| `Asia/Aden` \| `Asia/Almaty` \| `Asia/Amman` \| `Asia/Anadyr` \| `Asia/Aqtau` \| `Asia/Aqtobe` \| `Asia/Ashgabat` \| `Asia/Ashkhabad` \| `Asia/Atyrau` \| `Asia/Baghdad` \| `Asia/Bahrain` \| `Asia/Baku` \| `Asia/Bangkok` \| `Asia/Barnaul` \| `Asia/Beirut` \| `Asia/Bishkek` \| `Asia/Brunei` \| `Asia/Calcutta` \| `Asia/Chita` \| `Asia/Choibalsan` \| `Asia/Chongqing` \| `Asia/Chungking` \| `Asia/Colombo` \| `Asia/Dacca` \| `Asia/Damascus` \| `Asia/Dhaka` \| `Asia/Dili` \| `Asia/Dubai` \| `Asia/Dushanbe` \| `Asia/Famagusta` \| `Asia/Gaza` \| `Asia/Harbin` \| `Asia/Hebron` \| `Asia/Ho_Chi_Minh` \| `Asia/Hong_Kong` \| `Asia/Hovd` \| `Asia/Irkutsk` \| `Asia/Istanbul` \| `Asia/Jakarta` \| `Asia/Jayapura` \| `Asia/Jerusalem` \| `Asia/Kabul` \| `Asia/Kamchatka` \| `Asia/Karachi` \| `Asia/Kashgar` \| `Asia/Kathmandu` \| `Asia/Katmandu` \| `Asia/Khandyga` \| `Asia/Kolkata` \| `Asia/Krasnoyarsk` \| `Asia/Kuala_Lumpur` \| `Asia/Kuching` \| `Asia/Kuwait` \| `Asia/Macao` \| `Asia/Macau` \| `Asia/Magadan` \| `Asia/Makassar` \| `Asia/Manila` \| `Asia/Muscat` \| `Asia/Nicosia` \| `Asia/Novokuznetsk` \| `Asia/Novosibirsk` \| `Asia/Omsk` \| `Asia/Oral` \| `Asia/Phnom_Penh` \| `Asia/Pontianak` \| `Asia/Pyongyang` \| `Asia/Qatar` \| `Asia/Qostanay` \| `Asia/Qyzylorda` \| `Asia/Rangoon` \| `Asia/Riyadh` \| `Asia/Saigon` \| `Asia/Sakhalin` \| `Asia/Samarkand` \| `Asia/Seoul` \| `Asia/Shanghai` \| `Asia/Singapore` \| `Asia/Srednekolymsk` \| `Asia/Taipei` \| `Asia/Tashkent` \| `Asia/Tbilisi` \| `Asia/Tehran` \| `Asia/Tel_Aviv` \| `Asia/Thimbu` \| `Asia/Thimphu` \| `Asia/Tokyo` \| `Asia/Tomsk` \| `Asia/Ujung_Pandang` \| `Asia/Ulaanbaatar` \| `Asia/Ulan_Bator` \| `Asia/Urumqi` \| `Asia/Ust-Nera` \| `Asia/Vientiane` \| `Asia/Vladivostok` \| `Asia/Yakutsk` \| `Asia/Yangon` \| `Asia/Yekaterinburg` \| `Asia/Yerevan` \| `Atlantic/Azores` \| `Atlantic/Bermuda` \| `Atlantic/Canary` \| `Atlantic/Cape_Verde` \| `Atlantic/Faeroe` \| `Atlantic/Faroe` \| `Atlantic/Jan_Mayen` \| `Atlantic/Madeira` \| `Atlantic/Reykjavik` \| `Atlantic/South_Georgia` \| `Atlantic/St_Helena` \| `Atlantic/Stanley` \| `Australia/ACT` \| `Australia/Adelaide` \| `Australia/Brisbane` \| `Australia/Broken_Hill` \| `Australia/Canberra` \| `Australia/Currie` \| `Australia/Darwin` \| `Australia/Eucla` \| `Australia/Hobart` \| `Australia/LHI` \| `Australia/Lindeman` \| `Australia/Lord_Howe` \| `Australia/Melbourne` \| `Australia/NSW` \| `Australia/North` \| `Australia/Perth` \| `Australia/Queensland` \| `Australia/South` \| `Australia/Sydney` \| `Australia/Tasmania` \| `Australia/Victoria` \| `Australia/West` \| `Australia/Yancowinna` \| `Brazil/Acre` \| `Brazil/DeNoronha` \| `Brazil/East` \| `Brazil/West` \| `CET` \| `CST6CDT` \| `Canada/Atlantic` \| `Canada/Central` \| `Canada/Eastern` \| `Canada/Mountain` \| `Canada/Newfoundland` \| `Canada/Pacific` \| `Canada/Saskatchewan` \| `Canada/Yukon` \| `Chile/Continental` \| `Chile/EasterIsland` \| `Cuba` \| `EET` \| `EST` \| `EST5EDT` \| `Egypt` \| `Eire` \| `Etc/GMT` \| `Etc/GMT+0` \| `Etc/GMT+1` \| `Etc/GMT+10` \| `Etc/GMT+11` \| `Etc/GMT+12` \| `Etc/GMT+2` \| `Etc/GMT+3` \| `Etc/GMT+4` \| `Etc/GMT+5` \| `Etc/GMT+6` \| `Etc/GMT+7` \| `Etc/GMT+8` \| `Etc/GMT+9` \| `Etc/GMT-0` \| `Etc/GMT-1` \| `Etc/GMT-10` \| `Etc/GMT-11` \| `Etc/GMT-12` \| `Etc/GMT-13` \| `Etc/GMT-14` \| `Etc/GMT-2` \| `Etc/GMT-3` \| `Etc/GMT-4` \| `Etc/GMT-5` \| `Etc/GMT-6` \| `Etc/GMT-7` \| `Etc/GMT-8` \| `Etc/GMT-9` \| `Etc/GMT0` \| `Etc/Greenwich` \| `Etc/UCT` \| `Etc/UTC` \| `Etc/Universal` \| `Etc/Zulu` \| `Europe/Amsterdam` \| `Europe/Andorra` \| `Europe/Astrakhan` \| `Europe/Athens` \| `Europe/Belfast` \| `Europe/Belgrade` \| `Europe/Berlin` \| `Europe/Bratislava` \| `Europe/Brussels` \| `Europe/Bucharest` \| `Europe/Budapest` \| `Europe/Busingen` \| `Europe/Chisinau` \| `Europe/Copenhagen` \| `Europe/Dublin` \| `Europe/Gibraltar` \| `Europe/Guernsey` \| `Europe/Helsinki` \| `Europe/Isle_of_Man` \| `Europe/Istanbul` \| `Europe/Jersey` \| `Europe/Kaliningrad` \| `Europe/Kiev` \| `Europe/Kirov` \| `Europe/Kyiv` \| `Europe/Lisbon` \| `Europe/Ljubljana` \| `Europe/London` \| `Europe/Luxembourg` \| `Europe/Madrid` \| `Europe/Malta` \| `Europe/Mariehamn` \| `Europe/Minsk` \| `Europe/Monaco` \| `Europe/Moscow` \| `Europe/Nicosia` \| `Europe/Oslo` \| `Europe/Paris` \| `Europe/Podgorica` \| `Europe/Prague` \| `Europe/Riga` \| `Europe/Rome` \| `Europe/Samara` \| `Europe/San_Marino` \| `Europe/Sarajevo` \| `Europe/Saratov` \| `Europe/Simferopol` \| `Europe/Skopje` \| `Europe/Sofia` \| `Europe/Stockholm` \| `Europe/Tallinn` \| `Europe/Tirane` \| `Europe/Tiraspol` \| `Europe/Ulyanovsk` \| `Europe/Uzhgorod` \| `Europe/Vaduz` \| `Europe/Vatican` \| `Europe/Vienna` \| `Europe/Vilnius` \| `Europe/Volgograd` \| `Europe/Warsaw` \| `Europe/Zagreb` \| `Europe/Zaporozhye` \| `Europe/Zurich` \| `GB` \| `GB-Eire` \| `GMT` \| `GMT+0` \| `GMT-0` \| `GMT0` \| `Greenwich` \| `HST` \| `Hongkong` \| `Iceland` \| `Indian/Antananarivo` \| `Indian/Chagos` \| `Indian/Christmas` \| `Indian/Cocos` \| `Indian/Comoro` \| `Indian/Kerguelen` \| `Indian/Mahe` \| `Indian/Maldives` \| `Indian/Mauritius` \| `Indian/Mayotte` \| `Indian/Reunion` \| `Iran` \| `Israel` \| `Jamaica` \| `Japan` \| `Kwajalein` \| `Libya` \| `MET` \| `MST` \| `MST7MDT` \| `Mexico/BajaNorte` \| `Mexico/BajaSur` \| `Mexico/General` \| `NZ` \| `NZ-CHAT` \| `Navajo` \| `PRC` \| `PST8PDT` \| `Pacific/Apia` \| `Pacific/Auckland` \| `Pacific/Bougainville` \| `Pacific/Chatham` \| `Pacific/Chuuk` \| `Pacific/Easter` \| `Pacific/Efate` \| `Pacific/Enderbury` \| `Pacific/Fakaofo` \| `Pacific/Fiji` \| `Pacific/Funafuti` \| `Pacific/Galapagos` \| `Pacific/Gambier` \| `Pacific/Guadalcanal` \| `Pacific/Guam` \| `Pacific/Honolulu` \| `Pacific/Johnston` \| `Pacific/Kanton` \| `Pacific/Kiritimati` \| `Pacific/Kosrae` \| `Pacific/Kwajalein` \| `Pacific/Majuro` \| `Pacific/Marquesas` \| `Pacific/Midway` \| `Pacific/Nauru` \| `Pacific/Niue` \| `Pacific/Norfolk` \| `Pacific/Noumea` \| `Pacific/Pago_Pago` \| `Pacific/Palau` \| `Pacific/Pitcairn` \| `Pacific/Pohnpei` \| `Pacific/Ponape` \| `Pacific/Port_Moresby` \| `Pacific/Rarotonga` \| `Pacific/Saipan` \| `Pacific/Samoa` \| `Pacific/Tahiti` \| `Pacific/Tarawa` \| `Pacific/Tongatapu` \| `Pacific/Truk` \| `Pacific/Wake` \| `Pacific/Wallis` \| `Pacific/Yap` \| `Poland` \| `Portugal` \| `ROC` \| `ROK` \| `Singapore` \| `Turkey` \| `UCT` \| `US/Alaska` \| `US/Aleutian` \| `US/Arizona` \| `US/Central` \| `US/East-Indiana` \| `US/Eastern` \| `US/Hawaii` \| `US/Indiana-Starke` \| `US/Michigan` \| `US/Mountain` \| `US/Pacific` \| `US/Samoa` \| `UTC` \| `Universal` \| `W-SU` \| `WET` \| `Zulu` | no | Timezone for correctly determining daylight saving times for repeating events |

**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('calendar.create_calendar', [
  {
    color: 'string',
    name: 'string',
  },
]);
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? }.

`calendar.create_event`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
`cid`	ObjectId	no
`allDay`	boolean	no
`attendees`	Record<string, boolean>	no
`calendar_id`	ObjectId	yes
`end`	number	yes
`location`	string	no
`notes`	string	no
`repeating`	boolean	no
`repeat`	any	no
`start`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`title`	string	yes

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('calendar.create_event', [
  {
    calendar_id: '507f1f77bcf86cd799439011',
    end: 0,
    start: Date.now(), // Time (milliseconds since 1970-01-01 UTC)
    title: 'string',
  },
]);
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? }.

`calendar.create_own_ical`

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('calendar.create_own_ical', []);
console.log(result);

Returns

Field	Type	Required	Description
`_id`	ObjectId	yes
`uid`	userId	yes	userId
`url`	string	yes
`created`	timestamp	no	Time (milliseconds since 1970-01-01 UTC)
`updated`	timestamp	no	Time (milliseconds since 1970-01-01 UTC)
`personalICal`	boolean	no

Auth: requires an authenticated session.

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

`calendar.generate_ical_link`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required): calendarId

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('calendar.generate_ical_link', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

Field	Type	Required	Description
`_id`	ObjectId	yes
`uid`	userId	yes	userId
`cid`	WorkspaceId	yes	workspaceId (former networkId)
`url`	string	yes
`calendar`	ObjectId	yes	calendarId
`personalICal`	boolean	yes
`created`	timestamp	no	Time (milliseconds since 1970-01-01 UTC)
`updated`	timestamp	no	Time (milliseconds since 1970-01-01 UTC)

Auth: requires an authenticated session.

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

`calendar.invite_respond`

Description

Change attending status for event

Parameters

Argument 1 (Record<string, boolean>, required): Event { [event: string]: boolean \| null }

Argument 2 (ObjectId, optional): UserId, defaults to userId from current session

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('calendar.invite_respond', [
  {
    '507f1f77bcf86cd799439012': false, // fieldId: value
  },
  '507f1f77bcf86cd799439011', // ObjectId
]);
console.log(result);

Returns

Array of objects:

Field	Type	Required	Description
`result`	boolean	yes
`event`	any	no

Auth: requires an authenticated session.

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

`calendar.list_all`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, optional):

Field	Type	Required	Description
`calendar_id`	ObjectId	no	calendarId
`cid`	WorkspaceId	no	workspaceId (former networkId)

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('calendar.list_all', [
  {
    calendar_id: '507f1f77bcf86cd799439011', // calendarId
    cid: '507f1f77bcf86cd799439011', // workspaceId (former networkId)
  },
]);
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? }.

`calendar.list_ical_links`

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('calendar.list_ical_links', []);
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? }.

`calendar.load_calendars`

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('calendar.load_calendars', []);
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? }.

`calendar.load_event`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId \| ObjectId[], required):

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('calendar.load_event', [
  '507f1f77bcf86cd799439011', // argument 1 (required)
]);
console.log(result);

Returns

any \| any[]

Auth: requires an authenticated session.

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

`calendar.load_events`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
`calendars`	ObjectId[]	yes
`start`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`end`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`user`	ObjectId[]	no
`showUnassigned`	boolean	no
`eventIds`	ObjectId[]	no

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('calendar.load_events', [
  {
    calendars: ['507f1f77bcf86cd799439011'],
    start: Date.now(), // Time (milliseconds since 1970-01-01 UTC)
    end: Date.now(), // Time (milliseconds since 1970-01-01 UTC)
  },
]);
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? }.

`calendar.load_repeat_series`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

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('calendar.load_repeat_series', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
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? }.

`calendar.remove_calendar`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

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('calendar.remove_calendar', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

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

`calendar.remove_event`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

Argument 2 (object, optional):

Field	Type	Required	Description
`repeat_id`	ObjectId	no
`remove`	`future` \| `all` \| `single`	no	One of: `future`, `all`, `single`.

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('calendar.remove_event', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  {
    repeat_id: '507f1f77bcf86cd799439011',
    remove: 'future',
  },
]);
console.log(result);

Returns

HailerResult

Auth: requires an authenticated session.

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

`calendar.remove_ical_link`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

Argument 2 (string, required):

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('calendar.remove_ical_link', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // argument 2 (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

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

`calendar.remove_invite`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required): Event id

Argument 2 (userId, required): User 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('calendar.remove_invite', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  '507f1f77bcf86cd799439011', // userId (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

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

`calendar.remove_own_ical`

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('calendar.remove_own_ical', []);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

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

`calendar.save_selected_calendars`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId[], required):

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('calendar.save_selected_calendars', [
  ['507f1f77bcf86cd799439011'],
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

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

`calendar.upcoming_events`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId \| ObjectId[], optional):

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('calendar.upcoming_events', [
  '507f1f77bcf86cd799439011', // argument 1
]);
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? }.

`calendar.update_calendar`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
`_id`	ObjectId	yes
`name`	string	yes
`description`	string	no
`color`	string	yes
`timezone`	`Africa/Abidjan` \| `Africa/Accra` \| `Africa/Addis_Ababa` \| `Africa/Algiers` \| `Africa/Asmara` \| `Africa/Asmera` \| `Africa/Bamako` \| `Africa/Bangui` \| `Africa/Banjul` \| `Africa/Bissau` \| `Africa/Blantyre` \| `Africa/Brazzaville` \| `Africa/Bujumbura` \| `Africa/Cairo` \| `Africa/Casablanca` \| `Africa/Ceuta` \| `Africa/Conakry` \| `Africa/Dakar` \| `Africa/Dar_es_Salaam` \| `Africa/Djibouti` \| `Africa/Douala` \| `Africa/El_Aaiun` \| `Africa/Freetown` \| `Africa/Gaborone` \| `Africa/Harare` \| `Africa/Johannesburg` \| `Africa/Juba` \| `Africa/Kampala` \| `Africa/Khartoum` \| `Africa/Kigali` \| `Africa/Kinshasa` \| `Africa/Lagos` \| `Africa/Libreville` \| `Africa/Lome` \| `Africa/Luanda` \| `Africa/Lubumbashi` \| `Africa/Lusaka` \| `Africa/Malabo` \| `Africa/Maputo` \| `Africa/Maseru` \| `Africa/Mbabane` \| `Africa/Mogadishu` \| `Africa/Monrovia` \| `Africa/Nairobi` \| `Africa/Ndjamena` \| `Africa/Niamey` \| `Africa/Nouakchott` \| `Africa/Ouagadougou` \| `Africa/Porto-Novo` \| `Africa/Sao_Tome` \| `Africa/Timbuktu` \| `Africa/Tripoli` \| `Africa/Tunis` \| `Africa/Windhoek` \| `America/Adak` \| `America/Anchorage` \| `America/Anguilla` \| `America/Antigua` \| `America/Araguaina` \| `America/Argentina/Buenos_Aires` \| `America/Argentina/Catamarca` \| `America/Argentina/ComodRivadavia` \| `America/Argentina/Cordoba` \| `America/Argentina/Jujuy` \| `America/Argentina/La_Rioja` \| `America/Argentina/Mendoza` \| `America/Argentina/Rio_Gallegos` \| `America/Argentina/Salta` \| `America/Argentina/San_Juan` \| `America/Argentina/San_Luis` \| `America/Argentina/Tucuman` \| `America/Argentina/Ushuaia` \| `America/Aruba` \| `America/Asuncion` \| `America/Atikokan` \| `America/Atka` \| `America/Bahia` \| `America/Bahia_Banderas` \| `America/Barbados` \| `America/Belem` \| `America/Belize` \| `America/Blanc-Sablon` \| `America/Boa_Vista` \| `America/Bogota` \| `America/Boise` \| `America/Buenos_Aires` \| `America/Cambridge_Bay` \| `America/Campo_Grande` \| `America/Cancun` \| `America/Caracas` \| `America/Catamarca` \| `America/Cayenne` \| `America/Cayman` \| `America/Chicago` \| `America/Chihuahua` \| `America/Ciudad_Juarez` \| `America/Coral_Harbour` \| `America/Cordoba` \| `America/Costa_Rica` \| `America/Coyhaique` \| `America/Creston` \| `America/Cuiaba` \| `America/Curacao` \| `America/Danmarkshavn` \| `America/Dawson` \| `America/Dawson_Creek` \| `America/Denver` \| `America/Detroit` \| `America/Dominica` \| `America/Edmonton` \| `America/Eirunepe` \| `America/El_Salvador` \| `America/Ensenada` \| `America/Fort_Nelson` \| `America/Fort_Wayne` \| `America/Fortaleza` \| `America/Glace_Bay` \| `America/Godthab` \| `America/Goose_Bay` \| `America/Grand_Turk` \| `America/Grenada` \| `America/Guadeloupe` \| `America/Guatemala` \| `America/Guayaquil` \| `America/Guyana` \| `America/Halifax` \| `America/Havana` \| `America/Hermosillo` \| `America/Indiana/Indianapolis` \| `America/Indiana/Knox` \| `America/Indiana/Marengo` \| `America/Indiana/Petersburg` \| `America/Indiana/Tell_City` \| `America/Indiana/Vevay` \| `America/Indiana/Vincennes` \| `America/Indiana/Winamac` \| `America/Indianapolis` \| `America/Inuvik` \| `America/Iqaluit` \| `America/Jamaica` \| `America/Jujuy` \| `America/Juneau` \| `America/Kentucky/Louisville` \| `America/Kentucky/Monticello` \| `America/Knox_IN` \| `America/Kralendijk` \| `America/La_Paz` \| `America/Lima` \| `America/Los_Angeles` \| `America/Louisville` \| `America/Lower_Princes` \| `America/Maceio` \| `America/Managua` \| `America/Manaus` \| `America/Marigot` \| `America/Martinique` \| `America/Matamoros` \| `America/Mazatlan` \| `America/Mendoza` \| `America/Menominee` \| `America/Merida` \| `America/Metlakatla` \| `America/Mexico_City` \| `America/Miquelon` \| `America/Moncton` \| `America/Monterrey` \| `America/Montevideo` \| `America/Montreal` \| `America/Montserrat` \| `America/Nassau` \| `America/New_York` \| `America/Nipigon` \| `America/Nome` \| `America/Noronha` \| `America/North_Dakota/Beulah` \| `America/North_Dakota/Center` \| `America/North_Dakota/New_Salem` \| `America/Nuuk` \| `America/Ojinaga` \| `America/Panama` \| `America/Pangnirtung` \| `America/Paramaribo` \| `America/Phoenix` \| `America/Port-au-Prince` \| `America/Port_of_Spain` \| `America/Porto_Acre` \| `America/Porto_Velho` \| `America/Puerto_Rico` \| `America/Punta_Arenas` \| `America/Rainy_River` \| `America/Rankin_Inlet` \| `America/Recife` \| `America/Regina` \| `America/Resolute` \| `America/Rio_Branco` \| `America/Rosario` \| `America/Santa_Isabel` \| `America/Santarem` \| `America/Santiago` \| `America/Santo_Domingo` \| `America/Sao_Paulo` \| `America/Scoresbysund` \| `America/Shiprock` \| `America/Sitka` \| `America/St_Barthelemy` \| `America/St_Johns` \| `America/St_Kitts` \| `America/St_Lucia` \| `America/St_Thomas` \| `America/St_Vincent` \| `America/Swift_Current` \| `America/Tegucigalpa` \| `America/Thule` \| `America/Thunder_Bay` \| `America/Tijuana` \| `America/Toronto` \| `America/Tortola` \| `America/Vancouver` \| `America/Virgin` \| `America/Whitehorse` \| `America/Winnipeg` \| `America/Yakutat` \| `America/Yellowknife` \| `Antarctica/Casey` \| `Antarctica/Davis` \| `Antarctica/DumontDUrville` \| `Antarctica/Macquarie` \| `Antarctica/Mawson` \| `Antarctica/McMurdo` \| `Antarctica/Palmer` \| `Antarctica/Rothera` \| `Antarctica/South_Pole` \| `Antarctica/Syowa` \| `Antarctica/Troll` \| `Antarctica/Vostok` \| `Arctic/Longyearbyen` \| `Asia/Aden` \| `Asia/Almaty` \| `Asia/Amman` \| `Asia/Anadyr` \| `Asia/Aqtau` \| `Asia/Aqtobe` \| `Asia/Ashgabat` \| `Asia/Ashkhabad` \| `Asia/Atyrau` \| `Asia/Baghdad` \| `Asia/Bahrain` \| `Asia/Baku` \| `Asia/Bangkok` \| `Asia/Barnaul` \| `Asia/Beirut` \| `Asia/Bishkek` \| `Asia/Brunei` \| `Asia/Calcutta` \| `Asia/Chita` \| `Asia/Choibalsan` \| `Asia/Chongqing` \| `Asia/Chungking` \| `Asia/Colombo` \| `Asia/Dacca` \| `Asia/Damascus` \| `Asia/Dhaka` \| `Asia/Dili` \| `Asia/Dubai` \| `Asia/Dushanbe` \| `Asia/Famagusta` \| `Asia/Gaza` \| `Asia/Harbin` \| `Asia/Hebron` \| `Asia/Ho_Chi_Minh` \| `Asia/Hong_Kong` \| `Asia/Hovd` \| `Asia/Irkutsk` \| `Asia/Istanbul` \| `Asia/Jakarta` \| `Asia/Jayapura` \| `Asia/Jerusalem` \| `Asia/Kabul` \| `Asia/Kamchatka` \| `Asia/Karachi` \| `Asia/Kashgar` \| `Asia/Kathmandu` \| `Asia/Katmandu` \| `Asia/Khandyga` \| `Asia/Kolkata` \| `Asia/Krasnoyarsk` \| `Asia/Kuala_Lumpur` \| `Asia/Kuching` \| `Asia/Kuwait` \| `Asia/Macao` \| `Asia/Macau` \| `Asia/Magadan` \| `Asia/Makassar` \| `Asia/Manila` \| `Asia/Muscat` \| `Asia/Nicosia` \| `Asia/Novokuznetsk` \| `Asia/Novosibirsk` \| `Asia/Omsk` \| `Asia/Oral` \| `Asia/Phnom_Penh` \| `Asia/Pontianak` \| `Asia/Pyongyang` \| `Asia/Qatar` \| `Asia/Qostanay` \| `Asia/Qyzylorda` \| `Asia/Rangoon` \| `Asia/Riyadh` \| `Asia/Saigon` \| `Asia/Sakhalin` \| `Asia/Samarkand` \| `Asia/Seoul` \| `Asia/Shanghai` \| `Asia/Singapore` \| `Asia/Srednekolymsk` \| `Asia/Taipei` \| `Asia/Tashkent` \| `Asia/Tbilisi` \| `Asia/Tehran` \| `Asia/Tel_Aviv` \| `Asia/Thimbu` \| `Asia/Thimphu` \| `Asia/Tokyo` \| `Asia/Tomsk` \| `Asia/Ujung_Pandang` \| `Asia/Ulaanbaatar` \| `Asia/Ulan_Bator` \| `Asia/Urumqi` \| `Asia/Ust-Nera` \| `Asia/Vientiane` \| `Asia/Vladivostok` \| `Asia/Yakutsk` \| `Asia/Yangon` \| `Asia/Yekaterinburg` \| `Asia/Yerevan` \| `Atlantic/Azores` \| `Atlantic/Bermuda` \| `Atlantic/Canary` \| `Atlantic/Cape_Verde` \| `Atlantic/Faeroe` \| `Atlantic/Faroe` \| `Atlantic/Jan_Mayen` \| `Atlantic/Madeira` \| `Atlantic/Reykjavik` \| `Atlantic/South_Georgia` \| `Atlantic/St_Helena` \| `Atlantic/Stanley` \| `Australia/ACT` \| `Australia/Adelaide` \| `Australia/Brisbane` \| `Australia/Broken_Hill` \| `Australia/Canberra` \| `Australia/Currie` \| `Australia/Darwin` \| `Australia/Eucla` \| `Australia/Hobart` \| `Australia/LHI` \| `Australia/Lindeman` \| `Australia/Lord_Howe` \| `Australia/Melbourne` \| `Australia/NSW` \| `Australia/North` \| `Australia/Perth` \| `Australia/Queensland` \| `Australia/South` \| `Australia/Sydney` \| `Australia/Tasmania` \| `Australia/Victoria` \| `Australia/West` \| `Australia/Yancowinna` \| `Brazil/Acre` \| `Brazil/DeNoronha` \| `Brazil/East` \| `Brazil/West` \| `CET` \| `CST6CDT` \| `Canada/Atlantic` \| `Canada/Central` \| `Canada/Eastern` \| `Canada/Mountain` \| `Canada/Newfoundland` \| `Canada/Pacific` \| `Canada/Saskatchewan` \| `Canada/Yukon` \| `Chile/Continental` \| `Chile/EasterIsland` \| `Cuba` \| `EET` \| `EST` \| `EST5EDT` \| `Egypt` \| `Eire` \| `Etc/GMT` \| `Etc/GMT+0` \| `Etc/GMT+1` \| `Etc/GMT+10` \| `Etc/GMT+11` \| `Etc/GMT+12` \| `Etc/GMT+2` \| `Etc/GMT+3` \| `Etc/GMT+4` \| `Etc/GMT+5` \| `Etc/GMT+6` \| `Etc/GMT+7` \| `Etc/GMT+8` \| `Etc/GMT+9` \| `Etc/GMT-0` \| `Etc/GMT-1` \| `Etc/GMT-10` \| `Etc/GMT-11` \| `Etc/GMT-12` \| `Etc/GMT-13` \| `Etc/GMT-14` \| `Etc/GMT-2` \| `Etc/GMT-3` \| `Etc/GMT-4` \| `Etc/GMT-5` \| `Etc/GMT-6` \| `Etc/GMT-7` \| `Etc/GMT-8` \| `Etc/GMT-9` \| `Etc/GMT0` \| `Etc/Greenwich` \| `Etc/UCT` \| `Etc/UTC` \| `Etc/Universal` \| `Etc/Zulu` \| `Europe/Amsterdam` \| `Europe/Andorra` \| `Europe/Astrakhan` \| `Europe/Athens` \| `Europe/Belfast` \| `Europe/Belgrade` \| `Europe/Berlin` \| `Europe/Bratislava` \| `Europe/Brussels` \| `Europe/Bucharest` \| `Europe/Budapest` \| `Europe/Busingen` \| `Europe/Chisinau` \| `Europe/Copenhagen` \| `Europe/Dublin` \| `Europe/Gibraltar` \| `Europe/Guernsey` \| `Europe/Helsinki` \| `Europe/Isle_of_Man` \| `Europe/Istanbul` \| `Europe/Jersey` \| `Europe/Kaliningrad` \| `Europe/Kiev` \| `Europe/Kirov` \| `Europe/Kyiv` \| `Europe/Lisbon` \| `Europe/Ljubljana` \| `Europe/London` \| `Europe/Luxembourg` \| `Europe/Madrid` \| `Europe/Malta` \| `Europe/Mariehamn` \| `Europe/Minsk` \| `Europe/Monaco` \| `Europe/Moscow` \| `Europe/Nicosia` \| `Europe/Oslo` \| `Europe/Paris` \| `Europe/Podgorica` \| `Europe/Prague` \| `Europe/Riga` \| `Europe/Rome` \| `Europe/Samara` \| `Europe/San_Marino` \| `Europe/Sarajevo` \| `Europe/Saratov` \| `Europe/Simferopol` \| `Europe/Skopje` \| `Europe/Sofia` \| `Europe/Stockholm` \| `Europe/Tallinn` \| `Europe/Tirane` \| `Europe/Tiraspol` \| `Europe/Ulyanovsk` \| `Europe/Uzhgorod` \| `Europe/Vaduz` \| `Europe/Vatican` \| `Europe/Vienna` \| `Europe/Vilnius` \| `Europe/Volgograd` \| `Europe/Warsaw` \| `Europe/Zagreb` \| `Europe/Zaporozhye` \| `Europe/Zurich` \| `GB` \| `GB-Eire` \| `GMT` \| `GMT+0` \| `GMT-0` \| `GMT0` \| `Greenwich` \| `HST` \| `Hongkong` \| `Iceland` \| `Indian/Antananarivo` \| `Indian/Chagos` \| `Indian/Christmas` \| `Indian/Cocos` \| `Indian/Comoro` \| `Indian/Kerguelen` \| `Indian/Mahe` \| `Indian/Maldives` \| `Indian/Mauritius` \| `Indian/Mayotte` \| `Indian/Reunion` \| `Iran` \| `Israel` \| `Jamaica` \| `Japan` \| `Kwajalein` \| `Libya` \| `MET` \| `MST` \| `MST7MDT` \| `Mexico/BajaNorte` \| `Mexico/BajaSur` \| `Mexico/General` \| `NZ` \| `NZ-CHAT` \| `Navajo` \| `PRC` \| `PST8PDT` \| `Pacific/Apia` \| `Pacific/Auckland` \| `Pacific/Bougainville` \| `Pacific/Chatham` \| `Pacific/Chuuk` \| `Pacific/Easter` \| `Pacific/Efate` \| `Pacific/Enderbury` \| `Pacific/Fakaofo` \| `Pacific/Fiji` \| `Pacific/Funafuti` \| `Pacific/Galapagos` \| `Pacific/Gambier` \| `Pacific/Guadalcanal` \| `Pacific/Guam` \| `Pacific/Honolulu` \| `Pacific/Johnston` \| `Pacific/Kanton` \| `Pacific/Kiritimati` \| `Pacific/Kosrae` \| `Pacific/Kwajalein` \| `Pacific/Majuro` \| `Pacific/Marquesas` \| `Pacific/Midway` \| `Pacific/Nauru` \| `Pacific/Niue` \| `Pacific/Norfolk` \| `Pacific/Noumea` \| `Pacific/Pago_Pago` \| `Pacific/Palau` \| `Pacific/Pitcairn` \| `Pacific/Pohnpei` \| `Pacific/Ponape` \| `Pacific/Port_Moresby` \| `Pacific/Rarotonga` \| `Pacific/Saipan` \| `Pacific/Samoa` \| `Pacific/Tahiti` \| `Pacific/Tarawa` \| `Pacific/Tongatapu` \| `Pacific/Truk` \| `Pacific/Wake` \| `Pacific/Wallis` \| `Pacific/Yap` \| `Poland` \| `Portugal` \| `ROC` \| `ROK` \| `Singapore` \| `Turkey` \| `UCT` \| `US/Alaska` \| `US/Aleutian` \| `US/Arizona` \| `US/Central` \| `US/East-Indiana` \| `US/Eastern` \| `US/Hawaii` \| `US/Indiana-Starke` \| `US/Michigan` \| `US/Mountain` \| `US/Pacific` \| `US/Samoa` \| `UTC` \| `Universal` \| `W-SU` \| `WET` \| `Zulu`	no	One of: `Africa/Abidjan`, `Africa/Accra`, `Africa/Addis_Ababa`, `Africa/Algiers`, `Africa/Asmara`, `Africa/Asmera`, `Africa/Bamako`, `Africa/Bangui`, `Africa/Banjul`, `Africa/Bissau`, `Africa/Blantyre`, `Africa/Brazzaville`, `Africa/Bujumbura`, `Africa/Cairo`, `Africa/Casablanca`, `Africa/Ceuta`, `Africa/Conakry`, `Africa/Dakar`, `Africa/Dar_es_Salaam`, `Africa/Djibouti`, `Africa/Douala`, `Africa/El_Aaiun`, `Africa/Freetown`, `Africa/Gaborone`, `Africa/Harare`, `Africa/Johannesburg`, `Africa/Juba`, `Africa/Kampala`, `Africa/Khartoum`, `Africa/Kigali`, `Africa/Kinshasa`, `Africa/Lagos`, `Africa/Libreville`, `Africa/Lome`, `Africa/Luanda`, `Africa/Lubumbashi`, `Africa/Lusaka`, `Africa/Malabo`, `Africa/Maputo`, `Africa/Maseru`, `Africa/Mbabane`, `Africa/Mogadishu`, `Africa/Monrovia`, `Africa/Nairobi`, `Africa/Ndjamena`, `Africa/Niamey`, `Africa/Nouakchott`, `Africa/Ouagadougou`, `Africa/Porto-Novo`, `Africa/Sao_Tome`, `Africa/Timbuktu`, `Africa/Tripoli`, `Africa/Tunis`, `Africa/Windhoek`, `America/Adak`, `America/Anchorage`, `America/Anguilla`, `America/Antigua`, `America/Araguaina`, `America/Argentina/Buenos_Aires`, `America/Argentina/Catamarca`, `America/Argentina/ComodRivadavia`, `America/Argentina/Cordoba`, `America/Argentina/Jujuy`, `America/Argentina/La_Rioja`, `America/Argentina/Mendoza`, `America/Argentina/Rio_Gallegos`, `America/Argentina/Salta`, `America/Argentina/San_Juan`, `America/Argentina/San_Luis`, `America/Argentina/Tucuman`, `America/Argentina/Ushuaia`, `America/Aruba`, `America/Asuncion`, `America/Atikokan`, `America/Atka`, `America/Bahia`, `America/Bahia_Banderas`, `America/Barbados`, `America/Belem`, `America/Belize`, `America/Blanc-Sablon`, `America/Boa_Vista`, `America/Bogota`, `America/Boise`, `America/Buenos_Aires`, `America/Cambridge_Bay`, `America/Campo_Grande`, `America/Cancun`, `America/Caracas`, `America/Catamarca`, `America/Cayenne`, `America/Cayman`, `America/Chicago`, `America/Chihuahua`, `America/Ciudad_Juarez`, `America/Coral_Harbour`, `America/Cordoba`, `America/Costa_Rica`, `America/Coyhaique`, `America/Creston`, `America/Cuiaba`, `America/Curacao`, `America/Danmarkshavn`, `America/Dawson`, `America/Dawson_Creek`, `America/Denver`, `America/Detroit`, `America/Dominica`, `America/Edmonton`, `America/Eirunepe`, `America/El_Salvador`, `America/Ensenada`, `America/Fort_Nelson`, `America/Fort_Wayne`, `America/Fortaleza`, `America/Glace_Bay`, `America/Godthab`, `America/Goose_Bay`, `America/Grand_Turk`, `America/Grenada`, `America/Guadeloupe`, `America/Guatemala`, `America/Guayaquil`, `America/Guyana`, `America/Halifax`, `America/Havana`, `America/Hermosillo`, `America/Indiana/Indianapolis`, `America/Indiana/Knox`, `America/Indiana/Marengo`, `America/Indiana/Petersburg`, `America/Indiana/Tell_City`, `America/Indiana/Vevay`, `America/Indiana/Vincennes`, `America/Indiana/Winamac`, `America/Indianapolis`, `America/Inuvik`, `America/Iqaluit`, `America/Jamaica`, `America/Jujuy`, `America/Juneau`, `America/Kentucky/Louisville`, `America/Kentucky/Monticello`, `America/Knox_IN`, `America/Kralendijk`, `America/La_Paz`, `America/Lima`, `America/Los_Angeles`, `America/Louisville`, `America/Lower_Princes`, `America/Maceio`, `America/Managua`, `America/Manaus`, `America/Marigot`, `America/Martinique`, `America/Matamoros`, `America/Mazatlan`, `America/Mendoza`, `America/Menominee`, `America/Merida`, `America/Metlakatla`, `America/Mexico_City`, `America/Miquelon`, `America/Moncton`, `America/Monterrey`, `America/Montevideo`, `America/Montreal`, `America/Montserrat`, `America/Nassau`, `America/New_York`, `America/Nipigon`, `America/Nome`, `America/Noronha`, `America/North_Dakota/Beulah`, `America/North_Dakota/Center`, `America/North_Dakota/New_Salem`, `America/Nuuk`, `America/Ojinaga`, `America/Panama`, `America/Pangnirtung`, `America/Paramaribo`, `America/Phoenix`, `America/Port-au-Prince`, `America/Port_of_Spain`, `America/Porto_Acre`, `America/Porto_Velho`, `America/Puerto_Rico`, `America/Punta_Arenas`, `America/Rainy_River`, `America/Rankin_Inlet`, `America/Recife`, `America/Regina`, `America/Resolute`, `America/Rio_Branco`, `America/Rosario`, `America/Santa_Isabel`, `America/Santarem`, `America/Santiago`, `America/Santo_Domingo`, `America/Sao_Paulo`, `America/Scoresbysund`, `America/Shiprock`, `America/Sitka`, `America/St_Barthelemy`, `America/St_Johns`, `America/St_Kitts`, `America/St_Lucia`, `America/St_Thomas`, `America/St_Vincent`, `America/Swift_Current`, `America/Tegucigalpa`, `America/Thule`, `America/Thunder_Bay`, `America/Tijuana`, `America/Toronto`, `America/Tortola`, `America/Vancouver`, `America/Virgin`, `America/Whitehorse`, `America/Winnipeg`, `America/Yakutat`, `America/Yellowknife`, `Antarctica/Casey`, `Antarctica/Davis`, `Antarctica/DumontDUrville`, `Antarctica/Macquarie`, `Antarctica/Mawson`, `Antarctica/McMurdo`, `Antarctica/Palmer`, `Antarctica/Rothera`, `Antarctica/South_Pole`, `Antarctica/Syowa`, `Antarctica/Troll`, `Antarctica/Vostok`, `Arctic/Longyearbyen`, `Asia/Aden`, `Asia/Almaty`, `Asia/Amman`, `Asia/Anadyr`, `Asia/Aqtau`, `Asia/Aqtobe`, `Asia/Ashgabat`, `Asia/Ashkhabad`, `Asia/Atyrau`, `Asia/Baghdad`, `Asia/Bahrain`, `Asia/Baku`, `Asia/Bangkok`, `Asia/Barnaul`, `Asia/Beirut`, `Asia/Bishkek`, `Asia/Brunei`, `Asia/Calcutta`, `Asia/Chita`, `Asia/Choibalsan`, `Asia/Chongqing`, `Asia/Chungking`, `Asia/Colombo`, `Asia/Dacca`, `Asia/Damascus`, `Asia/Dhaka`, `Asia/Dili`, `Asia/Dubai`, `Asia/Dushanbe`, `Asia/Famagusta`, `Asia/Gaza`, `Asia/Harbin`, `Asia/Hebron`, `Asia/Ho_Chi_Minh`, `Asia/Hong_Kong`, `Asia/Hovd`, `Asia/Irkutsk`, `Asia/Istanbul`, `Asia/Jakarta`, `Asia/Jayapura`, `Asia/Jerusalem`, `Asia/Kabul`, `Asia/Kamchatka`, `Asia/Karachi`, `Asia/Kashgar`, `Asia/Kathmandu`, `Asia/Katmandu`, `Asia/Khandyga`, `Asia/Kolkata`, `Asia/Krasnoyarsk`, `Asia/Kuala_Lumpur`, `Asia/Kuching`, `Asia/Kuwait`, `Asia/Macao`, `Asia/Macau`, `Asia/Magadan`, `Asia/Makassar`, `Asia/Manila`, `Asia/Muscat`, `Asia/Nicosia`, `Asia/Novokuznetsk`, `Asia/Novosibirsk`, `Asia/Omsk`, `Asia/Oral`, `Asia/Phnom_Penh`, `Asia/Pontianak`, `Asia/Pyongyang`, `Asia/Qatar`, `Asia/Qostanay`, `Asia/Qyzylorda`, `Asia/Rangoon`, `Asia/Riyadh`, `Asia/Saigon`, `Asia/Sakhalin`, `Asia/Samarkand`, `Asia/Seoul`, `Asia/Shanghai`, `Asia/Singapore`, `Asia/Srednekolymsk`, `Asia/Taipei`, `Asia/Tashkent`, `Asia/Tbilisi`, `Asia/Tehran`, `Asia/Tel_Aviv`, `Asia/Thimbu`, `Asia/Thimphu`, `Asia/Tokyo`, `Asia/Tomsk`, `Asia/Ujung_Pandang`, `Asia/Ulaanbaatar`, `Asia/Ulan_Bator`, `Asia/Urumqi`, `Asia/Ust-Nera`, `Asia/Vientiane`, `Asia/Vladivostok`, `Asia/Yakutsk`, `Asia/Yangon`, `Asia/Yekaterinburg`, `Asia/Yerevan`, `Atlantic/Azores`, `Atlantic/Bermuda`, `Atlantic/Canary`, `Atlantic/Cape_Verde`, `Atlantic/Faeroe`, `Atlantic/Faroe`, `Atlantic/Jan_Mayen`, `Atlantic/Madeira`, `Atlantic/Reykjavik`, `Atlantic/South_Georgia`, `Atlantic/St_Helena`, `Atlantic/Stanley`, `Australia/ACT`, `Australia/Adelaide`, `Australia/Brisbane`, `Australia/Broken_Hill`, `Australia/Canberra`, `Australia/Currie`, `Australia/Darwin`, `Australia/Eucla`, `Australia/Hobart`, `Australia/LHI`, `Australia/Lindeman`, `Australia/Lord_Howe`, `Australia/Melbourne`, `Australia/NSW`, `Australia/North`, `Australia/Perth`, `Australia/Queensland`, `Australia/South`, `Australia/Sydney`, `Australia/Tasmania`, `Australia/Victoria`, `Australia/West`, `Australia/Yancowinna`, `Brazil/Acre`, `Brazil/DeNoronha`, `Brazil/East`, `Brazil/West`, `CET`, `CST6CDT`, `Canada/Atlantic`, `Canada/Central`, `Canada/Eastern`, `Canada/Mountain`, `Canada/Newfoundland`, `Canada/Pacific`, `Canada/Saskatchewan`, `Canada/Yukon`, `Chile/Continental`, `Chile/EasterIsland`, `Cuba`, `EET`, `EST`, `EST5EDT`, `Egypt`, `Eire`, `Etc/GMT`, `Etc/GMT+0`, `Etc/GMT+1`, `Etc/GMT+10`, `Etc/GMT+11`, `Etc/GMT+12`, `Etc/GMT+2`, `Etc/GMT+3`, `Etc/GMT+4`, `Etc/GMT+5`, `Etc/GMT+6`, `Etc/GMT+7`, `Etc/GMT+8`, `Etc/GMT+9`, `Etc/GMT-0`, `Etc/GMT-1`, `Etc/GMT-10`, `Etc/GMT-11`, `Etc/GMT-12`, `Etc/GMT-13`, `Etc/GMT-14`, `Etc/GMT-2`, `Etc/GMT-3`, `Etc/GMT-4`, `Etc/GMT-5`, `Etc/GMT-6`, `Etc/GMT-7`, `Etc/GMT-8`, `Etc/GMT-9`, `Etc/GMT0`, `Etc/Greenwich`, `Etc/UCT`, `Etc/UTC`, `Etc/Universal`, `Etc/Zulu`, `Europe/Amsterdam`, `Europe/Andorra`, `Europe/Astrakhan`, `Europe/Athens`, `Europe/Belfast`, `Europe/Belgrade`, `Europe/Berlin`, `Europe/Bratislava`, `Europe/Brussels`, `Europe/Bucharest`, `Europe/Budapest`, `Europe/Busingen`, `Europe/Chisinau`, `Europe/Copenhagen`, `Europe/Dublin`, `Europe/Gibraltar`, `Europe/Guernsey`, `Europe/Helsinki`, `Europe/Isle_of_Man`, `Europe/Istanbul`, `Europe/Jersey`, `Europe/Kaliningrad`, `Europe/Kiev`, `Europe/Kirov`, `Europe/Kyiv`, `Europe/Lisbon`, `Europe/Ljubljana`, `Europe/London`, `Europe/Luxembourg`, `Europe/Madrid`, `Europe/Malta`, `Europe/Mariehamn`, `Europe/Minsk`, `Europe/Monaco`, `Europe/Moscow`, `Europe/Nicosia`, `Europe/Oslo`, `Europe/Paris`, `Europe/Podgorica`, `Europe/Prague`, `Europe/Riga`, `Europe/Rome`, `Europe/Samara`, `Europe/San_Marino`, `Europe/Sarajevo`, `Europe/Saratov`, `Europe/Simferopol`, `Europe/Skopje`, `Europe/Sofia`, `Europe/Stockholm`, `Europe/Tallinn`, `Europe/Tirane`, `Europe/Tiraspol`, `Europe/Ulyanovsk`, `Europe/Uzhgorod`, `Europe/Vaduz`, `Europe/Vatican`, `Europe/Vienna`, `Europe/Vilnius`, `Europe/Volgograd`, `Europe/Warsaw`, `Europe/Zagreb`, `Europe/Zaporozhye`, `Europe/Zurich`, `GB`, `GB-Eire`, `GMT`, `GMT+0`, `GMT-0`, `GMT0`, `Greenwich`, `HST`, `Hongkong`, `Iceland`, `Indian/Antananarivo`, `Indian/Chagos`, `Indian/Christmas`, `Indian/Cocos`, `Indian/Comoro`, `Indian/Kerguelen`, `Indian/Mahe`, `Indian/Maldives`, `Indian/Mauritius`, `Indian/Mayotte`, `Indian/Reunion`, `Iran`, `Israel`, `Jamaica`, `Japan`, `Kwajalein`, `Libya`, `MET`, `MST`, `MST7MDT`, `Mexico/BajaNorte`, `Mexico/BajaSur`, `Mexico/General`, `NZ`, `NZ-CHAT`, `Navajo`, `PRC`, `PST8PDT`, `Pacific/Apia`, `Pacific/Auckland`, `Pacific/Bougainville`, `Pacific/Chatham`, `Pacific/Chuuk`, `Pacific/Easter`, `Pacific/Efate`, `Pacific/Enderbury`, `Pacific/Fakaofo`, `Pacific/Fiji`, `Pacific/Funafuti`, `Pacific/Galapagos`, `Pacific/Gambier`, `Pacific/Guadalcanal`, `Pacific/Guam`, `Pacific/Honolulu`, `Pacific/Johnston`, `Pacific/Kanton`, `Pacific/Kiritimati`, `Pacific/Kosrae`, `Pacific/Kwajalein`, `Pacific/Majuro`, `Pacific/Marquesas`, `Pacific/Midway`, `Pacific/Nauru`, `Pacific/Niue`, `Pacific/Norfolk`, `Pacific/Noumea`, `Pacific/Pago_Pago`, `Pacific/Palau`, `Pacific/Pitcairn`, `Pacific/Pohnpei`, `Pacific/Ponape`, `Pacific/Port_Moresby`, `Pacific/Rarotonga`, `Pacific/Saipan`, `Pacific/Samoa`, `Pacific/Tahiti`, `Pacific/Tarawa`, `Pacific/Tongatapu`, `Pacific/Truk`, `Pacific/Wake`, `Pacific/Wallis`, `Pacific/Yap`, `Poland`, `Portugal`, `ROC`, `ROK`, `Singapore`, `Turkey`, `UCT`, `US/Alaska`, `US/Aleutian`, `US/Arizona`, `US/Central`, `US/East-Indiana`, `US/Eastern`, `US/Hawaii`, `US/Indiana-Starke`, `US/Michigan`, `US/Mountain`, `US/Pacific`, `US/Samoa`, `UTC`, `Universal`, `W-SU`, `WET`, `Zulu`.
`updated`	timestamp	no	Time (milliseconds since 1970-01-01 UTC)
`allowGuests`	boolean	no

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('calendar.update_calendar', [
  {
    _id: '507f1f77bcf86cd799439011',
    name: 'string',
    color: 'string',
  },
]);
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? }.

`calendar.update_event`

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, required):

Field	Type	Required
`_id`	ObjectId	yes
`allDay`	boolean	no
`attendees`	Record<string, boolean>	no
`calendar_id`	ObjectId	yes
`end`	number \| timestamp	yes
`location`	string	no
`notes`	string	no
`repeat_id`	ObjectId	no
`start`	number \| timestamp	yes
`title`	string	yes
`cid`	ObjectId	no

Argument 2 (object, optional):

Field	Type	Required	Description
`repeat_id`	ObjectId	no
`update`	`future` \| `all` \| `single`	no	One of: `future`, `all`, `single`.

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('calendar.update_event', [
  {
    _id: '507f1f77bcf86cd799439011',
    calendar_id: '507f1f77bcf86cd799439011',
    end: 0,
    start: 0,
    title: 'string',
  },
  {
    repeat_id: '507f1f77bcf86cd799439011',
    update: 'future',
  },
]);
console.log(result);

Returns

any \| Record<string, boolean>

Auth: requires an authenticated session.

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

Endpoints

Legacy

V2

V3

Calendar

Endpoints

`calendar.calendar_permission`

`calendar.create_event`

`calendar.create_own_ical`

`calendar.generate_ical_link`

`calendar.invite_respond`

`calendar.list_all`

`calendar.list_ical_links`

`calendar.load_calendars`

`calendar.load_event`

`calendar.load_events`

`calendar.load_repeat_series`

`calendar.remove_calendar`

`calendar.remove_event`

`calendar.remove_ical_link`

`calendar.remove_invite`

`calendar.remove_own_ical`

`calendar.save_selected_calendars`

`calendar.upcoming_events`

`calendar.update_calendar`

`calendar.update_event`

Legacy

V2

V3

Calendar ​

Endpoints ​

calendar.calendar_permission ​

calendar.create_event ​

calendar.create_own_ical ​

calendar.generate_ical_link ​

calendar.invite_respond ​

calendar.list_all ​

calendar.list_ical_links ​

calendar.load_calendars ​

calendar.load_event ​

calendar.load_events ​

calendar.load_repeat_series ​

calendar.remove_calendar ​

calendar.remove_event ​

calendar.remove_ical_link ​

calendar.remove_invite ​

calendar.remove_own_ical ​

calendar.save_selected_calendars ​

calendar.upcoming_events ​

calendar.update_calendar ​

calendar.update_event ​

Calendar

Endpoints

`calendar.calendar_permission`

`calendar.create_event`

`calendar.create_own_ical`

`calendar.generate_ical_link`

`calendar.invite_respond`

`calendar.list_all`

`calendar.list_ical_links`

`calendar.load_calendars`

`calendar.load_event`

`calendar.load_events`

`calendar.load_repeat_series`

`calendar.remove_calendar`

`calendar.remove_event`

`calendar.remove_ical_link`

`calendar.remove_invite`

`calendar.remove_own_ical`

`calendar.save_selected_calendars`

`calendar.upcoming_events`

`calendar.update_calendar`

`calendar.update_event`