Variable: getRequiredScopes

const getRequiredScopes: object

Defined in: rest/v2/oauth2/scopes.ts:143

Get the Oauth scopes that are required for a certain path or for multiple paths with certain attributes

Type declaration

forAttributes()

forAttributes: (requiredAttributes, ...routes) => PatreonOauthScope[] = getRequiredScopesForAttributes

Parameters

requiredAttributes

memberAddress?

boolean

memberEmail?

boolean

userEmail?

boolean

userMemberships?

"client" | "all"

userOwnCampaign?

boolean

routes

...("campaign" | "member" | "post" | "webhook" | "campaigns" | "identity" | "campaignPosts" | "campaignMembers" | "webhooks")[]

Returns

PatreonOauthScope[]

forPath()

forPath: (path, query) => PatreonOauthScope[] = getRequiredScopesForPath

Parameters

path

string

query

BasePatreonQuery

Returns

PatreonOauthScope[]