renameCollection method

Future<DynamiteResponse<CollaborationResourcesRenameCollectionResponseApplicationJson, void>> renameCollection({ required String collectionName, required int collectionId, bool? oCSAPIRequest, })

Rename a collection.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. 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_Request for the request send by this method.
• $renameCollection_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<CollaborationResourcesRenameCollectionResponseApplicationJson, void>> renameCollection({
  required String collectionName,
  required int collectionId,
  bool? oCSAPIRequest,
}) async {
  final _request = $renameCollection_Request(
    collectionName: collectionName,
    collectionId: collectionId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $renameCollection_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<CollaborationResourcesRenameCollectionResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}