$setFavorites_Request method

@experimental Request $setFavorites_Request({ required BuiltList<String> favorites, bool? oCSAPIRequest, })

Set favorites list.

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

Parameters:

• favorites Favorite addresses.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Favorites updated

See:

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

Implementation

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

  final _path =
      _i4.UriTemplate('/ocs/v2.php/apps/weather_status/api/v1/favorites{?favorites%5B%5D*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _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 _i5.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}