getAllHistoriesFromPeopleImport static method

Future<PcoCollection<PcoPeoplePeopleImportHistory>> getAllHistoriesFromPeopleImport(String peopleImportId, { String? id, PcoPeoplePeopleImportHistoryQuery? query, bool includeAllRelated = false, bool includeHousehold = false, bool includePerson = false, })

Will get a PcoCollection containing ALL PcoPeoplePeopleImportHistory objects (expecting many) using a path like this: /people/v2/people_imports/$peopleImportId/histories

Available Query Filters:

• creates
• household_creates
• household_updates
• identical
• updates

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.

This function forces the query.getAll to be true.

Implementation

static Future<PcoCollection<PcoPeoplePeopleImportHistory>>
    getAllHistoriesFromPeopleImport(
  String peopleImportId, {
  String? id,
  PcoPeoplePeopleImportHistoryQuery? query,
  bool includeAllRelated = false,
  bool includeHousehold = false,
  bool includePerson = false,
}) async {
  query ??= PcoPeoplePeopleImportHistoryQuery();
  query.getAll = true;
  if (includeAllRelated)
    query.include.addAll(PcoPeoplePeopleImportHistory.canInclude);
  if (includeHousehold) query.include.add('household');
  if (includePerson) query.include.add('person');
  var url = '/people/v2/people_imports/$peopleImportId/histories';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeoplePeopleImportHistory>(url,
      query: query, apiVersion: kApiVersion);
}