Struct Groups 

pub struct Groups {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl Groups

pub async fn list<'a>( &'a self, 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>, ) -> Result<PaginatedGroupList, Error>

Perform a GET request to /api/groups/.

Parameters:

• 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.

use futures_util::TryStreamExt;
async fn example_groups_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut groups = client.groups();
    let mut stream = groups.list_stream(
        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),
    );
    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: &GroupRequest) -> Result<Group, Error>

Perform a POST request to /api/groups/.

async fn example_groups_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::Group = client
        .groups()
        .create(&paperless_api_client::types::GroupRequest {
            name: "some-string".to_string(),
            permissions: vec!["some-string".to_string()],
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

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

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

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

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

Parameters:

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

async fn example_groups_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::Group = client
        .groups()
        .update(
            4 as i64,
            &paperless_api_client::types::GroupRequest {
                name: "some-string".to_string(),
                permissions: vec!["some-string".to_string()],
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

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

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

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

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

Parameters:

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

async fn example_groups_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::Group = client
        .groups()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedGroupRequest {
                name: Some("some-string".to_string()),
                permissions: Some(vec!["some-string".to_string()]),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Groups

fn clone(&self) -> Groups

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Groups

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

Formats the value using the given formatter.