PcoGivingPerson class

This class represents a PCO Giving Person Object

Instantiation

  • This object cannot be created through the API.
  • Instantiate from existing JSON data using the PcoGivingPerson.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 Planning Center Person record that has been added to Giving.

The Person object in Planning Center is so crucial that we have an entire product dedicated to managing, keeping track of, editing, and creating these records and metadata around them. For additional info, take a look at the Planning Center People API Docs.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • permissions (ro) -> PCO: permissions
  • emailAddresses (ro) -> PCO: email_addresses
  • addresses (ro) -> PCO: addresses
  • phoneNumbers (ro) -> PCO: phone_numbers
  • firstName (ro) -> PCO: first_name
  • lastName (ro) -> PCO: last_name
  • donorNumber (ro) -> PCO: donor_number

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Person",
  "id": "1",
  "attributes": {
    "permissions": "string",
    "email_addresses": [],
    "addresses": [],
    "phone_numbers": [],
    "first_name": "string",
    "last_name": "string",
    "donor_number": 1
  },
  "relationships": {
    "primary_campus": {
      "data": {
        "type": "Campus",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoGivingPerson({String? id, String? permissions, List? emailAddresses, List? addresses, List? phoneNumbers, String? firstName, String? lastName, int? donorNumber, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoGivingPerson object. This object cannot be created with the API
factory
PcoGivingPerson.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoGivingPerson.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

addresses → List
no setter
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
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
donorNumber → int
no setter
emailAddresses → List
no setter
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
firstName → String
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String?
no setterinherited
included → List<PcoResource>
contains included items parsed into objects
no setterinherited
lastName → String
no setter
contains the links data returned by the api if present
no setterinherited
needsSave → bool
no setterinherited
pcoApplication ↔ String
latefinalinherited
permissions → String
no setter
phoneNumbers → List
no setter
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
resourceType ↔ String
all planning center resources must have a type
latefinalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
slug → String
no setterinherited
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
getBatches({PcoGivingBatchQuery? query}) → Future<PcoCollection<PcoGivingBatch>>
Will get a collection of PcoGivingBatch objects (expecting many) using a path like this: https://api.planningcenteronline.com/giving/v2/people/1/batches
getBatchGroups({PcoGivingBatchGroupQuery? query}) → Future<PcoCollection<PcoGivingBatchGroup>>
Will get a collection of PcoGivingBatchGroup objects (expecting many) using a path like this: https://api.planningcenteronline.com/giving/v2/people/1/batch_groups
getDonations({PcoGivingDonationQuery? query}) → Future<PcoCollection<PcoGivingDonation>>
Will get a collection of PcoGivingDonation objects (expecting many) using a path like this: https://api.planningcenteronline.com/giving/v2/people/1/donations
getPaymentMethods({PcoGivingPaymentMethodQuery? query}) → Future<PcoCollection<PcoGivingPaymentMethod>>
Will get a collection of PcoGivingPaymentMethod objects (expecting many) using a path like this: https://api.planningcenteronline.com/giving/v2/people/1/payment_methods
getPledges({PcoGivingPledgeQuery? query}) → Future<PcoCollection<PcoGivingPledge>>
Will get a collection of PcoGivingPledge objects (expecting many) using a path like this: https://api.planningcenteronline.com/giving/v2/people/1/pledges
getPrimaryCampus({PcoGivingCampusQuery? query}) → Future<PcoCollection<PcoGivingCampus>>
Will get a collection of PcoGivingCampus objects (expecting one) using a path like this: https://api.planningcenteronline.com/giving/v2/people/1/primary_campus
getRecurringDonations({PcoGivingRecurringDonationQuery? query}) → Future<PcoCollection<PcoGivingRecurringDonation>>
Will get a collection of PcoGivingRecurringDonation objects (expecting many) using a path like this: https://api.planningcenteronline.com/giving/v2/people/1/recurring_donations
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, PcoGivingPersonQuery? query, bool getAll = false}) → Future<PcoCollection<PcoGivingPerson>>
Will get a PcoCollection of PcoGivingPerson objects (expecting many) using a path like this: /giving/v2/people
getAll({String? id, PcoGivingPersonQuery? query}) → Future<PcoCollection<PcoGivingPerson>>
Will get a PcoCollection containing ALL PcoGivingPerson objects (expecting many) using a path like this: /giving/v2/people
getJointGiverFromPledge(String pledgeId, {PcoGivingPersonQuery? query, bool getAll = false}) → Future<PcoCollection<PcoGivingPerson>>
Will get a PcoCollection of PcoGivingPerson objects (expecting one) using a path like this: /giving/v2/pledges/$pledgeId/joint_giver
getOwnerFromBatch(String batchId, {PcoGivingPersonQuery? query, bool getAll = false}) → Future<PcoCollection<PcoGivingPerson>>
Will get a PcoCollection of PcoGivingPerson objects (expecting one) using a path like this: /giving/v2/batches/$batchId/owner
getOwnerFromBatchGroup(String batchGroupId, {PcoGivingPersonQuery? query, bool getAll = false}) → Future<PcoCollection<PcoGivingPerson>>
Will get a PcoCollection of PcoGivingPerson objects (expecting one) using a path like this: /giving/v2/batch_groups/$batchGroupId/owner
getSingle(String id, {PcoGivingPersonQuery? query}) → Future<PcoGivingPerson?>
Will get a single PcoGivingPerson object using a path like this: /giving/v2/people/[id]

Constants

kAddresses → const String
kApiVersion → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kDonorNumber → const String
kEmailAddresses → const String
kFirstName → const String
kId → const String
kLastName → const String
kPcoApplication → const String
kPermissions → const String
kPhoneNumbers → const String
kTypeId → const String
kTypeString → const String