Class: PatreonUserClientInstance<IncludeAll>

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

Extends

• PatreonSharedClient<"default", IncludeAll>

Type Parameters

Type Parameter
IncludeAll extends boolean

Constructors

Constructor

new PatreonUserClientInstance<IncludeAll>(client, token): PatreonUserClientInstance<IncludeAll>

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

Parameters

Parameter	Type
client	PatreonUserClient<IncludeAll>
token	Oauth2StoredToken

Returns

PatreonUserClientInstance<IncludeAll>

Overrides

PatreonSharedClient<'default', IncludeAll>.constructor

Properties

Property	Modifier	Type	Description	Inherited from
client	public	PatreonUserClient<IncludeAll>	-	-
listCampaignMembers	public	<Query>(campaignId, query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>	Deprecated	PatreonSharedClient.listCampaignMembers
listCampaignPosts	public	<Query>(campaignId, query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>	Deprecated	PatreonSharedClient.listCampaignPosts
listCampaigns	public	<Query>(query?, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>	Deprecated	PatreonSharedClient.listCampaigns
listOauth2	public	<Query>(path, query, options?) => AsyncGenerator<GetResponsePayload<Query>, number, unknown>	Deprecated	PatreonSharedClient.listOauth2
token	readonly	Oauth2StoredToken	-	-

Methods

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

PatreonSharedClient.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

PatreonSharedClient.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

PatreonSharedClient.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

PatreonSharedClient.fetchCampaigns

---

fetchDiscordId()

fetchDiscordId(): Promise<undefined | string>

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

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/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

PatreonSharedClient.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

PatreonSharedClient.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

PatreonSharedClient.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

PatreonSharedClient.fetchPost

---

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

PatreonSharedClient.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

PatreonSharedClient.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

PatreonSharedClient.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

PatreonSharedClient.paginateOauth2