getAll static method

Future<PcoCollection<PcoPeopleMaritalStatus>> getAll({
  1. String? id,
  2. PcoPeopleMaritalStatusQuery? query,
})

Will get a PcoCollection containing ALL PcoPeopleMaritalStatus objects (expecting many) using a path like this: /people/v2/marital_statuses

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<PcoPeopleMaritalStatus>> getAll({
  String? id,
  PcoPeopleMaritalStatusQuery? query,
}) async {
  query ??= PcoPeopleMaritalStatusQuery();
  query.getAll = true;

  var url = '/people/v2/marital_statuses';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleMaritalStatus>(url,
      query: query, apiVersion: kApiVersion);
}