Class: TiltifyClient

TiltifyClient(clientID, clientSecret)

new TiltifyClient(clientID, clientSecret)

A TiltifyClient contains all of the sub-types that exist on the Tiltify API
Parameters:
Name Type Description
clientID string The Client ID that you got from Tiltify.
clientSecret string The Client Secret that you got from Tiltify.
Source:

Members

Campaigns :Campaign

this.Campaigns is used to get info about campaigns
Type:
Source:

Causes :Cause

this.Causes is used to get info about causes
Type:
Source:

FundraisingEvents :FundraisingEvents

this.FundraisingEvents is used to get info about fundraising events
Type:
Source:

Team :Team

this.Team is used to get info about a team
Type:
Source:

TeamCampaigns :TeamCampaign

this.TeamCampaign is used to get info about team campaigns
Type:
Source:

User :User

this.User is used to get info about a user
Type:
Source:

Webhook :User

this.Webhook is used to get info, subscribe, and manage webhooks
Type:
Source:

Methods

(async) _doRequest(path, method, payload)

_doRequest does a single request and returns the response. Normally this is wrapped in _sendRequest, but for some endpoints like Campaigns.getRecentDonations(id) need to send only a single request. This function is not actually called in the TiltifyClient, and is passed down to each of the types.
Parameters:
Name Type Default Description
path string The path, without /api/.
method string GET HTTP method to make calls with, default to GET
payload Object JSON payload to send
Source:

(async) _sendRequest(path, callback)

_sendRequest is used for all endpoints, but only has a recursive effect when called againt an endpoint that contains a `metadata.after` string
Parameters:
Name Type Description
path string The path, without /api/public/
callback function A function to call when we're done processing.
Source:

(async) generateKey(attempt)

Generate an access token to call the api, recursively calls itself when regenerating keys
Parameters:
Name Type Default Description
attempt int 1 Attempt counter, for spacing out retries
Source:

(async) initialize()

Generate access key and fully initialize the client
Source:

setKey(key)

Set the API key manually, this also disables the refresh checker. Primarily used for testing
Parameters:
Name Type Description
key string API key
Source: