setFavorites method

Future<DynamiteResponse<WeatherStatusSetFavoritesResponseApplicationJson, void>> setFavorites({ required BuiltList<String> favorites, bool? oCSAPIRequest, })

Set favorites list.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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_Request for the request send by this method.
• $setFavorites_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<WeatherStatusSetFavoritesResponseApplicationJson, void>> setFavorites({
  required BuiltList<String> favorites,
  bool? oCSAPIRequest,
}) async {
  final _request = $setFavorites_Request(
    favorites: favorites,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $setFavorites_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<WeatherStatusSetFavoritesResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}