getSingleFromPersonAndAvailableSignup static method

Future<PcoServicesSignupSheet?> getSingleFromPersonAndAvailableSignup(String personId, String availableSignupId, String id, { PcoServicesSignupSheetQuery? query, bool includeAllRelated = false, bool includeScheduledPeople = false, bool includeSignupSheetMetadata = false, })

Will get a single PcoServicesSignupSheet object using a path like this: /services/v2/people/$personId/available_signups/$availableSignupId/signup_sheets/[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<PcoServicesSignupSheet?> getSingleFromPersonAndAvailableSignup(
  String personId,
  String availableSignupId,
  String id, {
  PcoServicesSignupSheetQuery? query,
  bool includeAllRelated = false,
  bool includeScheduledPeople = false,
  bool includeSignupSheetMetadata = false,
}) async {
  query ??= PcoServicesSignupSheetQuery();
  if (includeAllRelated)
    query.include.addAll(PcoServicesSignupSheet.canInclude);
  if (includeScheduledPeople) query.include.add('scheduled_people');
  if (includeSignupSheetMetadata) query.include.add('signup_sheet_metadata');
  var url =
      '/services/v2/people/$personId/available_signups/$availableSignupId/signup_sheets/$id';
  var retval = await PcoCollection.fromApiCall<PcoServicesSignupSheet>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}