renameFolderRaw method

  1. @experimental
DynamiteRawResponse<void, void> renameFolderRaw({
  1. required int folderId,
  2. required String name,
})

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:

  • name

Status codes:

  • 200

See:

  • renameFolder for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i3.experimental
_i1.DynamiteRawResponse<void, void> renameFolderRaw({
  required int folderId,
  required String name,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{};

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

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

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

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

  final _path = _i2.UriTemplate('/index.php/apps/news/api/v1-3/folders/{folderId}{?name*}').expand(_parameters);
  return _i1.DynamiteRawResponse<void, void>(
    response: executeRequest(
      'put',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: null,
    headersType: null,
    serializers: _$jsonSerializers,
  );
}