Class: PatreonUserClient<IncludeAll>
Defined in: clients/v2/user.ts:54
Extends
PatreonClient<IncludeAll>
Type Parameters
| Type Parameter | Default type |
|---|---|
IncludeAll extends boolean | false |
Constructors
Constructor
new PatreonUserClient<
IncludeAll>(options):PatreonUserClient<IncludeAll>
Defined in: clients/v2/user.ts:55
Parameters
| Parameter | Type |
|---|---|
options | PatreonUserClientOptions<IncludeAll> |
Returns
PatreonUserClient<IncludeAll>
Overrides
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
lives | public | WriteResourceSharedClient<Live, "default", IncludeAll, string> | Interact with the lives API routes. From the Patreon documentation:\ The Live APIs are early-access, and may be subject to change based on feedback from our partners. See https://docs.patreon.com/#post-api-oauth2-v2-lives | PatreonClient.lives |
normalized | public | PatreonSharedClient<"normalized", IncludeAll> | Applies the normalize method on all responses. | PatreonClient.normalized |
simplified | public | PatreonSharedClient<"simplified", IncludeAll> | Applies the simplify method on all responses. | PatreonClient.simplified |
webhooks | public | WebhookClient<IncludeAll> | Interact with the webhooks API. Client to use for creating, updating and getting webhooks from the current client. See https://docs.patreon.com/#apiv2-webhook-endpoints | PatreonClient.webhooks |
Accessors
name
Get Signature
get name():
string|null
Defined in: clients/v2/base.ts:101
The application name of the client.
Returns
string | null
Set Signature
set name(
value):void
Defined in: clients/v2/base.ts:105
Parameters
| Parameter | Type |
|---|---|
value | string | null |
Returns
void
Inherited from
oauth
Get Signature
get oauth():
PatreonOauthClient
Defined in: clients/v2/base.ts:93
Returns
Inherited from
rest
Get Signature
get rest():
RestClient
Defined in: clients/v2/base.ts:89
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
Inherited from
Methods
createInstance()
createInstance(
request):Promise<PatreonUserClientInstance<IncludeAll>>
Defined in: clients/v2/user.ts:85
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: clients/v2/shared.ts:300
Fetch a campaign.
Type Parameters
| Type Parameter | Default type |
|---|---|
Query extends BasePatreonQueryType<Campaign, false> | If<IncludeAll, PatreonQuery<Campaign, "benefits" | "goals" | "live_access_rules" | "tiers" | "creator", RelationshipMap<Campaign, "benefits" | "goals" | "live_access_rules" | "tiers" | "creator">, false>, PatreonQuery<Campaign, never, never, false>> |
Parameters
| Parameter | Type | Description |
|---|---|---|
campaignId | string | The id of the campaign to return. |
query? | Query | The query for requesting relationships and attributes |
options? | Oauth2RouteOptions | The request options. Allows for authentication (token) and fetch options. |
Returns
Promise<GetResponsePayload<Query>>
The API response for the route. If using a (client) response parser, the response will be transformed.
See
https://docs.patreon.com/#get-api-oauth2-v2-campaigns-campaign_id
Requires
campaigns scope.
Inherited from
fetchCampaignMembers()
fetchCampaignMembers<
Query>(campaignId,query?,options?):Promise<GetResponsePayload<Query>>
Defined in: clients/v2/shared.ts:322
Fetch campaign members. This returns a single page of members, to paginate through more pages see paginateCampaignMembers.
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 | Description |
|---|---|---|
campaignId | string | The campaign id of the members |
query? | Query | The query for requesting relationships and attributes |
options? | Oauth2RouteOptions | The request options. Allows for authentication (token) and fetch options. |
Returns
Promise<GetResponsePayload<Query>>
The API response for the route. If using a (client) response parser, the response will be transformed.
See
https://docs.patreon.com/#get-api-oauth2-v2-campaigns-campaign_id-members
Requires
campaigns.members scope. For the address the campaigns.members.address scope is required.
Inherited from
PatreonClient.fetchCampaignMembers
fetchCampaignPosts()
fetchCampaignPosts<
Query>(campaignId,query?,options?):Promise<GetResponsePayload<Query>>
Defined in: clients/v2/shared.ts:343
Fetch campaign posts. This returns a single page of posts, to paginate through more pages see paginateCampaignPosts.
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 | Description |
|---|---|---|
campaignId | string | The campaign id of the posts |
query? | Query | The query for requesting relationships and attributes |
options? | Oauth2RouteOptions | The request options. Allows for authentication (token) and fetch options. |
Returns
Promise<GetResponsePayload<Query>>
The API response for the route. If using a (client) response parser, the response will be transformed.
See
https://docs.patreon.com/#get-api-oauth2-v2-campaigns-campaign_id-posts
Requires
campaigns.posts scope
Inherited from
PatreonClient.fetchCampaignPosts
fetchCampaigns()
fetchCampaigns<
Query>(query?,options?):Promise<GetResponsePayload<Query>>
Defined in: clients/v2/shared.ts:281
Fetch campaigns. This returns a single page of campaigns, to paginate through more pages see paginateCampaigns.
Type Parameters
| Type Parameter | Default type |
|---|---|
Query extends BasePatreonQueryType<Campaign, true> | If<IncludeAll, PatreonQuery<Campaign, "benefits" | "goals" | "live_access_rules" | "tiers" | "creator", RelationshipMap<Campaign, "benefits" | "goals" | "live_access_rules" | "tiers" | "creator">, true>, PatreonQuery<Campaign, never, never, true>> |
Parameters
| Parameter | Type | Description |
|---|---|---|
query? | Query | The query for requesting relationships and attributes |
options? | Oauth2RouteOptions | The request options. Allows for authentication (token) and fetch options. |
Returns
Promise<GetResponsePayload<Query>>
The API response for the route. If using a (client) response parser, the response will be transformed.
See
https://docs.patreon.com/#get-api-oauth2-v2-campaigns
Requires
campaigns scope.
Inherited from
fetchIdentity()
fetchIdentity<
Query>(query?,options?):Promise<GetResponsePayload<Query>>
Defined in: clients/v2/shared.ts:402
Fetch the current user for the oauth token.
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 | Description |
|---|---|---|
query? | Query | The query for requesting relationships and attributes |
options? | Oauth2RouteOptions | The request options. Allows for authentication (token) and fetch options. |
Returns
Promise<GetResponsePayload<Query>>
The API response for the route. If using a (client) response parser, the response will be transformed.
See
https://docs.patreon.com/#get-api-oauth2-v2-identity
Requires
identity scope.
Inherited from
fetchMember()
fetchMember<
Query>(memberId,query?,options?):Promise<GetResponsePayload<Query>>
Defined in: clients/v2/shared.ts:363
Fetch a member.
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 | Description |
|---|---|---|
memberId | string | The id of the member to return. |
query? | Query | The query for requesting relationships and attributes |
options? | Oauth2RouteOptions | The request options. Allows for authentication (token) and fetch options. |
Returns
Promise<GetResponsePayload<Query>>
The API response for the route. If using a (client) response parser, the response will be transformed.
See
https://docs.patreon.com/#get-api-oauth2-v2-members-member_id
Requires
campaigns.members scope.
Inherited from
fetchOauth2()
fetchOauth2<
Query>(path,query,options?):Promise<GetResponsePayload<Query>>
Defined in: clients/v2/shared.ts:234
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
fetchPost()
fetchPost<
Query>(postId,query?,options?):Promise<GetResponsePayload<Query>>
Defined in: clients/v2/shared.ts:383
Fetch a post.
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 | Description |
|---|---|---|
postId | string | The id of the post to return. |
query? | Query | The query for requesting relationships and attributes |
options? | Oauth2RouteOptions | The request options. Allows for authentication (token) and fetch options. |
Returns
Promise<GetResponsePayload<Query>>
The API response for the route. If using a (client) response parser, the response will be transformed.
See
https://docs.patreon.com/#get-api-oauth2-v2-posts-id
Requires
campaigns.posts scope.
Inherited from
fetchToken()
Call Signature
fetchToken(
request):Promise<Oauth2StoredToken|undefined>
Defined in: clients/v2/user.ts:67
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<Oauth2StoredToken | undefined>
the access token of the user.
See
PatreonUserClient.oauth.getOauthTokenFromCode
Call Signature
fetchToken(
url):Promise<Oauth2StoredToken|undefined>
Defined in: clients/v2/user.ts:68
Fetch the token from the incoming redirect request (with a code query).
Parameters
| Parameter | Type |
|---|---|
url | string |
Returns
Promise<Oauth2StoredToken | undefined>
the access token of the user.
See
PatreonUserClient.oauth.getOauthTokenFromCode
Call Signature
fetchToken(
request):Promise<Oauth2StoredToken|undefined>
Defined in: clients/v2/user.ts:69
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<Oauth2StoredToken | undefined>
the access token of the user.
See
PatreonUserClient.oauth.getOauthTokenFromCode
paginateCampaignMembers()
paginateCampaignMembers<
Query>(campaignId,query?,options?):AsyncGenerator<GetResponsePayload<Query>,number,unknown>
Defined in: clients/v2/shared.ts:422
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: clients/v2/shared.ts:433
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: clients/v2/shared.ts:412
Type Parameters
| Type Parameter | Default type |
|---|---|
Query extends BasePatreonQueryType<Campaign, true> | If<IncludeAll, PatreonQuery<Campaign, "benefits" | "goals" | "live_access_rules" | "tiers" | "creator", RelationshipMap<Campaign, "benefits" | "goals" | "live_access_rules" | "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: clients/v2/shared.ts:254
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
createCustomParser()
staticcreateCustomParser<TransformType,IncludeAll>(client,transformType,parser):PatreonSharedClient<TransformType,IncludeAll>
Defined in: clients/v2/base.ts:153
Type Parameters
| Type Parameter | Default type |
|---|---|
TransformType extends keyof ResponseTransformMap<BasePatreonQuery> | - |
IncludeAll extends boolean | boolean |
Parameters
| Parameter | Type |
|---|---|
client | PatreonClient<IncludeAll> |
transformType | TransformType |
parser | ResponseTransformMap<BasePatreonQuery>[TransformType] |
Returns
PatreonSharedClient<TransformType, IncludeAll>
Inherited from
PatreonClient.createCustomParser
hasAllQueriesEnabled()
statichasAllQueriesEnabled<Client>(client):boolean
Defined in: clients/v2/base.ts:147
Type Parameters
| Type Parameter |
|---|
Client extends PatreonClient<boolean> |
Parameters
| Parameter | Type |
|---|---|
client | Client |
Returns
boolean