Class: PurchasesHelper

PurchasesHelper()

A helper type for resource purchase-related API endpoints.

Constructor

new PurchasesHelper()

Source:

Methods

(async) fetch(resourceId, purchaseId) → {Purchase}

Fetch a purchase for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
purchaseId number The identifier of the purchase.
Source:
Returns:
A raw data object.
Type
Purchase

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

List a page of purchases 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.<Purchase>

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

List all pages of purchases 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.<Purchase>

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

List multiple pages of purchases 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.<Purchase>