Struct SavedViews 

pub struct SavedViews {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl SavedViews

pub async fn list<'a>( &'a self, page: Option<i64>, page_size: Option<i64>, ) -> Result<PaginatedSavedViewList, Error>

Perform a GET request to /api/saved_views/.

Parameters:

• page: Option<i64>: A page number within the paginated result set.
• page_size: Option<i64>: Number of results to return per page.

use futures_util::TryStreamExt;
async fn example_saved_views_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut saved_views = client.saved_views();
    let mut stream = saved_views.list_stream(Some(4 as i64));
    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: &SavedViewRequest, ) -> Result<SavedView, Error>

Perform a POST request to /api/saved_views/.

async fn example_saved_views_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::SavedView = client
        .saved_views()
        .create(&paperless_api_client::types::SavedViewRequest {
            name: "some-string".to_string(),
            show_on_dashboard: true,
            show_in_sidebar: true,
            sort_field: Some("some-string".to_string()),
            sort_reverse: Some(true),
            filter_rules: vec![paperless_api_client::types::SavedViewFilterRuleRequest {
                rule_type: 4 as i64,
                value: Some("some-string".to_string()),
            }],
            page_size: Some(4 as i64),
            display_mode: Some(paperless_api_client::types::DisplayMode::LargeCards),
            display_fields: Some(serde_json::Value::String("some-string".to_string())),
            owner: Some(4 as i64),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

• id: i64: A unique integer value identifying this saved view. (required)

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

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

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

Parameters:

• id: i64: A unique integer value identifying this saved view. (required)

async fn example_saved_views_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::SavedView = client
        .saved_views()
        .update(
            4 as i64,
            &paperless_api_client::types::SavedViewRequest {
                name: "some-string".to_string(),
                show_on_dashboard: true,
                show_in_sidebar: true,
                sort_field: Some("some-string".to_string()),
                sort_reverse: Some(true),
                filter_rules: vec![paperless_api_client::types::SavedViewFilterRuleRequest {
                    rule_type: 4 as i64,
                    value: Some("some-string".to_string()),
                }],
                page_size: Some(4 as i64),
                display_mode: Some(paperless_api_client::types::DisplayMode::LargeCards),
                display_fields: Some(serde_json::Value::String("some-string".to_string())),
                owner: Some(4 as i64),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

• id: i64: A unique integer value identifying this saved view. (required)

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

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

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

Parameters:

• id: i64: A unique integer value identifying this saved view. (required)

async fn example_saved_views_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::SavedView = client
        .saved_views()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedSavedViewRequest {
                name: Some("some-string".to_string()),
                show_on_dashboard: Some(true),
                show_in_sidebar: Some(true),
                sort_field: Some("some-string".to_string()),
                sort_reverse: Some(true),
                filter_rules: Some(vec![paperless_api_client::types::SavedViewFilterRuleRequest {
                    rule_type: 4 as i64,
                    value: Some("some-string".to_string()),
                }]),
                page_size: Some(4 as i64),
                display_mode: Some(paperless_api_client::types::DisplayMode::LargeCards),
                display_fields: Some(serde_json::Value::String("some-string".to_string())),
                owner: Some(4 as i64),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for SavedViews

fn clone(&self) -> SavedViews

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SavedViews

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

Formats the value using the given formatter.