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

Interface: MockClientConfig

Defined in: packages/planning-center-people-ts/src/testing/simple-factories.ts:8

Properties

people?

optional people: object

Defined in: packages/planning-center-people-ts/src/testing/simple-factories.ts:9

getAll()?

optional getAll: () => Promise<any>

Returns

Promise<any>

getById()?

optional getById: (id) => Promise<any>

Parameters

id

string

Returns

Promise<any>

create()?

optional create: (data) => Promise<any>

Parameters

data

any

Returns

Promise<any>

update()?

optional update: (id, data) => Promise<any>

Parameters

id

string

data

any

Returns

Promise<any>

delete()?

optional delete: (id) => Promise<void>

Parameters

id

string

Returns

Promise<void>

findOrCreate()?

optional findOrCreate: (options) => Promise<any>

Parameters

options

any

Returns

Promise<any>

createWithContacts()?

optional createWithContacts: (personData, contacts) => Promise<any>

Parameters

personData

any

contacts

any

Returns

Promise<any>

search()?

optional search: (criteria) => Promise<any>

Parameters

criteria

any

Returns

Promise<any>

getAllPages()?

optional getAllPages: (options?) => Promise<any>

Parameters

options?

any

Returns

Promise<any>

addEmail()?

optional addEmail: (personId, data) => Promise<any>

Parameters

personId

string

data

any

Returns

Promise<any>

addPhoneNumber()?

optional addPhoneNumber: (personId, data) => Promise<any>

Parameters

personId

string

data

any

Returns

Promise<any>

addAddress()?

optional addAddress: (personId, data) => Promise<any>

Parameters

personId

string

data

any

Returns

Promise<any>

addSocialProfile()?

optional addSocialProfile: (personId, data) => Promise<any>

Parameters

personId

string

data

any

Returns

Promise<any>

fields?

optional fields: object

Defined in: packages/planning-center-people-ts/src/testing/simple-factories.ts:24

getAllFieldDefinitions()?

optional getAllFieldDefinitions: () => Promise<any[]>

Returns

Promise<any[]>

getFieldDefinition()?

optional getFieldDefinition: (id) => Promise<any>

Parameters

id

string

Returns

Promise<any>

getFieldDefinitionBySlug()?

optional getFieldDefinitionBySlug: (slug) => Promise<any>

Parameters

slug

string

Returns

Promise<any>

getFieldDefinitionByName()?

optional getFieldDefinitionByName: (name) => Promise<any>

Parameters

name

string

Returns

Promise<any>

setPersonField()?

optional setPersonField: (personId, options) => Promise<any>

Parameters

personId

string

options

any

Returns

Promise<any>

setPersonFieldById()?

optional setPersonFieldById: (personId, fieldId, value) => Promise<any>

Parameters

personId

string

fieldId

string

value

string

Returns

Promise<any>

setPersonFieldBySlug()?

optional setPersonFieldBySlug: (personId, slug, value) => Promise<any>

Parameters

personId

string

slug

string

value

string

Returns

Promise<any>

setPersonFieldByName()?

optional setPersonFieldByName: (personId, name, value) => Promise<any>

Parameters

personId

string

name

string

value

string

Returns

Promise<any>

workflows?

optional workflows: object

Defined in: packages/planning-center-people-ts/src/testing/simple-factories.ts:34

getAll()?

optional getAll: (options?) => Promise<any>

Parameters

options?

any

Returns

Promise<any>

getById()?

optional getById: (id) => Promise<any>

Parameters

id

string

Returns

Promise<any>

create()?

optional create: (data) => Promise<any>

Parameters

data

any

Returns

Promise<any>

update()?

optional update: (id, data) => Promise<any>

Parameters

id

string

data

any

Returns

Promise<any>

delete()?

optional delete: (id) => Promise<void>

Parameters

id

string

Returns

Promise<void>

getAllPages()?

optional getAllPages: (options?) => Promise<any>

Parameters

options?

any

Returns

Promise<any>

addPersonToWorkflow()?

optional addPersonToWorkflow: (personId, workflowId, options?) => Promise<any>

Parameters

personId

string

workflowId

string

options?

any

Returns

Promise<any>

createWorkflowCard()?

optional createWorkflowCard: (workflowId, personId) => Promise<any>

Parameters

workflowId

string

personId

string

Returns

Promise<any>

createWorkflowCardNote()?

optional createWorkflowCardNote: (personId, workflowCardId, data) => Promise<any>

Parameters

personId

string

workflowCardId

string

data

any

Returns

Promise<any>

batch?

optional batch: object

Defined in: packages/planning-center-people-ts/src/testing/simple-factories.ts:45

execute()?

optional execute: (operations) => Promise<any>

Parameters

operations

any[]

Returns

Promise<any>