Repository navigation
v3.0.0
Adds support for Paperless-ngx 3.x, which reworked the task API. Paperless 2.x remains supported — the tools detect and adapt to either server.
The version jumps from 0.1.6 to 3.0.0 so the major tracks the Paperless-ngx major it targets. There are no 1.x or 2.x releases of this package.
Fixed
list_tasksfailed outright against Paperless 3.x. 3.0 paginates/api/tasks/({count, next, previous, results}); 2.x returned a bare array. The tool sliced the response directly and died withresponse.slice is not a function. Both shapes are now accepted and the tool still returns a plain array.post_documentwithpoll: truenever completed against Paperless 3.x. Two independent causes, both silent — the upload succeeded but the tool always reported a timeout with nodocument_id:- the consumer poll read
/api/tasks/?task_id=…as an array, so it never found its task on 3.x; - terminal-state detection compared against uppercase
SUCCESS/FAILURE/REVOKED, but 3.x reports lowercasesuccess/failure/revoked. Status comparison is now case-insensitive.
- the consumer poll read
post_documentreturned nodocument_idon Paperless 3.x even when the consumer succeeded: 3.x replaced the task'srelated_documentwith arelated_document_idsarray. Both are now read.
Added
list_tasksgained the Paperless 3.x filterstask_typeandtrigger_source. The 2.xtask_nameandtypefilters are kept for older servers. Each server silently ignores the filters it does not know, so the correct pair applies automatically; the tool descriptions say which version each belongs to.task_typecovers the task kinds 3.x added:mail_fetch,llm_index,empty_trash,check_workflows,bulk_update,reprocess_document,build_share_link,bulk_delete. Note that 2.x'scheck_sanityissanity_checkin 3.x.
Changed (BREAKING)
list_tasksstatusvalues are now lowercase (success, notSUCCESS), matching the 3.x vocabulary. Paperless 2.x requires uppercase and rejects lowercase with a 400, so the tool retries with the other casing and remembers which the server accepted — callers pass lowercase either way.list_tasksno longer acceptsstatus: "RETRY"or"RECEIVED". Paperless 3.x removed both from the task status enum.post_documentreports the server's own status casing in its result (successon 3.x,SUCCESSon 2.x) rather than always uppercasing it.
Full Changelog: v0.1.6...v3.0.0