Class: PatreonCreatorClient<IncludeAll>

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

Extends

PatreonClient<IncludeAll>

Type Parameters

Type Parameter	Default type
`IncludeAll` extends `boolean`	`false`

Constructors

Constructor

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

Defined in: rest/v2/clients/creator.ts:9

Parameters

Parameter	Type
`options`	`PatreonClientOptions`<`IncludeAll`>

Returns

PatreonCreatorClient<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`
`lives`	`public`	`WriteResourceSharedClient`<`Live`, `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. NOTE: due to type complexity, the response might be typed as an union of a paginated and resource response. If this happens, apply the `normalize` method on the default response manually. I have no idea how to fix this bug.	`PatreonClient`.`normalized`
`simplified`	`public`	`PatreonSharedClient`<`"simplified"`, `IncludeAll`>	Applies the `simplify` method on all responses. NOTE: due to type complexity, the response might be typed as an union of a paginated and resource response. If this happens, apply the `simplify` method on the default response manually. I have no idea how to fix this bug.	`PatreonClient`.`simplified`
`webhooks`	`public`	`WebhookClient`	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(): null | string

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

The application name of the client.

Returns

null | string

Set Signature

set name(value): void

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

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:113

Returns

PatreonOauthClient

Inherited from

PatreonClient.oauth

rest

Get Signature

get rest(): RestClient

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

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

fetchApplicationToken()

fetchApplicationToken(): Promise<{ success: true; token: Oauth2StoredToken; } | { success: false; token: undefined; }>

Defined in: rest/v2/clients/creator.ts:32

Fetch the current application token from the configured store and updates the token.

Returns

Promise<{ success: true; token: Oauth2StoredToken; } | { success: false; token: undefined; }>

if the token is updated and stored, and the token

Deprecated

Use the CacheTokenStore class to store and fetch any tokens. See the documentation for an example: https://patreon-api.pages.dev/guide/features/oauth#creator-token

fetchCampaign()

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

Defined in: rest/v2/clients/shared.ts:239

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:250

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:261

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:229

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:294

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:272

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:191

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:283

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:193

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.

Deprecated

Use the CacheTokenStore class to store and fetch any tokens. See the documentation for an example: https://patreon-api.pages.dev/guide/features/oauth#creator-token

Inherited from

PatreonClient.fetchStoredToken

initialize()

initialize(): Promise<boolean>

Defined in: rest/v2/clients/creator.ts:19

Calls PatreonCreatorClient.fetchApplicationToken.

Returns

Promise<boolean>

Whether the call was successful or not

Deprecated

Use the CacheTokenStore class to store and fetch any tokens. See the documentation for an example: https://patreon-api.pages.dev/guide/features/oauth#creator-token

paginateCampaignMembers()

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

Defined in: rest/v2/clients/shared.ts:314

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:325

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:304

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:211

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:204

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>

Deprecated

Use the CacheTokenStore class to store and fetch any tokens. See the documentation for an example: https://patreon-api.pages.dev/guide/features/oauth#creator-token

Inherited from

PatreonClient.putStoredToken

createCustomParser()

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

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

Type Parameters

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

Parameters

Parameter	Type	Description
`client`	`PatreonClient`<`IncludeAll`>	-
`type`	`Type`	-
`parser`	`ResponseTransformMap`<`BasePatreonQuery`>[`Type`]	-
`includeAllQueries`	`IncludeAll`	TODO: replace with hasAllQueriesEnabled method

Returns

PatreonSharedClient<Type, IncludeAll>

Inherited from

PatreonClient.createCustomParser

hasAllQueriesEnabled()

static hasAllQueriesEnabled<Client>(client): boolean

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

Type Parameters

Type Parameter
`Client` extends `PatreonClient`<`boolean`>

Parameters

Parameter	Type
`client`	`Client`

Returns

boolean

Inherited from

PatreonClient.hasAllQueriesEnabled

Class: PatreonCreatorClient<IncludeAll> ​

Extends ​

Type Parameters ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

Accessors ​

name ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

Returns ​

Inherited from ​

oauth ​

Get Signature ​

Returns ​

Inherited from ​

rest ​

Get Signature ​

Returns ​

Inherited from ​

Methods ​

fetchApplicationToken() ​

Returns ​

Deprecated ​

fetchCampaign() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

fetchCampaignMembers() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

fetchCampaignPosts() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

fetchCampaigns() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

fetchIdentity() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

fetchMember() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

fetchOauth2() ​

Type Parameters ​

Parameters ​

Returns ​

Throws ​

Inherited from ​

fetchPost() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

fetchStoredToken() ​

Returns ​

Deprecated ​

Inherited from ​

initialize() ​

Returns ​

Deprecated ​

paginateCampaignMembers() ​

Type Parameters ​

Parameters ​

Class: PatreonCreatorClient<IncludeAll>

Extends

Type Parameters

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

name

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

oauth

Get Signature

Returns

Inherited from

rest

Get Signature

Returns

Inherited from

Methods

fetchApplicationToken()

Returns

Deprecated

fetchCampaign()

Type Parameters

Parameters

Returns

Inherited from

fetchCampaignMembers()

Type Parameters

Parameters

Returns

Inherited from

fetchCampaignPosts()

Type Parameters

Parameters

Returns

Inherited from

fetchCampaigns()

Type Parameters

Parameters

Returns

Inherited from

fetchIdentity()

Type Parameters

Parameters

Returns

Inherited from

fetchMember()

Type Parameters

Parameters

Returns

Inherited from

fetchOauth2()

Type Parameters

Parameters

Returns

Throws

Inherited from

fetchPost()

Type Parameters

Parameters

Returns

Inherited from

fetchStoredToken()

Returns

Deprecated

Inherited from

initialize()

Returns

Deprecated

paginateCampaignMembers()

Type Parameters

Parameters