PcoPeoplePerson class

This class represents a PCO People Person Object

Instantiation

  • Create a new instance using the PcoPeoplePerson() constructor
  • Instantiate from existing JSON data using the PcoPeoplePerson.fromJson() constructor.
  • Load an instance from the API using one of the static methods defined on this class.

Usage

  • Fields exposed by the API are readable through getter methods.
  • Fields writable by the API are exposed through setter methods.
  • Original json data is exposed through the read-only attributes map.
  • Additional data is available through the read-only links and relationships maps.
  • Available relationships / includes are exposed through typed getters.

Description

A person record represents a single member/user of the application. Each person has different permissions that determine how the user can use this app (if at all).

Attributes (and permissions)

  • id (ro) -> PCO: id
  • givenName (rw) -> PCO: given_name
  • firstName (rw) -> PCO: first_name
  • nickname (rw) -> PCO: nickname
  • middleName (rw) -> PCO: middle_name
  • lastName (rw) -> PCO: last_name
  • birthdate (rw) -> PCO: birthdate
  • anniversary (rw) -> PCO: anniversary
  • gender (rw) -> PCO: gender
  • grade (rw) -> PCO: grade
  • isChild (rw) -> PCO: child
  • graduationYear (rw) -> PCO: graduation_year
  • isSiteAdministrator (rw) -> PCO: site_administrator
  • isAccountingAdministrator (rw) -> PCO: accounting_administrator
  • peoplePermissions (rw) -> PCO: people_permissions
  • membership (rw) -> PCO: membership
  • inactivatedAt (rw) -> PCO: inactivated_at
  • status (rw) -> PCO: status
  • medicalNotes (rw) -> PCO: medical_notes
  • createdAt (ro) -> PCO: created_at
  • updatedAt (ro) -> PCO: updated_at
  • avatar (rw) -> PCO: avatar
  • name (ro) -> PCO: name
  • demographicAvatarUrl (ro) -> PCO: demographic_avatar_url
  • directoryStatus (ro) -> PCO: directory_status
  • isPassedBackgroundCheck (ro) -> PCO: passed_background_check
  • isCanCreateForms (ro) -> PCO: can_create_forms
  • schoolType (ro) -> PCO: school_type
  • remoteId (rw) -> PCO: remote_id
  • searchName (ro) -> PCO: search_name
  • searchPhoneNumber (ro) -> PCO: search_phone_number
  • searchPhoneNumberE164 (ro) -> PCO: search_phone_number_e164
  • searchNameOrEmail (ro) -> PCO: search_name_or_email
  • searchNameOrEmailOrPhoneNumber (ro) -> PCO: search_name_or_email_or_phone_number
  • primaryCampusId (wo) -> PCO: primary_campus_id
  • genderId (wo) -> PCO: gender_id

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Person",
  "id": "1",
  "attributes": {
    "given_name": "string",
    "first_name": "string",
    "nickname": "string",
    "middle_name": "string",
    "last_name": "string",
    "birthdate": "2000-01-01",
    "anniversary": "2000-01-01",
    "gender": "string",
    "grade": 1,
    "child": true,
    "graduation_year": 1,
    "site_administrator": true,
    "accounting_administrator": true,
    "people_permissions": "string",
    "membership": "string",
    "inactivated_at": "2000-01-01T12:00:00Z",
    "status": "string",
    "medical_notes": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "avatar": "string",
    "name": "string",
    "demographic_avatar_url": "string",
    "directory_status": "string",
    "passed_background_check": true,
    "can_create_forms": true,
    "school_type": "string",
    "remote_id": 1
  },
  "relationships": {
    "primary_campus": {
      "data": {
        "type": "PrimaryCampus",
        "id": "1"
      }
    },
    "gender": {
      "data": {
        "type": "Gender",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoPeoplePerson({String? id, String? givenName, String? firstName, String? nickname, String? middleName, String? lastName, String? birthdate, String? anniversary, String? gender, int? grade, bool? isChild, int? graduationYear, bool? isSiteAdministrator, bool? isAccountingAdministrator, String? peoplePermissions, String? membership, DateTime? inactivatedAt, String? status, String? medicalNotes, DateTime? createdAt, DateTime? updatedAt, String? avatar, String? name, String? demographicAvatarUrl, String? directoryStatus, bool? isPassedBackgroundCheck, bool? isCanCreateForms, String? schoolType, int? remoteId, String? searchName, String? searchPhoneNumber, String? searchPhoneNumberE164, String? searchNameOrEmail, String? searchNameOrEmailOrPhoneNumber, String? primaryCampusId, String? genderId, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoPeoplePerson object using this endpoint: https://api.planningcenteronline.com/people/v2/people
factory
PcoPeoplePerson.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoPeoplePerson.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

anniversary ↔ String
pass null to remove key from attributes
getter/setter pair
api → PlanningCenter
planning center resources must be tied to an api
no setterinherited
apiEndpoint → String
no setterinherited
apiPath → String
PcoResources include their own path as a link object but this might be null if we haven't created/fetched the object yet Child classes should redefine this getter to allow for manual path overrides
no setteroverride
apiVersion → String
child classes can override these getters which will allow methods in this class to see static variables from child classes
no setteroverride
attributes → ReadOnlyMapView<String, dynamic>
contains the underlying attributes returned by the api and allows a user to access arbitrary data in the attributes by actual api name
no setterinherited
avatar ↔ String
pass null to remove key from attributes
getter/setter pair
birthdate ↔ String
pass null to remove key from attributes
getter/setter pair
canCreate → bool
no setteroverride
canDestroy → bool
no setteroverride
canUpdate → bool
no setteroverride
createAllowed → List<String>
no setteroverride
createdAt → DateTime
no setterinherited
createPathTemplate → String
no setteroverride
defaultPathTemplate → String
no setteroverride
demographicAvatarUrl → String
no setter
directoryStatus → String
no setter
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
firstName ↔ String
pass null to remove key from attributes
getter/setter pair
gender ↔ String
pass null to remove key from attributes
getter/setter pair
genderId ↔ String
pass null to remove key from attributes
getter/setter pair
givenName ↔ String
pass null to remove key from attributes
getter/setter pair
grade ↔ int
pass null to remove key from attributes
getter/setter pair
graduationYear ↔ int
pass null to remove key from attributes
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id → String?
no setterinherited
inactivatedAt ↔ DateTime
pass null to remove key from attributes
getter/setter pair
included → List<PcoResource>
contains included items parsed into objects
no setterinherited
includedAddresses → List<PcoPeopleAddress>
no setter
includedEmails → List<PcoPeopleEmail>
no setter
includedFieldData → List<PcoPeopleFieldDatum>
no setter
includedHouseholds → List<PcoPeopleHousehold>
no setter
includedInactiveReason → PcoPeopleInactiveReason?
no setter
includedMaritalStatus → PcoPeopleMaritalStatus?
no setter
includedNamePrefix → PcoPeopleNamePrefix?
no setter
includedNameSuffix → PcoPeopleNameSuffix?
no setter
includedOrganization → PcoPeopleOrganization?
no setter
includedPersonApps → List<PcoPeoplePersonApp>
no setter
includedPhoneNumbers → List<PcoPeoplePhoneNumber>
no setter
includedPlatformNotifications → List<PcoPeoplePlatformNotification>
no setter
includedPrimaryCampus → PcoPeopleCampus?
no setter
includedSchool → PcoPeopleSchoolOption?
no setter
includedSocialProfiles → List<PcoPeopleSocialProfile>
no setter
isAccountingAdministrator ↔ bool
pass null to remove key from attributes
getter/setter pair
isCanCreateForms → bool
no setter
isChild ↔ bool
pass null to remove key from attributes
getter/setter pair
isPassedBackgroundCheck → bool
no setter
isSiteAdministrator ↔ bool
pass null to remove key from attributes
getter/setter pair
lastName ↔ String
pass null to remove key from attributes
getter/setter pair
contains the links data returned by the api if present
no setterinherited
medicalNotes ↔ String
pass null to remove key from attributes
getter/setter pair
membership ↔ String
pass null to remove key from attributes
getter/setter pair
middleName ↔ String
pass null to remove key from attributes
getter/setter pair
name → String
no setter
needsSave → bool
no setterinherited
nickname ↔ String
pass null to remove key from attributes
getter/setter pair
pcoApplication ↔ String
latefinalinherited
peoplePermissions ↔ String
pass null to remove key from attributes
getter/setter pair
primaryCampusId ↔ String
pass null to remove key from attributes
getter/setter pair
relationships → ReadOnlyMapView<String, List<PcoResource>>
contains relationships parsed into objects even though the api sends relationship objects as Maps or Lists we always put them into lists for consistency
no setterinherited
remoteId ↔ int
pass null to remove key from attributes
getter/setter pair
resourceType ↔ String
all planning center resources must have a type
latefinalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schoolType → String
no setter
searchName → String
no setter
searchNameOrEmail → String
no setter
searchNameOrEmailOrPhoneNumber → String
no setter
searchPhoneNumber → String
no setter
searchPhoneNumberE164 → String
no setter
slug → String
no setterinherited
status ↔ String
pass null to remove key from attributes
getter/setter pair
updateAllowed → List<String>
no setteroverride
updatedAt → DateTime
no setterinherited

Methods

coerceDouble(dynamic a) → double
inherited
coerceInt(dynamic a) → int
inherited
delete() → Future<PlanningCenterApiResponse<PlanningCenterApiData>>
inherited
filteredAttributes(List<String> allowedKeys) → Map<String, dynamic>
inherited
fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded}) → dynamic
Takes a full JSON:API Response Object (the contents of a "data" field) will clear and update id, apiPath, attributes and _relationships
inherited
getAddresses({PcoPeopleAddressQuery? query}) → Future<PcoCollection<PcoPeopleAddress>>
Will get a collection of PcoPeopleAddress objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/addresses
getApps({PcoPeopleAppQuery? query}) → Future<PcoCollection<PcoPeopleApp>>
Will get a collection of PcoPeopleApp objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/apps
getConnectedPeople({PcoPeopleConnectedPersonQuery? query}) → Future<PcoCollection<PcoPeopleConnectedPerson>>
Will get a collection of PcoPeopleConnectedPerson objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/connected_people
getEmails({PcoPeopleEmailQuery? query}) → Future<PcoCollection<PcoPeopleEmail>>
Will get a collection of PcoPeopleEmail objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/emails
getFieldData({PcoPeopleFieldDatumQuery? query}) → Future<PcoCollection<PcoPeopleFieldDatum>>
Will get a collection of PcoPeopleFieldDatum objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/field_data
getHouseholdMemberships({PcoPeopleHouseholdMembershipQuery? query}) → Future<PcoCollection<PcoPeopleHouseholdMembership>>
Will get a collection of PcoPeopleHouseholdMembership objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/household_memberships
getHouseholds({PcoPeopleHouseholdQuery? query}) → Future<PcoCollection<PcoPeopleHousehold>>
Will get a collection of PcoPeopleHousehold objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/households
getInactiveReason({PcoPeopleInactiveReasonQuery? query}) → Future<PcoCollection<PcoPeopleInactiveReason>>
Will get a collection of PcoPeopleInactiveReason objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/inactive_reason
getMaritalStatus({PcoPeopleMaritalStatusQuery? query}) → Future<PcoCollection<PcoPeopleMaritalStatus>>
Will get a collection of PcoPeopleMaritalStatus objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/marital_status
getMessageGroups({PcoPeopleMessageGroupQuery? query}) → Future<PcoCollection<PcoPeopleMessageGroup>>
Will get a collection of PcoPeopleMessageGroup objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/message_groups
getMessages({PcoPeopleMessageQuery? query}) → Future<PcoCollection<PcoPeopleMessage>>
Will get a collection of PcoPeopleMessage objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/messages
getNamePrefix({PcoPeopleNamePrefixQuery? query}) → Future<PcoCollection<PcoPeopleNamePrefix>>
Will get a collection of PcoPeopleNamePrefix objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/name_prefix
getNameSuffix({PcoPeopleNameSuffixQuery? query}) → Future<PcoCollection<PcoPeopleNameSuffix>>
Will get a collection of PcoPeopleNameSuffix objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/name_suffix
getNotes({PcoPeopleNoteQuery? query}) → Future<PcoCollection<PcoPeopleNote>>
Will get a collection of PcoPeopleNote objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/notes
getOrganization({PcoPeopleOrganizationQuery? query}) → Future<PcoCollection<PcoPeopleOrganization>>
Will get a collection of PcoPeopleOrganization objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/organization
getPersonApps({PcoPeoplePersonAppQuery? query}) → Future<PcoCollection<PcoPeoplePersonApp>>
Will get a collection of PcoPeoplePersonApp objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/person_apps
getPhoneNumbers({PcoPeoplePhoneNumberQuery? query}) → Future<PcoCollection<PcoPeoplePhoneNumber>>
Will get a collection of PcoPeoplePhoneNumber objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/phone_numbers
getPlatformNotifications({PcoPeoplePlatformNotificationQuery? query}) → Future<PcoCollection<PcoPeoplePlatformNotification>>
Will get a collection of PcoPeoplePlatformNotification objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/platform_notifications
getPrimaryCampus({PcoPeopleCampusQuery? query}) → Future<PcoCollection<PcoPeopleCampus>>
Will get a collection of PcoPeopleCampus objects (expecting one) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/primary_campus
getSchool({PcoPeopleSchoolOptionQuery? query}) → Future<PcoCollection<PcoPeopleSchoolOption>>
Will get a collection of PcoPeopleSchoolOption objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/school
getSocialProfiles({PcoPeopleSocialProfileQuery? query}) → Future<PcoCollection<PcoPeopleSocialProfile>>
Will get a collection of PcoPeopleSocialProfile objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/social_profiles
getWorkflowCards({PcoPeopleWorkflowCardQuery? query}) → Future<PcoCollection<PcoPeopleWorkflowCard>>
Will get a collection of PcoPeopleWorkflowCard objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/workflow_cards
getWorkflowShares({PcoPeopleWorkflowShareQuery? query}) → Future<PcoCollection<PcoPeopleWorkflowShare>>
Will get a collection of PcoPeopleWorkflowShare objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/people/1/workflow_shares
handleIncludes(List<Map<String, dynamic>> included) → void
This function populates the relationships with typed resource objects based on the data in the included map of the json.
inherited
handleItem(Map<String, dynamic> data) → PcoResource?
inherited
handleRelationships(Map<String, dynamic> items, [List<Map<String, dynamic>> included = const []]) → Map<String, List<PcoResource>>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
save({Map<String, PcoResource>? withRelated, List<PcoResource>? withIncluded}) → Future<PlanningCenterApiResponse<PlanningCenterApiData>>
Many Planning Center endpoints allow or require additional relationships and/or included items to be sent with a create/update operation. Since these cannot always be determined by the automatic code generation, they may be included as arguments to the save operation.
inherited
toCreateResource() → Map<String, dynamic>
create the attributes Map for this object without the id field using only the attributes allowed in create (post) operations
inherited
toDataMap({Map<String, PcoResource>? withRelated, List<PcoResource>? withIncluded}) → Map<String, dynamic>
create a json-api Map for this object automatically selecting create or update based on the existence of the id field. Will result in something like this:
inherited
toIdResource() → Map<String, dynamic>
returns the simplest representation of this resource with only the type and the id:
inherited
toJson({dynamic includeAttributes = true, dynamic includeRelationships = false}) → Map<String, dynamic>
Some api requests only want the type and id of an object. In those cases, set includeAttributes to false or call toIdResource instead.
inherited
toString() → String
A string representation of this object.
inherited
toUpdateResource() → Map<String, dynamic>
create the attributes Map for this object using only the attributes allowed in update (patch) operations
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

canInclude → List<String>
possible includes with parameter ?include=a,b
no setter
canOrderBy → List<String>
possible orderings with parameter ?order=
no setter
canQuery → List<String>
possible queries using parameters like ?wherekey=value or ?wheregt|lt=value
no setter

Static Methods

get({String? id, PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting many) using a path like this: /people/v2/people
getAll({String? id, PcoPeoplePersonQuery? query, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection containing ALL PcoPeoplePerson objects (expecting many) using a path like this: /people/v2/people
getAllFromHousehold(String householdId, {String? id, PcoPeoplePersonQuery? query, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection containing ALL PcoPeoplePerson objects (expecting many) using a path like this: /people/v2/households/$householdId/people
getAllFromList(String listId, {String? id, PcoPeoplePersonQuery? query, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection containing ALL PcoPeoplePerson objects (expecting many) using a path like this: /people/v2/lists/$listId/people
getAssigneeFromPersonAndWorkflowCard(String personId, String workflowCardId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/people/$personId/workflow_cards/$workflowCardId/assignee
getCreatedByFromList(String listId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/lists/$listId/created_by
getCreatedByFromListAndRuleAndCondition(String listId, String ruleId, String conditionId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/lists/$listId/rules/$ruleId/conditions/$conditionId/created_by
getCreatedByFromNote(String noteId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/notes/$noteId/created_by
getCreatedByFromReport(String reportId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/reports/$reportId/created_by
getDefaultAssigneeFromWorkflowAndStep(String workflowId, String stepId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/workflows/$workflowId/steps/$stepId/default_assignee
getFromEmail(String emailId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/emails/$emailId/person
getFromFieldData(String fieldDataId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/field_data/$fieldDataId/person
getFromFormAndFormSubmission(String formId, String formSubmissionId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/forms/$formId/form_submissions/$formSubmissionId/person
getFromFromMessageGroup(String messageGroupId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/message_groups/$messageGroupId/from
getFromHousehold(String householdId, {String? id, PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting many) using a path like this: /people/v2/households/$householdId/people
getFromHouseholdAndHouseholdMembership(String householdId, String householdMembershipId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/households/$householdId/household_memberships/$householdMembershipId/person
getFromList(String listId, {String? id, PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting many) using a path like this: /people/v2/lists/$listId/people
getFromListAndShare(String listId, String shareId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/lists/$listId/shares/$shareId/person
getFromNote(String noteId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/notes/$noteId/person
getFromNoteCategoryAndShare(String noteCategoryId, String shareId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/note_categories/$noteCategoryId/shares/$shareId/person
getFromPeopleImportAndHistory(String peopleImportId, String historyId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/people_imports/$peopleImportId/histories/$historyId/person
getFromPersonAndWorkflowCard(String personId, String workflowCardId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/people/$personId/workflow_cards/$workflowCardId/person
getFromPersonAndWorkflowShare(String personId, String workflowShareId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/people/$personId/workflow_shares/$workflowShareId/person
getFromSocialProfile(String socialProfileId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/social_profiles/$socialProfileId/person
getFromWorkflowAndStepAndAssigneeSummary(String workflowId, String stepId, String assigneeSummaryId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/workflows/$workflowId/steps/$stepId/assignee_summaries/$assigneeSummaryId/person
getSharedPeopleFromWorkflow(String workflowId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/workflows/$workflowId/shared_people
getSingle(String id, {PcoPeoplePersonQuery? query, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoPeoplePerson?>
Will get a single PcoPeoplePerson object using a path like this: /people/v2/people/[id]
getSingleFromHousehold(String householdId, String id, {PcoPeoplePersonQuery? query, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoPeoplePerson?>
Will get a single PcoPeoplePerson object using a path like this: /people/v2/households/$householdId/people/[id]
getSingleFromList(String listId, String id, {PcoPeoplePersonQuery? query, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoPeoplePerson?>
Will get a single PcoPeoplePerson object using a path like this: /people/v2/lists/$listId/people/[id]
getSubscribersFromNoteCategory(String noteCategoryId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/note_categories/$noteCategoryId/subscribers
getToFromMessage(String messageId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/messages/$messageId/to
getUpdatedByFromList(String listId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/lists/$listId/updated_by
getUpdatedByFromReport(String reportId, {PcoPeoplePersonQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAddresses = false, bool includeEmails = false, bool includeFieldData = false, bool includeHouseholds = false, bool includeInactiveReason = false, bool includeMaritalStatus = false, bool includeNamePrefix = false, bool includeNameSuffix = false, bool includeOrganization = false, bool includePersonApps = false, bool includePhoneNumbers = false, bool includePlatformNotifications = false, bool includePrimaryCampus = false, bool includeSchool = false, bool includeSocialProfiles = false}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a PcoCollection of PcoPeoplePerson objects (expecting one) using a path like this: /people/v2/reports/$reportId/updated_by