FoldersApi

Functions

@PUT(value = "folders/{folderId}/documents")

abstract suspend fun addDocumentsToFolder(@Path(value = "folderId") folderId: String, @Body addOrRemoveDocumentsFromFolderDto: AddOrRemoveDocumentsFromFolderDto): Response<DocumentsAddedOrRemovedFromFolderResponseDto>

Add document(s) to folder This endpoint allows you to add one or more documents to a folder owned by the user Responses:

@POST(value = "folders")

abstract suspend fun createFolder(@Body folderCreateRequestDto: FolderCreateRequestDto): Response<FolderCreationResponseDto>

Add a new folder for a user This endpoint allows you to add a folder to the authenticating user's account. Responses:

@DELETE(value = "folders/{folderId}")

abstract suspend fun deleteFolder(@Path(value = "folderId") folderId: String, @Query(value = "deleteDocuments") deleteDocuments: Boolean? = false): Response<EmptyObjectResponseDto>

Delete a folder for a user This endpoint allows you to delete a folder from the authenticating user's account. Responses:

@DELETE(value = "folders")

abstract suspend fun deleteFolders(@Query(value = "folders") folders: String, @Query(value = "deleteDocuments") deleteDocuments: Boolean? = false): Response<EmptyObjectResponseDto>

Delete multiple folders for a user This endpoint allows you to perform a batch deletion of folders on a User object. Responses:

@GET(value = "folders")

abstract suspend fun getFolders(@Query(value = "locale") locale: String? = null): Response<GetFoldersListResponseDto>

List the folders for a user This endpoint allows you to list the folders in the authenticating user's account. Responses:

@DELETE(value = "folders/{folderId}/documents")

abstract suspend fun removeDocumentFromFolder(@Path(value = "folderId") folderId: String, @Query(value = "documentIds") documentIds: String): Response<DocumentsAddedOrRemovedFromFolderResponseDto>

Remove document(s) from folder This endpoint allows you to remove multiple documents from a folder owned by the user Responses:

@PUT(value = "folders/{folderId}")

abstract suspend fun upsertFolder(@Path(value = "folderId") folderId: String, @Body folderUpdateRequestDto: FolderUpdateRequestDto): Response<EmptyObjectResponseDto>

Update a folder for a user This endpoint allows you to update a folder in the authenticating user's account. Responses: