Struct Users 

pub struct Users {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl Users

pub async fn list<'a>( &'a self, ordering: Option<String>, page: Option<i64>, page_size: Option<i64>, username_icontains: Option<String>, username_iendswith: Option<String>, username_iexact: Option<String>, username_istartswith: Option<String>, ) -> Result<PaginatedUserList, Error>

Perform a GET request to /api/users/.

Parameters:

• 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.
• username_icontains: Option<String>
• username_iendswith: Option<String>
• username_iexact: Option<String>
• username_istartswith: Option<String>

use futures_util::TryStreamExt;
async fn example_users_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut users = client.users();
    let mut stream = users.list_stream(
        Some("some-string".to_string()),
        Some(4 as i64),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
        Some("some-string".to_string()),
    );
    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: &UserRequest) -> Result<User, Error>

Perform a POST request to /api/users/.

async fn example_users_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::User = client
        .users()
        .create(&paperless_api_client::types::UserRequest {
            username: "some-string".to_string(),
            email: Some("email@example.com".to_string()),
            password: Some("some-string".to_string()),
            first_name: Some("some-string".to_string()),
            last_name: Some("some-string".to_string()),
            date_joined: Some(chrono::Utc::now()),
            is_staff: Some(true),
            is_active: Some(true),
            is_superuser: Some(true),
            groups: Some(vec![4 as i64]),
            user_permissions: Some(vec!["some-string".to_string()]),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Parameters:

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

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

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

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

Parameters:

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

async fn example_users_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::User = client
        .users()
        .update(
            4 as i64,
            &paperless_api_client::types::UserRequest {
                username: "some-string".to_string(),
                email: Some("email@example.com".to_string()),
                password: Some("some-string".to_string()),
                first_name: Some("some-string".to_string()),
                last_name: Some("some-string".to_string()),
                date_joined: Some(chrono::Utc::now()),
                is_staff: Some(true),
                is_active: Some(true),
                is_superuser: Some(true),
                groups: Some(vec![4 as i64]),
                user_permissions: Some(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/users/{id}/.

Parameters:

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

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

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

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

Parameters:

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

async fn example_users_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::User = client
        .users()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedUserRequest {
                username: Some("some-string".to_string()),
                email: Some("email@example.com".to_string()),
                password: Some("some-string".to_string()),
                first_name: Some("some-string".to_string()),
                last_name: Some("some-string".to_string()),
                date_joined: Some(chrono::Utc::now()),
                is_staff: Some(true),
                is_active: Some(true),
                is_superuser: Some(true),
                groups: Some(vec![4 as i64]),
                user_permissions: Some(vec!["some-string".to_string()]),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Perform a POST request to /api/users/{id}/deactivate_totp/.

Parameters:

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

async fn example_users_deactivate_totp_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: bool = client.users().deactivate_totp_create(4 as i64).await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Users

fn clone(&self) -> Users

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Users

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

Formats the value using the given formatter.