planning-center-monorepo v1.0.0
planning-center-monorepo / planning-center-people-ts/src / PcoClient
Class: PcoClient
Defined in: packages/planning-center-people-ts/src/client.ts:46
Implements
EventEmitter
Constructors
Constructor
new PcoClient(
config):PcoClient
Defined in: packages/planning-center-people-ts/src/client.ts:66
Parameters
config
Returns
PcoClient
Properties
people
people:
PeopleModule
Defined in: packages/planning-center-people-ts/src/client.ts:47
fields
fields:
FieldsModule
Defined in: packages/planning-center-people-ts/src/client.ts:48
workflows
workflows:
WorkflowsModule
Defined in: packages/planning-center-people-ts/src/client.ts:49
contacts
contacts:
ContactsModule
Defined in: packages/planning-center-people-ts/src/client.ts:50
households
households:
HouseholdsModule
Defined in: packages/planning-center-people-ts/src/client.ts:51
notes
notes:
NotesModule
Defined in: packages/planning-center-people-ts/src/client.ts:52
lists
lists:
ListsModule
Defined in: packages/planning-center-people-ts/src/client.ts:53
campus
campus:
CampusModule
Defined in: packages/planning-center-people-ts/src/client.ts:54
serviceTime
serviceTime:
ServiceTimeModule
Defined in: packages/planning-center-people-ts/src/client.ts:55
forms
forms:
FormsModule
Defined in: packages/planning-center-people-ts/src/client.ts:56
reports
reports:
ReportsModule
Defined in: packages/planning-center-people-ts/src/client.ts:57
batch
batch:
BatchExecutor
Defined in: packages/planning-center-people-ts/src/client.ts:58
Methods
on()
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:94
Parameters
eventType
"request:start"
handler
EventHandler<RequestStartEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:95
Parameters
eventType
"request:complete"
handler
EventHandler<RequestCompleteEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:96
Parameters
eventType
"request:error"
handler
EventHandler<RequestErrorEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:97
Parameters
eventType
"auth:success"
handler
EventHandler<AuthSuccessEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:98
Parameters
eventType
"auth:failure"
handler
EventHandler<AuthFailureEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:99
Parameters
eventType
"auth:refresh"
handler
EventHandler<AuthRefreshEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:100
Parameters
eventType
"rate:limit"
handler
EventHandler<RateLimitEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:101
Parameters
eventType
"rate:available"
handler
EventHandler<RateAvailableEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:102
Parameters
eventType
"cache:hit"
handler
EventHandler<CacheHitEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:103
Parameters
eventType
"cache:miss"
handler
EventHandler<CacheMissEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:104
Parameters
eventType
"cache:set"
handler
EventHandler<CacheSetEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:105
Parameters
eventType
"cache:invalidate"
handler
EventHandler<CacheInvalidateEvent>
Returns
void
Implementation of
BaseEventEmitter.on
Call Signature
on(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:106
Parameters
eventType
"error"
handler
EventHandler<ErrorEvent>
Returns
void
Implementation of
BaseEventEmitter.on
off()
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:113
Parameters
eventType
"request:start"
handler
EventHandler<RequestStartEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:114
Parameters
eventType
"request:complete"
handler
EventHandler<RequestCompleteEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:115
Parameters
eventType
"request:error"
handler
EventHandler<RequestErrorEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:116
Parameters
eventType
"auth:success"
handler
EventHandler<AuthSuccessEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:117
Parameters
eventType
"auth:failure"
handler
EventHandler<AuthFailureEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:118
Parameters
eventType
"auth:refresh"
handler
EventHandler<AuthRefreshEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:119
Parameters
eventType
"rate:limit"
handler
EventHandler<RateLimitEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:120
Parameters
eventType
"rate:available"
handler
EventHandler<RateAvailableEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:121
Parameters
eventType
"cache:hit"
handler
EventHandler<CacheHitEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:122
Parameters
eventType
"cache:miss"
handler
EventHandler<CacheMissEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:123
Parameters
eventType
"cache:set"
handler
EventHandler<CacheSetEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:124
Parameters
eventType
"cache:invalidate"
handler
EventHandler<CacheInvalidateEvent>
Returns
void
Implementation of
BaseEventEmitter.off
Call Signature
off(
eventType,handler):void
Defined in: packages/planning-center-people-ts/src/client.ts:125
Parameters
eventType
"error"
handler
EventHandler<ErrorEvent>
Returns
void
Implementation of
BaseEventEmitter.off
emit()
emit<
T>(event):void
Defined in: packages/planning-center-people-ts/src/client.ts:132
Type Parameters
T
T extends PcoEvent
Parameters
event
T
Returns
void
Implementation of
BaseEventEmitter.emit
getConfig()
getConfig():
PcoClientConfig
Defined in: packages/planning-center-people-ts/src/client.ts:139
Get the current configuration
Returns
updateConfig()
updateConfig(
updates):void
Defined in: packages/planning-center-people-ts/src/client.ts:146
Update the configuration
Parameters
updates
Partial<PeopleClientConfig>
Returns
void
getPerformanceMetrics()
getPerformanceMetrics():
Record<string, {count:number;averageTime:number;minTime:number;maxTime:number;errorRate:number; }>
Defined in: packages/planning-center-people-ts/src/client.ts:173
Get performance metrics
Returns
Record<string, { count: number; averageTime: number; minTime: number; maxTime: number; errorRate: number; }>
getRateLimitInfo()
getRateLimitInfo():
Record<string, {limit:number;remaining:number;resetTime:number; }>
Defined in: packages/planning-center-people-ts/src/client.ts:180
Get rate limit information
Returns
Record<string, { limit: number; remaining: number; resetTime: number; }>
removeAllListeners()
removeAllListeners(
eventType?):void
Defined in: packages/planning-center-people-ts/src/client.ts:187
Clear all event listeners
Parameters
eventType?
Returns
void
listenerCount()
listenerCount(
eventType):number
Defined in: packages/planning-center-people-ts/src/client.ts:194
Get the number of listeners for an event type
Parameters
eventType
Returns
number
eventTypes()
eventTypes():
EventType[]
Defined in: packages/planning-center-people-ts/src/client.ts:201
Get all registered event types