patreon-api.ts

Appearance

Class: PatreonUserClientInstance ​

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

Extends ​

  • PatreonClientMethods<boolean>

Constructors ​

Constructor ​

new PatreonUserClientInstance(client, token): PatreonUserClientInstance

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

Parameters ​

client ​

PatreonUserClient<boolean>

token ​

Oauth2StoredToken

Returns ​

PatreonUserClientInstance

Overrides ​

PatreonClientMethods<boolean>.constructor

Properties ​

client ​

client: PatreonUserClient<boolean>

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

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> = 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:245

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<Post, true> = 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:249

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<Campaign, true> = 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: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 ​

PatreonClientMethods.listOauth2

normalized ​

normalized: GenericPatreonClientMethods<"normalized", boolean>

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

Inherited from ​

PatreonClientMethods.normalized

simplified ​

simplified: GenericPatreonClientMethods<"simplified", boolean>

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

Inherited from ​

PatreonClientMethods.simplified

token ​

readonly token: Oauth2StoredToken

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

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 ​

PatreonClientMethods.name

oauth ​

Get Signature ​

get oauth(): PatreonOauthClient

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

Returns ​

PatreonOauthClient

Inherited from ​

PatreonClientMethods.oauth

Methods ​

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> = 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:156

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<Member, true> = 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:167

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<Post, true> = 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:135

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<Campaign, true> = 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

fetchDiscordId() ​

fetchDiscordId(): Promise<undefined | string>

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

Fetch the ID of the Discord connection.

This will only work if the current token is associated with the user.

Returns ​

Promise<undefined | string>

The discord user ID

fetchIdentity() ​

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

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

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<User, false> = 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:178

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<Member, false> = 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: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 ​

PatreonClientMethods.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> = 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

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> = 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:231

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<Post, true> = 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:210

Type Parameters ​

Query ​

Query extends BasePatreonQueryType<Campaign, true> = 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: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 ​

PatreonClientMethods.paginateOauth2

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 ​

PatreonClientMethods.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 ​

PatreonClientMethods.hasAllQueriesEnabled