$resolve_Request method

@experimental Request $resolve_Request({ required BuiltList<String> references, int? limit, bool? oCSAPIRequest, })

Resolve multiple references.

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

Parameters:

• references References to resolve.
• limit Maximum amount of references to resolve. Defaults to 1.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: References returned

See:

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

Implementation

@_i2.experimental
_i3.Request $resolve_Request({
  required BuiltList<String> references,
  int? limit,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $references =
      _$jsonSerializers.serialize(references, specifiedType: const FullType(BuiltList, [FullType(String)]));
  _parameters['references%5B%5D'] = $references;

  var $limit = _$jsonSerializers.serialize(limit, specifiedType: const FullType(int));
  $limit ??= 1;
  _parameters['limit'] = $limit;

  final _path = _i5.UriTemplate('/ocs/v2.php/references/resolve{?references%5B%5D*,limit*}').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;
}