getFromHousehold static method

Future<PcoCollection<PcoPeopleHouseholdMembership>> getFromHousehold(String householdId, { String? id, PcoPeopleHouseholdMembershipQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeHousehold = false, bool includePerson = false, })

Will get a PcoCollection of PcoPeopleHouseholdMembership objects (expecting many) using a path like this: /people/v2/households/$householdId/household_memberships

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<PcoPeopleHouseholdMembership>> getFromHousehold(
  String householdId, {
  String? id,
  PcoPeopleHouseholdMembershipQuery? query,
  bool getAll = false,
  bool includeAllRelated = false,
  bool includeHousehold = false,
  bool includePerson = false,
}) async {
  query ??= PcoPeopleHouseholdMembershipQuery();
  if (getAll) query.getAll = true;
  if (includeAllRelated)
    query.include.addAll(PcoPeopleHouseholdMembership.canInclude);
  if (includeHousehold) query.include.add('household');
  if (includePerson) query.include.add('person');
  var url = '/people/v2/households/$householdId/household_memberships';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleHouseholdMembership>(url,
      query: query, apiVersion: kApiVersion);
}