Struct WorkflowTriggers 

pub struct WorkflowTriggers {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl WorkflowTriggers

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

Perform a GET request to /api/workflow_triggers/.

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_workflow_triggers_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut workflow_triggers = client.workflow_triggers();
    let mut stream = workflow_triggers.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: &WorkflowTriggerRequest, ) -> Result<WorkflowTrigger, Error>

Perform a POST request to /api/workflow_triggers/.

async fn example_workflow_triggers_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::WorkflowTrigger = client
        .workflow_triggers()
        .create(&paperless_api_client::types::WorkflowTriggerRequest {
            id: Some(4 as i64),
            sources: vec![4 as i64],
            type_: 4 as i64,
            filter_path: Some("some-string".to_string()),
            filter_filename: Some("some-string".to_string()),
            filter_mailrule: Some(4 as i64),
            matching_algorithm: Some(4 as i64),
            match_: Some("some-string".to_string()),
            is_insensitive: Some(true),
            filter_has_tags: Some(vec![4 as i64]),
            filter_has_correspondent: Some(4 as i64),
            filter_has_document_type: Some(4 as i64),
            schedule_offset_days: Some(4 as i64),
            schedule_is_recurring: Some(true),
            schedule_recurring_interval_days: Some(4 as i64),
            schedule_date_field: Some(paperless_api_client::types::ScheduleDateFieldEnum::Modified),
            schedule_date_custom_field: Some(4 as i64),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

• id: i64: A unique integer value identifying this workflow trigger. (required)

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

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

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

Parameters:

• id: i64: A unique integer value identifying this workflow trigger. (required)

async fn example_workflow_triggers_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::WorkflowTrigger = client
        .workflow_triggers()
        .update(
            4 as i64,
            &paperless_api_client::types::WorkflowTriggerRequest {
                id: Some(4 as i64),
                sources: vec![4 as i64],
                type_: 4 as i64,
                filter_path: Some("some-string".to_string()),
                filter_filename: Some("some-string".to_string()),
                filter_mailrule: Some(4 as i64),
                matching_algorithm: Some(4 as i64),
                match_: Some("some-string".to_string()),
                is_insensitive: Some(true),
                filter_has_tags: Some(vec![4 as i64]),
                filter_has_correspondent: Some(4 as i64),
                filter_has_document_type: Some(4 as i64),
                schedule_offset_days: Some(4 as i64),
                schedule_is_recurring: Some(true),
                schedule_recurring_interval_days: Some(4 as i64),
                schedule_date_field: Some(paperless_api_client::types::ScheduleDateFieldEnum::Modified),
                schedule_date_custom_field: 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/workflow_triggers/{id}/.

Parameters:

• id: i64: A unique integer value identifying this workflow trigger. (required)

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

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

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

Parameters:

• id: i64: A unique integer value identifying this workflow trigger. (required)

async fn example_workflow_triggers_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::WorkflowTrigger = client
        .workflow_triggers()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedWorkflowTriggerRequest {
                id: Some(4 as i64),
                sources: vec![4 as i64],
                type_: Some(4 as i64),
                filter_path: Some("some-string".to_string()),
                filter_filename: Some("some-string".to_string()),
                filter_mailrule: Some(4 as i64),
                matching_algorithm: Some(4 as i64),
                match_: Some("some-string".to_string()),
                is_insensitive: Some(true),
                filter_has_tags: Some(vec![4 as i64]),
                filter_has_correspondent: Some(4 as i64),
                filter_has_document_type: Some(4 as i64),
                schedule_offset_days: Some(4 as i64),
                schedule_is_recurring: Some(true),
                schedule_recurring_interval_days: Some(4 as i64),
                schedule_date_field: Some(paperless_api_client::types::ScheduleDateFieldEnum::Modified),
                schedule_date_custom_field: Some(4 as i64),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for WorkflowTriggers

fn clone(&self) -> WorkflowTriggers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowTriggers

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

Formats the value using the given formatter.