getNotesRaw method

  1. @experimental
DynamiteRawResponse<BuiltList<Note>, void> getNotesRaw({
  1. String? category,
  2. String? exclude,
  3. int? pruneBefore,
  4. int? chunkSize,
  5. String? chunkCursor,
  6. String? ifNoneMatch,
})

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:

  • category
  • exclude Defaults to ''.
  • pruneBefore Defaults to 0.
  • chunkSize Defaults to 0.
  • chunkCursor
  • ifNoneMatch

Status codes:

  • 200

See:

Implementation

@experimental
DynamiteRawResponse<BuiltList<Note>, void> getNotesRaw({
  String? category,
  String? exclude,
  int? pruneBefore,
  int? chunkSize,
  String? chunkCursor,
  String? ifNoneMatch,
}) {
  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 $category = jsonSerializers.serialize(category, specifiedType: const FullType(String));
  _parameters['category'] = $category;

  var $exclude = jsonSerializers.serialize(exclude, specifiedType: const FullType(String));
  $exclude ??= '';
  _parameters['exclude'] = $exclude;

  var $pruneBefore = jsonSerializers.serialize(pruneBefore, specifiedType: const FullType(int));
  $pruneBefore ??= 0;
  _parameters['pruneBefore'] = $pruneBefore;

  var $chunkSize = jsonSerializers.serialize(chunkSize, specifiedType: const FullType(int));
  $chunkSize ??= 0;
  _parameters['chunkSize'] = $chunkSize;

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

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

  final _path =
      UriTemplate('/index.php/apps/notes/api/v1/notes{?category*,exclude*,pruneBefore*,chunkSize*,chunkCursor*}')
          .expand(_parameters);
  return DynamiteRawResponse<BuiltList<Note>, void>(
    response: executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(BuiltList, [FullType(Note)]),
    headersType: null,
    serializers: jsonSerializers,
  );
}