planning-center-monorepo / planning-center-people-ts/src / PcoClientConfigWithRefresh

Interface: PcoClientConfigWithRefresh

Defined in: packages/planning-center-people-ts/src/auth.ts:24

Properties

personalAccessToken?

optional personalAccessToken: string

Defined in: packages/planning-center-people-ts/src/auth.ts:26

Personal Access Token (for single-user apps)

accessToken?

optional accessToken: string

Defined in: packages/planning-center-people-ts/src/auth.ts:28

OAuth 2.0 Access Token (for multi-user apps)

refreshToken?

optional refreshToken: string

Defined in: packages/planning-center-people-ts/src/auth.ts:30

OAuth 2.0 Refresh Token (for multi-user apps)

appId?

optional appId: string

Defined in: packages/planning-center-people-ts/src/auth.ts:32

App ID (for Personal Access Token auth)

appSecret?

optional appSecret: string

Defined in: packages/planning-center-people-ts/src/auth.ts:34

App Secret (for Personal Access Token auth)

onTokenRefresh?

optional onTokenRefresh: TokenRefreshCallback

Defined in: packages/planning-center-people-ts/src/auth.ts:36

Callback to handle token refresh

onTokenRefreshFailure?

optional onTokenRefreshFailure: TokenRefreshFailureCallback

Defined in: packages/planning-center-people-ts/src/auth.ts:38

Callback to handle token refresh failures

baseURL?

optional baseURL: string

Defined in: packages/planning-center-people-ts/src/auth.ts:40

Base URL override (defaults to people/v2)

rateLimit?

optional rateLimit: object

Defined in: packages/planning-center-people-ts/src/auth.ts:42

Rate limiting configuration

maxRequests

maxRequests: number

perMilliseconds

perMilliseconds: number

headers?

optional headers: Record<string, string>

Defined in: packages/planning-center-people-ts/src/auth.ts:47

Custom headers to include in all requests

timeout?

optional timeout: number

Defined in: packages/planning-center-people-ts/src/auth.ts:49

Request timeout in milliseconds

retry?

optional retry: object

Defined in: packages/planning-center-people-ts/src/auth.ts:51

Retry configuration

maxRetries?

optional maxRetries: number

baseDelay?

optional baseDelay: number

maxDelay?

optional maxDelay: number

onRetry()?

optional onRetry: (error, attempt) => void

Parameters

error

unknown

attempt

number

Returns

void