$deleteRecipe_Request method

@experimental Request $deleteRecipe_Request({ required String id, })

Delete an existing recipe.

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

Status codes:

• 200: The recipe was deleted successfully
• 502: An Exception was thrown

See:

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

Implementation

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

  final _path = _i5.UriTemplate('/index.php/apps/cookbook/api/v1/recipes/{id}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('delete', _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
  return _request;
}