getFromPerson static method

Future<PcoCollection<PcoPeoplePhoneNumber>> getFromPerson(
  1. String personId,
  2. {String? id,
  3. PcoPeoplePhoneNumberQuery? query,
  4. bool getAll = false}
)

Will get a PcoCollection of PcoPeoplePhoneNumber objects (expecting many) using a path like this: /people/v2/people/$personId/phone_numbers

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<PcoPeoplePhoneNumber>> getFromPerson(
  String personId, {
  String? id,
  PcoPeoplePhoneNumberQuery? query,
  bool getAll = false,
}) async {
  query ??= PcoPeoplePhoneNumberQuery();
  if (getAll) query.getAll = true;

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