getSettingsRaw method

  1. @experimental
DynamiteRawResponse<Settings, void> getSettingsRaw()

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.

Status codes:

  • 200

See:

Implementation

@experimental
DynamiteRawResponse<Settings, void> getSettingsRaw() {
  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
  const _path = '/index.php/apps/notes/api/v1/settings';
  return DynamiteRawResponse<Settings, void>(
    response: executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(Settings),
    headersType: null,
    serializers: jsonSerializers,
  );
}