patreon-api.ts

Appearance

Class: PatreonUserClient<IncludeAll> ​

Defined in: rest/v2/clients/user.ts:39

Extends ​

Type Parameters ​

IncludeAll ​

IncludeAll extends boolean = false

Constructors ​

Constructor ​

new PatreonUserClient<IncludeAll>(options): PatreonUserClient<IncludeAll>

Defined in: rest/v2/clients/user.ts:40

Parameters ​

options ​

PatreonClientOptions<IncludeAll>

Returns ​

PatreonUserClient<IncludeAll>

Overrides ​

PatreonClient.constructor

Properties ​

listCampaignMembers() ​

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

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

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 ​

PatreonClient.listCampaignMembers

listCampaignPosts() ​

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

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

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 ​

PatreonClient.listCampaignPosts

listCampaigns() ​

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

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

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 ​

PatreonClient.listCampaigns

listOauth2() ​

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

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

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 ​

PatreonClient.listOauth2

normalized ​

normalized: GenericPatreonClientMethods<"normalized", IncludeAll>

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

Inherited from ​

PatreonClient.normalized

simplified ​

simplified: GenericPatreonClientMethods<"simplified", IncludeAll>

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

Inherited from ​

PatreonClient.simplified

webhooks ​

webhooks: WebhookClient

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

Interact with the webhooks API.

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

Inherited from ​

PatreonClient.webhooks

Accessors ​

name ​

Get Signature ​

get name(): null | string

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

The application name of the client.

Default ​
ts
null
Returns ​

null | string

Set Signature ​

set name(value): void

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

Parameters ​
value ​

null | string

Returns ​

void

Inherited from ​

PatreonClient.name

oauth ​

Get Signature ​

get oauth(): PatreonOauthClient

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

Returns ​

PatreonOauthClient

Inherited from ​

PatreonClient.oauth

Methods ​

createInstance() ​

createInstance(request): Promise<PatreonUserClientInstance>

Defined in: rest/v2/clients/user.ts:68

Create a client with the current user authenticated.

Parameters ​

request ​

The request or url with the code query

string | { url: string; }

Returns ​

Promise<PatreonUserClientInstance>

a similar Oauth client that has the token of the current token

Throws ​

when failed to fetch access token

fetchCampaign() ​

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

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

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 ​

PatreonClient.fetchCampaign

fetchCampaignMembers() ​

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

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

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 ​

PatreonClient.fetchCampaignMembers

fetchCampaignPosts() ​

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

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

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 ​

PatreonClient.fetchCampaignPosts

fetchCampaigns() ​

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

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

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 ​

PatreonClient.fetchCampaigns

fetchIdentity() ​

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

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

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 ​

PatreonClient.fetchIdentity

fetchMember() ​

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

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

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 ​

PatreonClient.fetchMember

fetchOauth2() ​

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

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

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 ​

PatreonClient.fetchOauth2

fetchPost() ​

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

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

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 ​

PatreonClient.fetchPost

fetchStoredToken() ​

fetchStoredToken(): Promise<undefined | Oauth2StoredToken>

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

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.

Inherited from ​

PatreonClient.fetchStoredToken

fetchToken() ​

Call Signature ​

fetchToken(request): Promise<undefined | Oauth2StoredToken>

Defined in: rest/v2/clients/user.ts:50

Fetch the token from the incoming redirect request (with a code query).

Parameters ​
request ​

The request or url with the code query

url ​

string

Returns ​

Promise<undefined | Oauth2StoredToken>

the access token of the user.

See ​

PatreonUserClient.oauth.getOauthTokenFromCode

Call Signature ​

fetchToken(url): Promise<undefined | Oauth2StoredToken>

Defined in: rest/v2/clients/user.ts:51

Fetch the token from the incoming redirect request (with a code query).

Parameters ​
url ​

string

Returns ​

Promise<undefined | Oauth2StoredToken>

the access token of the user.

See ​

PatreonUserClient.oauth.getOauthTokenFromCode

Call Signature ​

fetchToken(request): Promise<undefined | Oauth2StoredToken>

Defined in: rest/v2/clients/user.ts:52

Fetch the token from the incoming redirect request (with a code query).

Parameters ​
request ​

The request or url with the code query

string | { url: string; }

Returns ​

Promise<undefined | Oauth2StoredToken>

the access token of the user.

See ​

PatreonUserClient.oauth.getOauthTokenFromCode

paginateCampaignMembers() ​

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

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

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 ​

PatreonClient.paginateCampaignMembers

paginateCampaignPosts() ​

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

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

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 ​

PatreonClient.paginateCampaignPosts

paginateCampaigns() ​

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

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

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 ​

PatreonClient.paginateCampaigns

paginateOauth2() ​

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

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

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 ​

PatreonClient.paginateOauth2

putStoredToken() ​

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

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

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>

Inherited from ​

PatreonClient.putStoredToken

createCustomParser() ​

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

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

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 ​

PatreonClient.createCustomParser

hasAllQueriesEnabled() ​

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

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

Type Parameters ​

Client ​

Client extends PatreonClientMethods<boolean>

Parameters ​

client ​

Client

Returns ​

client is Client & PatreonClientMethods<true>

Inherited from ​

PatreonClient.hasAllQueriesEnabled