Struct WorkflowActions 

pub struct WorkflowActions {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl WorkflowActions

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

Perform a GET request to /api/workflow_actions/.

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_actions_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut workflow_actions = client.workflow_actions();
    let mut stream = workflow_actions.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: &WorkflowActionRequest, ) -> Result<WorkflowAction, Error>

Perform a POST request to /api/workflow_actions/.

async fn example_workflow_actions_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::WorkflowAction = client
        .workflow_actions()
        .create(&paperless_api_client::types::WorkflowActionRequest {
            id: Some(4 as i64),
            type_: Some(4 as i64),
            assign_title: Some("some-string".to_string()),
            assign_tags: Some(vec![4 as i64]),
            assign_correspondent: Some(4 as i64),
            assign_document_type: Some(4 as i64),
            assign_storage_path: Some(4 as i64),
            assign_owner: Some(4 as i64),
            assign_view_users: Some(vec![4 as i64]),
            assign_view_groups: Some(vec![4 as i64]),
            assign_change_users: Some(vec![4 as i64]),
            assign_change_groups: Some(vec![4 as i64]),
            assign_custom_fields: Some(vec![4 as i64]),
            assign_custom_fields_values: Some(serde_json::Value::String("some-string".to_string())),
            remove_all_tags: Some(true),
            remove_tags: Some(vec![4 as i64]),
            remove_all_correspondents: Some(true),
            remove_correspondents: Some(vec![4 as i64]),
            remove_all_document_types: Some(true),
            remove_document_types: Some(vec![4 as i64]),
            remove_all_storage_paths: Some(true),
            remove_storage_paths: Some(vec![4 as i64]),
            remove_custom_fields: Some(vec![4 as i64]),
            remove_all_custom_fields: Some(true),
            remove_all_owners: Some(true),
            remove_owners: Some(vec![4 as i64]),
            remove_all_permissions: Some(true),
            remove_view_users: Some(vec![4 as i64]),
            remove_view_groups: Some(vec![4 as i64]),
            remove_change_users: Some(vec![4 as i64]),
            remove_change_groups: Some(vec![4 as i64]),
            email: Some(paperless_api_client::types::WorkflowActionEmailRequest {
                id: Some(4 as i64),
                subject: "some-string".to_string(),
                body: "some-string".to_string(),
                to: "some-string".to_string(),
                include_document: Some(true),
            }),
            webhook: Some(paperless_api_client::types::WorkflowActionWebhookRequest {
                id: Some(4 as i64),
                url: "some-string".to_string(),
                use_params: Some(true),
                as_json: Some(true),
                params: Some(serde_json::Value::String("some-string".to_string())),
                body: Some("some-string".to_string()),
                headers: Some(serde_json::Value::String("some-string".to_string())),
                include_document: Some(true),
            }),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

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

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

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

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

Parameters:

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

async fn example_workflow_actions_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::WorkflowAction = client
        .workflow_actions()
        .update(
            4 as i64,
            &paperless_api_client::types::WorkflowActionRequest {
                id: Some(4 as i64),
                type_: Some(4 as i64),
                assign_title: Some("some-string".to_string()),
                assign_tags: Some(vec![4 as i64]),
                assign_correspondent: Some(4 as i64),
                assign_document_type: Some(4 as i64),
                assign_storage_path: Some(4 as i64),
                assign_owner: Some(4 as i64),
                assign_view_users: Some(vec![4 as i64]),
                assign_view_groups: Some(vec![4 as i64]),
                assign_change_users: Some(vec![4 as i64]),
                assign_change_groups: Some(vec![4 as i64]),
                assign_custom_fields: Some(vec![4 as i64]),
                assign_custom_fields_values: Some(serde_json::Value::String(
                    "some-string".to_string(),
                )),
                remove_all_tags: Some(true),
                remove_tags: Some(vec![4 as i64]),
                remove_all_correspondents: Some(true),
                remove_correspondents: Some(vec![4 as i64]),
                remove_all_document_types: Some(true),
                remove_document_types: Some(vec![4 as i64]),
                remove_all_storage_paths: Some(true),
                remove_storage_paths: Some(vec![4 as i64]),
                remove_custom_fields: Some(vec![4 as i64]),
                remove_all_custom_fields: Some(true),
                remove_all_owners: Some(true),
                remove_owners: Some(vec![4 as i64]),
                remove_all_permissions: Some(true),
                remove_view_users: Some(vec![4 as i64]),
                remove_view_groups: Some(vec![4 as i64]),
                remove_change_users: Some(vec![4 as i64]),
                remove_change_groups: Some(vec![4 as i64]),
                email: Some(paperless_api_client::types::WorkflowActionEmailRequest {
                    id: Some(4 as i64),
                    subject: "some-string".to_string(),
                    body: "some-string".to_string(),
                    to: "some-string".to_string(),
                    include_document: Some(true),
                }),
                webhook: Some(paperless_api_client::types::WorkflowActionWebhookRequest {
                    id: Some(4 as i64),
                    url: "some-string".to_string(),
                    use_params: Some(true),
                    as_json: Some(true),
                    params: Some(serde_json::Value::String("some-string".to_string())),
                    body: Some("some-string".to_string()),
                    headers: Some(serde_json::Value::String("some-string".to_string())),
                    include_document: Some(true),
                }),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

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

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

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

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

Parameters:

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

async fn example_workflow_actions_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::WorkflowAction = client
        .workflow_actions()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedWorkflowActionRequest {
                id: Some(4 as i64),
                type_: Some(4 as i64),
                assign_title: Some("some-string".to_string()),
                assign_tags: Some(vec![4 as i64]),
                assign_correspondent: Some(4 as i64),
                assign_document_type: Some(4 as i64),
                assign_storage_path: Some(4 as i64),
                assign_owner: Some(4 as i64),
                assign_view_users: Some(vec![4 as i64]),
                assign_view_groups: Some(vec![4 as i64]),
                assign_change_users: Some(vec![4 as i64]),
                assign_change_groups: Some(vec![4 as i64]),
                assign_custom_fields: Some(vec![4 as i64]),
                assign_custom_fields_values: Some(serde_json::Value::String(
                    "some-string".to_string(),
                )),
                remove_all_tags: Some(true),
                remove_tags: Some(vec![4 as i64]),
                remove_all_correspondents: Some(true),
                remove_correspondents: Some(vec![4 as i64]),
                remove_all_document_types: Some(true),
                remove_document_types: Some(vec![4 as i64]),
                remove_all_storage_paths: Some(true),
                remove_storage_paths: Some(vec![4 as i64]),
                remove_custom_fields: Some(vec![4 as i64]),
                remove_all_custom_fields: Some(true),
                remove_all_owners: Some(true),
                remove_owners: Some(vec![4 as i64]),
                remove_all_permissions: Some(true),
                remove_view_users: Some(vec![4 as i64]),
                remove_view_groups: Some(vec![4 as i64]),
                remove_change_users: Some(vec![4 as i64]),
                remove_change_groups: Some(vec![4 as i64]),
                email: Some(paperless_api_client::types::WorkflowActionEmailRequest {
                    id: Some(4 as i64),
                    subject: "some-string".to_string(),
                    body: "some-string".to_string(),
                    to: "some-string".to_string(),
                    include_document: Some(true),
                }),
                webhook: Some(paperless_api_client::types::WorkflowActionWebhookRequest {
                    id: Some(4 as i64),
                    url: "some-string".to_string(),
                    use_params: Some(true),
                    as_json: Some(true),
                    params: Some(serde_json::Value::String("some-string".to_string())),
                    body: Some("some-string".to_string()),
                    headers: Some(serde_json::Value::String("some-string".to_string())),
                    include_document: Some(true),
                }),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for WorkflowActions

fn clone(&self) -> WorkflowActions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowActions

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

Formats the value using the given formatter.