Namespace: hs/calendar

Methods

hs/calendar.contentEvents (eventProperties)Promise asyncstatic

Retrieve all events of type 'content'

Name	Type	Description
eventProperties	object	An object containing event properties to search for

Properties:

Name	Type	Argument	Description
eventProperties.startDate	number
eventProperties.endDate	number
eventProperties.limit	number	<optional>

Returns:

Type	Description
Promise

Example

const hs = new HubspotClient(props);
hs.calendar.contentEvents(eventProperties).then(response => console.log(response))

hs/calendar.createTask (taskProperties)Promise asyncstatic

Create new task

Name	Type	Description
taskProperties	object	An object containing task properties to create

Properties:

Name	Type	Argument	Default	Description
taskProperties.eventDate	number
taskProperties.eventType	number	<optional>	PUBLISHING_TASK
taskProperties.category	number
taskProperties.state	number	<optional>	TODO
taskProperties.campaignGuid	number	<optional>
taskProperties.contentGroupId	number	<optional>		Required if category=BLOG_POST
taskProperties.topicIds	number	<optional>
taskProperties.templatePath	number	<optional>
taskProperties.name	number	<optional>
taskProperties.description	number	<optional>
taskProperties.ownerId	number	<optional>

Returns:

Type	Description
Promise

Example

const hs = new HubspotClient(props);
hs.calendar.createTask(taskProperties).then(response => console.log(response))

hs/calendar.deleteTask (taskId)Promise asyncstatic

Delete Task By ID

Name	Type	Description
taskId	number	ID of task to delete

Returns:

Type	Description
Promise

Example

const hs = new HubspotClient(props);
hs.calendar.deleteTask(taskId).then(response => console.log(response))

hs/calendar.events (eventProperties)Promise asyncstatic

Retrieve all event types

Name	Type	Description
eventProperties	object	An object containing event properties to search for

Properties:

Name	Type	Argument	Description
eventProperties.startDate	number
eventProperties.endDate	number
eventProperties.limit	number	<optional>

Returns:

Type	Description
Promise

Example

const hs = new HubspotClient(props);
hs.calendar.events(eventProperties).then(response => console.log(response))

hs/calendar.getTask (taskId)Promise asyncstatic

Get Task By ID

Name	Type	Description
taskId	number	ID of task to retrieve

Returns:

Type	Description
Promise

Example

const hs = new HubspotClient(props);
hs.calendar.getTask(taskId).then(response => console.log(response))

hs/calendar.socialEvents (eventProperties)Promise asyncstatic

Retrieve all events of type 'social'

Name	Type	Description
eventProperties	object	An object containing event properties to search for

Properties:

Name	Type	Argument	Description
eventProperties.startDate	number
eventProperties.endDate	number
eventProperties.limit	number	<optional>

Returns:

Type	Description
Promise

Example

const hs = new HubspotClient(props);
hs.calendar.socialEvents(eventProperties).then(response => console.log(response))

hs/calendar.taskEvents (eventProperties)Promise asyncstatic

Retrieve all events of type 'task'

Name	Type	Description
eventProperties	object	An object containing event properties to search for

Properties:

Name	Type	Argument	Description
eventProperties.startDate	number
eventProperties.endDate	number
eventProperties.limit	number	<optional>

Returns:

Type	Description
Promise

Example

const hs = new HubspotClient(props);
hs.calendar.taskEvents(eventProperties).then(response => console.log(response))

hs/calendar.updateTask (taskId, taskProperties)Promise asyncstatic

Update existing task

Name	Type	Description
taskId	number	ID of task to update
taskProperties	object	An object containing task properties to update

Properties:

Name	Type	Argument	Description
taskProperties.eventDate	number	<optional>
taskProperties.eventType	number	<optional>
taskProperties.category	number	<optional>
taskProperties.state	number	<optional>
taskProperties.campaignGuid	number	<optional>
taskProperties.topicIds	number	<optional>
taskProperties.name	number	<optional>
taskProperties.description	number	<optional>
taskProperties.ownerId	number	<optional>

Returns:

Type	Description
Promise

Example

const hs = new HubspotClient(props);
hs.calendar.updateTask(taskProperties).then(response => console.log(response))