getSingle static method

Future<PcoGivingDonation?> getSingle(
  1. String id, {
  2. PcoGivingDonationQuery? query,
  3. bool includeAllRelated = false,
  4. bool includeDesignations = false,
  5. bool includeLabels = false,
  6. bool includeNote = false,
  7. bool includeRefund = false,
})

Will get a single PcoGivingDonation object using a path like this: /giving/v2/donations/[id]

Available Query Filters:

  • succeeded

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<PcoGivingDonation?> getSingle(
  String id, {
  PcoGivingDonationQuery? query,
  bool includeAllRelated = false,
  bool includeDesignations = false,
  bool includeLabels = false,
  bool includeNote = false,
  bool includeRefund = false,
}) async {
  query ??= PcoGivingDonationQuery();
  if (includeAllRelated) query.include.addAll(PcoGivingDonation.canInclude);
  if (includeDesignations) query.include.add('designations');
  if (includeLabels) query.include.add('labels');
  if (includeNote) query.include.add('note');
  if (includeRefund) query.include.add('refund');
  var url = '/giving/v2/donations/$id';
  var retval = await PcoCollection.fromApiCall<PcoGivingDonation>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}