getSingle static method

Future<PcoPeopleHousehold?> getSingle(
  1. String id, {
  2. PcoPeopleHouseholdQuery? query,
  3. bool includePeople = false,
})

Will get a single PcoPeopleHousehold object using a path like this: /people/v2/households/[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<PcoPeopleHousehold?> getSingle(
  String id, {
  PcoPeopleHouseholdQuery? query,
  bool includePeople = false,
}) async {
  query ??= PcoPeopleHouseholdQuery();

  if (includePeople) query.include.add('people');
  var url = '/people/v2/households/$id';
  var retval = await PcoCollection.fromApiCall<PcoPeopleHousehold>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}