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
Request - Adds update nested feature
- Document
Share Links Response - Document
Type - Document
Type Counts - Document
Type Request - Email
Request Request - Email
Response - 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
Notes 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
Share Link 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 - 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§
- Color
Conversion Strategy - Color
Conversion Strategy Enum LeaveColorUnchanged- LeaveColorUnchangedRGB- RGBUseDeviceIndependentColor- UseDeviceIndependentColorGray- GrayCMYK- CMYK- Compression
Enum none- nonedeflated- deflatedbzip2- bzip2lzma- lzma- Content
Enum archive- archiveoriginals- originalsboth- both- Data
Type Enum string- stringurl- urldate- dateboolean- booleaninteger- integerfloat- floatmonetary- monetarydocumentlink- documentlinkselect- select- Display
Mode - Display
Mode Enum table- TablesmallCards- Small CardslargeCards- Large Cards- File
Version Enum archive- Archiveoriginal- Original- List
Task Name - 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- Schedule
Date Field Enum added- Addedcreated- Createdmodified- Modifiedcustom_field- Custom Field- Skip
Archive File - Skip
Archive File Enum never- neverwith_text- with_textalways- always- 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