Struct StoragePaths 

pub struct StoragePaths {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl StoragePaths

pub async fn list<'a>( &'a self, full_perms: Option<bool>, id: Option<i64>, id_in: Option<Vec<i64>>, name_icontains: Option<String>, name_iendswith: Option<String>, name_iexact: Option<String>, name_istartswith: Option<String>, ordering: Option<String>, page: Option<i64>, page_size: Option<i64>, path_icontains: Option<String>, path_iendswith: Option<String>, path_iexact: Option<String>, path_istartswith: Option<String>, ) -> Result<PaginatedStoragePathList, Error>

Perform a GET request to /api/storage_paths/.

Parameters:

• full_perms: Option<bool>
• id: Option<i64>
• id_in: Option<Vec<i64>>: Multiple values may be separated by commas.
• name_icontains: Option<String>
• name_iendswith: Option<String>
• name_iexact: Option<String>
• name_istartswith: Option<String>
• ordering: Option<String>: Which field to use when ordering the results.
• page: Option<i64>: A page number within the paginated result set.
• page_size: Option<i64>: Number of results to return per page.
• path_icontains: Option<String>
• path_iendswith: Option<String>
• path_iexact: Option<String>
• path_istartswith: Option<String>

use futures_util::TryStreamExt;
async fn example_storage_paths_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut storage_paths = client.storage_paths();
    let mut stream = storage_paths.list_stream(
        Some(true),
        Some(4 as i64),
        Some(vec![4 as i64]),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
        Some(4 as i64),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
    );
    loop {
        match stream.try_next().await {
            Ok(Some(item)) => {
                println!("{:?}", item);
            }
            Ok(None) => {
                break;
            }
            Err(err) => {
                return Err(err.into());
            }
        }
    }

    Ok(())
}

pub async fn create<'a>( &'a self, body: &StoragePathRequest, ) -> Result<StoragePath, Error>

Perform a POST request to /api/storage_paths/.

async fn example_storage_paths_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::StoragePath = client
        .storage_paths()
        .create(&paperless_api_client::types::StoragePathRequest {
            name: "some-string".to_string(),
            path: "some-string".to_string(),
            match_: Some("some-string".to_string()),
            matching_algorithm: Some(4 as i64),
            is_insensitive: Some(true),
            owner: Some(4 as i64),
            set_permissions: Some(paperless_api_client::types::SetPermissions {
                view: Some(paperless_api_client::types::View {
                    users: Some(vec![4 as i64]),
                    groups: Some(vec![4 as i64]),
                }),
                change: Some(paperless_api_client::types::Change {
                    users: Some(vec![4 as i64]),
                    groups: Some(vec![4 as i64]),
                }),
            }),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn retrieve<'a>( &'a self, full_perms: Option<bool>, id: i64, ) -> Result<StoragePath, Error>

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

Parameters:

• full_perms: Option<bool>
• id: i64: A unique integer value identifying this storage path. (required)

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

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

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

Parameters:

• id: i64: A unique integer value identifying this storage path. (required)

async fn example_storage_paths_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::StoragePath = client
        .storage_paths()
        .update(
            4 as i64,
            &paperless_api_client::types::StoragePathRequest {
                name: "some-string".to_string(),
                path: "some-string".to_string(),
                match_: Some("some-string".to_string()),
                matching_algorithm: Some(4 as i64),
                is_insensitive: Some(true),
                owner: Some(4 as i64),
                set_permissions: Some(paperless_api_client::types::SetPermissions {
                    view: Some(paperless_api_client::types::View {
                        users: Some(vec![4 as i64]),
                        groups: Some(vec![4 as i64]),
                    }),
                    change: Some(paperless_api_client::types::Change {
                        users: Some(vec![4 as i64]),
                        groups: Some(vec![4 as i64]),
                    }),
                }),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

When a storage path is deleted, see if documents using it require a rename/move

Parameters:

• id: i64: A unique integer value identifying this storage path. (required)

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

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

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

Parameters:

• id: i64: A unique integer value identifying this storage path. (required)

async fn example_storage_paths_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::StoragePath = client
        .storage_paths()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedStoragePathRequest {
                name: Some("some-string".to_string()),
                path: Some("some-string".to_string()),
                match_: Some("some-string".to_string()),
                matching_algorithm: Some(4 as i64),
                is_insensitive: Some(true),
                owner: Some(4 as i64),
                set_permissions: Some(paperless_api_client::types::SetPermissions {
                    view: Some(paperless_api_client::types::View {
                        users: Some(vec![4 as i64]),
                        groups: Some(vec![4 as i64]),
                    }),
                    change: Some(paperless_api_client::types::Change {
                        users: Some(vec![4 as i64]),
                        groups: Some(vec![4 as i64]),
                    }),
                }),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn test_create<'a>( &'a self, body: &StoragePathRequest, ) -> Result<StoragePath, Error>

Perform a POST request to /api/storage_paths/test/.

Test storage path against a document

async fn example_storage_paths_test_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::StoragePath = client
        .storage_paths()
        .test_create(&paperless_api_client::types::StoragePathRequest {
            name: "some-string".to_string(),
            path: "some-string".to_string(),
            match_: Some("some-string".to_string()),
            matching_algorithm: Some(4 as i64),
            is_insensitive: Some(true),
            owner: Some(4 as i64),
            set_permissions: Some(paperless_api_client::types::SetPermissions {
                view: Some(paperless_api_client::types::View {
                    users: Some(vec![4 as i64]),
                    groups: Some(vec![4 as i64]),
                }),
                change: Some(paperless_api_client::types::Change {
                    users: Some(vec![4 as i64]),
                    groups: Some(vec![4 as i64]),
                }),
            }),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for StoragePaths

fn clone(&self) -> StoragePaths

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoragePaths

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

Formats the value using the given formatter.