Class: UpdatesHelper

UpdatesHelper()

A helper type for resource update-related API endpoints.

Constructor

new UpdatesHelper()

Source:

Methods

(async) delete(resourceId, updateId)

Delete an update for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
updateId number The identifier of the update.
Source:

(async) fetch(resourceId, updateId) → {Update}

Fetch an update for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
updateId number The identifier of the update.
Source:
Returns:
A raw data object.
Type
Update

(async) latest(resourceId) → {Update}

Fetch the latest update for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
Source:
Returns:
A raw data object.
Type
Update

(async) list(resourceId, sort) → {Array.<Update>}

List a page of updates for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<Update>

(async) listAll(resourceId, sort) → {Array.<Update>}

List all pages of updates for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<Update>

(async) listUntil(resourceId, shouldContinue, sort) → {Array.<Update>}

List multiple pages of updates for a given resource until a condition is no longer met.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
shouldContinue function A function which determines if further pages are requested.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<Update>