Variable: getRequiredScopes

const getRequiredScopes: { forAttributes: (requiredAttributes, ...routes) => PatreonOauthScope[]; forPath: (path, query) => PatreonOauthScope[]; }

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

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

Parameter	Type
requiredAttributes	{ memberAddress?: boolean; memberEmail?: boolean; userEmail?: boolean; userMemberships?: "client" | "all"; userOwnCampaign?: boolean; }
requiredAttributes.memberAddress?	boolean
requiredAttributes.memberEmail?	boolean
requiredAttributes.userEmail?	boolean
requiredAttributes.userMemberships?	"client" | "all"
requiredAttributes.userOwnCampaign?	boolean
...routes	("campaign" | "member" | "post" | "webhook" | "campaigns" | "identity" | "campaignPosts" | "campaignMembers" | "webhooks")[]

Returns

PatreonOauthScope[]

forPath()

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

Parameters

Parameter	Type
path	string
query	BasePatreonQuery

Returns

PatreonOauthScope[]