$renameCollection_Request method

@experimental Request $renameCollection_Request({ required String collectionName, required int collectionId, bool? oCSAPIRequest, })

Rename a collection.

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

Parameters:

• collectionName New name.
• collectionId ID of the collection.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Collection returned
• 404: Collection not found
• 500

See:

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

Implementation

@_i2.experimental
_i3.Request $renameCollection_Request({
  required String collectionName,
  required int collectionId,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $collectionName = _$jsonSerializers.serialize(collectionName, specifiedType: const FullType(String));
  _parameters['collectionName'] = $collectionName;

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

  final _path = _i5.UriTemplate('/ocs/v2.php/collaboration/resources/collections/{collectionId}{?collectionName*}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}