planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-base-ts/src / OAuthAuth

Interface: OAuthAuth

Defined in: packages/planning-center-base-ts/src/types/config.ts:15 

Authentication configuration for OAuth 2.0 with required refresh handling

Properties

type

type: "oauth"

Defined in: packages/planning-center-base-ts/src/types/config.ts:16 

accessToken

accessToken: string

Defined in: packages/planning-center-base-ts/src/types/config.ts:17 

refreshToken

refreshToken: string

Defined in: packages/planning-center-base-ts/src/types/config.ts:18 

onRefresh()

onRefresh: (tokens) => void | Promise<void>

Defined in: packages/planning-center-base-ts/src/types/config.ts:19 

Parameters

tokens

accessToken

string

refreshToken

string

Returns

void | Promise<void>

onRefreshFailure()

onRefreshFailure: (error) => void | Promise<void>

Defined in: packages/planning-center-base-ts/src/types/config.ts:20 

Parameters

error

Error

Returns

void | Promise<void>

clientId?

optional clientId: string

Defined in: packages/planning-center-base-ts/src/types/config.ts:22 

Client ID for token refresh (optional, can use environment variable PCO_APP_ID)

clientSecret?

optional clientSecret: string

Defined in: packages/planning-center-base-ts/src/types/config.ts:24 

Client Secret for token refresh (optional, can use environment variable PCO_APP_SECRET)