PcoGivingBatchGroup class

This class represents a PCO Giving BatchGroup Object

Instantiation

  • Create a new instance using the PcoGivingBatchGroup() constructor
  • Instantiate from existing JSON data using the PcoGivingBatchGroup.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 BatchGroup is a collection of Batches.

BatchGroups are an optional way of organizing your Batches into groups that share common characteristics. These are completely customizable and can be used in whatever way makes sense to your organization's workflow.

Similarly to Batches, you can commit (see more in the Actions section) a BatchGroup, and by doing so, all Batches and Donations contained in the BatchGroup will also be committed.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • createdAt (ro) -> PCO: created_at
  • updatedAt (ro) -> PCO: updated_at
  • description (rw) -> PCO: description
  • isCommitted (ro) -> PCO: committed
  • totalCents (ro) -> PCO: total_cents
  • totalCurrency (ro) -> PCO: total_currency
  • status (ro) -> PCO: status

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions:

Raw Data Object Example

{
  "type": "BatchGroup",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "committed": true,
    "total_cents": 1,
    "total_currency": "string",
    "status": "string"
  },
  "relationships": {}
}
Inheritance

Constructors

PcoGivingBatchGroup({String? id, DateTime? createdAt, DateTime? updatedAt, String? description, bool? isCommitted, int? totalCents, String? totalCurrency, String? status, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoGivingBatchGroup object using this endpoint: https://api.planningcenteronline.com/giving/v2/batch_groups
factory
PcoGivingBatchGroup.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoGivingBatchGroup.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

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
description ↔ String
A brief description of what a batch group is for. This is displayed in Giving to help differentiate different batch groups from one another. If no description is provided for a batch group, it will be referred to as Untitled group within Giving.
getter/setter pair
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
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
isCommitted → bool
no setter
contains the links data returned by the api if present
no setterinherited
needsSave → bool
no setterinherited
pcoApplication ↔ String
latefinalinherited
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
status → String
no setter
totalCents → int
no setter
totalCurrency → String
no setter
updateAllowed → List<String>
no setteroverride
updatedAt → DateTime
no setterinherited

Methods

coerceDouble(dynamic a) → double
inherited
coerceInt(dynamic a) → int
inherited
commit(Object data) → Future<PlanningCenterApiResponse<PlanningCenterApiData>>
ACTION: commit
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/batch_groups/1/batches
getOwner({PcoGivingPersonQuery? query}) → Future<PcoCollection<PcoGivingPerson>>
Will get a collection of PcoGivingPerson objects (expecting many) using a path like this: https://api.planningcenteronline.com/giving/v2/batch_groups/1/owner
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
includedOwner<T extends PcoResource>() → List<T>
The code generator could not automatically determine the resource type of this relationship. For type safe code, you should specify it in the type argument when calling.
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, PcoGivingBatchGroupQuery? query, bool getAll = false, bool includeOwner = false}) → Future<PcoCollection<PcoGivingBatchGroup>>
Will get a PcoCollection of PcoGivingBatchGroup objects (expecting many) using a path like this: /giving/v2/batch_groups
getAll({String? id, PcoGivingBatchGroupQuery? query, bool includeOwner = false}) → Future<PcoCollection<PcoGivingBatchGroup>>
Will get a PcoCollection containing ALL PcoGivingBatchGroup objects (expecting many) using a path like this: /giving/v2/batch_groups
getAllFromBatch(String batchId, {String? id, PcoGivingBatchGroupQuery? query, bool includeOwner = false}) → Future<PcoCollection<PcoGivingBatchGroup>>
Will get a PcoCollection containing ALL PcoGivingBatchGroup objects (expecting many) using a path like this: /giving/v2/batches/$batchId/batch_group
getAllFromPerson(String personId, {String? id, PcoGivingBatchGroupQuery? query, bool includeOwner = false}) → Future<PcoCollection<PcoGivingBatchGroup>>
Will get a PcoCollection containing ALL PcoGivingBatchGroup objects (expecting many) using a path like this: /giving/v2/people/$personId/batch_groups
getFromBatch(String batchId, {String? id, PcoGivingBatchGroupQuery? query, bool getAll = false, bool includeOwner = false}) → Future<PcoCollection<PcoGivingBatchGroup>>
Will get a PcoCollection of PcoGivingBatchGroup objects (expecting many) using a path like this: /giving/v2/batches/$batchId/batch_group
getFromPerson(String personId, {String? id, PcoGivingBatchGroupQuery? query, bool getAll = false, bool includeOwner = false}) → Future<PcoCollection<PcoGivingBatchGroup>>
Will get a PcoCollection of PcoGivingBatchGroup objects (expecting many) using a path like this: /giving/v2/people/$personId/batch_groups
getSingle(String id, {PcoGivingBatchGroupQuery? query, bool includeOwner = false}) → Future<PcoGivingBatchGroup?>
Will get a single PcoGivingBatchGroup object using a path like this: /giving/v2/batch_groups/[id]
getSingleFromBatch(String batchId, String id, {PcoGivingBatchGroupQuery? query, bool includeOwner = false}) → Future<PcoGivingBatchGroup?>
Will get a single PcoGivingBatchGroup object using a path like this: /giving/v2/batches/$batchId/batch_group/[id]
getSingleFromPerson(String personId, String id, {PcoGivingBatchGroupQuery? query, bool includeOwner = false}) → Future<PcoGivingBatchGroup?>
Will get a single PcoGivingBatchGroup object using a path like this: /giving/v2/people/$personId/batch_groups/[id]

Constants

kApiVersion → const String
kCommitted → const String
kCreatedAt → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kDescription → const String
kId → const String
kPcoApplication → const String
kStatus → const String
kTotalCents → const String
kTotalCurrency → const String
kTypeId → const String
kTypeString → const String
kUpdatedAt → const String