paperless_api_client/
bulk_edit_objects.rs

1use crate::Client;
2use anyhow::Result;
3#[derive(Clone, Debug)]
4pub struct BulkEditObjects {
5    pub client: Client,
6}
7
8impl BulkEditObjects {
9    #[doc(hidden)]
10    pub fn new(client: Client) -> Self {
11        Self { client }
12    }
13
14    #[doc = "Perform a `POST` request to `/api/bulk_edit_objects/`.\n\nPerform a bulk edit operation on a list of objects\n\nSee <https://docs.paperless-ngx.com/api/#objects|Further documentation> for more information.\n\n```rust,no_run\nasync fn example_bulk_edit_objects_bulk_edit_objects() -> anyhow::Result<()> {\n    let client = paperless_api_client::Client::new_from_env();\n    let result: paperless_api_client::types::BulkEditResult = client\n        .bulk_edit_objects()\n        .bulk_edit_objects(&paperless_api_client::types::BulkEditObjectsRequest {\n            objects: vec![4 as i64],\n            object_type: paperless_api_client::types::ObjectTypeEnum::DocumentTypes,\n            operation: paperless_api_client::types::OperationEnum::Delete,\n            owner: Some(4 as i64),\n            permissions: Some(std::collections::HashMap::from([(\n                \"some-key\".to_string(),\n                serde_json::Value::String(\"some-string\".to_string()),\n            )])),\n            merge: true,\n        })\n        .await?;\n    println!(\"{:?}\", result);\n    Ok(())\n}\n```"]
15    #[tracing::instrument]
16    #[allow(non_snake_case)]
17    pub async fn bulk_edit_objects<'a>(
18        &'a self,
19        body: &crate::types::BulkEditObjectsRequest,
20    ) -> Result<crate::types::BulkEditResult, crate::types::error::Error> {
21        let mut req = self.client.client.request(
22            http::Method::POST,
23            format!("{}/{}", self.client.base_url, "api/bulk_edit_objects/"),
24        );
25        req = req.header("Authorization", format!("Token {}", &self.client.token));
26        req = req.json(body);
27        let resp = req.send().await?;
28        let status = resp.status();
29        if status.is_success() {
30            let text = resp.text().await.unwrap_or_default();
31            serde_json::from_str(&text).map_err(|err| {
32                crate::types::error::Error::from_serde_error(
33                    format_serde_error::SerdeError::new(text.to_string(), err),
34                    status,
35                )
36            })
37        } else {
38            let text = resp.text().await.unwrap_or_default();
39            Err(crate::types::error::Error::Server {
40                body: text.to_string(),
41                status,
42            })
43        }
44    }
45}