Crate paperless_api_client 

Paperless-ngx API client

API Details

OpenAPI Spec for Paperless-ngx

Client Details

The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
paperless-api-client = "6.0.0"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use paperless_api_client::Client;

let client = Client::new(
    String::from("api-key"),
);

Alternatively, the library can search for most of the variables required for the client in the environment:

• PAPERLESS_API_CLIENT_API_TOKEN

And then you can create a client from the environment.

use paperless_api_client::Client;

let client = Client::new_from_env();

Modules

bulk_edit_objectsrequests

configrequests

correspondentsrequests

custom_fieldsrequests

document_typesrequests

documentsrequests

groupsrequests

logsrequests

mail_accountsrequests

mail_rulesrequests

oauthrequests

profilerequests

remote_versionrequests

saved_viewsrequests

searchrequests

share_linksrequests

statisticsrequests

statusrequests

storage_pathsrequests

tagsrequests

tasksrequests

tokenrequests

trashrequests

types

This module contains the generated types for the library.

ui_settingsrequests

usersrequests

workflow_actionsrequests

workflow_triggersrequests

workflowsrequests

Structs

Clientrequests

Entrypoint for interacting with the API client.

RequestBuilderretry and requests

A request builder.