getFromPeopleImportAndHistory static method

Future<PcoCollection<PcoPeopleHousehold>> getFromPeopleImportAndHistory(
  1. String peopleImportId,
  2. String historyId,
  3. {PcoPeopleHouseholdQuery? query,
  4. bool getAll = false,
  5. bool includePeople = false}
)

Will get a PcoCollection of PcoPeopleHousehold objects (expecting one) using a path like this: /people/v2/people_imports/$peopleImportId/histories/$historyId/household

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<PcoPeopleHousehold>>
    getFromPeopleImportAndHistory(
  String peopleImportId,
  String historyId, {
  PcoPeopleHouseholdQuery? query,
  bool getAll = false,
  bool includePeople = false,
}) async {
  query ??= PcoPeopleHouseholdQuery();
  if (getAll) query.getAll = true;

  if (includePeople) query.include.add('people');
  var url =
      '/people/v2/people_imports/$peopleImportId/histories/$historyId/household';

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