Struct Config 

pub struct Config {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl Config

pub async fn list<'a>(&'a self) -> Result<Vec<ApplicationConfiguration>, Error>

Perform a GET request to /api/config/.

Get the application configuration

See <https://docs.paperless-ngx.com/configuration/|Application Configuration> for more information.

async fn example_config_list() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: Vec<paperless_api_client::types::ApplicationConfiguration> = client.config().list().await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn retrieve<'a>( &'a self, id: i64, ) -> Result<ApplicationConfiguration, Error>

Perform a GET request to /api/config/{id}/.

Parameters:

• id: i64: A unique integer value identifying this paperless application settings. (required)

async fn example_config_retrieve() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::ApplicationConfiguration = client.config().retrieve(4 as i64).await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn update<'a>( &'a self, id: i64, body: &ApplicationConfigurationRequest, ) -> Result<ApplicationConfiguration, Error>

Perform a PUT request to /api/config/{id}/.

Parameters:

• id: i64: A unique integer value identifying this paperless application settings. (required)

async fn example_config_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::ApplicationConfiguration = client
        .config()
        .update(
            4 as i64,
            &paperless_api_client::types::ApplicationConfigurationRequest {
                user_args: Some(serde_json::Value::String("some-string".to_string())),
                barcode_tag_mapping: Some(serde_json::Value::String("some-string".to_string())),
                output_type: Some(paperless_api_client::types::OutputType::Pdfa2),
                pages: Some(4 as i64),
                language: Some("some-string".to_string()),
                mode: Some(paperless_api_client::types::Mode::SkipNoarchive),
                skip_archive_file: Some(paperless_api_client::types::SkipArchiveFile::Always),
                image_dpi: Some(4 as i64),
                unpaper_clean: Some(paperless_api_client::types::UnpaperClean::None),
                deskew: Some(true),
                rotate_pages: Some(true),
                rotate_pages_threshold: Some(3.14 as f64),
                max_image_pixels: Some(3.14 as f64),
                color_conversion_strategy: Some(paperless_api_client::types::ColorConversionStrategy::Gray),
                app_title: Some("some-string".to_string()),
                app_logo: Some(bytes::Bytes::from("some-string")),
                barcodes_enabled: Some(true),
                barcode_enable_tiff_support: Some(true),
                barcode_string: Some("some-string".to_string()),
                barcode_retain_split_pages: Some(true),
                barcode_enable_asn: Some(true),
                barcode_asn_prefix: Some("some-string".to_string()),
                barcode_upscale: Some(3.14 as f64),
                barcode_dpi: Some(4 as i64),
                barcode_max_pages: Some(4 as i64),
                barcode_enable_tag: Some(true),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn destroy<'a>(&'a self, id: i64) -> Result<(), Error>

Perform a DELETE request to /api/config/{id}/.

Parameters:

• id: i64: A unique integer value identifying this paperless application settings. (required)

async fn example_config_destroy() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    client.config().destroy(4 as i64).await?;
    Ok(())
}

pub async fn partial_update<'a>( &'a self, id: i64, body: &PatchedApplicationConfigurationRequest, ) -> Result<ApplicationConfiguration, Error>

Perform a PATCH request to /api/config/{id}/.

Parameters:

• id: i64: A unique integer value identifying this paperless application settings. (required)

async fn example_config_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::ApplicationConfiguration = client
        .config()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedApplicationConfigurationRequest {
                user_args: Some(serde_json::Value::String("some-string".to_string())),
                barcode_tag_mapping: Some(serde_json::Value::String("some-string".to_string())),
                output_type: Some(paperless_api_client::types::OutputType::Pdfa2),
                pages: Some(4 as i64),
                language: Some("some-string".to_string()),
                mode: Some(paperless_api_client::types::Mode::SkipNoarchive),
                skip_archive_file: Some(paperless_api_client::types::SkipArchiveFile::Always),
                image_dpi: Some(4 as i64),
                unpaper_clean: Some(paperless_api_client::types::UnpaperClean::None),
                deskew: Some(true),
                rotate_pages: Some(true),
                rotate_pages_threshold: Some(3.14 as f64),
                max_image_pixels: Some(3.14 as f64),
                color_conversion_strategy: Some(paperless_api_client::types::ColorConversionStrategy::Gray),
                app_title: Some("some-string".to_string()),
                app_logo: Some(bytes::Bytes::from("some-string")),
                barcodes_enabled: Some(true),
                barcode_enable_tiff_support: Some(true),
                barcode_string: Some("some-string".to_string()),
                barcode_retain_split_pages: Some(true),
                barcode_enable_asn: Some(true),
                barcode_asn_prefix: Some("some-string".to_string()),
                barcode_upscale: Some(3.14 as f64),
                barcode_dpi: Some(4 as i64),
                barcode_max_pages: Some(4 as i64),
                barcode_enable_tag: Some(true),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.