Struct ShareLinks 

pub struct ShareLinks {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl ShareLinks

pub async fn list<'a>( &'a self, created_date_gt: Option<NaiveDate>, created_date_gte: Option<NaiveDate>, created_date_lt: Option<NaiveDate>, created_date_lte: Option<NaiveDate>, created_day: Option<f64>, created_gt: Option<DateTime<Utc>>, created_gte: Option<DateTime<Utc>>, created_lt: Option<DateTime<Utc>>, created_lte: Option<DateTime<Utc>>, created_month: Option<f64>, created_year: Option<f64>, expiration_date_gt: Option<NaiveDate>, expiration_date_gte: Option<NaiveDate>, expiration_date_lt: Option<NaiveDate>, expiration_date_lte: Option<NaiveDate>, expiration_day: Option<f64>, expiration_gt: Option<DateTime<Utc>>, expiration_gte: Option<DateTime<Utc>>, expiration_lt: Option<DateTime<Utc>>, expiration_lte: Option<DateTime<Utc>>, expiration_month: Option<f64>, expiration_year: Option<f64>, ordering: Option<String>, page: Option<i64>, page_size: Option<i64>, ) -> Result<PaginatedShareLinkList, Error>

Perform a GET request to /api/share_links/.

Parameters:

• created_date_gt: Option<chrono::NaiveDate>
• created_date_gte: Option<chrono::NaiveDate>
• created_date_lt: Option<chrono::NaiveDate>
• created_date_lte: Option<chrono::NaiveDate>
• created_day: Option<f64>
• created_gt: Option<chrono::DateTime<chrono::Utc>>
• created_gte: Option<chrono::DateTime<chrono::Utc>>
• created_lt: Option<chrono::DateTime<chrono::Utc>>
• created_lte: Option<chrono::DateTime<chrono::Utc>>
• created_month: Option<f64>
• created_year: Option<f64>
• expiration_date_gt: Option<chrono::NaiveDate>
• expiration_date_gte: Option<chrono::NaiveDate>
• expiration_date_lt: Option<chrono::NaiveDate>
• expiration_date_lte: Option<chrono::NaiveDate>
• expiration_day: Option<f64>
• expiration_gt: Option<chrono::DateTime<chrono::Utc>>
• expiration_gte: Option<chrono::DateTime<chrono::Utc>>
• expiration_lt: Option<chrono::DateTime<chrono::Utc>>
• expiration_lte: Option<chrono::DateTime<chrono::Utc>>
• expiration_month: Option<f64>
• expiration_year: Option<f64>
• 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.

use futures_util::TryStreamExt;
async fn example_share_links_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut share_links = client.share_links();
    let mut stream = share_links.list_stream(
        Some(chrono::Utc::now().date_naive()),
        Some(chrono::Utc::now().date_naive()),
        Some(chrono::Utc::now().date_naive()),
        Some(chrono::Utc::now().date_naive()),
        Some(3.14 as f64),
        Some(chrono::Utc::now()),
        Some(chrono::Utc::now()),
        Some(chrono::Utc::now()),
        Some(chrono::Utc::now()),
        Some(3.14 as f64),
        Some(3.14 as f64),
        Some(chrono::Utc::now().date_naive()),
        Some(chrono::Utc::now().date_naive()),
        Some(chrono::Utc::now().date_naive()),
        Some(chrono::Utc::now().date_naive()),
        Some(3.14 as f64),
        Some(chrono::Utc::now()),
        Some(chrono::Utc::now()),
        Some(chrono::Utc::now()),
        Some(chrono::Utc::now()),
        Some(3.14 as f64),
        Some(3.14 as f64),
        Some("some-string".to_string()),
        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: &ShareLinkRequest, ) -> Result<ShareLink, Error>

Perform a POST request to /api/share_links/.

async fn example_share_links_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::ShareLink = client
        .share_links()
        .create(&paperless_api_client::types::ShareLinkRequest {
            expiration: Some(chrono::Utc::now()),
            document: Some(4 as i64),
            file_version: Some(paperless_api_client::types::FileVersionEnum::Original),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

• id: i64: A unique integer value identifying this share link. (required)

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

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

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

Parameters:

• id: i64: A unique integer value identifying this share link. (required)

async fn example_share_links_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::ShareLink = client
        .share_links()
        .update(
            4 as i64,
            &paperless_api_client::types::ShareLinkRequest {
                expiration: Some(chrono::Utc::now()),
                document: Some(4 as i64),
                file_version: Some(paperless_api_client::types::FileVersionEnum::Original),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

• id: i64: A unique integer value identifying this share link. (required)

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

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

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

Parameters:

• id: i64: A unique integer value identifying this share link. (required)

async fn example_share_links_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::ShareLink = client
        .share_links()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedShareLinkRequest {
                expiration: Some(chrono::Utc::now()),
                document: Some(4 as i64),
                file_version: Some(paperless_api_client::types::FileVersionEnum::Original),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for ShareLinks

fn clone(&self) -> ShareLinks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShareLinks

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

Formats the value using the given formatter.