docs

Author: g-saracca

docs/useCases.md

@@ -51,6 +51,7 @@ The different use cases currently available in the package are classified below,
   - [Files write use cases](#files-write-use-cases)
     - [File Uploading Use Cases](#file-uploading-use-cases)
     - [Delete a File](#delete-a-file)
+    - [Replace a File](#replace-a-file)
 - [Metadata Blocks](#metadata-blocks)
   - [Metadata Blocks read use cases](#metadata-blocks-read-use-cases)
     - [Get All Facetable Metadata Fields](#get-all-facetable-metadata-fields)
@@ -1264,6 +1265,37 @@ Note that the behavior of deleting files depends on if the dataset has ever been
 - If the dataset has published, the file is deleted from the draft (and future published versions).
 - If the dataset has published, the deleted file can still be downloaded because it was part of a published version.
 
+#### Replace a File
+
+Replaces a File. Currently working for already uploaded S3 bucket files.
+
+##### Example call:
+
+```typescript
+import { replaceFile } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const fileId = 12345
+const uploadedFileDTO: UploadedFileDTO = {
+  fileName: 'the-file-name',
+  storageId: 'localstack1://mybucket:19121faf7e7-2c40322ff54e',
+  checksumType: 'md5',
+  checksumValue: 'ede3d3b685b4e137ba4cb2521329a75e',
+  mimeType: 'text/plain'
+}
+
+replaceFile.execute(fileId, uploadedFileDTO)
+
+/* ... */
+```
+
+_See [use case](../src/files/domain/useCases/ReplaceFile.ts) implementation_.
+
+The `fileId` parameter should be a number, the numeric identifier.
+
+The `uploadedFileDTO` parameter is a [UploadedFileDTO](../src/files/domain/dtos/UploadedFileDTO.ts) and includes properties related to the uploaded files. Some of these properties should be calculated from the uploaded File Blob objects and the resulting storage identifiers from the Upload File use case.
+
 ## Metadata Blocks
 
 ### Metadata Blocks read use cases