patreon-api.ts

Appearance

Variable: Oauth2Routes ​

const Oauth2Routes: object = Routes

Defined in: rest/v2/oauth2/routes.ts:94

Type declaration ​

campaign() ​

campaign(campaignId): `/campaigns/${string}`

Routes for:

  • GET /campaigns/{campaignId}

Parameters ​

campaignId ​

string

The id of the campaign to fetch

Returns ​

`/campaigns/${string}`

campaignMembers() ​

campaignMembers(campaignId): `/campaigns/${string}/members`

Routes for:

  • GET /campaigns/{campaignId}/members

Parameters ​

campaignId ​

string

The id of the campaign to fetch the members for

Returns ​

`/campaigns/${string}/members`

campaignPosts() ​

campaignPosts(campaignId): `/campaigns/${string}/posts`

Routes for:

  • GET /campaigns/{campaignId}/posts

Parameters ​

campaignId ​

string

The id of the campaign to fetch the posts of

Returns ​

`/campaigns/${string}/posts`

campaigns() ​

campaigns(): "/campaigns"

Routes for:

  • GET /campaigns

Returns ​

"/campaigns"

identity() ​

identity(): "/identity"

Routes for:

  • GET /identity

Returns ​

"/identity"

member() ​

member(memberId): `/members/${string}`

Routes for:

  • GET `/members/

Parameters ​

memberId ​

string

The id of the member to fetch

Returns ​

`/members/${string}`

post() ​

post(postId): `/posts/${string}`

Routes for:

  • GET /posts/{postId}

Parameters ​

postId ​

string

The id of the post to fetch

Returns ​

`/posts/${string}`

webhook() ​

webhook(webhookId): `/webhooks/${string}`

Routes for:

  • PATCH /webhooks/{webhookId}
  • DELETE /webhooks/{webhookId}

Parameters ​

webhookId ​

string

The id of the webhook

Returns ​

`/webhooks/${string}`

webhooks() ​

webhooks(): "/webhooks"

Routes for:

  • GET /webhooks
  • POST /webhooks

Returns ​

"/webhooks"

Deprecated ​

use Routes instead