Struct CustomFields 

pub struct CustomFields {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl CustomFields

pub async fn list<'a>( &'a self, id: Option<i64>, id_in: Option<Vec<i64>>, 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<PaginatedCustomFieldList, Error>

Perform a GET request to /api/custom_fields/.

Mixin to add document count to queryset, permissions-aware if needed

Parameters:

• id: Option<i64>
• id_in: Option<Vec<i64>>: Multiple values may be separated by commas.
• 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_custom_fields_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut custom_fields = client.custom_fields();
    let mut stream = custom_fields.list_stream(
        Some(4 as i64),
        Some(vec![4 as i64]),
        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: &CustomFieldRequest, ) -> Result<CustomField, Error>

Perform a POST request to /api/custom_fields/.

Mixin to add document count to queryset, permissions-aware if needed

async fn example_custom_fields_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::CustomField = client
        .custom_fields()
        .create(&paperless_api_client::types::CustomFieldRequest {
            name: "some-string".to_string(),
            data_type: paperless_api_client::types::DataTypeEnum::Monetary,
            extra_data: Some(serde_json::Value::String("some-string".to_string())),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

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

Mixin to add document count to queryset, permissions-aware if needed

Parameters:

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

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

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

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

Mixin to add document count to queryset, permissions-aware if needed

Parameters:

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

async fn example_custom_fields_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::CustomField = client
        .custom_fields()
        .update(
            4 as i64,
            &paperless_api_client::types::CustomFieldRequest {
                name: "some-string".to_string(),
                data_type: paperless_api_client::types::DataTypeEnum::Monetary,
                extra_data: Some(serde_json::Value::String("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/custom_fields/{id}/.

Mixin to add document count to queryset, permissions-aware if needed

Parameters:

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

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

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

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

Mixin to add document count to queryset, permissions-aware if needed

Parameters:

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

async fn example_custom_fields_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::CustomField = client
        .custom_fields()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedCustomFieldRequest {
                name: Some("some-string".to_string()),
                data_type: Some(paperless_api_client::types::DataTypeEnum::Monetary),
                extra_data: Some(serde_json::Value::String("some-string".to_string())),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for CustomFields

fn clone(&self) -> CustomFields

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomFields

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

Formats the value using the given formatter.