Saltar al contenido principal

CaseFilesModule

Sub-módulo para gestión de archivos adjuntos de casos en Shori

Permite buscar, descargar, actualizar y eliminar documentos asociados a un caso. Se accede a través de client.caso().files().

Operaciones disponibles

// Buscar archivos de un caso
CaseFileSearchResult result = client.caso().files().search("caso-documentId");

// Descargar archivos adjuntos al disco
AttachmentFilesFilter request = AttachmentFilesFilter.builder()
.casoId("caso-documentId")
.build();
List docs = client.caso().files().getAttachments(request);

// Actualizar metadatos de un archivo
client.caso().files().update(updateRequest);

// Eliminar un documento
client.caso().files().delete("documento-documentId");

Metodos

search(AttachmentFilesFilter filter)

Busca los archivos adjuntos de un caso específico

Retorna los metadatos de los archivos (nombre, extensión, ID de documento) sin descargarlos. Para descargar el contenido de los archivos, usa #getAttachments(AttachmentFilesFilter).

CaseFileSearchResult result = client.caso().files().search("caso-documentId");

for (CasoFileSearchResponse file : result.files) {
System.out.println("Archivo: " + file.getFileName() + "." + file.getExtension());
System.out.println("Documento ID: " + file.getDocumentId());
}

Parametros:

  • filterAttachmentFilesFilter Cuerpo de solicitud

Retorna: Lista de metadatos de archivos adjuntos al caso

Lanza:

  • ApiException — si hay error al consultar el API

getAttachments(AttachmentFilesFilter request)

Descarga los archivos adjuntos de un caso al disco local.

Cada archivo se descarga al directorio configurado en el cliente (o a la carpeta temporal del sistema si no se configuró ninguno).

GetAttachmentFilesRequest request = GetAttachmentFilesRequest.builder()
.casoId("caso-documentId")
.build();

List archivos = client.caso().files().getAttachments(request);

for (CasoFileSearchResponse archivo : archivos) {
File file = archivo.getFile(); // Archivo descargado en disco
System.out.println("Descargado en: " + file.getAbsolutePath());
System.out.println("Tamaño: " + file.length() + " bytes");
}

Parametros:

  • request — Request con el ID del caso y configuración de paginación

Retorna: Lista de archivos adjuntos con el File descargado en cada uno

Lanza:

  • ApiException — si hay error al consultar o descargar los archivos

update(CasoFileUpdateRequest request)

Actualiza los metadatos de un archivo adjunto.

CasoFileUpdateRequest request = CasoFileUpdateRequest.builder()
.id("archivo-documentId")
.isValid(true)
.isDeleted(false)
.build();

client.caso().files().update(request);

Parametros:

  • request — Datos de actualización del archivo

Lanza:

  • ApiException — si el archivo no existe o hay error en el servidor

delete(String documentId)

Elimina un documento adjunto de un caso.

client.caso().files().delete("documento-documentId");

Parametros:

  • documentId — UUID del documento a eliminar

Lanza:

  • ApiException — si el documento no existe o hay error en el servidor