Expand description
This module contains the generated types for the library.
Modules§
- base64
- Base64 data that encodes to url safe base64, but can decode from multiple base64 implementations to account for various clients and libraries. Compatible with serde and JsonSchema.
- error
requests - Error methods.
- multipart
requests - Multipart form data types.
- paginate
requests - Utility functions used for pagination.
- phone_
number - A library to implement phone numbers for our database and JSON serialization and deserialization.
Structs§
- Acknowledge
Tasks - Acknowledge
Tasks Request Body - Actor
- Application
Configuration - Application
Configuration Request - Basic
User - Basic
User Request - Bulk
Download - Bulk
Download Request - Bulk
Edit Documents Result - Bulk
Edit Objects Request - Bulk
Edit Request - Bulk
Edit Result - Change
- Classifier
- Correspondent
- Correspondent
Counts - Correspondent
Request - Custom
Field - Custom
Field Counts - Custom
Field Instance - Custom
Field Instance Request - Custom
Field Request - Database
- Document
- Adds update nested feature
- Document
List Request - Document
Permissions - Document
Request - Adds update nested feature
- Document
Share Links Response - Document
Type - Document
Type Counts - Document
Type Permissions - Document
Type Request - Email
Document Request Request - Email
Document Response - Email
Documents Response - Email
Request - Group
- Group
Request - Index
- LogEntry
- Mail
Account - Mail
Account Process Response - Mail
Account Request - Mail
Account Test Response - Mail
Rule - Mail
Rule Request - Metadata
- Migration
Status - Note
Create Request Request - Notes
- Notes
Request - Paginated
Correspondent List - Paginated
Custom Field List - Paginated
Document List - Paginated
Document Type List - Paginated
Group List - Paginated
LogEntry List - Paginated
Mail Account List - Paginated
Mail Rule List - Paginated
Processed Mail List - Paginated
Saved View List - Paginated
Share Link List - Paginated
Storage Path List - Paginated
TagList - Paginated
User List - Paginated
Workflow Action List - Paginated
Workflow List - Paginated
Workflow Trigger List - Paperless
Auth Token - Paperless
Auth Token Request - Patched
Application Configuration Request - Patched
Correspondent Request - Patched
Custom Field Request - Patched
Document Request - Adds update nested feature
- Patched
Document Type Request - Patched
Group Request - Patched
Mail Account Request - Patched
Mail Rule Request - Patched
Profile Request - Patched
Saved View Request - Patched
Storage Path Request - Patched
TagRequest - Patched
User Request - Patched
Workflow Action Request - Patched
Workflow Request - Patched
Workflow Trigger Request - Permissions
- Post
Document Request - Processed
Mail - Processed
Mail Request - Profile
- Profile
Disconnect Social Account Create Request Body - Profile
Totp Create Request Body - Sanity
Check - Saved
View - Saved
View Filter Rule - Saved
View Filter Rule Request - Saved
View Request - Search
Result - Selection
Data - SetPermissions
- Share
Link - Share
Link Request - Social
Account - Social
Account Request - Storage
- Storage
Path - Storage
Path Counts - Storage
Path Request - Suggestions
- System
Status - Tag
- TagCounts
- TagRequest
- Tasks
- Tasks
View - Tasks
View Request - Trash
Request - UiSettings
View - UiSettings
View Request - User
- User
Request - View
- Workflow
- Workflow
Action - Workflow
Action Email - Workflow
Action Email Request - Workflow
Action Request - Workflow
Action Webhook - Workflow
Action Webhook Request - Workflow
Request - Workflow
Trigger - Workflow
Trigger Request
Enums§
- Account
Type Enum 1- IMAP2- Gmail OAuth3- Outlook OAuth- Assign
Correspondent From Enum 1- Do not assign a correspondent2- Use mail address3- Use name (or mail address if not available)4- Use correspondent selected below- Assign
Title From Enum 1- Use subject as title2- Use attachment filename as title3- Do not assign title from rule- Attachment
Type Enum 1- Only process attachments.2- Process all files, including ‘inline’ attachments.- Color
Conversion Strategy - Color
Conversion Strategy Enum LeaveColorUnchanged- LeaveColorUnchangedRGB- RGBUseDeviceIndependentColor- UseDeviceIndependentColorGray- GrayCMYK- CMYK- Compression
Enum none- nonedeflated- deflatedbzip2- bzip2lzma- lzma- Consumption
Scope Enum 1- Only process attachments.2- Process full Mail (with embedded attachments in file) as .eml3- Process full Mail (with embedded attachments in file) as .eml + process attachments as separate documents- Content
Enum archive- archiveoriginals- originalsboth- both- Data
Type Enum string- stringurl- urldate- dateboolean- booleaninteger- integerfloat- floatmonetary- monetarydocumentlink- documentlinkselect- selectlongtext- longtext- Display
Mode - Display
Mode Enum table- TablesmallCards- Small CardslargeCards- Large Cards- File
Version Enum archive- Archiveoriginal- Original- Imap
Security Enum 1- No encryption2- Use SSL3- Use STARTTLS- List
Task Name - Mail
Rule Action Enum 1- Delete2- Move to specified folder3- Mark as read, don’t process read mails4- Flag the mail, don’t process flagged mails5- Tag the mail with specified tag, don’t process tagged mails- Matching
Algorithm 0- None1- Any word2- All words3- Exact match4- Regular expression5- Fuzzy word6- Automatic- Method
Enum set_correspondent- set_correspondentset_document_type- set_document_typeset_storage_path- set_storage_pathadd_tag- add_tagremove_tag- remove_tagmodify_tags- modify_tagsmodify_custom_fields- modify_custom_fieldsdelete- deletereprocess- reprocessset_permissions- set_permissionsrotate- rotatemerge- mergesplit- splitdelete_pages- delete_pagesedit_pdf- edit_pdf- Mode
- Mode
Enum skip- skipredo- redoforce- forceskip_noarchive- skip_noarchive- Object
Type Enum tags- tagscorrespondents- correspondentsdocument_types- document_typesstorage_paths- storage_paths- Operation
Enum set_permissions- set_permissionsdelete- delete- Output
Type - Output
Type Enum pdf- pdfpdfa- pdfapdfa-1- pdfa-1pdfa-2- pdfa-2pdfa-3- pdfa-3- PdfLayout
Enum 0- System default1- Text, then HTML2- HTML, then text3- HTML only4- Text only- Rule
Type Enum 0- title contains1- content contains2- ASN is3- correspondent is4- document type is5- is in inbox6- has tag7- has any tag8- created before9- created after10- created year is11- created month is12- created day is13- added before14- added after15- modified before16- modified after17- does not have tag18- does not have ASN19- title or content contains20- fulltext query21- more like this22- has tags in23- ASN greater than24- ASN less than25- storage path is26- has correspondent in27- does not have correspondent in28- has document type in29- does not have document type in30- has storage path in31- does not have storage path in32- owner is33- has owner in34- does not have owner35- does not have owner in36- has custom field value37- is shared by me38- has custom fields39- has custom field in40- does not have custom field in41- does not have custom field42- custom fields query43- created to44- created from45- added to46- added from47- mime type is- Schedule
Date Field Enum added- Addedcreated- Createdmodified- Modifiedcustom_field- Custom Field- Skip
Archive File - Skip
Archive File Enum never- neverwith_text- with_textalways- always- Sources
Enum 1- Consume Folder2- Api Upload3- Mail Fetch4- Web UI- Status
- Status
Enum FAILURE- FAILUREPENDING- PENDINGRECEIVED- RECEIVEDRETRY- RETRYREVOKED- REVOKEDSTARTED- STARTEDSUCCESS- SUCCESS- Task
Name - Name of the task that was run
- Task
Name Enum consume_file- Consume Filetrain_classifier- Train Classifiercheck_sanity- Check Sanityindex_optimize- Index Optimize- Tasks
View Type Enum auto_task- Auto Taskscheduled_task- Scheduled Taskmanual_task- Manual Task- Trash
Action Enum restore- restoreempty- empty- Type
- Unpaper
Clean - Unpaper
Clean Enum clean- cleanclean-final- clean-finalnone- none- Workflow
Action Type Enum 1- Assignment2- Removal3- Email4- Webhook- Workflow
Trigger Matching Algorithm Enum 0- None1- Any word2- All words3- Exact match4- Regular expression5- Fuzzy word- Workflow
Trigger Type Enum 1- Consumption Started2- Document Added3- Document Updated4- Scheduled