getDesignationsFromRecurringDonation static method
Future<PcoCollection<PcoGivingRecurringDonationDesignation> >
getDesignationsFromRecurringDonation(
- String recurringDonationId, {
- String? id,
- PcoGivingRecurringDonationDesignationQuery? query,
- bool getAll = false,
- bool includeFund = false,
Will get a PcoCollection
of PcoGivingRecurringDonationDesignation objects (expecting many)
using a path like this: /giving/v2/recurring_donations/$recurringDonationId/designations
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<PcoGivingRecurringDonationDesignation>>
getDesignationsFromRecurringDonation(
String recurringDonationId, {
String? id,
PcoGivingRecurringDonationDesignationQuery? query,
bool getAll = false,
bool includeFund = false,
}) async {
query ??= PcoGivingRecurringDonationDesignationQuery();
if (getAll) query.getAll = true;
if (includeFund) query.include.add('fund');
var url =
'/giving/v2/recurring_donations/$recurringDonationId/designations';
if (id != null) url += '/$id';
return PcoCollection.fromApiCall<PcoGivingRecurringDonationDesignation>(url,
query: query, apiVersion: kApiVersion);
}