getFromDonationAndRefundAndDesignationRefund static method

Future<PcoCollection<PcoGivingDesignation>> getFromDonationAndRefundAndDesignationRefund(
  1. String donationId,
  2. String designationRefundId, {
  3. PcoGivingDesignationQuery? query,
  4. bool getAll = false,
})

Will get a PcoCollection of PcoGivingDesignation objects (expecting one) using a path like this: /giving/v2/donations/$donationId/refund/designation_refunds/$designationRefundId/designation

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<PcoGivingDesignation>>
    getFromDonationAndRefundAndDesignationRefund(
  String donationId,
  String designationRefundId, {
  PcoGivingDesignationQuery? query,
  bool getAll = false,
}) async {
  query ??= PcoGivingDesignationQuery();
  if (getAll) query.getAll = true;

  var url =
      '/giving/v2/donations/$donationId/refund/designation_refunds/$designationRefundId/designation';

  return PcoCollection.fromApiCall<PcoGivingDesignation>(url,
      query: query, apiVersion: kApiVersion);
}