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

Interface: CorePcoClientConfig

Defined in: packages/planning-center-people-ts/src/core.ts:19

Properties

personalAccessToken?

optional personalAccessToken: string

Defined in: packages/planning-center-people-ts/src/core.ts:21

Personal Access Token Client ID (for single-user apps)

personalAccessTokenSecret?

optional personalAccessTokenSecret: string

Defined in: packages/planning-center-people-ts/src/core.ts:23

Personal Access Token Client Secret (alternative to PCO_PERSONAL_ACCESS_SECRET env var)

accessToken?

optional accessToken: string

Defined in: packages/planning-center-people-ts/src/core.ts:25

OAuth 2.0 Access Token (for multi-user apps)

refreshToken?

optional refreshToken: string

Defined in: packages/planning-center-people-ts/src/core.ts:27

OAuth 2.0 Refresh Token (for multi-user apps)

onTokenRefresh?

optional onTokenRefresh: TokenRefreshCallback

Defined in: packages/planning-center-people-ts/src/core.ts:29

Callback to handle token refresh

onTokenRefreshFailure?

optional onTokenRefreshFailure: TokenRefreshFailureCallback

Defined in: packages/planning-center-people-ts/src/core.ts:31

Callback to handle token refresh failures

appId?

optional appId: string

Defined in: packages/planning-center-people-ts/src/core.ts:33

App ID (for Personal Access Token auth)

appSecret?

optional appSecret: string

Defined in: packages/planning-center-people-ts/src/core.ts:35

App Secret (for Personal Access Token auth)

baseURL?

optional baseURL: string

Defined in: packages/planning-center-people-ts/src/core.ts:37

Base URL override (defaults to people/v2)

rateLimit?

optional rateLimit: object

Defined in: packages/planning-center-people-ts/src/core.ts:39

Rate limiting configuration

maxRequests

maxRequests: number

perMilliseconds

perMilliseconds: number

headers?

optional headers: Record<string, string>

Defined in: packages/planning-center-people-ts/src/core.ts:44

Custom headers to include in all requests

timeout?

optional timeout: number

Defined in: packages/planning-center-people-ts/src/core.ts:46

Request timeout in milliseconds

retry?

optional retry: object

Defined in: packages/planning-center-people-ts/src/core.ts:48

Retry configuration

maxRetries?

optional maxRetries: number

baseDelay?

optional baseDelay: number

maxDelay?

optional maxDelay: number

onRetry()?

optional onRetry: (error, attempt) => void

Parameters

error

PcoError

attempt

number

Returns

void

debug?

optional debug: boolean | PcoDebugOptions

Defined in: packages/planning-center-people-ts/src/core.ts:55

Enable debug logging (same as base package; optional for v1 createPcoClient flow)