patreon-api.ts

Appearance

Interface: OauthClient ​

Defined in: schemas/v2/resources/oauth_client.ts:4

A client created by a developer, used for getting OAuth2 access tokens.

Properties ​

author_name ​

author_name: null | string

Defined in: schemas/v2/resources/oauth_client.ts:8

The author name provided during client setup.

category ​

category: string

Defined in: schemas/v2/resources/oauth_client.ts:13

client_secret ​

client_secret: string

Defined in: schemas/v2/resources/oauth_client.ts:18

The client's secret.

default_scopes ​

default_scopes: string

Defined in: schemas/v2/resources/oauth_client.ts:24

The client's default OAuth scopes for the authorization flow.

Deprecated ​

description ​

description: string

Defined in: schemas/v2/resources/oauth_client.ts:29

The description provided during client setup.

domain ​

domain: null | string

Defined in: schemas/v2/resources/oauth_client.ts:35

The domain provided during client setup.

Format ​

uri

icon_url ​

icon_url: null | string

Defined in: schemas/v2/resources/oauth_client.ts:41

The URL of the icon used in the OAuth authorization flow.

Format ​

uri

name ​

name: string

Defined in: schemas/v2/resources/oauth_client.ts:46

The name provided during client setup.

privacy_policy_url ​

privacy_policy_url: null | string

Defined in: schemas/v2/resources/oauth_client.ts:52

The URL of the privacy policy provided during client setup.

Format ​

uri

redirect_uris ​

redirect_uris: string

Defined in: schemas/v2/resources/oauth_client.ts:57

The allowable redirect URIs for the OAuth authorization flow.

tos_url ​

tos_url: string

Defined in: schemas/v2/resources/oauth_client.ts:63

The URL of the terms of service provided during client setup.

Format ​

uri

version ​

version: number

Defined in: schemas/v2/resources/oauth_client.ts:69

The Patreon API version the client is targeting.

Example ​

ts
2