Class: abstract PatreonClient<IncludeAll>

Defined in: rest/v2/clients/base.ts:67

Extends

• PatreonClientMethods<IncludeAll>

Extended by

• PatreonCreatorClient
• PatreonUserClient

Type Parameters

IncludeAll

IncludeAll extends boolean = false

Constructors

Constructor

new PatreonClient<IncludeAll>(options, type): PatreonClient<IncludeAll>

Defined in: rest/v2/clients/base.ts:77

Parameters

options

PatreonClientOptions<IncludeAll>

type

"creator" | "oauth"

Returns

PatreonClient<IncludeAll>

Overrides

PatreonClientMethods<IncludeAll>.constructor

Properties

listCampaignMembers()

listCampaignMembers: <Query>(campaignId, query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Defined in: rest/v2/clients/baseMethods.ts:250

Type Parameters

Query

Query extends BasePatreonQueryType<Member, true> = If<IncludeAll, PatreonQuery<Member, "address" | "campaign" | "user" | "currently_entitled_tiers" | "pledge_history", RelationshipMap<Member, "address" | "campaign" | "user" | "currently_entitled_tiers" | "pledge_history">, true>, PatreonQuery<Member, never, never, true>>

Parameters

campaignId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Deprecated

Inherited from

PatreonClientMethods.listCampaignMembers

---

listCampaignPosts()

listCampaignPosts: <Query>(campaignId, query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Defined in: rest/v2/clients/baseMethods.ts:248

Type Parameters

Query

Query extends BasePatreonQueryType<Post, true> = If<IncludeAll, PatreonQuery<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">, true>, PatreonQuery<Post, never, never, true>>

Parameters

campaignId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Deprecated

Inherited from

PatreonClientMethods.listCampaignPosts

---

listCampaigns()

listCampaigns: <Query>(query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Defined in: rest/v2/clients/baseMethods.ts:252

Type Parameters

Query

Query extends BasePatreonQueryType<Campaign, true> = If<IncludeAll, PatreonQuery<Campaign, "benefits" | "creator" | "goals" | "tiers", RelationshipMap<Campaign, "benefits" | "creator" | "goals" | "tiers">, true>, PatreonQuery<Campaign, never, never, true>>

Parameters

query?

Query = ...

options?

Oauth2RouteOptions

Returns

AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Deprecated

Inherited from

PatreonClientMethods.listCampaigns

---

listOauth2()

listOauth2: <Query>(path, query, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Defined in: rest/v2/clients/baseMethods.ts:246

Paginate the Patreon Oauth V2 API until all pages are fetched

Type Parameters

Query

Query extends BasePatreonQuery

Parameters

path

string

The Oauth V2 API Route

query

Query

The query builder with included fields and attributes

options?

Oauth2FetchOptions

Request options

Returns

AsyncGenerator<GetResponsePayload<Query>, number, unknown>

the amount of pages fetched

Yields

a page of response data

Deprecated

Inherited from

PatreonClientMethods.listOauth2

---

name

name: null | string = null

Defined in: rest/v2/clients/baseMethods.ts:266

The application name of the client.

Default

null

Inherited from

PatreonClientMethods.name

---

normalized

normalized: GenericPatreonClientMethods<"normalized", IncludeAll>

Defined in: rest/v2/clients/baseMethods.ts:260

Inherited from

PatreonClientMethods.normalized

---

oauth

oauth: PatreonOauthClient

Defined in: rest/v2/clients/baseMethods.ts:256

Inherited from

PatreonClientMethods.oauth

---

simplified

simplified: GenericPatreonClientMethods<"simplified", IncludeAll>

Defined in: rest/v2/clients/baseMethods.ts:258

Inherited from

PatreonClientMethods.simplified

---

webhooks

webhooks: WebhookClient

Defined in: rest/v2/clients/base.ts:75

Interact with the webhooks API.

Client to use for creating, updating and getting webhooks from the current client.

Methods

fetchCampaign()

fetchCampaign<Query>(campaignId, query?, options?): Promise<GetResponsePayload<Query>>

Defined in: rest/v2/clients/baseMethods.ts:148

Type Parameters

Query

Query extends BasePatreonQueryType<Campaign, false> = If<IncludeAll, PatreonQuery<Campaign, "benefits" | "creator" | "goals" | "tiers", RelationshipMap<Campaign, "benefits" | "creator" | "goals" | "tiers">, false>, PatreonQuery<Campaign, never, never, false>>

Parameters

campaignId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

Promise<GetResponsePayload<Query>>

Inherited from

PatreonClientMethods.fetchCampaign

---

fetchCampaignMembers()

fetchCampaignMembers<Query>(campaignId, query?, options?): Promise<GetResponsePayload<Query>>

Defined in: rest/v2/clients/baseMethods.ts:159

Type Parameters

Query

Query extends BasePatreonQueryType<Member, true> = If<IncludeAll, PatreonQuery<Member, "address" | "campaign" | "user" | "currently_entitled_tiers" | "pledge_history", RelationshipMap<Member, "address" | "campaign" | "user" | "currently_entitled_tiers" | "pledge_history">, true>, PatreonQuery<Member, never, never, true>>

Parameters

campaignId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

Promise<GetResponsePayload<Query>>

Inherited from

PatreonClientMethods.fetchCampaignMembers

---

fetchCampaignPosts()

fetchCampaignPosts<Query>(campaignId, query?, options?): Promise<GetResponsePayload<Query>>

Defined in: rest/v2/clients/baseMethods.ts:170

Type Parameters

Query

Query extends BasePatreonQueryType<Post, true> = If<IncludeAll, PatreonQuery<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">, true>, PatreonQuery<Post, never, never, true>>

Parameters

campaignId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

Promise<GetResponsePayload<Query>>

Inherited from

PatreonClientMethods.fetchCampaignPosts

---

fetchCampaigns()

fetchCampaigns<Query>(query?, options?): Promise<GetResponsePayload<Query>>

Defined in: rest/v2/clients/baseMethods.ts:138

Type Parameters

Query

Query extends BasePatreonQueryType<Campaign, true> = If<IncludeAll, PatreonQuery<Campaign, "benefits" | "creator" | "goals" | "tiers", RelationshipMap<Campaign, "benefits" | "creator" | "goals" | "tiers">, true>, PatreonQuery<Campaign, never, never, true>>

Parameters

query?

Query = ...

options?

Oauth2RouteOptions

Returns

Promise<GetResponsePayload<Query>>

Inherited from

PatreonClientMethods.fetchCampaigns

---

fetchIdentity()

fetchIdentity<Query>(query?, options?): Promise<GetResponsePayload<Query>>

Defined in: rest/v2/clients/baseMethods.ts:203

Type Parameters

Query

Query extends BasePatreonQueryType<User, false> = If<IncludeAll, PatreonQuery<User, "campaign" | "memberships", RelationshipMap<User, "campaign" | "memberships">, false>, PatreonQuery<User, never, never, false>>

Parameters

query?

Query = ...

options?

Oauth2RouteOptions

Returns

Promise<GetResponsePayload<Query>>

Inherited from

PatreonClientMethods.fetchIdentity

---

fetchMember()

fetchMember<Query>(memberId, query?, options?): Promise<GetResponsePayload<Query>>

Defined in: rest/v2/clients/baseMethods.ts:181

Type Parameters

Query

Query extends BasePatreonQueryType<Member, false> = If<IncludeAll, PatreonQuery<Member, "address" | "campaign" | "user" | "currently_entitled_tiers" | "pledge_history", RelationshipMap<Member, "address" | "campaign" | "user" | "currently_entitled_tiers" | "pledge_history">, false>, PatreonQuery<Member, never, never, false>>

Parameters

memberId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

Promise<GetResponsePayload<Query>>

Inherited from

PatreonClientMethods.fetchMember

---

fetchOauth2()

fetchOauth2<Query>(path, query, options?): Promise<GetResponsePayload<Query>>

Defined in: rest/v2/clients/baseMethods.ts:95

Fetch the Patreon Oauth V2 API

Type Parameters

Query

Query extends BasePatreonQuery

Parameters

path

string

The Oauth V2 API Route

query

Query

The query builder with included fields and attributes

options?

Oauth2FetchOptions

Request options

Returns

Promise<GetResponsePayload<Query>>

the response for succesful requests

Throws

on failed request

Inherited from

PatreonClientMethods.fetchOauth2

---

fetchPost()

fetchPost<Query>(postId, query?, options?): Promise<GetResponsePayload<Query>>

Defined in: rest/v2/clients/baseMethods.ts:192

Type Parameters

Query

Query extends BasePatreonQueryType<Post, false> = If<IncludeAll, PatreonQuery<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">, false>, PatreonQuery<Post, never, never, false>>

Parameters

postId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

Promise<GetResponsePayload<Query>>

Inherited from

PatreonClientMethods.fetchPost

---

fetchStoredToken()

fetchStoredToken(): Promise<undefined | Oauth2StoredToken>

Defined in: rest/v2/clients/base.ts:108

Fetch the stored token with the get method from the client options

Returns

Promise<undefined | Oauth2StoredToken>

the stored token, if options.store.get is defined and returns succesfully.

---

paginateCampaignMembers()

paginateCampaignMembers<Query>(campaignId, query?, options?): AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Defined in: rest/v2/clients/baseMethods.ts:223

Type Parameters

Query

Query extends BasePatreonQueryType<Member, true> = If<IncludeAll, PatreonQuery<Member, "address" | "campaign" | "user" | "currently_entitled_tiers" | "pledge_history", RelationshipMap<Member, "address" | "campaign" | "user" | "currently_entitled_tiers" | "pledge_history">, true>, PatreonQuery<Member, never, never, true>>

Parameters

campaignId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Inherited from

PatreonClientMethods.paginateCampaignMembers

---

paginateCampaignPosts()

paginateCampaignPosts<Query>(campaignId, query?, options?): AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Defined in: rest/v2/clients/baseMethods.ts:234

Type Parameters

Query

Query extends BasePatreonQueryType<Post, true> = If<IncludeAll, PatreonQuery<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">, true>, PatreonQuery<Post, never, never, true>>

Parameters

campaignId

string

query?

Query = ...

options?

Oauth2RouteOptions

Returns

AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Inherited from

PatreonClientMethods.paginateCampaignPosts

---

paginateCampaigns()

paginateCampaigns<Query>(query?, options?): AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Defined in: rest/v2/clients/baseMethods.ts:213

Type Parameters

Query

Query extends BasePatreonQueryType<Campaign, true> = If<IncludeAll, PatreonQuery<Campaign, "benefits" | "creator" | "goals" | "tiers", RelationshipMap<Campaign, "benefits" | "creator" | "goals" | "tiers">, true>, PatreonQuery<Campaign, never, never, true>>

Parameters

query?

Query = ...

options?

Oauth2RouteOptions

Returns

AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Inherited from

PatreonClientMethods.paginateCampaigns

---

paginateOauth2()

paginateOauth2<Query>(path, query, options?): AsyncGenerator<GetResponsePayload<Query>, number, unknown>

Defined in: rest/v2/clients/baseMethods.ts:117

Paginate the Patreon Oauth V2 API until all pages are fetched

Type Parameters

Query

Query extends BasePatreonQuery

Parameters

path

string

The Oauth V2 API Route

query

Query

The query builder with included fields and attributes

options?

Oauth2FetchOptions

Request options

Returns

AsyncGenerator<GetResponsePayload<Query>, number, unknown>

the amount of pages fetched

Yields

a page of response data

Inherited from

PatreonClientMethods.paginateOauth2

---

putStoredToken()

putStoredToken(token, cache?): Promise<void>

Defined in: rest/v2/clients/base.ts:117

Save your token with the method from the client options

Parameters

token

Oauth2StoredToken

The token to save

cache?

boolean

Whether to overwrite the application token cache and update it with the token

Returns

Promise<void>

---

createCustomParser()

static createCustomParser<Type, IncludeAll>(client, type, parser, includeAllQueries): GenericPatreonClientMethods<Type, IncludeAll>

Defined in: rest/v2/clients/baseMethods.ts:295

Type Parameters

Type

Type extends keyof ResponseTransformMap<BasePatreonQuery>

IncludeAll

IncludeAll extends boolean = boolean

Parameters

client

PatreonClientMethods<IncludeAll>

type

Type

parser

ResponseTransformMap<BasePatreonQuery>[Type]

includeAllQueries

IncludeAll

Returns

GenericPatreonClientMethods<Type, IncludeAll>

Inherited from

PatreonClientMethods.createCustomParser

---

hasAllQueriesEnabled()

static hasAllQueriesEnabled<Client>(client): client is Client & PatreonClientMethods<true>

Defined in: rest/v2/clients/baseMethods.ts:289

Type Parameters

Client

Client extends PatreonClientMethods<boolean>

Parameters

client

Client

Returns

client is Client & PatreonClientMethods<true>

Inherited from

PatreonClientMethods.hasAllQueriesEnabled