getSingleFromHousehold static method

Future<PcoPeopleHouseholdMembership?> getSingleFromHousehold(
  1. String householdId,
  2. String id, {
  3. PcoPeopleHouseholdMembershipQuery? query,
  4. bool includeAllRelated = false,
  5. bool includeHousehold = false,
  6. bool includePerson = false,
})

Will get a single PcoPeopleHouseholdMembership object using a path like this: /people/v2/households/$householdId/household_memberships/[id]

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<PcoPeopleHouseholdMembership?> getSingleFromHousehold(
  String householdId,
  String id, {
  PcoPeopleHouseholdMembershipQuery? query,
  bool includeAllRelated = false,
  bool includeHousehold = false,
  bool includePerson = false,
}) async {
  query ??= PcoPeopleHouseholdMembershipQuery();
  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/$id';
  var retval = await PcoCollection.fromApiCall<PcoPeopleHouseholdMembership>(
      url,
      query: query,
      apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}