getFromPerson static method

Future<PcoCollection<PcoGivingRecurringDonation>> getFromPerson(
  1. String personId, {
  2. String? id,
  3. PcoGivingRecurringDonationQuery? query,
  4. bool getAll = false,
  5. bool includeDesignations = false,
})

Will get a PcoCollection of PcoGivingRecurringDonation objects (expecting many) using a path like this: /giving/v2/people/$personId/recurring_donations

Getting a PcoCollection is useful even when retrieving a single object because it contains error data and helper functions.

Additional options may be specified by using the query argument, but some query options are also available as boolean flags in this function call too.

Implementation

static Future<PcoCollection<PcoGivingRecurringDonation>> getFromPerson(
  String personId, {
  String? id,
  PcoGivingRecurringDonationQuery? query,
  bool getAll = false,
  bool includeDesignations = false,
}) async {
  query ??= PcoGivingRecurringDonationQuery();
  if (getAll) query.getAll = true;

  if (includeDesignations) query.include.add('designations');
  var url = '/giving/v2/people/$personId/recurring_donations';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoGivingRecurringDonation>(url,
      query: query, apiVersion: kApiVersion);
}