$searchByPhoneNumbers_Request method

@experimental Request $searchByPhoneNumbers_Request({ required String location, required ContentString<BuiltMap<String, BuiltList<String>>> search, bool? oCSAPIRequest, })

Search users by their phone numbers.

Returns a DynamiteRequest backing the searchByPhoneNumbers operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• location Location of the phone number (for country code).
• search Phone numbers to search for.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Users returned
• 400: Invalid location

See:

• searchByPhoneNumbers for a method executing this request and parsing the response.
• $searchByPhoneNumbers_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $searchByPhoneNumbers_Request({
  required String location,
  required ContentString<BuiltMap<String, BuiltList<String>>> search,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $location = _$jsonSerializers.serialize(location, specifiedType: const FullType(String));
  _parameters['location'] = $location;

  final $search = _$jsonSerializers.serialize(
    search,
    specifiedType: const FullType(ContentString, [
      FullType(BuiltMap, [
        FullType(String),
        FullType(BuiltList, [FullType(String)]),
      ]),
    ]),
  );
  _parameters['search'] = $search;

  final _path = _i5.UriTemplate('/ocs/v2.php/cloud/users/search/by-phone{?location*,search*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}