Entity objects

Most of the library's methods return entityObjects, which mirror the objects in our API Reference with just a little tweak, they also feature a set of methods that can be called on the entityObject.

Supported entity objects

Methods

methodDescription

refresh

Retrieves the most recent state of entityObnject from the server.

update

Updates the entityObject fields on the server with the values contained in the object passed as argument.

save

Updates the entire entityObject fields on the server with the values contained in the object passed as argument.

refresh

Arguments: None

Signature: <entity>.refresh()

Return: <entity>

update

Arguments: propertiesObject: Object => An object containing entity properties

Signature: <entity>.update(propertiesObject)

Return: <entity>

save

Arguments: propertiesObject: Object => An object containing all entity properties

Signature: <entity>.save()

Return: <entity>

Last updated