Class: PatreonUserClient<IncludeAll>

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

Extends

• PatreonClient<IncludeAll>

Type Parameters

Type Parameter	Default type
IncludeAll extends boolean	false

Constructors

Constructor

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

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

Parameters

Parameter	Type
options	PatreonClientOptions<IncludeAll>

Returns

PatreonUserClient<IncludeAll>

Overrides

PatreonClient.constructor

Properties

Property	Modifier	Type	Description	Inherited from
listCampaignMembers	public	<Query>(campaignId, query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>	Deprecated	PatreonClient.listCampaignMembers
listCampaignPosts	public	<Query>(campaignId, query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>	Deprecated	PatreonClient.listCampaignPosts
listCampaigns	public	<Query>(query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>	Deprecated	PatreonClient.listCampaigns
listOauth2	public	<Query>(path, query, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>	Deprecated	PatreonClient.listOauth2
normalized	public	PatreonSharedClient<"normalized", IncludeAll>	-	PatreonClient.normalized
simplified	public	PatreonSharedClient<"simplified", IncludeAll>	-	PatreonClient.simplified
webhooks	public	WebhookClient	Interact with the webhooks API. Client to use for creating, updating and getting webhooks from the current client.	PatreonClient.webhooks

Accessors

name

Get Signature

get name(): null | string

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

The application name of the client.

Returns

null | string

Set Signature

set name(value): void

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

Parameters

Parameter	Type
value	null | string

Returns

void

Inherited from

PatreonClient.name

---

oauth

Get Signature

get oauth(): PatreonOauthClient

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

Returns

PatreonOauthClient

Inherited from

PatreonClient.oauth

---

rest

Get Signature

get rest(): RestClient

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

Interact with the API directly. Calling the API using the rest client will not use any of the client options for oauth and tokens.

Returns

RestClient

Inherited from

PatreonClient.rest

Methods

createInstance()

createInstance(request): Promise<PatreonUserClientInstance<IncludeAll>>

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

Create a client with the current user authenticated.

Parameters

Parameter	Type	Description
request	string | { url: string; }	The request or url with the code query

Returns

Promise<PatreonUserClientInstance<IncludeAll>>

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/shared.ts:144

Type Parameters

Type Parameter	Default type
Query extends BasePatreonQueryType<Campaign, false>	If<IncludeAll, PatreonQuery<Campaign, "benefits" | "goals" | "tiers" | "creator", RelationshipMap<Campaign, "benefits" | "goals" | "tiers" | "creator">, false>, PatreonQuery<Campaign, never, never, false>>

Parameters

Parameter	Type
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/shared.ts:155

Type Parameters

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

Parameters

Parameter	Type
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/shared.ts:166

Type Parameters

Type Parameter	Default type
Query extends BasePatreonQueryType<Post, true>	If<IncludeAll, PatreonQuery<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">, true>, PatreonQuery<Post, never, never, true>>

Parameters

Parameter	Type
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/shared.ts:134

Type Parameters

Type Parameter	Default type
Query extends BasePatreonQueryType<Campaign, true>	If<IncludeAll, PatreonQuery<Campaign, "benefits" | "goals" | "tiers" | "creator", RelationshipMap<Campaign, "benefits" | "goals" | "tiers" | "creator">, true>, PatreonQuery<Campaign, never, never, true>>

Parameters

Parameter	Type
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/shared.ts:199

Type Parameters

Type Parameter	Default type
Query extends BasePatreonQueryType<User, false>	If<IncludeAll, PatreonQuery<User, "campaign" | "memberships", RelationshipMap<User, "campaign" | "memberships">, false>, PatreonQuery<User, never, never, false>>

Parameters

Parameter	Type
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/shared.ts:177

Type Parameters

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

Parameters

Parameter	Type
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/shared.ts:96

Fetch the Patreon Oauth V2 API

Type Parameters

Type Parameter
Query extends BasePatreonQuery

Parameters

Parameter	Type	Description
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/shared.ts:188

Type Parameters

Type Parameter	Default type
Query extends BasePatreonQueryType<Post, false>	If<IncludeAll, PatreonQuery<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">, false>, PatreonQuery<Post, never, never, false>>

Parameters

Parameter	Type
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:159

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

Parameter	Type	Description
request	{ url: string; }	The request or url with the code query
request.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

Parameter	Type
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

Parameter	Type	Description
request	string | { url: string; }	The request or url with the code query

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/shared.ts:219

Type Parameters

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

Parameters

Parameter	Type
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/shared.ts:230

Type Parameters

Type Parameter	Default type
Query extends BasePatreonQueryType<Post, true>	If<IncludeAll, PatreonQuery<Post, "campaign" | "user", RelationshipMap<Post, "campaign" | "user">, true>, PatreonQuery<Post, never, never, true>>

Parameters

Parameter	Type
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/shared.ts:209

Type Parameters

Type Parameter	Default type
Query extends BasePatreonQueryType<Campaign, true>	If<IncludeAll, PatreonQuery<Campaign, "benefits" | "goals" | "tiers" | "creator", RelationshipMap<Campaign, "benefits" | "goals" | "tiers" | "creator">, true>, PatreonQuery<Campaign, never, never, true>>

Parameters

Parameter	Type
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/shared.ts:116

Paginate the Patreon Oauth V2 API until all pages are fetched

Type Parameters

Type Parameter
Query extends BasePatreonQuery

Parameters

Parameter	Type	Description
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:168

Save your token with the method from the client options

Parameters

Parameter	Type	Description
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): PatreonSharedClient<Type, IncludeAll>

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

Type Parameters

Type Parameter	Default type
Type extends keyof ResponseTransformMap<BasePatreonQuery>	-
IncludeAll extends boolean	boolean

Parameters

Parameter	Type
client	PatreonClient<IncludeAll>
type	Type
parser	ResponseTransformMap<BasePatreonQuery>[Type]
includeAllQueries	IncludeAll

Returns

PatreonSharedClient<Type, IncludeAll>

Inherited from

PatreonClient.createCustomParser

---

hasAllQueriesEnabled()

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

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

Type Parameters

Type Parameter
Client extends PatreonClient<boolean>

Parameters

Parameter	Type
client	Client

Returns

client is Client & PatreonClient<true>

Inherited from

PatreonClient.hasAllQueriesEnabled