updateNoteRaw method

  1. @experimental
DynamiteRawResponse<Note, void> updateNoteRaw({
  1. required int id,
  2. String? content,
  3. int? modified,
  4. String? title,
  5. String? category,
  6. int? favorite,
  7. String? ifMatch,
})

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • content
  • modified
  • title
  • category
  • favorite
  • ifMatch

Status codes:

  • 200

See:

Implementation

@experimental
DynamiteRawResponse<Note, void> updateNoteRaw({
  required int id,
  String? content,
  int? modified,
  String? title,
  String? category,
  int? favorite,
  String? ifMatch,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  final $id = jsonSerializers.serialize(id, specifiedType: const FullType(int));
  _parameters['id'] = $id;

  final $content = jsonSerializers.serialize(content, specifiedType: const FullType(String));
  _parameters['content'] = $content;

  final $modified = jsonSerializers.serialize(modified, specifiedType: const FullType(int));
  _parameters['modified'] = $modified;

  final $title = jsonSerializers.serialize(title, specifiedType: const FullType(String));
  _parameters['title'] = $title;

  final $category = jsonSerializers.serialize(category, specifiedType: const FullType(String));
  _parameters['category'] = $category;

  final $favorite = jsonSerializers.serialize(favorite, specifiedType: const FullType(int));
  _parameters['favorite'] = $favorite;

  final $ifMatch = jsonSerializers.serialize(ifMatch, specifiedType: const FullType(String));
  if ($ifMatch != null) {
    _headers['If-Match'] = const dynamite_utils.HeaderEncoder().convert($ifMatch);
  }

  final _path = UriTemplate('/index.php/apps/notes/api/v1/notes/{id}{?content*,modified*,title*,category*,favorite*}')
      .expand(_parameters);
  return DynamiteRawResponse<Note, void>(
    response: executeRequest(
      'put',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(Note),
    headersType: null,
    serializers: jsonSerializers,
  );
}