$renameCategory_Request method

@experimental Request $renameCategory_Request({ required String category, required RenameCategoryRequestApplicationJson $body, })

Rename a category.

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

Parameters:

• category The name of the category to be queried as urlencoded string.

Put the string _ to obtain all recipes with no category.

Status codes:

• 200: The category was renamed successfully
• 400: The new category name was not included during the request.
• 500: The renaming did not succeed.

See:

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

Implementation

@_i2.experimental
_i3.Request $renameCategory_Request({
  required String category,
  required RenameCategoryRequestApplicationJson $body,
}) {
  final _parameters = <String, Object?>{};
  final __category = _$jsonSerializers.serialize(category, specifiedType: const FullType(String));
  _parameters['category'] = __category;

  final _path = _i5.UriTemplate('/index.php/apps/cookbook/api/v1/category/{category}').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 = _i4.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  _request.headers['Content-Type'] = 'application/json';
  _request.body = json.encode(
    _$jsonSerializers.serialize($body, specifiedType: const FullType(RenameCategoryRequestApplicationJson)),
  );
  return _request;
}